From 2959ffd48dae2df1e43bd236a8846035026491b8 Mon Sep 17 00:00:00 2001 From: Steve S Date: Tue, 5 May 2026 15:55:02 -0400 Subject: [PATCH 1/2] Bump base image version (#61047) --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 7ec6e6bd9fdc..567e20f66006 100644 --- a/Dockerfile +++ b/Dockerfile @@ -10,7 +10,7 @@ # --------------------------------------------------------------- # To update the sha: # https://github.com/github/gh-base-image/pkgs/container/gh-base-image%2Fgh-base-noble -FROM ghcr.io/github/gh-base-image/gh-base-noble:20260326-105710-g59112a0a7@sha256:ba809251141daf76a02c7c064ae2c3b27a904f2f62b16582f62fe4328267f38f AS base +FROM ghcr.io/github/gh-base-image/gh-base-noble:20260501-222137-g8063ecb13@sha256:9c650d5e53cbf6c95951373d197ede7955329ef695f5fc6fb8a1c56a8e3b817f AS base # Install curl for Node install and determining the early access branch # Install git for cloning docs-early-access & translations repos From 4f3dacffca200fcc60e74c81ccdab32a87ed84e8 Mon Sep 17 00:00:00 2001 From: Evan Bonsignori Date: Tue, 5 May 2026 12:59:43 -0700 Subject: [PATCH 2/2] Deprecate GHES 3.14 (#61000) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- .gitignore | 1 + .../events-that-trigger-workflows.md | 2 +- ...c-user-license-sync-for-your-enterprise.md | 4 +- ...rsonal-access-tokens-in-your-enterprise.md | 8 +- ...d-security-features-for-your-enterprise.md | 8 +- ...aming-the-audit-log-for-your-enterprise.md | 4 +- .../upgrading-a-cluster.md | 6 - .../increasing-storage-capacity.md | 2 +- content/admin/overview/system-overview.md | 2 +- .../performing-an-upgrade/index.md | 4 +- ...preparing-for-the-elasticsearch-upgrade.md | 56 - ...n-issues-with-upgrades-to-your-instance.md | 10 - .../github-advanced-security.md | 5 +- .../view-enterprise-usage.md | 3 +- .../about-code-scanning-alerts.md | 4 - .../pull-request-alert-metrics.md | 4 +- .../secret-security/about-push-protection.md | 9 +- ...-with-push-protection-from-the-rest-api.md | 4 +- ...out-enabling-security-features-at-scale.md | 4 +- .../about-security-overview.md | 6 +- .../code-security/getting-started/index.md | 1 - ...ickstart-for-securing-your-organization.md | 119 - ...iguring-default-setup-for-code-scanning.md | 3 - ...ing-your-configuration-of-default-setup.md | 5 +- .../using-the-codeql-model-editor.md | 2 +- ...ode-scanning-alerts-for-your-repository.md | 4 - ...urity-configuration-for-your-enterprise.md | 12 +- ...rity-features-for-multiple-repositories.md | 58 - .../establish-complete-coverage/index.md | 2 +- ...efault-setup-for-code-scanning-at-scale.md | 84 +- ...pplying-a-custom-security-configuration.md | 4 +- ...security-settings-for-your-organization.md | 4 +- ...reating-a-custom-security-configuration.md | 16 +- ...-github-advanced-security-license-usage.md | 4 +- ...eleting-a-custom-security-configuration.md | 4 +- ...ries-from-their-security-configurations.md | 4 +- ...editing-a-custom-security-configuration.md | 4 +- ...organization-using-the-repository-table.md | 4 +- ...ing-custom-patterns-for-secret-scanning.md | 10 +- .../managing-custom-patterns.md | 7 +- ...cret-scanning-for-non-provider-patterns.md | 10 +- ...ing-secret-scanning-for-your-repository.md | 8 - ...ng-delegated-bypass-for-push-protection.md | 6 +- ...h-push-protection-from-the-command-line.md | 4 +- ...g-with-push-protection-in-the-github-ui.md | 4 +- ...e-rules-to-prioritize-dependabot-alerts.md | 38 +- .../configuring-dependabot-alerts.md | 21 +- ...configuring-dependabot-security-updates.md | 12 +- .../enabling-the-dependency-graph.md | 2 +- .../assessing-adoption-code-security.md | 27 +- .../find-insecure-repositories.md | 4 +- ...viewing-metrics-for-pull-request-alerts.md | 4 +- ...ptions-and-steps-for-compiled-languages.md | 14 +- .../security-overview-permissions.md | 2 +- ...ret-scanning-pattern-configuration-data.md | 7 +- .../security-configuration-enforcement.md | 4 +- ...-using-advanced-setup-for-code-scanning.md | 4 +- ...g-repositories-with-attachment-failures.md | 4 +- ...nough-github-advanced-security-licenses.md | 4 +- .../unexpected-default-setup.md | 4 +- .../dependabot-options-reference.md | 10 +- .../phase-3-pilot-programs.md | 14 - ...phase-5-rollout-and-scale-code-scanning.md | 10 +- ...ase-6-rollout-and-scale-secret-scanning.md | 8 - .../secure-your-organization/index.md | 2 + .../about-github-advanced-security.md | 8 - ...analysis-settings-for-your-organization.md | 92 - ...s-for-repositories-in-your-organization.md | 5 +- .../managing-custom-organization-roles.md | 2 +- ...-security-managers-in-your-organization.md | 10 +- ...ssions-of-predefined-organization-roles.md | 10 +- .../roles-in-an-organization.md | 7 - .../using-organization-roles.md | 6 +- ...cess-token-policy-for-your-organization.md | 8 +- ...my-commit-is-blocked-by-push-protection.md | 10 +- ...lyzing-changes-to-a-repositorys-content.md | 2 - .../viewing-a-projects-contributors.md | 4 - content/rest/enterprise-admin/index.md | 8 +- content/rest/enterprise-admin/manage-ghes.md | 2 +- .../enterprise-admin/management-console.md | 73 - data/features/pre-security-configurations.yml | 3 - ...urity-configurations-beta-and-pre-beta.yml | 3 - .../enterprise-server/3-14/0-rc1.yml | 226 - .../enterprise-server/3-14/0.yml | 254 - .../enterprise-server/3-14/1.yml | 88 - .../enterprise-server/3-14/10.yml | 58 - .../enterprise-server/3-14/11.yml | 60 - .../enterprise-server/3-14/12.yml | 93 - .../enterprise-server/3-14/13.yml | 63 - .../enterprise-server/3-14/14.yml | 52 - .../enterprise-server/3-14/15.yml | 48 - .../enterprise-server/3-14/16.yml | 49 - .../enterprise-server/3-14/17.yml | 50 - .../enterprise-server/3-14/18.yml | 52 - .../enterprise-server/3-14/19.yml | 52 - .../enterprise-server/3-14/2.yml | 96 - .../enterprise-server/3-14/20.yml | 64 - .../enterprise-server/3-14/21.yml | 41 - .../enterprise-server/3-14/22.yml | 54 - .../enterprise-server/3-14/23.yml | 52 - .../enterprise-server/3-14/24.yml | 66 - .../enterprise-server/3-14/25.yml | 60 - .../enterprise-server/3-14/26.yml | 67 - .../enterprise-server/3-14/3.yml | 90 - .../enterprise-server/3-14/4.yml | 48 - .../enterprise-server/3-14/5.yml | 49 - .../enterprise-server/3-14/6.yml | 84 - .../enterprise-server/3-14/7.yml | 70 - .../enterprise-server/3-14/8.yml | 91 - .../enterprise-server/3-14/9.yml | 70 - .../secret-scanning-new-custom-pattern-org.md | 2 +- ...bot-grouped-security-updates-how-enable.md | 2 +- .../dependabot/supported-package-managers.md | 17 +- .../hardware-considerations-all-platforms.md | 4 +- .../rate-limit-live-dotcom-requests.md | 1 - .../what-is-available-ghecom.md | 4 +- .../custom-org-roles-settings-step.md | 2 +- .../beta-prs-discussions-wikis-scanned.md | 6 - .../secret-scanning/what-is-scanned.md | 1 - .../security/note-securing-your-org.md | 2 +- data/variables/code-scanning.yml | 4 +- data/variables/product.yml | 4 +- src/audit-logs/data/ghes-3.14/enterprise.json | 24512 -- .../data/ghes-3.14/organization.json | 22542 -- src/audit-logs/data/ghes-3.14/user.json | 12477 - .../fine-grained-pat-permissions.json | 6200 - .../fine-grained-pat.json | 3672 - .../server-to-server-permissions.json | 7940 - .../server-to-server-rest.json | 4072 - .../user-to-server-rest.json | 4428 - ...hql_upcoming_changes.public-enterprise.yml | 528 - src/graphql/data/ghes-3.14/previews.json | 1 - .../ghes-3.14/schema.docs-enterprise.graphql | 56354 ----- src/graphql/data/ghes-3.14/schema.json | 84718 ------- .../data/ghes-3.14/upcoming-changes.json | 580 - .../data/ghes-3.14-2022-11-28/actions.json | 37161 --- .../data/ghes-3.14-2022-11-28/activity.json | 175053 --------------- .../announcement-banners.json | 269 - src/rest/data/ghes-3.14-2022-11-28/apps.json | 15418 -- .../data/ghes-3.14-2022-11-28/billing.json | 174 - .../data/ghes-3.14-2022-11-28/branches.json | 21370 -- .../data/ghes-3.14-2022-11-28/checks.json | 14225 -- .../ghes-3.14-2022-11-28/code-scanning.json | 6990 - .../codes-of-conduct.json | 197 - .../ghes-3.14-2022-11-28/collaborators.json | 4311 - .../data/ghes-3.14-2022-11-28/commits.json | 10832 - .../data/ghes-3.14-2022-11-28/dependabot.json | 8641 - .../dependency-graph.json | 819 - .../ghes-3.14-2022-11-28/deploy-keys.json | 518 - .../ghes-3.14-2022-11-28/deployments.json | 7406 - .../data/ghes-3.14-2022-11-28/emojis.json | 1931 - .../enterprise-admin.json | 18349 -- src/rest/data/ghes-3.14-2022-11-28/gists.json | 11888 - src/rest/data/ghes-3.14-2022-11-28/git.json | 2521 - .../data/ghes-3.14-2022-11-28/gitignore.json | 139 - .../data/ghes-3.14-2022-11-28/issues.json | 69879 ------ .../data/ghes-3.14-2022-11-28/licenses.json | 583 - .../data/ghes-3.14-2022-11-28/markdown.json | 151 - src/rest/data/ghes-3.14-2022-11-28/meta.json | 497 - .../data/ghes-3.14-2022-11-28/metrics.json | 770 - .../data/ghes-3.14-2022-11-28/migrations.json | 7535 - .../oauth-authorizations.json | 7872 - src/rest/data/ghes-3.14-2022-11-28/orgs.json | 23744 -- .../data/ghes-3.14-2022-11-28/packages.json | 10957 - src/rest/data/ghes-3.14-2022-11-28/pages.json | 1996 - .../projects-classic.json | 5240 - src/rest/data/ghes-3.14-2022-11-28/pulls.json | 30115 --- .../data/ghes-3.14-2022-11-28/rate-limit.json | 435 - .../data/ghes-3.14-2022-11-28/reactions.json | 4368 - .../data/ghes-3.14-2022-11-28/releases.json | 5479 - src/rest/data/ghes-3.14-2022-11-28/repos.json | 43852 ---- .../data/ghes-3.14-2022-11-28/search.json | 9717 - .../ghes-3.14-2022-11-28/secret-scanning.json | 4347 - .../security-advisories.json | 1603 - src/rest/data/ghes-3.14-2022-11-28/teams.json | 12820 -- src/rest/data/ghes-3.14-2022-11-28/users.json | 8114 - src/rest/lib/config.json | 3 - .../lib/enterprise-server-releases.ts | 3 +- .../branch_protection_configuration.json | 112 - .../ghes-3.14/branch_protection_rule.json | 927 - .../bypass_request_secret_scanning.json | 2118 - src/webhooks/data/ghes-3.14/cache_sync.json | 69 - src/webhooks/data/ghes-3.14/check_run.json | 8039 - src/webhooks/data/ghes-3.14/check_suite.json | 2761 - .../data/ghes-3.14/code_scanning_alert.json | 3182 - .../data/ghes-3.14/commit_comment.json | 64 - src/webhooks/data/ghes-3.14/create.json | 81 - .../data/ghes-3.14/custom_property.json | 297 - .../ghes-3.14/custom_property_values.json | 97 - src/webhooks/data/ghes-3.14/delete.json | 69 - .../data/ghes-3.14/dependabot_alert.json | 4727 - src/webhooks/data/ghes-3.14/deploy_key.json | 232 - src/webhooks/data/ghes-3.14/deployment.json | 2095 - .../ghes-3.14/deployment_protection_rule.json | 3866 - .../data/ghes-3.14/deployment_review.json | 4949 - .../data/ghes-3.14/deployment_status.json | 2904 - src/webhooks/data/ghes-3.14/discussion.json | 12258 - .../data/ghes-3.14/discussion_comment.json | 1923 - src/webhooks/data/ghes-3.14/enterprise.json | 56 - src/webhooks/data/ghes-3.14/fork.json | 776 - .../ghes-3.14/github_app_authorization.json | 30 - src/webhooks/data/ghes-3.14/gollum.json | 95 - src/webhooks/data/ghes-3.14/installation.json | 596 - .../ghes-3.14/installation_repositories.json | 525 - .../data/ghes-3.14/installation_target.json | 291 - .../data/ghes-3.14/issue_comment.json | 2960 - src/webhooks/data/ghes-3.14/issues.json | 36727 --- src/webhooks/data/ghes-3.14/label.json | 362 - src/webhooks/data/ghes-3.14/member.json | 621 - src/webhooks/data/ghes-3.14/membership.json | 803 - src/webhooks/data/ghes-3.14/meta.json | 148 - src/webhooks/data/ghes-3.14/milestone.json | 1462 - src/webhooks/data/ghes-3.14/organization.json | 1284 - src/webhooks/data/ghes-3.14/package.json | 1978 - src/webhooks/data/ghes-3.14/page_build.json | 236 - .../personal_access_token_request.json | 1437 - src/webhooks/data/ghes-3.14/ping.json | 175 - src/webhooks/data/ghes-3.14/project.json | 1348 - src/webhooks/data/ghes-3.14/project_card.json | 1355 - .../data/ghes-3.14/project_column.json | 480 - src/webhooks/data/ghes-3.14/projects_v2.json | 3758 - .../data/ghes-3.14/projects_v2_item.json | 1825 - src/webhooks/data/ghes-3.14/public.json | 47 - src/webhooks/data/ghes-3.14/pull_request.json | 66173 ------ .../data/ghes-3.14/pull_request_review.json | 9885 - .../pull_request_review_comment.json | 9319 - .../ghes-3.14/pull_request_review_thread.json | 6882 - src/webhooks/data/ghes-3.14/push.json | 361 - .../data/ghes-3.14/registry_package.json | 1863 - src/webhooks/data/ghes-3.14/release.json | 3486 - src/webhooks/data/ghes-3.14/repository.json | 935 - .../data/ghes-3.14/repository_dispatch.json | 65 - .../data/ghes-3.14/repository_ruleset.json | 4863 - .../repository_vulnerability_alert.json | 1118 - .../data/ghes-3.14/secret_scanning_alert.json | 1666 - .../secret_scanning_alert_location.json | 713 - .../data/ghes-3.14/security_advisory.json | 824 - .../data/ghes-3.14/security_and_analysis.json | 132 - src/webhooks/data/ghes-3.14/sponsorship.json | 3125 - src/webhooks/data/ghes-3.14/star.json | 124 - src/webhooks/data/ghes-3.14/status.json | 609 - src/webhooks/data/ghes-3.14/team.json | 1428 - src/webhooks/data/ghes-3.14/team_add.json | 258 - src/webhooks/data/ghes-3.14/user.json | 352 - src/webhooks/data/ghes-3.14/watch.json | 57 - .../data/ghes-3.14/workflow_dispatch.json | 63 - src/webhooks/data/ghes-3.14/workflow_job.json | 2018 - src/webhooks/data/ghes-3.14/workflow_run.json | 4579 - 248 files changed, 167 insertions(+), 1050365 deletions(-) delete mode 100644 content/admin/upgrading-your-instance/performing-an-upgrade/preparing-for-the-elasticsearch-upgrade.md delete mode 100644 content/code-security/getting-started/quickstart-for-securing-your-organization.md delete mode 100644 content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/enabling-security-features-for-multiple-repositories.md delete mode 100644 content/rest/enterprise-admin/management-console.md delete mode 100644 data/features/pre-security-configurations.yml delete mode 100644 data/features/security-configurations-beta-and-pre-beta.yml delete mode 100644 data/release-notes/enterprise-server/3-14/0-rc1.yml delete mode 100644 data/release-notes/enterprise-server/3-14/0.yml delete mode 100644 data/release-notes/enterprise-server/3-14/1.yml delete mode 100644 data/release-notes/enterprise-server/3-14/10.yml delete mode 100644 data/release-notes/enterprise-server/3-14/11.yml delete mode 100644 data/release-notes/enterprise-server/3-14/12.yml delete mode 100644 data/release-notes/enterprise-server/3-14/13.yml delete mode 100644 data/release-notes/enterprise-server/3-14/14.yml delete mode 100644 data/release-notes/enterprise-server/3-14/15.yml delete mode 100644 data/release-notes/enterprise-server/3-14/16.yml delete mode 100644 data/release-notes/enterprise-server/3-14/17.yml delete mode 100644 data/release-notes/enterprise-server/3-14/18.yml delete mode 100644 data/release-notes/enterprise-server/3-14/19.yml delete mode 100644 data/release-notes/enterprise-server/3-14/2.yml delete mode 100644 data/release-notes/enterprise-server/3-14/20.yml delete mode 100644 data/release-notes/enterprise-server/3-14/21.yml delete mode 100644 data/release-notes/enterprise-server/3-14/22.yml delete mode 100644 data/release-notes/enterprise-server/3-14/23.yml delete mode 100644 data/release-notes/enterprise-server/3-14/24.yml delete mode 100644 data/release-notes/enterprise-server/3-14/25.yml delete mode 100644 data/release-notes/enterprise-server/3-14/26.yml delete mode 100644 data/release-notes/enterprise-server/3-14/3.yml delete mode 100644 data/release-notes/enterprise-server/3-14/4.yml delete mode 100644 data/release-notes/enterprise-server/3-14/5.yml delete mode 100644 data/release-notes/enterprise-server/3-14/6.yml delete mode 100644 data/release-notes/enterprise-server/3-14/7.yml delete mode 100644 data/release-notes/enterprise-server/3-14/8.yml delete mode 100644 data/release-notes/enterprise-server/3-14/9.yml delete mode 100644 data/reusables/secret-scanning/beta-prs-discussions-wikis-scanned.md delete mode 100644 src/audit-logs/data/ghes-3.14/enterprise.json delete mode 100644 src/audit-logs/data/ghes-3.14/organization.json delete mode 100644 src/audit-logs/data/ghes-3.14/user.json delete mode 100644 src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json delete mode 100644 src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json delete mode 100644 src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json delete mode 100644 src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json delete mode 100644 src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json delete mode 100644 src/graphql/data/ghes-3.14/graphql_upcoming_changes.public-enterprise.yml delete mode 100644 src/graphql/data/ghes-3.14/previews.json delete mode 100644 src/graphql/data/ghes-3.14/schema.docs-enterprise.graphql delete mode 100644 src/graphql/data/ghes-3.14/schema.json delete mode 100644 src/graphql/data/ghes-3.14/upcoming-changes.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/actions.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/activity.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/announcement-banners.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/apps.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/billing.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/branches.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/checks.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/code-scanning.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/codes-of-conduct.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/collaborators.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/commits.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/dependabot.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/dependency-graph.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/deploy-keys.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/deployments.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/emojis.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/enterprise-admin.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/gists.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/git.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/gitignore.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/issues.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/licenses.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/markdown.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/meta.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/metrics.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/migrations.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/oauth-authorizations.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/orgs.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/packages.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/pages.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/projects-classic.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/pulls.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/rate-limit.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/reactions.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/releases.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/repos.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/search.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/secret-scanning.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/security-advisories.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/teams.json delete mode 100644 src/rest/data/ghes-3.14-2022-11-28/users.json delete mode 100644 src/webhooks/data/ghes-3.14/branch_protection_configuration.json delete mode 100644 src/webhooks/data/ghes-3.14/branch_protection_rule.json delete mode 100644 src/webhooks/data/ghes-3.14/bypass_request_secret_scanning.json delete mode 100644 src/webhooks/data/ghes-3.14/cache_sync.json delete mode 100644 src/webhooks/data/ghes-3.14/check_run.json delete mode 100644 src/webhooks/data/ghes-3.14/check_suite.json delete mode 100644 src/webhooks/data/ghes-3.14/code_scanning_alert.json delete mode 100644 src/webhooks/data/ghes-3.14/commit_comment.json delete mode 100644 src/webhooks/data/ghes-3.14/create.json delete mode 100644 src/webhooks/data/ghes-3.14/custom_property.json delete mode 100644 src/webhooks/data/ghes-3.14/custom_property_values.json delete mode 100644 src/webhooks/data/ghes-3.14/delete.json delete mode 100644 src/webhooks/data/ghes-3.14/dependabot_alert.json delete mode 100644 src/webhooks/data/ghes-3.14/deploy_key.json delete mode 100644 src/webhooks/data/ghes-3.14/deployment.json delete mode 100644 src/webhooks/data/ghes-3.14/deployment_protection_rule.json delete mode 100644 src/webhooks/data/ghes-3.14/deployment_review.json delete mode 100644 src/webhooks/data/ghes-3.14/deployment_status.json delete mode 100644 src/webhooks/data/ghes-3.14/discussion.json delete mode 100644 src/webhooks/data/ghes-3.14/discussion_comment.json delete mode 100644 src/webhooks/data/ghes-3.14/enterprise.json delete mode 100644 src/webhooks/data/ghes-3.14/fork.json delete mode 100644 src/webhooks/data/ghes-3.14/github_app_authorization.json delete mode 100644 src/webhooks/data/ghes-3.14/gollum.json delete mode 100644 src/webhooks/data/ghes-3.14/installation.json delete mode 100644 src/webhooks/data/ghes-3.14/installation_repositories.json delete mode 100644 src/webhooks/data/ghes-3.14/installation_target.json delete mode 100644 src/webhooks/data/ghes-3.14/issue_comment.json delete mode 100644 src/webhooks/data/ghes-3.14/issues.json delete mode 100644 src/webhooks/data/ghes-3.14/label.json delete mode 100644 src/webhooks/data/ghes-3.14/member.json delete mode 100644 src/webhooks/data/ghes-3.14/membership.json delete mode 100644 src/webhooks/data/ghes-3.14/meta.json delete mode 100644 src/webhooks/data/ghes-3.14/milestone.json delete mode 100644 src/webhooks/data/ghes-3.14/organization.json delete mode 100644 src/webhooks/data/ghes-3.14/package.json delete mode 100644 src/webhooks/data/ghes-3.14/page_build.json delete mode 100644 src/webhooks/data/ghes-3.14/personal_access_token_request.json delete mode 100644 src/webhooks/data/ghes-3.14/ping.json delete mode 100644 src/webhooks/data/ghes-3.14/project.json delete mode 100644 src/webhooks/data/ghes-3.14/project_card.json delete mode 100644 src/webhooks/data/ghes-3.14/project_column.json delete mode 100644 src/webhooks/data/ghes-3.14/projects_v2.json delete mode 100644 src/webhooks/data/ghes-3.14/projects_v2_item.json delete mode 100644 src/webhooks/data/ghes-3.14/public.json delete mode 100644 src/webhooks/data/ghes-3.14/pull_request.json delete mode 100644 src/webhooks/data/ghes-3.14/pull_request_review.json delete mode 100644 src/webhooks/data/ghes-3.14/pull_request_review_comment.json delete mode 100644 src/webhooks/data/ghes-3.14/pull_request_review_thread.json delete mode 100644 src/webhooks/data/ghes-3.14/push.json delete mode 100644 src/webhooks/data/ghes-3.14/registry_package.json delete mode 100644 src/webhooks/data/ghes-3.14/release.json delete mode 100644 src/webhooks/data/ghes-3.14/repository.json delete mode 100644 src/webhooks/data/ghes-3.14/repository_dispatch.json delete mode 100644 src/webhooks/data/ghes-3.14/repository_ruleset.json delete mode 100644 src/webhooks/data/ghes-3.14/repository_vulnerability_alert.json delete mode 100644 src/webhooks/data/ghes-3.14/secret_scanning_alert.json delete mode 100644 src/webhooks/data/ghes-3.14/secret_scanning_alert_location.json delete mode 100644 src/webhooks/data/ghes-3.14/security_advisory.json delete mode 100644 src/webhooks/data/ghes-3.14/security_and_analysis.json delete mode 100644 src/webhooks/data/ghes-3.14/sponsorship.json delete mode 100644 src/webhooks/data/ghes-3.14/star.json delete mode 100644 src/webhooks/data/ghes-3.14/status.json delete mode 100644 src/webhooks/data/ghes-3.14/team.json delete mode 100644 src/webhooks/data/ghes-3.14/team_add.json delete mode 100644 src/webhooks/data/ghes-3.14/user.json delete mode 100644 src/webhooks/data/ghes-3.14/watch.json delete mode 100644 src/webhooks/data/ghes-3.14/workflow_dispatch.json delete mode 100644 src/webhooks/data/ghes-3.14/workflow_job.json delete mode 100644 src/webhooks/data/ghes-3.14/workflow_run.json diff --git a/.gitignore b/.gitignore index e36be8660ee2..899832b54b8b 100644 --- a/.gitignore +++ b/.gitignore @@ -109,3 +109,4 @@ translations/ # Shared local volume (bufo) .local +docs-ghes-3.14/ diff --git a/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md b/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md index 186211d44b84..2f38e2ff8ccb 100644 --- a/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md +++ b/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md @@ -830,7 +830,7 @@ jobs: > [!NOTE] > * The webhook payload available to GitHub Actions does not include the `added`, `removed`, and `modified` attributes in the `commit` object. You can retrieve the full commit object using the API. For information, see [AUTOTITLE](/graphql/reference/objects#commit) in the GraphQL API documentation or [AUTOTITLE](/rest/commits#get-a-commit). -> * {% ifversion fpt or ghec or ghes > 3.14 %}Events will not be created if more than 5,000 branches are pushed at once. {% endif %}Events will not be created for tags when more than three tags are pushed at once. +> * Events will not be created if more than 5,000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. Runs your workflow when you push a commit or tag, or when you create a repository from a template. diff --git a/content/admin/configuring-settings/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise.md b/content/admin/configuring-settings/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise.md index 44f8eda3a41b..fd7f18b3bb7c 100644 --- a/content/admin/configuring-settings/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise.md +++ b/content/admin/configuring-settings/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise.md @@ -22,7 +22,7 @@ category: {% data reusables.enterprise-licensing.about-license-sync %} For more information, see [AUTOTITLE](/admin/configuration/configuring-github-connect/about-github-connect#data-transmission). -If you enable automatic user license sync for your enterprise, every week, {% data variables.product.prodname_github_connect %} will automatically synchronize license usage between {% data variables.product.prodname_ghe_server %} and your enterprise on {% data variables.product.prodname_dotcom_the_website %}{% ifversion ghecom-license-sync %} or {% data variables.enterprise.data_residency_site %}{% endif %}. You can also synchronize your license data at any time outside of the automatic weekly sync, by manually triggering a license sync job. For more information, see [AUTOTITLE](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud#triggering-a-license-sync-job). +If you enable automatic user license sync for your enterprise, every week, {% data variables.product.prodname_github_connect %} will automatically synchronize license usage between {% data variables.product.prodname_ghe_server %} and your enterprise on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.enterprise.data_residency_site %}. You can also synchronize your license data at any time outside of the automatic weekly sync, by manually triggering a license sync job. For more information, see [AUTOTITLE](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud#triggering-a-license-sync-job). If you use multiple {% data variables.product.prodname_ghe_server %} instances, you can enable automatic license sync between each of your instances and the same enterprise account on {% data variables.product.prodname_ghe_cloud %}. @@ -34,7 +34,7 @@ You can also manually upload {% data variables.product.prodname_ghe_server %} us ## Enabling license synchronization -Before enabling license synchronization on {% data variables.location.product_location %}, you must enable {% data variables.product.prodname_github_connect %}. See {% ifversion ghecom-license-sync %}[AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-ghecom) or {% endif %}[AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-githubcom). +Before enabling license synchronization on {% data variables.location.product_location %}, you must enable {% data variables.product.prodname_github_connect %}. See [AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-ghecom) or [AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-githubcom). {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.github-connect-tab %} diff --git a/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise.md b/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise.md index 88656babd3d9..b023ad47e1e1 100644 --- a/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise.md +++ b/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise.md @@ -25,8 +25,8 @@ Regardless of the chosen policy, {% data variables.product.pat_generic_caps_plur {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} -1. Under **{% octicon "law" aria-hidden="true" aria-label="law" %} Policies**, click **{% data variables.product.pat_generic_caps_plural %}**. {% ifversion tabbed-pat-settings-ui %} -1. Select either the **Fine-grained tokens** or **Tokens (classic)** tab to enforce this policy based on the token type. {% endif %} +1. Under **{% octicon "law" aria-hidden="true" aria-label="law" %} Policies**, click **{% data variables.product.pat_generic_caps_plural %}**. +1. Select either the **Fine-grained tokens** or **Tokens (classic)** tab to enforce this policy based on the token type. 1. Under **{% data variables.product.pat_v2_caps_plural %}** or **Restrict {% data variables.product.pat_v1_plural %} from accessing your organizations**, select your access policy. 1. Click **Save**. @@ -72,7 +72,7 @@ By default, organizations require approval of {% data variables.product.pat_v2_p {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} -1. Under **{% octicon "law" aria-hidden="true" aria-label="law" %} Policies**, click **{% data variables.product.pat_generic_caps_plural %}**. {% ifversion tabbed-pat-settings-ui %} -1. Select the **Fine-grained tokens** tab. {% endif %} +1. Under **{% octicon "law" aria-hidden="true" aria-label="law" %} Policies**, click **{% data variables.product.pat_generic_caps_plural %}**. +1. Select the **Fine-grained tokens** tab. 1. Under **Require approval of {% data variables.product.pat_v2_plural %}**, select your approval policy: 1. Click **Save**. diff --git a/content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise.md b/content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise.md index b167204dd80a..439035abc008 100644 --- a/content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise.md +++ b/content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise.md @@ -17,9 +17,9 @@ category: You can use {% data variables.product.prodname_AS %} features to harden security for the organizations in your enterprise. -{% ifversion security-configurations %}{% data reusables.security-configurations.enable-security-features-with-gh-config %} +{% data reusables.security-configurations.enable-security-features-with-gh-config %} -To manage individual {% data variables.product.prodname_GHAS %} features, {% else %}To streamline management of {% data variables.product.prodname_AS %}, {% endif %}you can enable or disable each feature for all existing and/or new repositories within the organizations owned by your enterprise. +To manage individual {% data variables.product.prodname_GHAS %} features, you can enable or disable each feature for all existing and/or new repositories within the organizations owned by your enterprise. {% ifversion security-configurations-ghes-only %} @@ -49,8 +49,8 @@ When you enable one or more security and analysis features for existing reposito * To the right of the feature, click **Disable all** or **Enable all**. If the control for "{% data variables.product.prodname_GHAS %}" is disabled, you have no available licenses for {% data variables.product.prodname_GHAS %}. * To confirm the change, click the **Enable/Disable all** or **Enable/Disable for eligible repositories** button in the dialog that is displayed. -1. Optionally, to enable or disable a feature automatically when new private and internal repositories{% ifversion secret-scanning-user-owned-repos %}, user namespace repositories{% endif %}, or public repositories and repositories with {% data variables.product.prodname_GHAS %} enabled are created, select the checkbox below the feature.{% ifversion org-npp-enablement-security-configurations %} -1. Optionally, to enable the scanning of non-provider patterns, to the right of "Scan for non-provider patterns", click **Enable all**. To learn more about scanning for non-provider patterns, see [AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#non-provider-patterns) and [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts).{% endif %} +1. Optionally, to enable or disable a feature automatically when new private and internal repositories{% ifversion secret-scanning-user-owned-repos %}, user namespace repositories{% endif %}, or public repositories and repositories with {% data variables.product.prodname_GHAS %} enabled are created, select the checkbox below the feature. +1. Optionally, to enable the scanning of non-provider patterns, to the right of "Scan for non-provider patterns", click **Enable all**. To learn more about scanning for non-provider patterns, see [AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#non-provider-patterns) and [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts). 1. Optionally, to include a resource link in the message that members will see when they attempt to push a secret, select **Add a resource link in the CLI and web UI when a commit is blocked**, then type a URL, and click **Save link**. > [!NOTE] diff --git a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md index 6abb77de3ecc..750e91a90ac5 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md +++ b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md @@ -14,7 +14,6 @@ category: - Monitor and audit your enterprise --- - >[!NOTE] {% ifversion ghes %}{% data reusables.webhooks.webhooks-as-audit-log-alternative %}{% else %}{% data reusables.webhooks.webhooks-as-audit-log-alternative %}{% endif %} ## About audit log streaming @@ -114,8 +113,7 @@ From {% data variables.product.prodname_dotcom %}: 1. Under "Authentication", click **Access keys**.{% endif %} 1. Configure the stream settings. -{% ifversion ghec or ghes > 3.14 %} - - Under "Region", select the bucket's region. For example, `us-east-1`.{% endif %} + - Under "Region", select the bucket's region. For example, `us-east-1`. - Under "Bucket", type the name of the bucket you want to stream to. For example, `auditlog-streaming-test`. - Under "Access Key ID", type your access key ID. For example, `ABCAIOSFODNN7EXAMPLE1`. - Under "Secret Key", type your secret key. For example, `aBcJalrXUtnWXYZ/A1MDENG/zPxRfiCYEXAMPLEKEY`. diff --git a/content/admin/monitoring-and-managing-your-instance/configuring-clustering/upgrading-a-cluster.md b/content/admin/monitoring-and-managing-your-instance/configuring-clustering/upgrading-a-cluster.md index a8f0b79b1a75..7381d5c5cbe9 100644 --- a/content/admin/monitoring-and-managing-your-instance/configuring-clustering/upgrading-a-cluster.md +++ b/content/admin/monitoring-and-managing-your-instance/configuring-clustering/upgrading-a-cluster.md @@ -66,13 +66,7 @@ Use an upgrade package to upgrade a {% data variables.product.prodname_ghe_serve ### Upgrading the cluster nodes 1. Enable maintenance mode according to your scheduled window by connecting to the administrative shell of any cluster node and running `ghe-cluster-maintenance -s`. -{% ifversion ghes < 3.15 %} -1. If you're upgrading from version 3.11 or 3.12 to version 3.13 or later, Elasticsearch will be upgraded as part of the upgrade to your cluster. For more information, see [AUTOTITLE](/admin/upgrading-your-instance/performing-an-upgrade/preparing-for-the-elasticsearch-upgrade). - Before upgrading, you will need to run a script to prepare your cluster for an upgrade to 3.13 or 3.14. - 1. Ensure you are running the required patch release for your current version: **3.11.9** or later for 3.11, or **3.12.3** or later for 3.12. - 1. On any `elasticsearch-server` node, run `/usr/local/share/enterprise/ghe-es-auditlog-cluster-rebalance`. -{% endif %} 1. **With the exception of the primary MySQL node**, connect to the administrative shell of each of the {% data variables.product.prodname_ghe_server %} nodes. Run the `ghe-upgrade` command, providing the package file name you downloaded in step 4 of [Preparing to upgrade](#preparing-to-upgrade): diff --git a/content/admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity.md b/content/admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity.md index 717b27aa3a7f..32f2da632fd4 100644 --- a/content/admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity.md +++ b/content/admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity.md @@ -28,7 +28,7 @@ As more users join {% data variables.location.product_location %}, you may need ### Minimum recommended requirements -{% ifversion ghes > 3.14 %}{% data reusables.enterprise_installation.hardware-rec-table %}{% else %}{% data reusables.enterprise_installation.hardware-rec-table-legacy %}{% endif %} +{% data reusables.enterprise_installation.hardware-rec-table %} Root storage refers to the total size of your instance's root disk. The available space on the root filesystem is 50% of the total storage available on the root disk. For more information, see [AUTOTITLE](/admin/overview/system-overview#storage-architecture). diff --git a/content/admin/overview/system-overview.md b/content/admin/overview/system-overview.md index 8956b615f444..6cb1e18a6732 100644 --- a/content/admin/overview/system-overview.md +++ b/content/admin/overview/system-overview.md @@ -21,7 +21,7 @@ category: The root filesystem is included in the distributed machine image. It contains the base operating system and the {% data variables.product.prodname_ghe_server %} application environment. The root filesystem should be treated as ephemeral. Any data on the root filesystem will be replaced when upgrading to future {% data variables.product.prodname_ghe_server %} releases. -The root storage volume is split into two equally-sized partitions. One of the partitions will be mounted as the root filesystem (`/`). The other partition is only mounted during upgrades and rollbacks of upgrades as `/mnt/upgrade`, to facilitate easier rollbacks if necessary. For example, if a {% ifversion ghes > 3.14 %}400GB root volume is allocated, there will be 200GB allocated to the root filesystem and 200GB{% else %}200GB root volume is allocated, there will be 100GB allocated to the root filesystem and 100GB{% endif %} reserved for the upgrades and rollbacks. +The root storage volume is split into two equally-sized partitions. One of the partitions will be mounted as the root filesystem (`/`). The other partition is only mounted during upgrades and rollbacks of upgrades as `/mnt/upgrade`, to facilitate easier rollbacks if necessary. For example, if a 400GB root volume is allocated, there will be 200GB allocated to the root filesystem and 200GB reserved for the upgrades and rollbacks. In new installations of 3.14 and later, the root storage volume is split into four partitions. Two small partitions are for the supported boot modes (BIOS and UEFI), and the other two equally large partitions are for the {% data variables.product.prodname_ghe_server %} primary, and upgrades and rollbacks. diff --git a/content/admin/upgrading-your-instance/performing-an-upgrade/index.md b/content/admin/upgrading-your-instance/performing-an-upgrade/index.md index 29f5a3764cd1..dca37028a9d3 100644 --- a/content/admin/upgrading-your-instance/performing-an-upgrade/index.md +++ b/content/admin/upgrading-your-instance/performing-an-upgrade/index.md @@ -7,6 +7,8 @@ children: - /upgrading-with-a-hotpatch - /upgrading-with-an-upgrade-package - /migrating-from-github-enterprise-1110x-to-2123 - - /preparing-for-the-elasticsearch-upgrade shortTitle: Perform an upgrade +redirect_from: + - /admin/upgrading-your-instance/performing-an-upgrade/preparing-for-the-elasticsearch-upgrade --- + diff --git a/content/admin/upgrading-your-instance/performing-an-upgrade/preparing-for-the-elasticsearch-upgrade.md b/content/admin/upgrading-your-instance/performing-an-upgrade/preparing-for-the-elasticsearch-upgrade.md deleted file mode 100644 index bd5080ed5843..000000000000 --- a/content/admin/upgrading-your-instance/performing-an-upgrade/preparing-for-the-elasticsearch-upgrade.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Preparing for the Elasticsearch upgrade in {% data variables.product.prodname_ghe_server %} 3.13 -intro: As part of upgrading {% data variables.product.prodname_ghe_server %} to version 3.13 or later, the Elasticsearch service will be upgraded. -versions: - ghes: '>3.10 <3.15' -shortTitle: Elasticsearch upgrade in 3.13 -allowTitleToDifferFromFilename: true -redirect_from: - - /admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/preparing-for-the-elasticsearch-upgrade - - /admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/preparing-for-the-elasticsearch-upgrade -contentType: reference -category: - - Back up and upgrade your instance ---- - -## Overview - -Elasticsearch (ES) powers the search functionality on your {% data variables.product.prodname_ghe_server %} instance. To bring the benefits of better performance and security posture, when you upgrade your instance to version 3.13 or later, the Elasticsearch version in the appliance will be upgraded from 5.6.16 to 8.7.0. - -The following sections help administrators prepare for and monitor the Elasticsearch upgrade. The key points are: - -* The upgrade will temporarily degrade the experience of the search and audit log features. -* If you're upgrading an instance in a cluster configuration, you must run a script to prepare your cluster for the ES upgrade. See [AUTOTITLE](/admin/monitoring-and-managing-your-instance/configuring-clustering/upgrading-a-cluster#upgrading-the-cluster-nodes). -* For backups, all customers should take a snapshot of their instance when the upgrade is complete. - -## Impact on search and audit logs - -All search indexes will be rebuilt after the upgrade to ES8. Users will experience degraded search experience during the rebuild, but the instance is otherwise expected to be functional and available. The index rebuild process depends on the size of the data set and may take a few hours to days. - -Audit logs will not be available immediately after upgrade, and it may take several hours to migrate all audit logs. - -We strongly recommend you take a backup (using backup-utils) immediately following completion of the index rebuild and use that snapshot for all future restores. See [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/configuring-backups-on-your-instance). If you restore a backup from an instance running {% data variables.product.prodname_ghe_server %} 3.11 or 3.12, then any content that relies on ES will only be available after the ES indexes have been migrated and rebuilt on the 3.13 instance. - -## Monitoring the Elasticsearch upgrade - -You can monitor the progress of the ES upgrade in the site admin dashboard. - -1. In the upper-right corner of any page, click {% octicon "rocket" aria-label="Site admin" %}. -1. In the left sidebar, click **Search indexes**. - -When the index rebuild is complete, all the search indexes should show green and "100%." - -## Changing the number of repair workers - -By default, the number of index repair workers is set to the number of CPU cores divided by 8 (with an upper bound of 16). To speed up the index rebuild, you can adjust the worker count. However, before doing so, you should consider the potential impact to the load. - -{% data reusables.enterprise_installation.ssh-into-instance %} -1. To change the number of workers, enter the following command. - - ```shell copy - ghe-config app.github.es-workers NUMBER-OF-WORKERS - ``` - -1. Run `ghe-config-apply`. - -You can also adjust the worker count for individual index rebuilds in the "Search Indexes" section of the site admin dashboard. See the [Monitoring the Elasticsearch upgrade](#monitoring-the-elasticsearch-upgrade) section. diff --git a/content/admin/upgrading-your-instance/troubleshooting-upgrades/known-issues-with-upgrades-to-your-instance.md b/content/admin/upgrading-your-instance/troubleshooting-upgrades/known-issues-with-upgrades-to-your-instance.md index 60f76f44810a..71fa1e4e4b4c 100644 --- a/content/admin/upgrading-your-instance/troubleshooting-upgrades/known-issues-with-upgrades-to-your-instance.md +++ b/content/admin/upgrading-your-instance/troubleshooting-upgrades/known-issues-with-upgrades-to-your-instance.md @@ -27,15 +27,6 @@ We have extended the support window for versions 3.14, 3.15, 3.16, and 3.17. The We will continue to release patches for 3.14, 3.15, 3.16, and 3.17 throughout this extended support window. -{% ifversion ghes < 3.15 %} - -## Elasticsearch Upgrade - -As part of upgrading GitHub Enterprise Server to version 3.13 or later, the Elasticsearch service will be upgraded. {% data variables.product.company_short %} strongly recommends following the guidance in [AUTOTITLE](/admin/upgrading-your-instance/performing-an-upgrade/preparing-for-the-elasticsearch-upgrade). -{% endif %} - -{% ifversion ghes > 3.14 %} - ## Required root disk size increased to 400GB > [!Note] @@ -68,7 +59,6 @@ In case you did not have the opportunity to run the encryption diagnostics scrip If undecryptable records are detected, you will be prompted whether you want to proceed with the upgrade or not. If you proceed, the upgrade process deletes the undecryptable records. Otherwise, the upgrade process will exit. If you have any questions during the upgrade, you can reach out to {% data variables.contact.github_support %}. Once you have had the time and opportunity to understand the impact, you can retrigger the upgrade. -{% endif %} {% ifversion ghes < 3.17 %} diff --git a/content/billing/concepts/product-billing/github-advanced-security.md b/content/billing/concepts/product-billing/github-advanced-security.md index fd10c2ab230d..4d15e9ecb972 100644 --- a/content/billing/concepts/product-billing/github-advanced-security.md +++ b/content/billing/concepts/product-billing/github-advanced-security.md @@ -52,7 +52,7 @@ Each **active committer** to at least one repository with an {% data variables.p > [!NOTE] When a repository is migrated to {% data variables.product.github %} using {% data variables.product.prodname_importer_proper_name %}, {% data variables.product.prodname_GHAS %} only consumes licenses for commits and pushes made _after_ migration. Historic contributions from _before_ the migration are not considered. For more information, see [AUTOTITLE](/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/about-github-enterprise-importer). -{% ifversion security-configurations %}You can see the active and unique committers to an organization on the Global settings page for {% data variables.product.UI_advanced_security %}. Under "{% data variables.product.prodname_secret_protection %} repositories" and "{% data variables.product.prodname_code_security %} repositories", summaries and repository-level details are reported. See [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization/configuring-global-security-settings-for-your-organization).{% endif %} +You can see the active and unique committers to an organization on the Global settings page for {% data variables.product.UI_advanced_security %}. Under "{% data variables.product.prodname_secret_protection %} repositories" and "{% data variables.product.prodname_code_security %} repositories", summaries and repository-level details are reported. See [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization/configuring-global-security-settings-for-your-organization). ## Free use of {% data variables.product.prodname_GHAS %} features @@ -160,8 +160,7 @@ See [AUTOTITLE](/billing/how-tos/products/disable-ghas-for-enterprise). {%- ifversion fpt or ghec or ghes > 3.15 %} * [AUTOTITLE](/code-security/trialing-github-advanced-security/planning-a-trial-of-ghas){% endif %} -{%- ifversion fpt or ghec or ghes > 3.14 %} -* [AUTOTITLE](/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale){% endif %} +* [AUTOTITLE](/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale) {%- ifversion fpt or ghec or ghes > 3.15 %} * [AUTOTITLE](/admin/managing-code-security/securing-your-enterprise/about-security-configurations){% else %} * [AUTOTITLE](/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise){% endif %} diff --git a/content/billing/how-tos/manage-plan-and-licenses/view-enterprise-usage.md b/content/billing/how-tos/manage-plan-and-licenses/view-enterprise-usage.md index eaf21ee9d0eb..1128a5c9ae6d 100644 --- a/content/billing/how-tos/manage-plan-and-licenses/view-enterprise-usage.md +++ b/content/billing/how-tos/manage-plan-and-licenses/view-enterprise-usage.md @@ -85,8 +85,7 @@ If your {% data variables.product.github %} license includes {% data variables.v * Under "User licenses", view your total licenses, number of consumed licenses, and your subscription expiration date. * To view details for license usage or download a JSON file with license details, click **View users** or **Export license usage**. -* Review your current {% data variables.product.prodname_enterprise %} license, as well as consumed and available user licenses.{% ifversion ghes < 3.15 %} -* If you have purchased {% data variables.product.prodname_AS %}, you can review your total licenses used as well as a per-organization breakdown of active committers. See [AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise).{% endif %} +* Review your current {% data variables.product.prodname_enterprise %} license, as well as consumed and available user licenses. ## Reporting license information using the REST API diff --git a/content/code-security/concepts/code-scanning/about-code-scanning-alerts.md b/content/code-security/concepts/code-scanning/about-code-scanning-alerts.md index 0e8f949a7bf7..244ed74374fe 100644 --- a/content/code-security/concepts/code-scanning/about-code-scanning-alerts.md +++ b/content/code-security/concepts/code-scanning/about-code-scanning-alerts.md @@ -36,12 +36,8 @@ With a {% data variables.copilot.copilot_enterprise %} license, you can also ask {% endif %} -{% ifversion security-overview-org-codeql-pr-alerts %} - For {% data variables.product.prodname_code_scanning %} alerts from {% data variables.product.prodname_codeql %} analysis, you can use security overview to see how {% data variables.product.prodname_codeql %} is performing in pull requests in repositories across your organization, and to identify repositories where you may need to take action. For more information, see [AUTOTITLE](/code-security/concepts/code-scanning/pull-request-alert-metrics). -{% endif %} - {% data reusables.code-scanning.audit-code-scanning-events %} ## About alert details diff --git a/content/code-security/concepts/code-scanning/pull-request-alert-metrics.md b/content/code-security/concepts/code-scanning/pull-request-alert-metrics.md index 3feb44b1aa44..51ff4a5b4ffb 100644 --- a/content/code-security/concepts/code-scanning/pull-request-alert-metrics.md +++ b/content/code-security/concepts/code-scanning/pull-request-alert-metrics.md @@ -6,7 +6,9 @@ permissions: '{% data reusables.permissions.security-overview %}' product: '{% data reusables.gated-features.security-overview-fpt-cs-only %}' contentType: concepts versions: - feature: security-overview-org-codeql-pr-alerts + fpt: '*' + ghec: '*' + ghes: '*' category: - Secure at scale --- diff --git a/content/code-security/concepts/secret-security/about-push-protection.md b/content/code-security/concepts/secret-security/about-push-protection.md index c6ba63c9562a..6742aa6315b4 100644 --- a/content/code-security/concepts/secret-security/about-push-protection.md +++ b/content/code-security/concepts/secret-security/about-push-protection.md @@ -26,8 +26,9 @@ Push protection blocks secrets detected in: * Pushes from the command line * Commits made in the {% data variables.product.prodname_dotcom %} UI{% ifversion push-protection-delegated-bypass-file-upload-support %} -* File uploads to a repository on {% data variables.product.github %}{% endif %}{% ifversion secret-scanning-push-protection-content-endpoints %} -* Requests to the REST API{% endif %} +* File uploads to a repository on {% data variables.product.github %}{% endif %} +* Requests to the REST API +* Interactions with the {% data variables.product.github %} MCP server (public repositories only) When push protection detects a potential secret during a push attempt, it will block the push and provide a detailed message explaining the reason for the block. You will need to review the code in question, remove any sensitive information, and reattempt the push. @@ -90,7 +91,6 @@ After you enable push protection for repositories, you can customize it by: ## Next steps -{% ifversion security-configurations %} To enable push protection: * **For a repository**, see [AUTOTITLE](/code-security/secret-scanning/enabling-secret-scanning-features/enabling-push-protection-for-your-repository). {% ifversion security-configurations-cloud -%} @@ -100,8 +100,5 @@ To enable push protection: {% else -%} * **For an organization**, you need to apply a {% data variables.product.prodname_security_configuration %}. See [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/creating-a-custom-security-configuration). {% endif %} -{% else %} -To get started with push protection, see [AUTOTITLE](/code-security/secret-scanning/enabling-secret-scanning-features/enabling-push-protection-for-your-repository). -{% endif %} For a list of secrets and service providers supported by push protection, see [AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets). diff --git a/content/code-security/concepts/secret-security/working-with-push-protection-from-the-rest-api.md b/content/code-security/concepts/secret-security/working-with-push-protection-from-the-rest-api.md index d2a206453d78..08eee769dde4 100644 --- a/content/code-security/concepts/secret-security/working-with-push-protection-from-the-rest-api.md +++ b/content/code-security/concepts/secret-security/working-with-push-protection-from-the-rest-api.md @@ -4,7 +4,9 @@ shortTitle: Push protection from the REST API intro: Learn your options for unblocking your push to {% data variables.product.prodname_dotcom %} using the REST API if {% data variables.product.prodname_secret_scanning %} detects a secret in the content of your API request. permissions: '{% data reusables.permissions.push-protection-resolve-block %}' versions: - feature: secret-scanning-push-protection-content-endpoints + fpt: '*' + ghec: '*' + ghes: '*' redirect_from: - /code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-rest-api contentType: concepts diff --git a/content/code-security/concepts/security-at-scale/about-enabling-security-features-at-scale.md b/content/code-security/concepts/security-at-scale/about-enabling-security-features-at-scale.md index 541518eadf62..574e5ecb1bfe 100644 --- a/content/code-security/concepts/security-at-scale/about-enabling-security-features-at-scale.md +++ b/content/code-security/concepts/security-at-scale/about-enabling-security-features-at-scale.md @@ -3,7 +3,9 @@ title: About enabling security features at scale shortTitle: Organization security intro: You can quickly secure your organization at scale with {% data variables.product.prodname_security_configurations %} and {% data variables.product.prodname_global_settings %}. versions: - feature: security-configurations + fpt: '*' + ghec: '*' + ghes: '*' redirect_from: - /code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale - /code-security/concepts/security-at-scale/about-security-configurations diff --git a/content/code-security/concepts/security-at-scale/about-security-overview.md b/content/code-security/concepts/security-at-scale/about-security-overview.md index 4b67f404c9e6..e5b771ae07b4 100644 --- a/content/code-security/concepts/security-at-scale/about-security-overview.md +++ b/content/code-security/concepts/security-at-scale/about-security-overview.md @@ -63,7 +63,7 @@ There are dedicated views for each type of security alert. You can limit your an ## About security overview for organizations -The application security team at your company can use the different views for both broad and specific analyses of your organization's security status. For example, the team can use the "Overview" dashboard view to track your organization's security landscape and progression. {% ifversion pre-security-configurations %}You can also use security overview to find a set of repositories and enable or disable security features for them all at the same time. For more information, see [AUTOTITLE](/code-security/security-overview/enabling-security-features-for-multiple-repositories).{% endif %} +The application security team at your company can use the different views for both broad and specific analyses of your organization's security status. For example, the team can use the "Overview" dashboard view to track your organization's security landscape and progression. You can find security overview on the **{% data variables.product.prodname_security_and_quality_tab %}** tab for any organization. Each view shows a summary of the data that you have access to. As you add filters, all data and metrics across the view change to reflect the repositories or alerts that you've selected. @@ -74,8 +74,8 @@ Security overview has multiple views that provide different ways to explore enab * **Coverage:** assess the adoption of security features across repositories in the organization, see [AUTOTITLE](/code-security/security-overview/assessing-adoption-code-security).{% ifversion ghas-products %}{% ifversion secret-risk-assessment %} * **Assessments:** regardless of the enablement status of {% data variables.product.prodname_AS %} features, organizations on {% data variables.product.prodname_team %} and {% data variables.product.prodname_enterprise %} can run a free report to scan the code in the organization for leaked secrets, see [AUTOTITLE](/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/about-secret-risk-assessment).{% endif %}{% endif %}{% ifversion security-campaigns %} * **Campaigns:** coordinate and measure targeted remediation efforts, grouping related security tasks across repositories, assigning owners, and tracking progress toward defined risk‑reduction goals.{% endif %} -* **Enablement:** see how quickly different teams are adopting security features.{% ifversion security-overview-org-codeql-pr-alerts %} -* **{% data variables.product.prodname_codeql %} pull requests:** assess the impact of running {% data variables.product.prodname_codeql %} on pull requests and how development teams are resolving {% data variables.product.prodname_code_scanning %} alerts, see [AUTOTITLE](/code-security/security-overview/viewing-metrics-for-pull-request-alerts).{% endif %}{% ifversion dependabot-metrics %} +* **Enablement:** see how quickly different teams are adopting security features. +* **{% data variables.product.prodname_codeql %} pull requests:** assess the impact of running {% data variables.product.prodname_codeql %} on pull requests and how development teams are resolving {% data variables.product.prodname_code_scanning %} alerts, see [AUTOTITLE](/code-security/security-overview/viewing-metrics-for-pull-request-alerts).{% ifversion dependabot-metrics %} * **{% data variables.product.prodname_dependabot %}**: prioritize and track critical vulnerabilities by identifying, remediating, and measuring security improvements across repositories.{% endif %} * **{% data variables.product.prodname_secret_scanning_caps %}:** find out which types of secret are blocked by push protection{% ifversion security-overview-delegated-bypass-requests %} and which teams are bypassing push protection{% endif %}, see [AUTOTITLE](/code-security/security-overview/viewing-metrics-for-secret-scanning-push-protection){% ifversion security-overview-delegated-bypass-requests %} and [AUTOTITLE](/code-security/security-overview/reviewing-requests-to-bypass-push-protection){% endif %}. diff --git a/content/code-security/getting-started/index.md b/content/code-security/getting-started/index.md index fdd0e2310adc..24723dc0505f 100644 --- a/content/code-security/getting-started/index.md +++ b/content/code-security/getting-started/index.md @@ -10,7 +10,6 @@ versions: children: - /github-security-features - /quickstart-for-securing-your-repository - - /quickstart-for-securing-your-organization contentType: get-started --- diff --git a/content/code-security/getting-started/quickstart-for-securing-your-organization.md b/content/code-security/getting-started/quickstart-for-securing-your-organization.md deleted file mode 100644 index e99b3b993e62..000000000000 --- a/content/code-security/getting-started/quickstart-for-securing-your-organization.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: Quickstart for securing your organization -intro: You can use a number of {% data variables.product.prodname_dotcom %} features to help keep your organization secure. -permissions: '{% data reusables.permissions.security-org-enable %}' -redirect_from: - - /code-security/getting-started/securing-your-organization -versions: - feature: pre-security-configurations -contentType: get-started -shortTitle: Secure organization quickstart -category: - - Plan your security strategy ---- - - -## Introduction - -As an organization owner or security manager, you can use {% data variables.product.company_short %}'s security features to keep your organization's code, dependencies, and secrets secure. For more information, see [AUTOTITLE](/code-security/getting-started/github-security-features). - -Your organization's security needs are unique. You may want to enable a feature if your organization has been impacted by a vulnerability that a certain feature would have prevented, or if the feature will help your organization meet a compliance requirement. - -You can enable security features across multiple repositories in an organization at the same time. For each feature you want to enable, you must decide how to roll out the feature across your organization's repositories. Different features have different effects on your organization and its contributors, so it's important to assess the impact each feature will have. For example: - -* Some features can generate notifications to inform your organization's members about specific vulnerabilities: to ensure these notifications are targeted and relevant, you may want to ask members to check their notification settings before you enable a feature. For more information, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications). -* Some features can consume resources for each repository in which they're enabled. For example, enabling {% data variables.product.prodname_code_scanning %} in a private repository may consume a {% data variables.product.prodname_GHAS %} license, and running {% data variables.product.prodname_code_scanning %} analysis in a repository will incur usage of {% data variables.product.prodname_actions %} or another CI system. - -As an organization owner, you can give certain users permission to enable or disable security features by assigning the "security manager" role to a team. Security managers can configure security settings and monitor usage of security features across your organization. For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - -## About prerequisites of features - -Some security features have prerequisites. For example, {% data variables.product.prodname_dependabot_alerts %} use information from the dependency graph, so enabling {% data variables.product.prodname_dependabot_alerts %} automatically enables the dependency graph. - -Some features are only available to enterprises that use {% data variables.product.prodname_GHAS %} and have enabled {% data variables.product.prodname_AS %} as a feature for repositories. For more information, see [AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security#about-advanced-security-features). - ->[!NOTE] -> Enterprises can set a policy to manage which organizations can enable {% data variables.product.prodname_GHAS %}. For more information, see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise). - -There are some features you must configure for each repository individually. For example, to enable {% data variables.product.prodname_dependabot_version_updates %} in a repository, you must add a `dependabot.yml` file specifying where to find information about the project's dependencies. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates). - -## Enabling security features in your organization - -When you have decided to enable a security feature, the next step is to decide how to roll out that feature across your organization. - -* If you want to roll out a feature as quickly as possible, you can enable it for all eligible repositories at once. For more information, see [Enabling a feature for all repositories](#enabling-a-feature-for-all-repositories). -* If you want control over how quickly you roll out a feature, and which features are enabled in which repositories, you can enable a feature for a selection of repositories. For more information, see [Enabling a feature for a selection of repositories](#enabling-a-feature-for-a-selection-of-repositories). - -When you have decided how to enable a feature for your organization's existing repositories, you must also decide how to handle any new repositories that are created in your organization in the future. For more information, see [Enabling a feature for new repositories](#enabling-a-feature-for-new-repositories). - -For more information about creating a strategy for rolling out security features across a large organization or enterprise, see [AUTOTITLE](/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale). - -### Enabling a feature for all repositories - -The quickest way to roll out a security feature is to enable it for all repositories in your organization at once. If you've identified a critical need for a feature, enabling it for all repositories offers you protection across your entire organization, without requiring you to pause to devise a rollout plan. - -Before you enable a feature for all repositories, you should consider the impact this action will have. If you're not sure about the effects a feature will have, it is safest to start by enabling the feature for a limited selection of repositories. Enabling a feature for all repositories at once is likely to be a suitable option in the following situations. - -* You have an overview of all the repositories in your organization, and you're confident that they'll all benefit from a certain feature. -* If a feature requires resources such as {% data variables.product.prodname_GHAS %} licenses or {% data variables.product.prodname_actions %} minutes, you have assessed the resources that will be required and are happy to proceed. -* If the feature generates notifications or pull requests, you're confident that these will be targeted and relevant for the members who receive them or have to review them. - -When you're ready to proceed, follow these steps to enable a feature for all repositories. - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} - -1. In the left sidebar, click **{% octicon "codescan" aria-hidden="true" aria-label="codescan" %} Code security and analysis**. -1. Locate the feature that you want to enable and use any associated check boxes to fine-tune the options. -1. When you are ready to enable the feature for all repositories in your organization where the feature is supported, next to the name of the feature, click **Enable all**. - -When you click **Enable all**, you'll be prompted to confirm your choice. You'll also be told if the feature depends on another feature, or requires {% data variables.product.prodname_GHAS %}. For more information, see [AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories). - -### Enabling a feature for a selection of repositories - -In some cases, it is better to identify a selection of repositories that require a feature, then enable the feature just for those repositories. - -If you're not sure about the impact a feature will have, you may want to test the feature on a limited selection of repositories before you commit to enabling the feature for all repositories, or you may want to roll out the feature gradually over several phases. You may also be aware that some repositories in your organization require a different set of features than others. - -You can use the "Security coverage" view to identify repositories that require a certain feature, then enable the feature for those repositories. The following steps describe how to find the "Security coverage" view. - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.security-overview %} - -1. In the sidebar, click **{% octicon "meter" aria-hidden="true" aria-label="meter" %} Coverage**. - -On this view, you can use checkboxes to select specific repositories, or you can use the search bar to find the repositories where you want to enable a feature. For example, you can use filters to identify repositories where a certain team has write or admin access, or exclude repositories that don't require the same level of protection, such as test repositories or repositories for internal documentation. Then you can enable features for all selected repositories at once. For more information, see [AUTOTITLE](/code-security/security-overview/enabling-security-features-for-multiple-repositories). - -If you have a limited number of licenses for {% data variables.product.prodname_GHAS %}, you may want to prioritize repositories that contain critical projects, or that have the highest commit frequencies. See [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security). - -{% data reusables.security-overview.settings-limitations %} - -### Enabling a feature for new repositories - -You can choose to enable a security feature automatically in all new repositories that are created in your organization. Enabling features in new repositories ensures they are protected immediately, and ensures any vulnerabilities in the repositories are identified as early as possible. However, to use security features as efficiently as possible, you may prefer to review each new repository individually. - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} - -1. In the left sidebar, click **{% octicon "codescan" aria-hidden="true" aria-label="codescan" %} Code security and analysis**. -1. Below the name of the feature, select the option for automatically enabling the feature in applicable future repositories. - - ![Screenshot of "Code security and analysis" page. Below "Dependabot alerts", the checkbox to enable alerts in new repositories is outlined in orange.](/assets/images/help/security/enable-for-new-repos.png) - -## Monitoring the impact of security features - -When you have enabled a feature, you should communicate with repository administrators and contributors in your organization to assess the impact of the feature. You may need to adjust the configuration of some features at the repository level, or reassess the distribution of security features across your organization. You should also monitor the security alerts that a feature generates, and your members' responses to these alerts. - -You can use security overview to see which teams and repositories are affected by security alerts, with a breakdown of alerts by severity. For more information, see [AUTOTITLE](/code-security/security-overview/assessing-code-security-risk). - -Security overview also has a dashboard where you can explore high-level trends and metrics to gain insight into your organization's security landscape. For more information, see [AUTOTITLE](/code-security/security-overview/viewing-security-insights). - -You can use various tools to monitor the actions that your organization's members are taking in response to security alerts. For more information, see [AUTOTITLE](/code-security/getting-started/auditing-security-alerts). - -## Next steps - -To help users report security vulnerabilities, you can create a default security policy that will display in any of your organization's public repositories that do not have their own security policy. For more information, see [AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file). - -Once your organization's security setup is in place, you may want to prevent users from changing the security settings in a repository. An enterprise owner can prevent repository administrators from enabling or disabling features in a repository. For more information, see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise). - -{% data reusables.security-overview.security-information-about-actions %} diff --git a/content/code-security/how-tos/find-and-fix-code-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning.md b/content/code-security/how-tos/find-and-fix-code-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning.md index ede625d63b3c..0cdb3b7c8c1c 100644 --- a/content/code-security/how-tos/find-and-fix-code-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning.md +++ b/content/code-security/how-tos/find-and-fix-code-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning.md @@ -61,7 +61,6 @@ Your repository is eligible for default setup for {% data variables.product.prod You will then see a "{% data variables.product.prodname_codeql %} default configuration" dialog summarizing the {% data variables.product.prodname_code_scanning %} configuration automatically created by default setup. - 1. Optionally, to customize your {% data variables.product.prodname_code_scanning %} setup, click **{% octicon "pencil" aria-hidden="true" aria-label="pencil" %} Edit**. * To add or remove a language from the analysis performed by default setup, select or deselect that language in the "Languages" section. * To specify the {% data variables.product.prodname_codeql %} query suite you would like to use, select your preferred query suite in the "Query suites" section. @@ -107,9 +106,7 @@ To assign a self-hosted runner for default setup, you can use {% ifversion code- Once you've assigned custom labels to self-hosted runners, your repositories can use those runners for {% data variables.product.prodname_code_scanning %} default setup. -{% ifversion security-configurations %} You can also use {% data variables.product.prodname_security_configurations %} to assign labels to self-hosted runners for {% data variables.product.prodname_code_scanning %}. See [AUTOTITLE](/code-security/securing-your-organization/meeting-your-specific-security-needs-with-custom-security-configurations/creating-a-custom-security-configuration#creating-a-custom-security-configuration). -{% endif %} {% ifversion fpt or ghec %} diff --git a/content/code-security/how-tos/find-and-fix-code-vulnerabilities/manage-your-configuration/editing-your-configuration-of-default-setup.md b/content/code-security/how-tos/find-and-fix-code-vulnerabilities/manage-your-configuration/editing-your-configuration-of-default-setup.md index bd2ab3e6b4e7..a92193fdb9eb 100644 --- a/content/code-security/how-tos/find-and-fix-code-vulnerabilities/manage-your-configuration/editing-your-configuration-of-default-setup.md +++ b/content/code-security/how-tos/find-and-fix-code-vulnerabilities/manage-your-configuration/editing-your-configuration-of-default-setup.md @@ -76,11 +76,8 @@ For more information about {% data variables.product.prodname_codeql %} model pa {% data reusables.profile.access_org %} {% data reusables.organizations.org_settings %} -{% ifversion security-configurations %} {% data reusables.security-configurations.display-global-settings %} -{% else %} -1. Click **{% data variables.product.UI_advanced_security %}**. -{% endif %} + 1. Find the "{% data variables.product.prodname_code_scanning_caps %}" section. 1. Next to "Expand {% data variables.product.prodname_codeql %} analysis," click **Configure**. 1. Enter references to the published model packs you want to use, one per line, then click **Save**. diff --git a/content/code-security/how-tos/find-and-fix-code-vulnerabilities/scan-from-vs-code/using-the-codeql-model-editor.md b/content/code-security/how-tos/find-and-fix-code-vulnerabilities/scan-from-vs-code/using-the-codeql-model-editor.md index c210726db3cc..d08a3c3e0298 100644 --- a/content/code-security/how-tos/find-and-fix-code-vulnerabilities/scan-from-vs-code/using-the-codeql-model-editor.md +++ b/content/code-security/how-tos/find-and-fix-code-vulnerabilities/scan-from-vs-code/using-the-codeql-model-editor.md @@ -31,7 +31,7 @@ The model editor has two different modes: * **Dependency mode:** The editor identifies all of the publicly accessible APIs in the selected {% data variables.product.prodname_codeql %} database. This view guides you through modeling each public API that the codebase makes available. When you have finished modeling the entire API, you can save the model and use it to improve the {% data variables.product.prodname_codeql %} analysis for all codebases that use the dependency. -The rest of this article covers the practical aspects of modelling dependencies using the {% data variables.product.prodname_codeql %} model editor. For technical information, see [Customizing library models for Java and Kotlin](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-java-and-kotlin/){% ifversion fpt or ghec or ghes > 3.14 %}, [Customizing Library Models for Python](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-python/), [Customizing Library Models for Ruby](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-ruby/), and [Customizing library models for C#](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-csharp/){% elsif ghes %}, [Customizing Library Models for Ruby](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-ruby/), and [Customizing library models for C#](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-csharp/){% endif %} in the {% data variables.product.prodname_codeql %} language documentation. +The rest of this article covers the practical aspects of modelling dependencies using the {% data variables.product.prodname_codeql %} model editor. For technical information, see [Customizing library models for Java and Kotlin](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-java-and-kotlin/), [Customizing Library Models for Python](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-python/), [Customizing Library Models for Ruby](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-ruby/), and [Customizing library models for C#](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-csharp/) in the {% data variables.product.prodname_codeql %} language documentation. ## Displaying the {% data variables.product.prodname_codeql %} model editor diff --git a/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/assessing-code-scanning-alerts-for-your-repository.md b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/assessing-code-scanning-alerts-for-your-repository.md index 55a83e78c75b..e604c43d557d 100644 --- a/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/assessing-code-scanning-alerts-for-your-repository.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/assessing-code-scanning-alerts-for-your-repository.md @@ -51,14 +51,10 @@ With a {% data variables.copilot.copilot_enterprise %} license, you can ask {% d {% endif %} -{% ifversion security-overview-org-codeql-pr-alerts %} - ## Viewing metrics for {% data variables.product.prodname_codeql %} pull request alerts for an organization For {% data variables.product.prodname_code_scanning %} alerts from {% data variables.product.prodname_codeql %} analysis, you can use security overview to see how {% data variables.product.prodname_codeql %} is performing in pull requests in repositories where you have write access across your organization, and to identify repositories where you may need to take action. For more information, see [AUTOTITLE](/code-security/concepts/code-scanning/pull-request-alert-metrics). -{% endif %} - ## Filtering {% data variables.product.prodname_code_scanning %} alerts You can filter the alerts shown in the {% data variables.product.prodname_code_scanning %} alerts view. This is useful if there are many alerts as you can focus on a particular type of alert. There are some predefined filters and a range of keywords that you can use to refine the list of alerts displayed. diff --git a/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/creating-a-custom-security-configuration-for-your-enterprise.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/creating-a-custom-security-configuration-for-your-enterprise.md index 3e9c5569e846..66b3ecae2d8b 100644 --- a/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/creating-a-custom-security-configuration-for-your-enterprise.md +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/creating-a-custom-security-configuration-for-your-enterprise.md @@ -51,8 +51,8 @@ When creating a security configuration, keep in mind that: Your site administrator must enable validity checks before you can use this feature. See [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-secret-scanning-for-your-appliance).{% endif %}{% endif %}{% ifversion fpt or ghec %} * **Extended metadata**. To learn more about extended metadata checks, see [About extended metadata checks](/code-security/concepts/secret-security/about-validity-checks#about-extended-metadata-checks) and [AUTOTITLE](/code-security/tutorials/remediate-leaked-secrets/evaluating-alerts#reviewing-extended-metadata-for-a-token). > [!NOTE] - > You can only enable extended metadata checks if validity checks are enabled.{% endif %}{% ifversion org-npp-enablement-security-configurations %} - * **Non-provider patterns**. To learn more about scanning for non-provider patterns, see [AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#non-provider-patterns) and [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts).{% endif %}{% ifversion secret-scanning-ai-generic-secret-detection %} + > You can only enable extended metadata checks if validity checks are enabled.{% endif %} + * **Non-provider patterns**. To learn more about scanning for non-provider patterns, see [AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#non-provider-patterns) and [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts).{% ifversion secret-scanning-ai-generic-secret-detection %} * **Scan for generic passwords**. To learn more, see [AUTOTITLE](/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-generic-secrets).{% endif %} * **Push protection**. To learn about push protection, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-push-protection).{% ifversion push-protection-delegated-bypass-configurations-enterprise %} * **Bypass privileges**. By assigning bypass privileges{% ifversion push-protection-org-enterprise-exemptions %} or exemptions{% endif %}, selected actors can bypass{% ifversion push-protection-org-enterprise-exemptions %} or skip{% endif %} push protection. There is a review and approval process for all other contributors. See [AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection).{% endif %}{% ifversion security-delegated-alert-dismissal %} @@ -93,8 +93,8 @@ When creating a security configuration, keep in mind that: 1. In the "{% data variables.product.prodname_GHAS %} features" row, choose whether to include or exclude {% data variables.product.prodname_GHAS %} (GHAS) features. 1. In the "{% data variables.product.prodname_secret_scanning_caps %}" table, choose whether you want to enable, disable, or keep the existing settings for the following security features:{% ifversion ghes > 3.16 %} * **Alerts**. To learn about {% data variables.secret-scanning.alerts %}, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-secret-scanning).{% endif %} {% ifversion secret-scanning-validity-check-partner-patterns %} - * **Validity checks**. To learn more about validity checks for partner patterns, see [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/evaluating-alerts#checking-a-secrets-validity).{% endif %}{% ifversion org-npp-enablement-security-configurations %} - * **Non-provider patterns**. To learn more about scanning for non-provider patterns, see [AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#non-provider-patterns) and [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts).{% endif %}{% ifversion secret-scanning-ai-generic-secret-detection %} + * **Validity checks**. To learn more about validity checks for partner patterns, see [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/evaluating-alerts#checking-a-secrets-validity).{% endif %} + * **Non-provider patterns**. To learn more about scanning for non-provider patterns, see [AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#non-provider-patterns) and [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts).{% ifversion secret-scanning-ai-generic-secret-detection %} * **Scan for generic passwords**. To learn more, see [AUTOTITLE](/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-generic-secrets).{% endif %} * **Push protection**. To learn about push protection, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-push-protection).{% ifversion security-delegated-alert-dismissal %} * **Prevent direct alert dismissals**. To learn more, see [AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/enabling-delegated-alert-dismissal-for-secret-scanning).{% endif %} @@ -143,8 +143,8 @@ When creating a security configuration, keep in mind that: > You cannot manually change the enablement setting for the dependency graph. This setting is installed and managed by a site administrator at the instance level. 1. In the "{% data variables.product.prodname_code_scanning_caps %}" section of the security settings table, choose whether you want to enable, disable, or keep the existing settings for {% data variables.product.prodname_code_scanning %} default setup. To learn about default setup, see [AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning#about-default-setup). 1. In the "{% data variables.product.prodname_secret_scanning_caps %}" section of the security settings table, choose whether you want to enable, disable, or keep the existing settings for the following security features: - * **Alerts**. To learn about {% data variables.secret-scanning.alerts %}, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-secret-scanning).{% ifversion org-npp-enablement-security-configurations %} - * **Non-provider patterns**. To learn more about scanning for non-provider patterns, see [AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#non-provider-patterns) and [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts).{% endif %} + * **Alerts**. To learn about {% data variables.secret-scanning.alerts %}, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-secret-scanning). + * **Non-provider patterns**. To learn more about scanning for non-provider patterns, see [AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#non-provider-patterns) and [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts). * **Push protection**. To learn about push protection, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-push-protection). 1. Optionally, in the "Policy" section, you can choose to automatically apply the {% data variables.product.prodname_security_configuration %} to newly created repositories depending on their visibility. Select the **None** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %} dropdown menu, then click **Public**, or **Private and internal**, or **All repositories**. diff --git a/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/enabling-security-features-for-multiple-repositories.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/enabling-security-features-for-multiple-repositories.md deleted file mode 100644 index 0a3501bb34d4..000000000000 --- a/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/enabling-security-features-for-multiple-repositories.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: Enabling security features for multiple repositories -shortTitle: Enable security features -intro: You can use security overview to select a subset of repositories and enable security features for them all. -permissions: '{% data reusables.permissions.security-org-enable %}' -allowTitleToDifferFromFilename: true -versions: - feature: security-configurations-beta-and-pre-beta -redirect_from: - - /code-security/security-overview/enabling-security-features-for-multiple-repositories -contentType: how-tos -category: - - Secure at scale ---- - -## About enabling security features - -If you're a security manager, repository administrator, or organization owner, you can use security overview to enable or disable security features for multiple repositories at the same time. You can enable or disable security features for all repositories visible on the "Security coverage" view in security overview for an organization. - -You can use checkboxes to select which repositories you want to include, or use the search bar to narrow down to a specific subset of repositories, and enable or disable security features for that group. This is useful if you want to introduce a feature to your organization gradually over time, or if your organization requires a complex security setup where different features are enabled in different repositories. For example, if you are enabling a feature across a group of repositories, you may find the following filtering options helpful. - -* To exclude certain repositories from the selection, you can assign a topic such as `test` to these repositories, then exclude them from the results with a search like `-topic:test`. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics). -* If a team uses repositories that all require a certain feature, you can use the `team:` filter to search for repositories where a team has write access. -* If you're enabling {% data variables.product.prodname_code_scanning %}, you can see which repositories are eligible for default setup with the search `code-scanning-default-setup:eligible`. For more information, see [AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-at-scale). -* You can use custom repository properties to filter security overview to show results from specific groups of repositories. Custom properties are metadata that organization owners can add and set for repositories in an organization. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization). - -For more information on filters you can use in different parts of security overview, see [AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview). - -For more information about the different ways of enabling security features in an organization, see {% ifversion security-configurations %}[AUTOTITLE](/code-security/securing-your-organization).{% else %}[AUTOTITLE](/code-security/getting-started/quickstart-for-securing-your-organization).{% endif %} - -## Enabling security features for multiple repositories - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.security-overview %} -{% data reusables.security-overview.security-overview-coverage-view %} -1. You can use the search bar to narrow down visible repositories in the "Security coverage" view based on filters such as repository name or enablement status of security features. -1. In the list of repositories, select each repository you want to modify the enablement of security features for. To select all repositories on the page, click the checkbox next to **NUMBER Active**. To select all repositories that match the current search, click the checkbox next to **NUMBER Active** and then click **Select all NUMBER repos**. -1. Click **Security settings** next to **NUMBER selected**. -1. In the side panel, next to all the security features you want to enable or disable, select **Enable** or **Disable**. -1. As you make changes, the **Apply changes** button reports the number of security features you have edited. To confirm the changes, click **Apply changes NUMBER**. Alternatively, click {% octicon "x" aria-label="Close" %} to close the panel without making changes. - - {% data reusables.security-overview.settings-limitations %} - - ![Screenshot of the "Security coverage" view with the side panel open. The "Apply changes" button is highlighted in a dark orange outline.](/assets/images/help/security-overview/security-coverage-view-multi-repo-side-panel.png) - -The security features that you can enable and disable in this view are: - -* Dependency graph -* {% data variables.product.prodname_dependabot_alerts %} -* {% data variables.product.prodname_dependabot_security_updates %} -* {% data variables.product.prodname_GHAS %} -* {% data variables.product.prodname_code_scanning_caps %} default setup -* {% data variables.secret-scanning.alerts_caps %} -* {% data variables.product.prodname_secret_scanning_caps %} as a push protection - -If you're blocked from enabling a security feature due to an enterprise policy, you will still be able to see the affected repository in the "Security Coverage" view and access the side panel from the **{% octicon "gear" aria-hidden="true" aria-label="gear" %} Security settings** button. However, you will see a message in the side panel indicating that the functionality is not available. For more information about enterprise policies, see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise). - -Organization owners and security managers can use security overview to enable or disable security features for all repositories belonging to their organization. There are no enterprise policies that restrict organization owners or security managers from enabling or disabling any security features. For more information about enterprise policies, see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/about-enterprise-policies). diff --git a/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/index.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/index.md index 78dece7a74c0..5c9024a357a3 100644 --- a/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/index.md +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/index.md @@ -7,9 +7,9 @@ versions: ghec: '*' contentType: how-tos children: - - /enabling-security-features-for-multiple-repositories - /enabling-github-advanced-security-for-your-enterprise - /creating-a-custom-security-configuration-for-your-enterprise - /applying-a-custom-security-configuration-to-your-enterprise - /configuring-additional-secret-scanning-settings-for-your-enterprise --- + diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/configuring-default-setup-for-code-scanning-at-scale.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/configuring-default-setup-for-code-scanning-at-scale.md index ee44df0ef84f..ef7ed00654eb 100644 --- a/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/configuring-default-setup-for-code-scanning-at-scale.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/configuring-default-setup-for-code-scanning-at-scale.md @@ -21,13 +21,6 @@ With default setup for {% data variables.product.prodname_code_scanning %}, you For repositories that are not suitable for default setup, you can configure advanced setup at the repository level, or at the organization level using a script. -{% ifversion pre-security-configurations %} - -> [!NOTE] -> Configuring default setup for all repositories in an organization through your organization's settings page _will not_ override existing configurations of default setup. However, configuring default setup on a subset of repositories in an organization through security overview _will_ override existing configurations of default setup on those repositories. - -{% endif %} - ## Prerequisites A repository must meet all the following criteria to be eligible for default setup: @@ -37,24 +30,7 @@ A repository must meet all the following criteria to be eligible for default set ## Configuring default setup for all eligible repositories in an organization -{% ifversion security-configurations %} You can enable default setup for all eligible repositories in your organization. For more information, see [AUTOTITLE](/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale). -{% else %} -Through the "{% data variables.product.UI_advanced_security %}" page of your organization's settings, you can enable default setup for all eligible repositories in your organization. - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.security-and-analysis %} -1. Click **Enable all** next to "{% data variables.product.prodname_code_scanning_caps %}." -1. In the "Query suites" section of the "Enable {% data variables.product.prodname_code_scanning %} default setup" dialog box displayed, select the query suite your configuration of default setup will run. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/codeql-query-suites). -1. To enable your configuration of default setup, click **Enable for eligible repositories**. -1. Optionally, to recommend the "Extended" query suite throughout your organization when enabling default setup, select "Recommend the extended query suite for repositories enabling default setup." - -> [!NOTE] -> * {% data reusables.code-scanning.limitation-org-enable-all %} -> * Enabling {% data variables.product.prodname_code_scanning %} for all eligible repositories in an organization will not override existing {% data variables.product.prodname_code_scanning %} configurations. For information on configuring default setup with different settings for specific repositories, see [AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning). -> * Enabling default setup for all eligible repositories in an organization includes eligible repositories without {% data variables.product.prodname_codeql %}-supported languages. If a {% data variables.product.prodname_codeql %}-supported language is later added to one of these repositories, default setup will begin scanning that repository and consuming {% data variables.product.prodname_actions %} minutes. - -{% endif %} + You can enable default setup for all eligible repositories in your organization. For more information, see [AUTOTITLE](/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale). ### Extending {% data variables.product.prodname_codeql %} coverage in default setup @@ -62,66 +38,8 @@ Through your organization's security settings page, you can extend coverage in d ## Configuring default setup for a subset of repositories in an organization -{% ifversion security-configurations %} - You can filter for specific repositories you would like to configure default setup for. For more information, see [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization/applying-a-custom-security-configuration). -{% endif %} - -{% ifversion pre-security-configurations %} - -Through security overview for your organization, you can find eligible repositories for default setup, then enable default setup across each of those repositories simultaneously. - -### Finding repositories that are eligible for default setup - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.security-overview %} -{% data reusables.security-overview.security-overview-coverage-view %} -1. In the search bar, enter one of the following queries: - -{%- ifversion ghes %} - - `code-scanning-default-setup:eligible is:public` shows repositories that have languages suitable for default setup and are eligible because they are visible to the public. - - `code-scanning-default-setup:eligible advanced-security:enabled` shows private or internal repositories that have languages suitable for default setup and are eligible because they have {% data variables.product.prodname_GHAS %} enabled. - - `code-scanning-default-setup:eligible is:private,internal advanced-security:not-enabled` shows private or internal repositories that have languages suitable for default setup but do not have {% data variables.product.prodname_GHAS %} enabled. Once you enable {% data variables.product.prodname_GHAS %} for these repositories, they can also be added to default setup. -{%- else %} - - `code-scanning-default-setup:eligible advanced-security:enabled` shows which repositories can be added to default setup immediately. - - `code-scanning-default-setup:eligible advanced-security:not-enabled` shows which repositories have languages suitable for default setup but do not have {% data variables.product.prodname_GHAS %} enabled. Once you enable {% data variables.product.prodname_GHAS %} for these repositories, they can also be added to default setup. - - `code-scanning-default-setup:not-eligible` shows repositories that are ineligible for default setup enablement at scale for any of the following reasons: - - The repositories already have existing configurations of advanced setup. - - The repositories only contain languages that cannot be analyzed by default setup. - - The repositories do not have {% data variables.product.prodname_GHAS %} enabled. -{%- endif %} - -You can select all of the displayed repositories, or a subset of them, and enable or disable default setup for {% data variables.product.prodname_code_scanning %} for them all at the same time. For more information, see step 5 of [Configuring default setup at scale for multiple repositories in an organization](#configuring-default-setup-at-scale-for-multiple-repositories-in-an-organization). - -### Configuring default setup at scale for multiple repositories in an organization - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.security-overview %} -{% data reusables.security-overview.security-overview-coverage-view %} -1. You can use the search bar to narrow down visible repositories in the "Security coverage" view based on name, or on the enablement status of security features. For example, to filter for repositories that are eligible for default setup and do not currently have default setup enabled, search for `code-scanning-default-setup:eligible`. -1. In the list of repositories, select each repository you want to enable {% data variables.product.prodname_code_scanning %} for. - * To enable {% data variables.product.prodname_code_scanning %} for all repositories on the page, select the checkbox next to **NUMBER Active**. - * To enable {% data variables.product.prodname_code_scanning %} for all repositories that match the current search, select the checkbox next to **NUMBER Active**, then click **Select all NUMBER repos**. -1. Click **Security settings** next to **NUMBER selected**. -1. In the side panel, in the "{% data variables.product.prodname_codeql %} Default Setup" section, select **No change**, then click **Enable**. -1. To confirm the enablement of {% data variables.product.prodname_code_scanning %} for the selected repositories, click **Apply changes NUMBER**. Alternatively, to select or deselect more repositories for {% data variables.product.prodname_code_scanning %} enablement, click {% octicon "x" aria-label="Close" %} to close the panel without applying your changes. - -> [!NOTE] - -{%- ifversion ghes %} -> * Enabling {% data variables.product.prodname_code_scanning %} for multiple repositories in an organization using security overview will override any existing {% data variables.product.prodname_code_scanning %} configurations for the selected repositories, including any previous query suite selections and workflows for advanced setups. -> * You can enable default setup for eligible repositories that do not contain {% data variables.product.prodname_codeql %}-supported languages. If a {% data variables.product.prodname_codeql %}-supported language is later added to one of these repositories, default setup will begin scanning that repository and consuming {% data variables.product.prodname_actions %} minutes. -{%- else %} -> Enabling {% data variables.product.prodname_code_scanning %} for multiple repositories in an organization using security overview will override any existing {% data variables.product.prodname_code_scanning %} configurations for the selected repositories, including any previous query suite selections and workflows for advanced setups. -{%- endif %} - - ![Screenshot of the "Security coverage" view with the side panel open. The "Apply changes" button is highlighted in a dark orange outline.](/assets/images/help/security-overview/security-coverage-view-multi-repo-side-panel.png) - - If you're blocked from enabling {% data variables.product.prodname_code_scanning %} due to an enterprise policy, you will still be able to see the affected repository in the "Security Coverage" view and access the side panel from the **{% octicon "gear" aria-hidden="true" aria-label="gear" %} Security settings** button. However, you will see a message in the side panel indicating that you cannot enable {% data variables.product.prodname_code_scanning %} for the selected repositories. For more information about enterprise policies, see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise). - -{% endif %} - {% ifversion org-private-registry %} ## Providing default setup access to private registries diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/applying-a-custom-security-configuration.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/applying-a-custom-security-configuration.md index e8e871ebe924..3cd5412cd3fd 100644 --- a/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/applying-a-custom-security-configuration.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/applying-a-custom-security-configuration.md @@ -4,7 +4,9 @@ shortTitle: Apply custom configuration intro: You can apply your {% data variables.product.prodname_custom_security_configuration %} to repositories in your organization to meet the specific security needs of those repositories. permissions: '{% data reusables.permissions.security-org-enable %}' versions: - feature: security-configurations + fpt: '*' + ghec: '*' + ghes: '*' redirect_from: - /code-security/securing-your-organization/meeting-your-specific-security-needs-with-custom-security-configurations/applying-a-custom-security-configuration - /code-security/securing-your-organization/enabling-security-features-in-your-organization/applying-a-custom-security-configuration diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/configuring-global-security-settings-for-your-organization.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/configuring-global-security-settings-for-your-organization.md index c968d0c36fdb..91d31caa6cf9 100644 --- a/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/configuring-global-security-settings-for-your-organization.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/configuring-global-security-settings-for-your-organization.md @@ -4,7 +4,9 @@ shortTitle: Configure global settings intro: Customize {% data variables.product.prodname_AS %} features for your organization by defining global settings that ensure consistent security standards and safeguard all your repositories. permissions: '{% data reusables.permissions.security-org-enable %}' versions: - feature: security-configurations + fpt: '*' + ghec: '*' + ghes: '*' redirect_from: - /code-security/securing-your-organization/enabling-security-features-in-your-organization/configuring-global-security-settings-for-your-organization contentType: how-tos diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/creating-a-custom-security-configuration.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/creating-a-custom-security-configuration.md index cd04bb8f5b34..8c0c460f4ab7 100644 --- a/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/creating-a-custom-security-configuration.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/creating-a-custom-security-configuration.md @@ -4,7 +4,9 @@ shortTitle: Create custom configuration intro: Build a {% data variables.product.prodname_custom_security_configuration %} to meet the specific security needs of repositories in your organization. permissions: '{% data reusables.permissions.security-org-enable %}' versions: - feature: security-configurations + fpt: '*' + ghec: '*' + ghes: '*' redirect_from: - /code-security/securing-your-organization/meeting-your-specific-security-needs-with-custom-security-configurations/creating-a-custom-security-configuration - /code-security/securing-your-organization/enabling-security-features-in-your-organization/creating-a-custom-security-configuration @@ -57,8 +59,8 @@ When creating a security configuration, keep in mind that: Your site administrator must enable validity checks before you can use this feature. See [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-secret-scanning-for-your-appliance).{% endif %}{% endif %}{% ifversion fpt or ghec %} * **Extended metadata**. To learn more about extended metadata checks, see [About extended metadata checks](/code-security/concepts/secret-security/about-validity-checks#about-extended-metadata-checks) and [AUTOTITLE](/code-security/tutorials/remediate-leaked-secrets/evaluating-alerts#reviewing-extended-metadata-for-a-token). > [!NOTE] - > You can only enable extended metadata checks if validity checks are enabled.{% endif %}{% ifversion org-npp-enablement-security-configurations %} - * **Non-provider patterns**. To learn more about scanning for non-provider patterns, see [AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#non-provider-patterns) and [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts).{% endif %}{% ifversion secret-scanning-ai-generic-secret-detection %} + > You can only enable extended metadata checks if validity checks are enabled.{% endif %} + * **Non-provider patterns**. To learn more about scanning for non-provider patterns, see [AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#non-provider-patterns) and [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts).{% ifversion secret-scanning-ai-generic-secret-detection %} * **Scan for generic passwords**. To learn more, see [AUTOTITLE](/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-generic-secrets).{% endif %} * **Push protection**. To learn about push protection, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-push-protection).{% ifversion push-protection-delegated-bypass-configurations %} * **Bypass privileges**. By assigning bypass privileges{% ifversion push-protection-org-enterprise-exemptions %} or exemptions{% endif %}, selected actors can bypass{% ifversion push-protection-org-enterprise-exemptions %} or skip{% endif %} push protection. There is a review and approval process for all other contributors. See [AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection).{% endif %}{% ifversion security-delegated-alert-dismissal %} @@ -99,8 +101,8 @@ When creating a security configuration, keep in mind that: 1. In the "{% data variables.product.prodname_GHAS %} features" row, choose whether to include or exclude {% data variables.product.prodname_GHAS %} (GHAS) features. 1. In the "{% data variables.product.prodname_secret_scanning_caps %}" table, choose whether you want to enable, disable, or keep the existing settings for the following security features:{% ifversion ghes > 3.16 %} * **Alerts**. To learn about {% data variables.secret-scanning.alerts %}, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-secret-scanning).{% endif %} {% ifversion secret-scanning-validity-check-partner-patterns %} - * **Validity checks**. To learn more about validity checks for partner patterns, see [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/evaluating-alerts#checking-a-secrets-validity).{% endif %}{% ifversion org-npp-enablement-security-configurations %} - * **Non-provider patterns**. To learn more about scanning for non-provider patterns, see [AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#non-provider-patterns) and [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts).{% endif %}{% ifversion secret-scanning-ai-generic-secret-detection %} + * **Validity checks**. To learn more about validity checks for partner patterns, see [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/evaluating-alerts#checking-a-secrets-validity).{% endif %} + * **Non-provider patterns**. To learn more about scanning for non-provider patterns, see [AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#non-provider-patterns) and [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts).{% ifversion secret-scanning-ai-generic-secret-detection %} * **Scan for generic passwords**. To learn more, see [AUTOTITLE](/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-generic-secrets).{% endif %} * **Push protection**. To learn about push protection, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-push-protection).{% ifversion push-protection-delegated-bypass-configurations %} * **Bypass privileges**. By assigning bypass privileges{% ifversion push-protection-org-enterprise-exemptions %} or exemptions{% endif %}, selected actors can bypass{% ifversion push-protection-org-enterprise-exemptions %} or skip{% endif %} push protection. There is a review and approval process for all other contributors. See [AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection).{% endif %}{% ifversion security-delegated-alert-dismissal %} @@ -149,8 +151,8 @@ When creating a security configuration, keep in mind that: > You cannot manually change the enablement setting for the dependency graph. This setting is installed and managed by a site administrator at the instance level. 1. In the "{% data variables.product.prodname_code_scanning_caps %}" section of the security settings table, choose whether you want to enable, disable, or keep the existing settings for {% data variables.product.prodname_code_scanning %} default setup. To learn about default setup, see [AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning#about-default-setup). 1. In the "{% data variables.product.prodname_secret_scanning_caps %}" section of the security settings table, choose whether you want to enable, disable, or keep the existing settings for the following security features: - * Alerts. To learn about {% data variables.secret-scanning.alerts %}, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-secret-scanning).{% ifversion org-npp-enablement-security-configurations %} - * Non-provider patterns. To learn more about scanning for non-provider patterns, see [AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#non-provider-patterns) and [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts).{% endif %} + * Alerts. To learn about {% data variables.secret-scanning.alerts %}, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-secret-scanning). + * Non-provider patterns. To learn more about scanning for non-provider patterns, see [AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#non-provider-patterns) and [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts). * Push protection. To learn about push protection, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-push-protection). {% ifversion push-protection-delegated-bypass-configurations %} 1. Optionally, under "Push protection", choose whether you want to grant bypass privileges{% ifversion push-protection-org-enterprise-exemptions %} or exemptions{% endif %} for selected actors in your organization. {% ifversion push-protection-org-enterprise-exemptions %}Bypass privileges allow actors to bypass push protection blocks, as well as review and approve bypass requests from other contributors, while exemptions stop push protection from running on pushes by selected actors.{% else %}By assigning bypass privileges, selected organization members can bypass push protection, and there is a review and approval process for all other contributors.{% endif %} For further guidance on how to configure this setting, see [AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/enabling-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-an-organization). diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/managing-your-github-advanced-security-license-usage.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/managing-your-github-advanced-security-license-usage.md index 8a1aa1dee1d0..6c4ad34a8d3a 100644 --- a/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/managing-your-github-advanced-security-license-usage.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/managing-your-github-advanced-security-license-usage.md @@ -6,7 +6,9 @@ allowTitleToDifferFromFilename: true permissions: '{% data reusables.permissions.security-org-enable %}' product: '{% data reusables.gated-features.ghas-billing %}' versions: - feature: security-configurations + fpt: '*' + ghec: '*' + ghes: '*' redirect_from: - /code-security/securing-your-organization/managing-the-security-of-your-organization/managing-your-github-advanced-security-license-usage contentType: how-tos diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/deleting-a-custom-security-configuration.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/deleting-a-custom-security-configuration.md index 61078aecb284..6923407057ac 100644 --- a/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/deleting-a-custom-security-configuration.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/deleting-a-custom-security-configuration.md @@ -4,7 +4,9 @@ shortTitle: Delete custom configuration intro: You can delete unnecessary {% data variables.product.prodname_custom_security_configurations %} in your organization. permissions: '{% data reusables.permissions.security-org-enable %}' versions: - feature: security-configurations + fpt: '*' + ghec: '*' + ghes: '*' redirect_from: - /code-security/securing-your-organization/managing-the-security-of-your-organization/deleting-a-custom-security-configuration contentType: how-tos diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/detaching-repositories-from-their-security-configurations.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/detaching-repositories-from-their-security-configurations.md index 6af36f2e6a9e..849283ef3d00 100644 --- a/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/detaching-repositories-from-their-security-configurations.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/detaching-repositories-from-their-security-configurations.md @@ -4,7 +4,9 @@ shortTitle: Detach security configuration intro: Go back to managing a repository's security settings on an individual basis. permissions: '{% data reusables.permissions.security-org-enable %}' versions: - feature: security-configurations + fpt: '*' + ghec: '*' + ghes: '*' redirect_from: - /code-security/securing-your-organization/managing-the-security-of-your-organization/detaching-repositories-from-their-security-configurations contentType: how-tos diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/editing-a-custom-security-configuration.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/editing-a-custom-security-configuration.md index 0da1b947ccb3..779b97965d3d 100644 --- a/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/editing-a-custom-security-configuration.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/editing-a-custom-security-configuration.md @@ -4,7 +4,9 @@ shortTitle: Edit custom configuration intro: Meet the security needs of your repositories by editing your {% data variables.product.prodname_custom_security_configuration %}. permissions: '{% data reusables.permissions.security-org-enable %}' versions: - feature: security-configurations + fpt: '*' + ghec: '*' + ghes: '*' redirect_from: - /code-security/securing-your-organization/managing-the-security-of-your-organization/editing-a-custom-security-configuration contentType: how-tos diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/filtering-repositories-in-your-organization-using-the-repository-table.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/filtering-repositories-in-your-organization-using-the-repository-table.md index dd512bedd19e..3f25b5f883a9 100644 --- a/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/filtering-repositories-in-your-organization-using-the-repository-table.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/filtering-repositories-in-your-organization-using-the-repository-table.md @@ -4,7 +4,9 @@ shortTitle: Filter repositories intro: You can filter the repository table for your organization to better manage the security settings of specific repositories. permissions: '{% data reusables.permissions.security-org-enable %}' versions: - feature: security-configurations + fpt: '*' + ghec: '*' + ghes: '*' redirect_from: - /code-security/securing-your-organization/managing-the-security-of-your-organization/filtering-repositories-in-your-organization-using-the-repository-table contentType: how-tos diff --git a/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/defining-custom-patterns-for-secret-scanning.md b/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/defining-custom-patterns-for-secret-scanning.md index d23afa7a9a70..ea4cafea0711 100644 --- a/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/defining-custom-patterns-for-secret-scanning.md +++ b/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/defining-custom-patterns-for-secret-scanning.md @@ -49,18 +49,12 @@ After your pattern is created, {% data reusables.secret-scanning.secret-scanning ## Defining a custom pattern for an organization -Before defining a custom pattern, you must ensure that you enable {% data variables.product.prodname_secret_scanning %} for the repositories that you want to scan in your organization. {% ifversion security-configurations %} You can use {% data variables.product.prodname_security_configurations %} to enable {% data variables.product.prodname_secret_scanning %} on all repositories in your organization. For more information, see [AUTOTITLE](/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).{% else %} -To enable {% data variables.product.prodname_secret_scanning %} on all repositories in your organization, see [AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization). -{% endif %} +Before defining a custom pattern, you must ensure that you enable {% data variables.product.prodname_secret_scanning %} for the repositories that you want to scan in your organization. You can use {% data variables.product.prodname_security_configurations %} to enable {% data variables.product.prodname_secret_scanning %} on all repositories in your organization. For more information, see [AUTOTITLE](/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale). {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -{% ifversion security-configurations %} 1. In the "Security" section of the sidebar, select the **{% data variables.product.UI_advanced_security %}** dropdown menu, then click **{% data variables.product.prodname_global_settings_caps %}**. -{% else %} -{% data reusables.organizations.security-and-analysis %} -{% data reusables.repositories.navigate-to-ghas-settings %} -{% endif %} + {% data reusables.advanced-security.secret-scanning-new-custom-pattern-org %} {% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %} 1. When you're ready to test your new custom pattern, to identify matches in select repositories without creating alerts, click **Save and dry run**. diff --git a/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/managing-custom-patterns.md b/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/managing-custom-patterns.md index 3ac2e78d65b7..c6f19d5bff42 100644 --- a/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/managing-custom-patterns.md +++ b/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/managing-custom-patterns.md @@ -72,14 +72,9 @@ Before enabling push protection for a custom pattern at organization level, you {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -{% ifversion security-configurations %} 1. In the "Security" section of the sidebar, select the **{% data variables.product.UI_advanced_security %}** dropdown menu, then click **{% data variables.product.prodname_global_settings_caps %}**. 1. Under "Custom patterns", click {% octicon "pencil" aria-label="Edit custom pattern" %} for the pattern of interest. -{% else %} -{% data reusables.organizations.security-and-analysis %} -{% data reusables.repositories.navigate-to-ghas-settings %} -{% data reusables.advanced-security.secret-scanning-edit-custom-pattern %} -{% endif %} + 1. To enable push protection for your custom pattern, scroll down to "Push Protection", and click **Enable**. {% indented_data_reference reusables.secret-scanning.push-protection-org-notes spaces=3 %} diff --git a/content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-secret-scanning-for-non-provider-patterns.md b/content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-secret-scanning-for-non-provider-patterns.md index 86fe2e42508d..588fd8bdc69c 100644 --- a/content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-secret-scanning-for-non-provider-patterns.md +++ b/content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-secret-scanning-for-non-provider-patterns.md @@ -1,7 +1,7 @@ --- title: Enabling secret scanning for non-provider patterns allowTitleToDifferFromFilename: true -intro: You can enable {% data variables.product.prodname_secret_scanning %} to detect additional potential secrets at the {% ifversion security-configurations %}repository and organization levels{% else %}repository level{% endif %}. +intro: You can enable {% data variables.product.prodname_secret_scanning %} to detect additional potential secrets at the repository and organization levels. permissions: '{% data reusables.permissions.security-repo-enable %}' product: '{% data reusables.gated-features.secret-scanning-non-provider-patterns %}' versions: @@ -25,25 +25,17 @@ You can enable scanning for non-provider patterns. Non-provider patterns corresp For more information about non-provider patterns, see "{% ifversion fpt or ghec %}[AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#about-user--alerts){% else %}[AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#about-secret-scanning-alerts){% endif %}." -{% ifversion security-configurations %} - ### Enabling detection of non-provider patterns for a repository -{% endif %} - {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-code-security-and-analysis %} 1. Under "{% data variables.product.UI_secret_protection_scanning %}", to the right of "Non-provider patterns", click **Enable**. -{% ifversion security-configurations %} - ### Enabling detection of non-provider patterns for an organization You can enable scanning for non-provider patterns at the organization level by applying a custom security configuration. For more information, see [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization/creating-a-custom-security-configuration). -{% endif %} - ## Further reading * [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning) diff --git a/content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-secret-scanning-for-your-repository.md b/content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-secret-scanning-for-your-repository.md index 4a9f07ec6e84..d019dbb6a86d 100644 --- a/content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-secret-scanning-for-your-repository.md +++ b/content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-secret-scanning-for-your-repository.md @@ -24,16 +24,8 @@ category: {% data variables.secret-scanning.user_alerts_caps %} can be enabled for any repository that is owned by an organization{% ifversion secret-scanning-user-owned-repos %}, and for repositories owned by user accounts when using {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_emus %}{% endif %}. -{% ifversion security-configurations %} - If you're an organization owner, you can enable {% data variables.product.prodname_secret_scanning %} for multiple repositories at a time using {% data variables.product.prodname_security_configurations %}. For more information, see [AUTOTITLE](/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale). -{% else %} - -If you're an organization owner, you can enable {% data variables.product.prodname_secret_scanning %} for multiple repositories at a time. For more information, see [AUTOTITLE](/code-security/getting-started/quickstart-for-securing-your-organization#enabling-security-features-in-your-organization). - -{% endif %} - {% ifversion security-configuration-enterprise-level %} If your organization is owned by an enterprise account, an enterprise owner can also enable {% data variables.product.prodname_secret_scanning %} at the enterprise level. For more information, see [AUTOTITLE](/admin/managing-code-security/securing-your-enterprise/creating-a-custom-security-configuration-for-your-enterprise). diff --git a/content/code-security/how-tos/secure-your-secrets/manage-bypass-requests/enabling-delegated-bypass-for-push-protection.md b/content/code-security/how-tos/secure-your-secrets/manage-bypass-requests/enabling-delegated-bypass-for-push-protection.md index d5dea53a309f..6f0cd84163e9 100644 --- a/content/code-security/how-tos/secure-your-secrets/manage-bypass-requests/enabling-delegated-bypass-for-push-protection.md +++ b/content/code-security/how-tos/secure-your-secrets/manage-bypass-requests/enabling-delegated-bypass-for-push-protection.md @@ -45,12 +45,8 @@ To enable delegated bypass, create the teams or roles that will manage bypass re {% data reusables.organizations.navigate-to-org %} {% data reusables.organizations.org_settings %} -{% ifversion security-configurations %} 1. In the "Security" section of the sidebar, select the **{% data variables.product.UI_advanced_security %}** dropdown menu, then click **{% data variables.product.prodname_global_settings_caps %}**. -{% else %} -{% data reusables.organizations.security-and-analysis %} -{% data reusables.repositories.navigate-to-ghas-settings %} -{% endif %} + 1. Under "Push protection," to the right of "Who can bypass push protection for {% data variables.product.prodname_secret_scanning %}," select the dropdown menu, then click **Specific roles or teams**. 1. Under "Bypass list," click **Add role or team**. 1. In the dialog box, select the roles and teams that you want to add to the bypass list, then click **Add selected**. diff --git a/content/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/working-with-push-protection-from-the-command-line.md b/content/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/working-with-push-protection-from-the-command-line.md index 599102f4dce4..bdcb28ffdd98 100644 --- a/content/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/working-with-push-protection-from-the-command-line.md +++ b/content/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/working-with-push-protection-from-the-command-line.md @@ -115,5 +115,5 @@ To resolve a blocked push, you must remove the secret from all of the commits it ## Further reading -* [AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-in-the-github-ui){% ifversion secret-scanning-push-protection-content-endpoints %} -* [AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-rest-api){% endif %} +* [AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-in-the-github-ui) +* [AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-rest-api) diff --git a/content/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/working-with-push-protection-in-the-github-ui.md b/content/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/working-with-push-protection-in-the-github-ui.md index 9ca9bfdd22aa..6bb45ec5548c 100644 --- a/content/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/working-with-push-protection-in-the-github-ui.md +++ b/content/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/working-with-push-protection-in-the-github-ui.md @@ -76,5 +76,5 @@ If your request is denied, you will need to remove the secret from the file befo ## Further reading -* [AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-command-line){% ifversion secret-scanning-push-protection-content-endpoints %} -* [AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-rest-api){% endif %} +* [AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-command-line) +* [AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-rest-api) diff --git a/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/customizing-auto-triage-rules-to-prioritize-dependabot-alerts.md b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/customizing-auto-triage-rules-to-prioritize-dependabot-alerts.md index a13a3d48e235..4f0872c1345f 100644 --- a/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/customizing-auto-triage-rules-to-prioritize-dependabot-alerts.md +++ b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/customizing-auto-triage-rules-to-prioritize-dependabot-alerts.md @@ -80,30 +80,7 @@ For more information about enabling or disabling {% data variables.product.prodn ## Adding {% data variables.dependabot.custom_rules %} to your organization -{% ifversion security-configurations %} You can add {% data variables.dependabot.custom_rules %} for all eligible repositories in your organization. For more information, see [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization/configuring-global-security-settings-for-your-organization#creating-and-managing-dependabot-auto-triage-rules). - -{% else %} - -> [!NOTE] -> During the {% data variables.release-phases.public_preview %}, you can create up to 25 {% data variables.dependabot.custom_rules %} for your organization. - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.security-and-analysis %} -{% data reusables.dependabot.navigate-to-org-level-dependabot-alert-rules %} -{% data reusables.dependabot.click-new-alert-rule %} -{% data reusables.dependabot.dependabot-alert-rule-set-name %} -1. Under "State", use the dropdown menu to choose how you want to apply the rule. - * Choose **Enforced** to prevent repository administrators from being able to edit, disable, or delete the rule in the repository's settings page. - * Choose **Enabled** to set the rule on-by-default for all repositories, while also allowing repository administrators to disable the rule in the repository's settings page. - * Alternatively, you can choose to set the rule as **Disabled**, which cannot be overridden at the repository level. Disabled rules are hidden for all repositories. -{% data reusables.dependabot.target-alerts-metadata %} -1. Under "Rules", select the action you want to take on alerts that match the metadata: - * Select **Dismiss alerts** to auto-dismiss alerts that match the metadata. You can choose to dismiss alerts indefinitely, or until a patch is available. - * Select **Open a pull request to resolve this alert** if you want {% data variables.product.prodname_dependabot %} to suggest changes to resolve alerts that match the metadata. Note that this option is unavailable if you have selected the option to dismiss the alerts indefinitely. -{% data reusables.dependabot.dependabot-alert-rules-click-create-rule %} - -{% endif %} + You can add {% data variables.dependabot.custom_rules %} for all eligible repositories in your organization. For more information, see [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization/configuring-global-security-settings-for-your-organization#creating-and-managing-dependabot-auto-triage-rules). ## Editing or deleting {% data variables.dependabot.custom_rules %} for your repository @@ -117,16 +94,5 @@ For more information about enabling or disabling {% data variables.product.prodn ## Editing or deleting {% data variables.dependabot.custom_rules %} for your organization -{% ifversion security-configurations %} You can edit or delete {% data variables.dependabot.custom_rules %} for all eligible repositories in your organization. For more information, see [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization/configuring-global-security-settings-for-your-organization#creating-and-managing-dependabot-auto-triage-rules). - -{% else %} + You can edit or delete {% data variables.dependabot.custom_rules %} for all eligible repositories in your organization. For more information, see [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization/configuring-global-security-settings-for-your-organization#creating-and-managing-dependabot-auto-triage-rules). -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.security-and-analysis %} -{% data reusables.dependabot.navigate-to-org-level-dependabot-alert-rules %} -1. Under "Organization rules", to the right of the rule that you want to edit or delete, click {% octicon "pencil" aria-label="Edit custom rule" %}. -{% data reusables.dependabot.custom-alert-rules-edit-rule %} -{% data reusables.dependabot.custom-alert-rules-delete-rule %} - -{% endif %} diff --git a/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-alerts.md b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-alerts.md index be5365ce3d08..40985bc60d5e 100644 --- a/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-alerts.md +++ b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-alerts.md @@ -73,26 +73,7 @@ An enterprise owner must first set up {% data variables.product.prodname_dependa ## Managing {% data variables.product.prodname_dependabot_alerts %} for your organization -{% ifversion security-configurations %} You can enable {% data variables.product.prodname_dependabot_alerts %} for all eligible repositories in your organization. For more information, see [AUTOTITLE](/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale). - -{% else %} - -You can enable or disable {% data variables.product.prodname_dependabot_alerts %} for some or all repositories owned by your organization. {% data reusables.security.note-securing-your-org %} - -### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for all existing repositories - -You can use security overview to find a set of repositories and enable or disable {% data variables.product.prodname_dependabot_alerts %} for them all at the same time. For more information, see [AUTOTITLE](/code-security/security-overview/enabling-security-features-for-multiple-repositories). - -You can also use the organization settings page for "{% data variables.product.UI_advanced_security %}" to enable or disable {% data variables.product.prodname_dependabot_alerts %} for all existing repositories in an organization. - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.security-and-analysis %} -1. Under "{% data variables.product.UI_advanced_security %}", to the right of {% data variables.product.prodname_dependabot_alerts %}, click **Disable all** or **Enable all**. -1. Optionally, to enable {% data variables.product.prodname_dependabot_alerts %} by default for new repositories in your organization, in the dialog box, select "Enable by default for new repositories". -1. Click **Disable {% data variables.product.prodname_dependabot_alerts %}** or **Enable {% data variables.product.prodname_dependabot_alerts %}** to disable or enable {% data variables.product.prodname_dependabot_alerts %} for all the repositories in your organization. - -{% endif %} +You can enable {% data variables.product.prodname_dependabot_alerts %} for all eligible repositories in your organization. For more information, see [AUTOTITLE](/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale). {% ifversion ghec or ghes %} diff --git a/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-security-updates.md b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-security-updates.md index 9fc5524db573..a3347d487f5a 100644 --- a/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-security-updates.md +++ b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-security-updates.md @@ -60,17 +60,7 @@ In order to use grouped security updates, you must first enable the following fe ### Enabling or disabling grouped {% data variables.product.prodname_dependabot_security_updates %} for an organization -{% ifversion security-configurations %} You can enable grouped {% data variables.product.prodname_dependabot_security_updates %} into a single pull request. For more information, see [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization/configuring-global-security-settings-for-your-organization#grouping-dependabot-security-updates). - -{% else %} - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.security-and-analysis %} -1. Under "{% data variables.product.UI_advanced_security %}," to the right of "Grouped security updates," click **Disable all** or **Enable all**. -1. Optionally, to enable grouped {% data variables.product.prodname_dependabot_security_updates %} for new repositories in your organization, select **Automatically enable for new repositories**. - -{% endif %} +You can enable grouped {% data variables.product.prodname_dependabot_security_updates %} into a single pull request. For more information, see [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization/configuring-global-security-settings-for-your-organization#grouping-dependabot-security-updates). ## Overriding the default behavior with a configuration file diff --git a/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/enabling-the-dependency-graph.md b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/enabling-the-dependency-graph.md index 9d212ebe3fae..6f7388574c1e 100644 --- a/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/enabling-the-dependency-graph.md +++ b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/enabling-the-dependency-graph.md @@ -38,7 +38,7 @@ Enabling the dependency graph gives {% data variables.product.github %} read-onl You can enable or disable the dependency graph for all repositories owned by your user account, regardless of their visibility. See [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-security-and-analysis-settings-for-your-personal-account). -You can also enable the dependency graph for multiple repositories in an organization at the same time. For more information, see {% ifversion security-configurations %}[AUTOTITLE](/code-security/securing-your-organization).{% else %}[AUTOTITLE](/code-security/getting-started/quickstart-for-securing-your-organization).{% endif %} +You can also enable the dependency graph for multiple repositories in an organization at the same time. For more information, see [AUTOTITLE](/code-security/securing-your-organization). {% endif %} diff --git a/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/assessing-adoption-code-security.md b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/assessing-adoption-code-security.md index e3e725972c8e..5d0b65f12f6d 100644 --- a/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/assessing-adoption-code-security.md +++ b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/assessing-adoption-code-security.md @@ -12,6 +12,7 @@ versions: ghec: '*' redirect_from: - /code-security/security-overview/assessing-adoption-code-security + - /code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/enabling-security-features-for-multiple-repositories category: - Secure at scale --- @@ -29,14 +30,6 @@ You can view data to assess the enablement of features for secure coding across 1. To display the "Security coverage" view, in the sidebar, click **{% octicon "meter" aria-hidden="true" aria-label="meter" %} Coverage**. {% data reusables.code-scanning.using-security-overview-coverage %} -{% ifversion pre-security-configurations %} -1. Optionally, click **{% octicon "gear" aria-hidden="true" aria-label="gear" %} Security settings** to enable security features for a repository and click **Save security settings** to confirm the changes. If a feature is not shown, it has more complex configuration requirements and you need to use the repository settings dialog. For more information, see [AUTOTITLE](/code-security/getting-started/securing-your-repository). -1. Optionally, select some or all of the repositories that match your current search and click **Security settings** in the table header to display a side panel where you can enable security features for the selected repositories. When you've finished, click **Apply changes** to confirm the changes. For more information, see [AUTOTITLE](/code-security/security-overview/enabling-security-features-for-multiple-repositories). - -{% data reusables.security-overview.settings-limitations %} - -{% endif %} - {% ifversion dependabot-updates-paused-enterprise-orgs %} In the list of repositories, a "Paused" label under "{% data variables.product.prodname_dependabot %}" indicates repositories for which {% data variables.product.prodname_dependabot_updates %} are paused. For information about inactivity criteria, see [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates#about-automatic-deactivation-of-dependabot-updates) and [AUTOTITLE](/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates#about-automatic-deactivation-of-dependabot-updates), for security and version updates, respectively.{% endif %} @@ -45,10 +38,6 @@ In the list of repositories, a "Paused" label under "{% data variables.product.p You can view data to assess the enablement of security features across organizations in an enterprise. -{% ifversion pre-security-configurations %} -In the enterprise-level view, you can view data about the enablement of features, but you cannot enable or disable features. -{% endif %} - {% ifversion ghes %}{% data reusables.enterprise-accounts.access-enterprise-ghes %}{% else %}{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}{% endif %} {% data reusables.code-scanning.click-code-security-enterprise %} 1. To display the "Security coverage" view, in the sidebar, click **Coverage**. @@ -58,12 +47,6 @@ In the enterprise-level view, you can view data about the enablement of features ## Viewing enablement trends for an organization -{% ifversion ghes < 3.15 %} - -> [!NOTE] The "Enablement trends" view is currently in {% data variables.release-phases.public_preview %} and is subject to change. - -{% endif %} - You can view data to assess the enablement status and enablement status trends of security features for an organization. {% data reusables.organizations.navigate-to-org %} @@ -78,12 +61,6 @@ You can view data to assess the enablement status and enablement status trends o ## Viewing enablement trends for an enterprise -{% ifversion ghes < 3.15 %} - -> [!NOTE] The "Enablement trends" view is currently in {% data variables.release-phases.public_preview %} and is subject to change. - -{% endif %} - You can view data to assess the enablement status and enablement status trends of security features across organizations in an enterprise. {% ifversion ghes %}{% data reusables.enterprise-accounts.access-enterprise-ghes %}{% else %}{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}{% endif %} @@ -101,7 +78,7 @@ You can view data to assess the enablement status and enablement status trends o After you have reviewed enablement coverage, consider the following actions. 1. Check if your enterprise has configured overly restrictive policies that limit the use of security features. See [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise). -1. Enable features that should be enabled on all repositories. For information on enabling features for a whole organization, see {% ifversion security-configurations %}[AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization){% else %}[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization){% endif %}. +1. Enable features that should be enabled on all repositories. For information on enabling features for a whole organization, see [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization). For example, {% data variables.secret-scanning.alerts %} and push protection reduce the risk of a security leak no matter what information is stored in the repository. If you see repositories that don't already use these features, you should either enable them or discuss an enablement plan with the team who owns the repository. diff --git a/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/find-insecure-repositories.md b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/find-insecure-repositories.md index 5b029da259ca..e483e377c4e2 100644 --- a/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/find-insecure-repositories.md +++ b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/find-insecure-repositories.md @@ -4,7 +4,9 @@ shortTitle: Find insecure repositories intro: Monitor and prioritize security alerts with security overview. permissions: '{% data reusables.permissions.security-org-enable %}' versions: - feature: security-configurations + fpt: '*' + ghec: '*' + ghes: '*' contentType: how-tos redirect_from: - /code-security/securing-your-organization/managing-the-security-of-your-organization/interpreting-security-findings-on-a-repository diff --git a/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-metrics-for-pull-request-alerts.md b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-metrics-for-pull-request-alerts.md index 65fb04ffb9e8..8b9629621735 100644 --- a/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-metrics-for-pull-request-alerts.md +++ b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-metrics-for-pull-request-alerts.md @@ -7,7 +7,9 @@ permissions: '{% data reusables.permissions.security-overview %}' product: '{% data reusables.gated-features.security-overview-fpt-cs-only %}' contentType: how-tos versions: - feature: security-overview-org-codeql-pr-alerts + fpt: '*' + ghec: '*' + ghes: '*' redirect_from: - /code-security/security-overview/viewing-metrics-for-pull-request-alerts category: diff --git a/content/code-security/reference/code-scanning/codeql/codeql-build-options-and-steps-for-compiled-languages.md b/content/code-security/reference/code-scanning/codeql/codeql-build-options-and-steps-for-compiled-languages.md index ecba2cbe1156..a312cd4326d8 100644 --- a/content/code-security/reference/code-scanning/codeql/codeql-build-options-and-steps-for-compiled-languages.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-build-options-and-steps-for-compiled-languages.md @@ -83,9 +83,7 @@ Windows runners require `powershell.exe` to be on the `PATH`. ## Building C# -{% data variables.product.prodname_codeql %} supports build modes {% ifversion codeql-no-build-csharp %}`none`, {% endif %}`autobuild` or `manual` for C# code. - -{% ifversion codeql-no-build-csharp %} +{% data variables.product.prodname_codeql %} supports build modes `none`, `autobuild` or `manual` for C# code. When you enable default setup for a repository that contains C# code, the build mode is set to `none` automatically. @@ -113,7 +111,7 @@ You can ensure a more accurate analysis by taking the following steps: * Check whether multiple versions of .NET are referenced, for example, `net48`, `net5.0`, and `netstandard1.6`. {% data variables.product.prodname_codeql %} can use only one version and this may affect accuracy. * Avoid colliding class names, otherwise this may cause missing method call targets, which has an impact on dataflow analysis. -### Autobuild summary for C#{% endif %} +### Autobuild summary for C# | Supported system type | System name | |----|----| @@ -137,12 +135,8 @@ For .NET Framework application development, you will need Microsoft Build Tools Windows runners require `powershell.exe` to be on the `PATH`. -{% ifversion codeql-no-build-csharp %} - If you plan to create {% data variables.product.prodname_codeql %} databases using `build-mode: none`, you also need to provide access to the public internet, or you must ensure that access to a private NuGet feed is available. -{% endif %} - #### Linux and macOS autodetection 1. Invoke `dotnet build` on the solution (`.sln`) or project (`.csproj`) file closest to the root. @@ -156,12 +150,8 @@ For .NET Core application development on self-hosted runners, the .NET SDK is re For .NET Framework application development, you will require Mono Runtime (to run `mono`, `msbuild`, or `nuget`). -{% ifversion codeql-no-build-csharp %} - If you plan to create {% data variables.product.prodname_codeql %} databases using `build-mode: none`, you also need to provide access to the public internet, or you must ensure that access to a private NuGet feed is available. -{% endif %} - ### C# compiler flags injected by {% data variables.product.prodname_codeql %} for manual builds The {% data variables.product.prodname_codeql %} tracer enables the extraction of all compiled languages by intercepting build processes and forwarding information to the relevant {% data variables.product.prodname_codeql %} language extractors. The tracer injects certain flags into the C# compiler invocation to ensure every component is built and included in the {% data variables.product.prodname_codeql %} database, which may cause your C# code to build in a different way to what you expect during {% data variables.product.prodname_codeql %} analysis. diff --git a/content/code-security/reference/permissions/security-overview-permissions.md b/content/code-security/reference/permissions/security-overview-permissions.md index fb0beff5cccf..5cdd5153984c 100644 --- a/content/code-security/reference/permissions/security-overview-permissions.md +++ b/content/code-security/reference/permissions/security-overview-permissions.md @@ -29,7 +29,7 @@ If you are an **organization or team member**, you can view security overview fo | Organization or team member with | Overview dashboard view | Risk and alerts views | Coverage view | |--------------------|-------------|---------------------|---------| -| `admin` access for one or more repositories | View data for those repositories | View data for those repositories | View data for those repositories{% ifversion pre-security-configurations %}, and enable and disable security features{% endif %} | +| `admin` access for one or more repositories | View data for those repositories | View data for those repositories | View data for those repositories | | `write` access for one or more repositories | View {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_dependabot %} data for those repositories | View {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_dependabot %} data for those repositories | No access | | `read` or `triage` access for one or more repositories | No access | No access | No access | | Security alert access for one or more repositories | View all security alert data for those repositories | View all security alert data for those repositories | No access | diff --git a/content/code-security/reference/secret-security/secret-scanning-pattern-configuration-data.md b/content/code-security/reference/secret-security/secret-scanning-pattern-configuration-data.md index 9b35ee9aac3c..7a558df0ef3c 100644 --- a/content/code-security/reference/secret-security/secret-scanning-pattern-configuration-data.md +++ b/content/code-security/reference/secret-security/secret-scanning-pattern-configuration-data.md @@ -4,9 +4,10 @@ shortTitle: Secret pattern data intro: Understand the data displayed in the {% data variables.product.prodname_secret_scanning %} pattern configuration page to make informed decisions about push protection settings. permissions: '{% data reusables.permissions.secret-risk-assessment-report-generation %}' versions: - feature: security-configurations + fpt: '*' + ghec: '*' + ghes: '*' contentType: reference - category: - Protect your secrets --- @@ -14,4 +15,4 @@ category: When configuring push protection, you can view performance data for each secret pattern to make informed enablement decisions. Use metrics like alert volume and false positive rates to balance security with developer experience. See [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/configuring-global-security-settings-for-your-organization#specifying-patterns-to-include-in-push-protection){% ifversion security-configuration-enterprise-level %} or [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/configuring-additional-secret-scanning-settings-for-your-enterprise#specifying-patterns-to-include-in-push-protection-for-your-enterprise){% endif %}. {% data reusables.secret-scanning.pattern-enablement-org-enterprise-chart %} - \ No newline at end of file + diff --git a/content/code-security/reference/security-at-scale/security-configuration-enforcement.md b/content/code-security/reference/security-at-scale/security-configuration-enforcement.md index a0b21fbc4b8c..84eb02ec729a 100644 --- a/content/code-security/reference/security-at-scale/security-configuration-enforcement.md +++ b/content/code-security/reference/security-at-scale/security-configuration-enforcement.md @@ -2,7 +2,9 @@ title: Security configuration enforcement intro: Understand the complexities of enforcing {% data variables.product.prodname_security_configurations %}. versions: - feature: security-configurations + fpt: '*' + ghec: '*' + ghes: '*' contentType: reference category: - Secure at scale diff --git a/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/a-repository-is-using-advanced-setup-for-code-scanning.md b/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/a-repository-is-using-advanced-setup-for-code-scanning.md index ea8f946b4c63..27d13fce320a 100644 --- a/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/a-repository-is-using-advanced-setup-for-code-scanning.md +++ b/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/a-repository-is-using-advanced-setup-for-code-scanning.md @@ -4,7 +4,9 @@ shortTitle: Active advanced setup intro: You see an error when you try to attach a {% data variables.product.prodname_security_configuration %} with default code scanning enabled to repositories that use advanced setup for code scanning. permissions: '{% data reusables.permissions.security-org-enable %}' versions: - feature: security-configurations + fpt: '*' + ghec: '*' + ghes: '*' redirect_from: - /code-security/securing-your-organization/troubleshooting-security-configurations/a-repository-has-an-existing-advanced-setup-for-code-scanning - /code-security/securing-your-organization/troubleshooting-security-configurations/a-repository-is-using-advanced-setup-for-code-scanning diff --git a/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/finding-repositories-with-attachment-failures.md b/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/finding-repositories-with-attachment-failures.md index 1fd1762a347d..0b6a7435ec26 100644 --- a/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/finding-repositories-with-attachment-failures.md +++ b/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/finding-repositories-with-attachment-failures.md @@ -5,7 +5,9 @@ allowTitleToDifferFromFilename: true intro: You can identify any repositories where the security configuration could not be attached, and follow guidance to remediate the problem. permissions: '{% data reusables.permissions.security-org-enable %}' versions: - feature: security-configurations + fpt: '*' + ghec: '*' + ghes: '*' redirect_from: - /code-security/securing-your-organization/managing-the-security-of-your-organization/finding-repositories-with-attachment-failures - /code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/finding-repositories-with-attachment-failures diff --git a/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/not-enough-github-advanced-security-licenses.md b/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/not-enough-github-advanced-security-licenses.md index b0f6d63fc433..c14a5cebbbf5 100644 --- a/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/not-enough-github-advanced-security-licenses.md +++ b/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/not-enough-github-advanced-security-licenses.md @@ -4,7 +4,9 @@ shortTitle: Not enough GHAS licenses intro: If you are on a subscription-based billing model for GHAS, you need available GHAS licenses to enable GHAS features on a private{% ifversion ghec or ghes %} or internal{% endif %} repository. permissions: '{% data reusables.permissions.security-org-enable %}' versions: - feature: security-configurations + fpt: '*' + ghec: '*' + ghes: '*' redirect_from: - /code-security/securing-your-organization/troubleshooting-security-configurations/not-enough-github-advanced-security-licenses - /code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/not-enough-github-advanced-security-licenses diff --git a/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/unexpected-default-setup.md b/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/unexpected-default-setup.md index 370ab3df79fd..92127c9ce795 100644 --- a/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/unexpected-default-setup.md +++ b/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/unexpected-default-setup.md @@ -4,7 +4,9 @@ shortTitle: Unexpected default setup intro: You apply a {% data variables.product.prodname_security_configuration %} with "Enabled with advanced setup allowed" and the existing advanced setup for {% data variables.product.prodname_code_scanning %} is ignored in some repositories. permissions: '{% data reusables.permissions.security-org-enable %}' versions: - feature: security-configurations + fpt: '*' + ghec: '*' + ghes: '*' redirect_from: - /code-security/securing-your-organization/troubleshooting-security-configurations/unexpected-default-setup - /code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/unexpected-default-setup diff --git a/content/code-security/reference/supply-chain-security/dependabot-options-reference.md b/content/code-security/reference/supply-chain-security/dependabot-options-reference.md index aea6d55c4831..ed26c6e664ac 100644 --- a/content/code-security/reference/supply-chain-security/dependabot-options-reference.md +++ b/content/code-security/reference/supply-chain-security/dependabot-options-reference.md @@ -534,7 +534,7 @@ Package manager | YAML value | Supported versions | | {% ifversion dependabot-bun-support %} | | Bun | `bun` | >=v1.2.5 | | {% endif %} | -| Bundler | `bundler` | {% ifversion ghes < 3.15 %}v1, {% endif %}v2 | +| Bundler | `bundler` | v2 | | Cargo | `cargo` | v1 | | Composer | `composer` | v2 | | {% ifversion dependabot-conda-support %} | @@ -565,7 +565,7 @@ Package manager | YAML value | Supported versions | | Nix flakes | `nix` | Not applicable | | {% endif %} | | npm | `npm` | v7, v8, v9, v10 | -| NuGet | `nuget` | {% ifversion fpt or ghec or ghes > 3.14 %}<=6.12.0{% endif %} | +| NuGet | `nuget` | <=6.12.0 | | {% ifversion dependabot-opentofu-support %} | | OpenTofu | `opentofu` | Not applicable | | {% endif %} | @@ -701,8 +701,6 @@ Each package manager **must** define a schedule interval. By default, {% data variables.product.prodname_dependabot %} randomly assigns a time to apply all the updates in the configuration file. You can use the `time` and `timezone` parameters to set a specific runtime for all intervals. {% ifversion dependabot-schedule-updates %}If you use a `cron` interval, you can define the update time with a `cronjob` expression.{% endif %} - - ### `day` Supported values: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, or `sunday` @@ -894,8 +892,6 @@ New version `2.0.0` > [!NOTE] > If the package manager you use does not yet support configuring the `versioning-strategy` parameter, or does not support a value you need, the strategy code is open source, so if you'd like a particular ecosystem to support a new strategy, you are always welcome to submit a pull request in . -{% ifversion dependabot-updates-supported-versioning-tags %} - ### Versioning tags @@ -923,8 +919,6 @@ New version `2.0.0` -{% endif %} - ## Top-level `registries` key Specify authentication details that {% data variables.product.prodname_dependabot %} can use to access private package registries, including registries hosted by GitLab or Bitbucket. diff --git a/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-3-pilot-programs.md b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-3-pilot-programs.md index 1af29ea0cca2..6a8d1cfda2e8 100644 --- a/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-3-pilot-programs.md +++ b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-3-pilot-programs.md @@ -29,14 +29,10 @@ If you haven't already enabled GHAS for your {% data variables.product.prodname_ {% endif %} -{% ifversion security-configurations %} - ## Piloting all {% data variables.product.prodname_GHAS %} features {% data reusables.security-configurations.enable-security-features-with-gh-config %} -{% endif %} - ## Piloting {% data variables.product.prodname_code_scanning %} {% ifversion ghes %} @@ -63,18 +59,8 @@ To enable secret scanning for your {% data variables.product.prodname_ghe_server {% endif %} -{% ifversion security-configurations %} - You need to enable {% data variables.product.prodname_secret_scanning %} and push protection for each pilot project. You can do this with a {% data variables.product.prodname_security_configuration %}. For more information, see [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization/creating-a-custom-security-configuration). -{% else %} - -You need to enable {% data variables.product.prodname_secret_scanning %} for each pilot project, either by enabling the feature for each repository or for all repositories in any organizations taking part in the project. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository) or [AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization). - -Next, enable push protection for each pilot project. - -{% endif %} - If you plan to configure a link to a resource in the message that's displayed when a developer attempts to push a blocked secret, now would be a good time to test and start to refine the guidance that you plan to make available. Start to review activity using the push protection metrics page in security overview. For more information, see [AUTOTITLE](/code-security/concepts/secret-security/push-protection-metrics). diff --git a/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md index 40fe9f05380c..c4fed8b654fa 100644 --- a/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md +++ b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md @@ -1,6 +1,6 @@ --- title: 'Phase 5: Rollout and scale code scanning' -intro: You can {% ifversion security-configuration-enterprise-level %}use security configurations{% else %}leverage the available APIs{% endif %} to rollout {% data variables.product.prodname_code_scanning %} across your enterprise{% ifversion security-configurations %}{% else %} using the repository data you collected earlier{% endif %}. +intro: You can {% ifversion security-configuration-enterprise-level %}use security configurations{% else %}leverage the available APIs{% endif %} to rollout {% data variables.product.prodname_code_scanning %} across your enterprise. versions: ghes: '*' ghec: '*' @@ -15,12 +15,8 @@ category: >[!TIP] > This article is part of a series on adopting {% data variables.product.prodname_GHAS %} at scale. For the previous article in this series, see [AUTOTITLE](/code-security/adopting-github-advanced-security-at-scale/phase-4-create-internal-documentation). -{% ifversion security-configurations %} - {% data reusables.security-configurations.enable-security-features-with-gh-config %} -{% endif %} - ## Enabling code scanning After piloting {% data variables.product.prodname_code_scanning %} and creating internal documentation for best practices, you can enable {% data variables.product.prodname_code_scanning %} across your company. You can configure {% data variables.product.prodname_code_scanning %} default setup for all repositories in an organization from security overview. For more information, see [AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale#configuring-default-setup-for-all-eligible-repositories-in-an-organization). @@ -37,12 +33,8 @@ To successfully manage and use {% data variables.product.prodname_code_scanning You'll also need SMEs if you need to use advanced setup for {% data variables.product.prodname_code_scanning %}. These SMEs will need knowledge of {% data variables.product.prodname_code_scanning %} alerts, as well as topics like {% data variables.product.prodname_actions %} and customizing {% data variables.product.prodname_code_scanning %} workflows for particular frameworks. For custom configurations of advanced setup, consider running meetings on complicated topics to scale the knowledge of several SMEs at once. -{% ifversion security-overview-org-codeql-pr-alerts %} - For {% data variables.product.prodname_code_scanning %} alerts from {% data variables.product.prodname_codeql %} analysis, you can use security overview to see how {% data variables.product.prodname_codeql %} is performing in pull requests in repositories across your organization, and to identify repositories where you may need to take action. For more information, see [AUTOTITLE](/code-security/concepts/code-scanning/pull-request-alert-metrics). -{% endif %} - {% ifversion copilot-chat-ghas-alerts %} With a {% data variables.copilot.copilot_enterprise %} license, you can also ask {% data variables.copilot.copilot_chat %} for help to better understand {% data variables.product.prodname_code_scanning %} alerts in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features). diff --git a/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md index fbd45ce7c24e..6bc0c5723df5 100644 --- a/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md +++ b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md @@ -15,16 +15,8 @@ category: >[!TIP] > This article is part of a series on adopting {% data variables.product.prodname_GHAS %} at scale. For the previous article in this series, see [AUTOTITLE](/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning). -{% ifversion security-configurations %} - {% data reusables.security-configurations.enable-security-features-with-gh-config %} -{% else %} - -You can enable secret scanning for individual repositories or for all repositories in an organization or enterprise. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository), [AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization), or [AUTOTITLE](/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise). - -{% endif %} - This article explains a high-level process focusing on enabling {% data variables.product.prodname_secret_scanning %} for all repositories in an organization. The principles described in this article can still be applied even if you take a more staggered approach of enabling {% data variables.product.prodname_secret_scanning %} for individual repositories. {% ifversion copilot-chat-ghas-alerts %} diff --git a/content/code-security/tutorials/secure-your-organization/index.md b/content/code-security/tutorials/secure-your-organization/index.md index cb0c0cf21a3b..6d15e6fe39f1 100644 --- a/content/code-security/tutorials/secure-your-organization/index.md +++ b/content/code-security/tutorials/secure-your-organization/index.md @@ -7,6 +7,8 @@ versions: ghes: '*' ghec: '*' contentType: tutorials +redirect_from: + - /code-security/getting-started/quickstart-for-securing-your-organization children: - /best-practices-for-preventing-data-leaks-in-your-organization - /best-practice-fix-alerts-at-scale diff --git a/content/get-started/learning-about-github/about-github-advanced-security.md b/content/get-started/learning-about-github/about-github-advanced-security.md index 043ea6a458d9..b3810a3cbb1c 100644 --- a/content/get-started/learning-about-github/about-github-advanced-security.md +++ b/content/get-started/learning-about-github/about-github-advanced-security.md @@ -152,15 +152,7 @@ To learn about what you need to know to plan your deployment of {% ifversion gha ## Enabling features -{% ifversion ghes < 3.15 %} -A site administrator must enable {% data variables.product.prodname_AS %} for {% data variables.location.product_location %} before you can use these features. See [AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise). -{% endif %} - -{% ifversion security-configurations %} {% data reusables.security-configurations.enable-security-features-with-gh-config %} -{% endif %} - -{% ifversion security-configurations %}{% else %}Once your system is set up, you can enable and disable these features at the organization or repository level. See [AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization) and [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository).{% endif %} If you are on a {% data variables.product.prodname_team %} or {% data variables.product.prodname_enterprise %} plan, license use for the entire team or enterprise is shown on your license page. {% ifversion fpt or ghec %}See [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage).{% endif %} diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md index aeaaff179cae..eb917e25d448 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md @@ -20,67 +20,10 @@ category: {% data variables.product.prodname_dotcom %} can help you to secure the repositories in your organization. You can manage the security and analysis features for all existing or new repositories that members create in your organization. If you have a license for {% data variables.product.prodname_GH_cs_or_sp %} then you can also manage access to these features. {% data reusables.advanced-security.more-info-ghas %} {% data reusables.security.some-security-and-analysis-features-are-enabled-by-default %} -{% ifversion security-configurations %} {% data reusables.security-configurations.enable-security-features-with-gh-config %} -{% endif %} {% data reusables.security.security-and-analysis-features-enable-read-only %} -{% ifversion pre-security-configurations %} - -## Displaying the security and analysis settings - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.security-and-analysis %} - -The page that's displayed allows you to enable or disable all security and analysis features for the repositories in your organization. - -If you have a license for {% data variables.product.prodname_GHAS %}, the page will also contain options to enable and disable {% data variables.product.prodname_GHAS %} features. Any repositories that use {% data variables.product.prodname_GHAS %} are listed at the bottom of the page. - -## Enabling or disabling a feature for all existing repositories - -You can enable or disable features for all repositories. - -You can use security overview to find a set of repositories and enable or disable security features for them all at the same time. For more information, see [AUTOTITLE](/code-security/security-overview/enabling-security-features-for-multiple-repositories). - -{% data reusables.advanced-security.note-org-enable-uses-seats %} - -> [!NOTE] -> If you encounter an error that reads "{% data variables.product.prodname_GHAS %} cannot be enabled because of a policy setting for the organization," contact your enterprise admin and ask them to change the {% data variables.product.prodname_GHAS %} policy for your enterprise. For more information, see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise). - -{% ifversion dependabot-alerts-enterprise-enablement %} - -> [!NOTE] -> When {% data variables.product.prodname_dependabot_alerts %} are enabled or disabled at the enterprise level, it overrides the organization level settings for {% data variables.product.prodname_dependabot_alerts %}. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts#managing-dependabot-alerts-for-your-enterprise). - -{% endif %} - -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 "{% data variables.product.UI_advanced_security %}", to the right of the feature, click **Disable all** or **Enable all** to display a confirmation dialog box. The control for "{% data variables.product.prodname_GHAS %}" is disabled if you have no available licenses for {% data variables.product.prodname_GHAS %}. -1. Review the information in the dialog box. -1. Optionally, if you are enabling private vulnerability reporting, dependency graph, or {% data variables.product.prodname_dependabot %}, select **Enable by default for new repositories**. - - ![Screenshot of the "Enable FEATURE" modal dialog, with the "Enable by default for new private repositories" option outlined in orange.](/assets/images/help/organizations/security-and-analysis-enable-by-default-in-modal.png) - -1. When you are ready to make the changes, click **Disable FEATURE** or **Enable FEATURE** to disable or enable the feature for all the repositories in your organization. -1. Optionally, in your feature's section of the security and analysis settings, select additional enablement settings. Additional enablement settings may include: - * Automatic enablement for a specific type of repository - * Feature-specific settings, such as recommending the extended query suite for {% data variables.product.prodname_code_scanning %} default setup throughout your organization, or automatic secret validation for {% data variables.product.prodname_secret_scanning %} - - > [!NOTE] - > * {% data reusables.code-scanning.limitation-org-enable-all %} - > * Enabling {% data variables.product.prodname_code_scanning %} for all eligible repositories in an organization will not override existing {% data variables.product.prodname_code_scanning %} configurations. For information on configuring default setup with different settings for specific repositories, see [AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning) and [AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale#configuring-default-setup-for-a-subset-of-repositories-in-an-organization). - -{% data reusables.security.displayed-information %} - -## 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 "{% data variables.product.UI_advanced_security %}", locate the feature, enable or disable the feature by default for new repositories in your organization. - -{% endif %} - ## Allowing {% data variables.product.prodname_dependabot %} to access private{% ifversion ghec or ghes %} or internal{% endif %} dependencies {% data variables.product.prodname_dependabot %} can check for outdated dependency references in a project and automatically generate a pull request to update them. To do this, {% data variables.product.prodname_dependabot %} must have access to all of the targeted dependency files. Typically, version updates will fail if one or more dependencies are inaccessible. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates). @@ -96,47 +39,12 @@ If your code depends on packages in a private{% ifversion ghec or ghes %} or int {% endif %} -{% ifversion security-configurations %} - For more information on how to grant {% data variables.product.prodname_dependabot %} access to private{% ifversion ghec or ghes %} or internal{% endif %} dependencies, see [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization/configuring-global-security-settings-for-your-organization#granting-dependabot-access-to-private-and-internal-repositories). -{% else %} - -To allow {% data variables.product.prodname_dependabot %} to access a private or internal {% data variables.product.prodname_dotcom %} repository: - -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 "Grant {% data variables.product.prodname_dependabot %} private repository access", click **Add internal and private repositories** to display a repository search field. - - ![Screenshot of the search dropdown. As you type, repository names that match your search are shown. The search text field is outlined in orange.](/assets/images/help/organizations/dependabot-private-repo-choose.png) - -1. Start typing the name of the repository you want to grant {% data variables.product.prodname_dependabot %} access to. -1. A list of matching repositories in the organization is displayed, click the repository you want to allow access to and this adds the repository to the allowed list. -1. Optionally, to remove a repository from the list, to the right of the repository, click {% octicon "x" aria-label="The X icon" %}. - -{% endif %} - ## Removing access to {% data variables.product.prodname_GHAS %} features from individual repositories in an organization -{% ifversion security-configurations %} - You can use {% data variables.product.prodname_security_configurations %} to remove access to {% data variables.product.prodname_GHAS %} features from individual repositories in an organization. For more information, see [AUTOTITLE](/code-security/securing-your-organization/managing-the-security-of-your-organization/managing-your-github-advanced-security-license-usage#turning-off-github-advanced-security-features-on-select-repositories-in-your-organization). -{% else %} - -You can manage access to {% data variables.product.prodname_GHAS %} features for a repository from its "Settings" tab. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository). However, you can also disable {% data variables.product.prodname_GHAS %} features for a repository from the "Settings" tab for the organization. - -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. To see a list of all the repositories in your organization with {% data variables.product.prodname_GHAS %} enabled, scroll to the "{% data variables.product.prodname_GHAS %} repositories" section. - - The table lists the number of unique committers for each repository. This is the number of licenses you could free up by removing access to {% data variables.product.prodname_GHAS %}. For more information, see [AUTOTITLE](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security). -1. To remove access to {% data variables.product.prodname_GHAS %} from a repository and free up licenses used by any active committers that are unique to the repository, click the adjacent {% octicon "x" aria-label="X symbol" %}. -1. In the confirmation dialog, click **Remove repository** to remove access to the features of {% data variables.product.prodname_GHAS %}. - -> [!NOTE] -> If you remove access to {% data variables.product.prodname_GHAS %} for a repository, you should communicate with the affected development team so that they know that the change was intended. This ensures that they don't waste time debugging failed runs of code scanning. - -{% endif %} - ## Further reading * [AUTOTITLE](/code-security/getting-started/securing-your-repository) diff --git a/content/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization.md b/content/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization.md index 32f899de62d1..ddac521d474d 100644 --- a/content/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization.md +++ b/content/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization.md @@ -35,7 +35,7 @@ You can add custom properties to your organization and set values for those prop 1. To add a new custom property, click **New property** in the upper right corner. 1. In the "Name" field, type the name you'd like to use for your custom property. The name can't contain spaces, and cannot exceed 75 characters in length. 1. Optionally, in the "Description" field, fill in a description of your custom property. -1. Under "Type", select the type of property you'd like to add. This can either be a text string{% ifversion ghes < 3.15 %} or a single select field{% else %}, a single select field, a multi select field, {% ifversion ghes > 3.20 %}a URL, {% endif %}or a true/false boolean{% endif %}. +1. Under "Type", select the type of property you'd like to add. This can either be a text string, a single select field, a multi select field, {% ifversion ghes > 3.20 %}a URL, {% endif %}or a true/false boolean. 1. Optionally, you can select **Allow repository actors to set this property**. When enabled, repository users and apps with the repository-level "custom properties" fine-grained permission will be able to set and update the property value for their repository. 1. Optionally, you can select **Require this property for all repositories** and add a default value. This means that you require that all repositories in your organization have a value for this property. Repositories that don’t have an explicit value for this property will inherit the default value. {% data reusables.organizations.custom-properties-required-values %} @@ -66,8 +66,6 @@ People with read permissions to a repository can view the values of custom prope {% data reusables.repositories.sidebar-settings %} 1. In the "Code and automation" section of the sidebar, click **{% octicon "tools" aria-hidden="true" aria-label="tools" %} Custom properties**. -{% ifversion ghec or fpt or ghes > 3.14 %} - ## Searching and filtering repositories by custom properties values You can search for repositories in your organization by custom properties values. @@ -77,4 +75,3 @@ You can search for repositories in your organization by custom properties values 1. Under your organization name, click **{% octicon "repo" aria-hidden="true" aria-label="repo" %} Repositories**. 1. In the search bar, type `prop` to see a list of all custom properties in your organization, and select the property you'd like to search by. -{% endif %} diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-organization-roles.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-organization-roles.md index 3b2d19efb3e7..96bad3c03391 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-organization-roles.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-organization-roles.md @@ -18,7 +18,7 @@ If you are an organization owner or have a custom role with the "View organizati To find the "Custom roles" page, you can follow the first steps in [Creating a custom role](#creating-a-custom-role). The exact steps will vary depending on which other settings page you have access to. -To{% ifversion org-pre-defined-roles %} view organization role permissions and{% endif %} manage organization role assignments, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles). +To view organization role permissions and manage organization role assignments, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles). ## Creating a custom role diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization.md index 912cdbb1f467..e72e5469a967 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization.md @@ -49,22 +49,16 @@ You can assign the security manager role to a maximum of 10 teams in your organi {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -{% ifversion security-configurations %} {% data reusables.security-configurations.display-global-settings %} -{% else %} -{% data reusables.organizations.security-and-analysis %} -{% endif %} + 1. In the "Security managers" section, in the search field, search for and select the team to give the role. Each team you select will appear in a list below the search bar. ## Removing the security manager role from a team in your organization {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -{% ifversion security-configurations %} {% data reusables.security-configurations.display-global-settings %} -{% else %} -{% data reusables.organizations.security-and-analysis %} -{% endif %} + 1. Under **Security managers**, next to the team you want to remove as security managers, click {% octicon "x" aria-label="Remove TEAM" %}. {% endif %} diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-predefined-organization-roles.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-predefined-organization-roles.md index 33b1a62d35cb..faea32074350 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-predefined-organization-roles.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-predefined-organization-roles.md @@ -1,10 +1,12 @@ --- title: Permissions of predefined organization roles -intro: "Learn about the predefined organization roles and the permissions each role grants in your organization." +intro: Learn about the predefined organization roles and the permissions each role grants in your organization. versions: - feature: 'org-pre-defined-roles' + fpt: '*' + ghec: '*' + ghes: '*' shortTitle: Predefined roles permissions -product: 'Organizations on {% data variables.product.prodname_ghe_cloud %}{% ifversion ghes %} and {% data variables.product.prodname_ghe_server %}{% endif %}' +product: Organizations on {% data variables.product.prodname_ghe_cloud %}{% ifversion ghes %} and {% data variables.product.prodname_ghe_server %}{% endif %} category: - Assign roles and permissions --- @@ -207,4 +209,4 @@ The following table summarizes which permissions are included with each predefin ## Next steps -* [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles) \ No newline at end of file +* [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles) diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md index 5e09ab514427..f9de55c44fe0 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md @@ -23,24 +23,18 @@ Repository-level roles give organization members, outside collaborators and team Team-level roles are roles that give permissions to manage a team. You can give any individual member of a team the team maintainer role, which gives the member a number of administrative permissions over a team. For more information, see [AUTOTITLE](/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member). -{% ifversion org-pre-defined-roles %} Organization-level roles are sets of permissions that can be assigned to individuals or teams to manage an organization and the organization's repositories, teams, and settings. For more information about all the roles available at the organization level, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-predefined-organization-roles). -{% endif %} {% ifversion ghec or ghes %} If your organization is owned by an enterprise account, enterprise owners can choose to join your organization with any role. For more information, see [AUTOTITLE](/admin/user-management/managing-organizations-in-your-enterprise/managing-your-role-in-an-organization-owned-by-your-enterprise). {% endif %} -{% ifversion org-pre-defined-roles %} - ## About predefined organization roles Predefined organization roles are roles that are available by default in every organization. You don't need to create them yourself. They can include both organization permissions that let the recipient manage the organization, as well as repository permissions that apply to all of the repositories in the organization. For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-predefined-organization-roles). -{% endif %} - ## About custom organization roles {% data reusables.organizations.custom-org-roles-intro %} @@ -52,7 +46,6 @@ This feature is only available to organizations on {% data variables.product.pro For more information on the permissions available with custom roles, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles). - ## Descriptions of predefined organization roles You can assign people to a variety of organization-level roles to control your members' access to your organization and its resources. diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles.md index 80a7aa619df9..f93843829d36 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles.md @@ -1,6 +1,6 @@ --- title: Using organization roles -intro: 'Learn how to{% ifversion org-pre-defined-roles %} view organization role permissions and{% endif %} manage organization role assignments.' +intro: 'Learn how to view organization role permissions and manage organization role assignments.' versions: fpt: '*' ghec: '*' @@ -22,8 +22,6 @@ In addition to pre-defined roles, you can also create up to 20 custom roles that {% endif %} -{% ifversion org-pre-defined-roles %} - ## Viewing organization role permissions {% data reusables.profile.access_org %} @@ -32,8 +30,6 @@ In addition to pre-defined roles, you can also create up to 20 custom roles that 1. To the right of any role, click **{% octicon "fold" aria-label="Show role permissions" %}**. 1. Optionally, to hide the role permissions again, click **{% octicon "fold" aria-label="Hide role permissions" %}**. -{% endif %} - ## Assigning an organization role {% ifversion ghec or ghes %} diff --git a/content/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization.md b/content/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization.md index f9b8cdb11e1a..bdd5bcea7e74 100644 --- a/content/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization.md +++ b/content/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization.md @@ -22,8 +22,8 @@ Regardless of the chosen policy, {% data variables.product.pat_generic_caps_plur {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -1. In the left sidebar, under **{% octicon "key" aria-hidden="true" aria-label="key" %} {% data variables.product.pat_generic_caps %}s**, click **Settings**. {% ifversion tabbed-pat-settings-ui %} -1. Select either the **Fine-grained tokens** or **Tokens (classic)** tab to enforce this policy based on the token type. {% endif %} +1. In the left sidebar, under **{% octicon "key" aria-hidden="true" aria-label="key" %} {% data variables.product.pat_generic_caps %}s**, click **Settings**. +1. Select either the **Fine-grained tokens** or **Tokens (classic)** tab to enforce this policy based on the token type. 1. Under **{% data variables.product.pat_v2_caps_plural %}** or **Restrict {% data variables.product.pat_v1_plural %} from accessing your organizations**, select your access policy. 1. Click **Save**. @@ -60,7 +60,7 @@ Organization owners can manage approval requirements for each {% data variables. {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -1. In the left sidebar, under **{% octicon "key" aria-hidden="true" aria-label="key" %} {% data variables.product.pat_generic_caps %}s**, click **Settings**. {% ifversion tabbed-pat-settings-ui %} -1. Select the **Fine-grained tokens** tab. {% endif %} +1. In the left sidebar, under **{% octicon "key" aria-hidden="true" aria-label="key" %} {% data variables.product.pat_generic_caps %}s**, click **Settings**. +1. Select the **Fine-grained tokens** tab. 1. Under **Require approval of {% data variables.product.pat_v2_plural %}**, select the option that meets your needs: 1. Click **Save**. diff --git a/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/my-commit-is-blocked-by-push-protection.md b/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/my-commit-is-blocked-by-push-protection.md index a6fcad2fb217..d45b24fa69db 100644 --- a/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/my-commit-is-blocked-by-push-protection.md +++ b/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/my-commit-is-blocked-by-push-protection.md @@ -17,16 +17,16 @@ Leaked secrets can pose serious security risks to your repository and your suppl If the repository you're contributing to on {% data variables.product.github %} is secured by push protection, you'll encounter a push protection block whenever you: * **Push commits** containing recognized secrets **from the command line** to the remote repository. -* **Commit changes** or upload files containing recognized secrets to a repository in the **{% data variables.product.github %} UI**. {% ifversion secret-scanning-push-protection-content-endpoints %} -* **Make certain requests** containing recognized secrets in **the REST API**.{% endif %} +* **Commit changes** or upload files containing recognized secrets to a repository in the **{% data variables.product.github %} UI**. +* **Make certain requests** containing recognized secrets in **the REST API**. ## Resolving a push protection block -In order to resolve the block, you should remove the secret from the commit {% ifversion secret-scanning-push-protection-content-endpoints %}(or request){% endif %}. If you believe the secret is safe to push, you may be able to bypass the block. For more information on how to remove the secret or, if necessary, bypass the block, see: +In order to resolve the block, you should remove the secret from the commit (or request). If you believe the secret is safe to push, you may be able to bypass the block. For more information on how to remove the secret or, if necessary, bypass the block, see: * [AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-command-line) -* [AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-in-the-github-ui){% ifversion secret-scanning-push-protection-content-endpoints %} -* [AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-rest-api){% endif %} +* [AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-in-the-github-ui) +* [AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-rest-api) ## Further reading diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md b/content/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md index 09336ac43c52..c4f99d75152a 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md @@ -47,9 +47,7 @@ The code frequency graph displays the content additions and deletions for each w {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %} 1. In the left sidebar, click **Code frequency**. -{%- ifversion accessible-charts %} {% data reusables.repositories.repositories-insights-graphs-download-steps %} -{% endif %} {% data reusables.repositories.activity-view %} For more information, see [AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/using-the-activity-view-to-see-changes-to-a-repository). diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md index c6ce937a7601..5511e1e9ca75 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md @@ -31,12 +31,8 @@ You can also see a list of people who have contributed to the project's Python d {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %} 1. In the left sidebar, click **Contributors**. -{%- ifversion accessible-charts %} 1. Optionally, to view contributors during a specific time period, to the right of "Contributors," click **Period: All**. Then select a time period. {% data reusables.repositories.repositories-insights-graphs-download-steps %} -{%- else %} -1. Optionally, to view contributors during a specific time period, click, then drag until the time period is selected. The contributors graph sums weekly commit numbers onto each Sunday, so your time period must include a Sunday. -{% endif %} ## Troubleshooting contributors diff --git a/content/rest/enterprise-admin/index.md b/content/rest/enterprise-admin/index.md index 02a194f2870a..6b15711773c8 100644 --- a/content/rest/enterprise-admin/index.md +++ b/content/rest/enterprise-admin/index.md @@ -6,6 +6,7 @@ redirect_from: - /v3/enterprise-admin - /v3/enterprise - /rest/reference/enterprise-admin + - /rest/enterprise-admin/management-console versions: ghes: '*' ghec: '*' @@ -24,7 +25,6 @@ children: - /ldap - /licensing - /manage-ghes - - /management-console - /network-configurations - /org-pre-receive-hooks - /organization-installations @@ -49,7 +49,7 @@ autogenerated: rest ## Endpoint URLs -These endpoints{% ifversion ghes %}, except the Manage GitHub Enterprise Server API {% ifversion ghes < 3.15 %} and Management Console API{% endif %},{% endif %} are prefixed with the following URL: +These endpoints{% ifversion ghes %}, except the Manage GitHub Enterprise Server API,{% endif %} are prefixed with the following URL: ```shell {% data variables.product.rest_url %} @@ -61,7 +61,7 @@ When endpoints include `{enterprise}`, replace `{enterprise}` with the handle fo {% ifversion ghes %} -Endpoints for the Manage GitHub Enterprise Server API{% ifversion ghes < 3.15 %} and Management Console API{% endif %} are only prefixed with a hostname and administration port: +Endpoints for the Manage GitHub Enterprise Server API are only prefixed with a hostname and administration port: ```shell http(s)://HOSTNAME:ADMINISTRATION-PORT/ @@ -76,7 +76,7 @@ Your {% data variables.product.prodname_ghe_server %} installation's API endpoin OAuth tokens must have the `site_admin` [OAuth scope](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes) when used with these endpoints. -These endpoints are only accessible to authenticated {% data variables.product.prodname_ghe_server %} site administrators, except for endpoints of the [AUTOTITLE](/rest/enterprise-admin/manage-ghes) API{% ifversion ghes < 3.15 %} and [AUTOTITLE](/rest/enterprise-admin/management-console) API{% endif %}, which allow authentication as a Management Console user. See [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console). +These endpoints are only accessible to authenticated {% data variables.product.prodname_ghe_server %} site administrators, except for endpoints of the [AUTOTITLE](/rest/enterprise-admin/manage-ghes) API, which allow authentication as a Management Console user. See [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console). {% data reusables.enterprise_management_console.api-deprecation %} diff --git a/content/rest/enterprise-admin/manage-ghes.md b/content/rest/enterprise-admin/manage-ghes.md index bc18efe9594e..585c454d7da4 100644 --- a/content/rest/enterprise-admin/manage-ghes.md +++ b/content/rest/enterprise-admin/manage-ghes.md @@ -16,7 +16,7 @@ category: You can manage {% data variables.location.product_location %} using the Manage {% data variables.product.prodname_ghe_server %} API. For example, you can retrieve information about the version of the {% data variables.product.prodname_ghe_server %} software running on the instance, or on instances with multiple nodes, view the status of replication. -> [!TIP] You can use this API to replace the functionality of the **Management Console API**, which was removed in {% data variables.product.prodname_ghe_server %} version 3.15. For a mapping between the endpoints, see {% ifversion ghes > 3.14 %}[AUTOTITLE](/enterprise-server@3.14/rest/enterprise-admin/management-console) in version 3.14 of the documentation.{% else %}[AUTOTITLE](/rest/enterprise-admin/management-console).{% endif %} +> [!TIP] You can use this API to replace the functionality of the **Management Console API**, which was removed in {% data variables.product.prodname_ghe_server %} version 3.15. Specify the port number when making API calls to endpoints for the Manage {% data variables.product.prodname_ghe_server %} API. If your instance uses TLS, the port number is 8443. Otherwise, the port number is 8080. If you cannot provide a port number, you'll need to configure your client to automatically follow redirects. For more information, see [AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-tls). diff --git a/content/rest/enterprise-admin/management-console.md b/content/rest/enterprise-admin/management-console.md deleted file mode 100644 index e4247cac59f8..000000000000 --- a/content/rest/enterprise-admin/management-console.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: REST API endpoints for Management Console -shortTitle: Management Console -allowTitleToDifferFromFilename: true -intro: >- - Use the REST API to manage your {% data variables.product.prodname_ghe_server %} - installation. -versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 - ghes: <=3.14 -autogenerated: rest -category: - - Administer enterprises and billing ---- - -## About the Management Console endpoints - -The full functionality of the Management Console endpoints was added to the [Manage GHES](/rest/enterprise-admin/manage-ghes) endpoints in {% data variables.product.prodname_ghe_server %} version 3.12. With feature parity achieved, the Management Console API endpoints were removed in version 3.15. - -{% ifversion management-console-manage-ghes-parity %} - -To help you migrate, the mapping table below shows the equivalent Manage GHES operation for each Management Console operation. Please migrate to the Manage GHES API endpoints as soon as possible. - -| Purpose | Management Console API operation | Manage GHES API operation | -| ------------- | ------------- | - | -| Get the configuration status | `GET /setup/api/configcheck` | [`GET /manage/v1/config/apply`](/rest/enterprise-admin/manage-ghes#get-the-status-of-a-ghe-config-apply-run) | -| Start a configuration process | `POST /setup/api/configure` | [`POST /manage/v1/config/apply`](/rest/enterprise-admin/manage-ghes#trigger-a-ghe-config-apply-run) | -| Get the maintenance status | `GET /setup/api/maintenance` | [`GET /manage/v1/maintenance`](/rest/enterprise-admin/manage-ghes#get-the-status-of-maintenance-mode) | -| Enable or disable maintenance mode | `POST /setup/api/maintenance` | [`POST /manage/v1/maintenance`](/rest/enterprise-admin/manage-ghes#set-the-status-of-maintenance-mode) | -| Get settings | `GET /setup/api/settings` | [`GET /manage/v1/config/settings`](/rest/enterprise-admin/manage-ghes#get-the-ghes-settings) | -| Set settings | `PUT /setup/api/settings` | [`PUT /manage/v1/config/settings`](/rest/enterprise-admin/manage-ghes#set-settings) | -| Get all authorized SSH keys | `GET /setup/api/settings/authorized-keys` | [`GET /manage/v1/access/ssh`](/rest/enterprise-admin/manage-ghes#get-the-configured-ssh-keys) | -| Add an authorized SSH key | `POST /setup/api/settings/authorized-keys` | [`POST /manage/v1/access/ssh`](/rest/enterprise-admin/manage-ghes#set-a-new-ssh-key) | -| Remove an authorized SSH key | `DELETE /setup/api/settings/authorized-keys` | [`DELETE /manage/v1/access/ssh`](/rest/enterprise-admin/manage-ghes#delete-a-ssh-key) | -| Create a GitHub license | `POST /setup/api/start` | [`POST /manage/v1/config/init`](/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload) | -| Upgrade a license | `POST /setup/api/upgrade` | [`PUT /manage/v1/config/license`](/rest/enterprise-admin/manage-ghes#upload-an-enterprise-license) | - -{% endif %} - -## About the {% data variables.enterprise.management_console %} - -You should explicitly set the port number when making API calls to the Management Console. If TLS is enabled on your enterprise, the port number is `8443`. Otherwise, the port number is `8080`. - -If you cannot provide a port number, you'll need to configure your tool to automatically follow redirects. - -You may also need to add the [`-k` flag](http://curl.haxx.se/docs/manpage.html#-k) when using `curl`, since {% data variables.product.github %} uses a self-signed certificate before you [add your own TLS certificate](/admin/configuration/configuring-network-settings/configuring-tls). - -### Authentication as the root site administrator - -You need to pass your [root site administrator password](/admin/configuration/administering-your-instance-from-the-management-console/managing-access-to-the-management-console) as an authentication token to every endpoint in this category except [Create a {% data variables.product.github %} license](#create-a-github-license). - -Use the `api_key` parameter to send this token with each request. For example: - -```shell -curl -L 'https://HOSTNAME:ADMIN-PORT/setup/api?api_key=YOUR_PASSWORD' -``` - -You can also use standard HTTP authentication to send this token. For example: - -```shell -curl -L -u "api_key:YOUR_PASSWORD" 'https://HOSTNAME:ADMIN-PORT/setup/api' -``` - -### Authentication as a {% data variables.enterprise.management_console %} user - -[Management Console user accounts](/admin/configuration/administering-your-instance-from-the-management-console/managing-access-to-the-management-console#management-console-user) can also authenticate to access this endpoint. - -To authenticate with the password for a {% data variables.enterprise.management_console %} user account, use standard HTTP authentication. In the following example, replace YOUR_USER_NAME and YOUR_PASSWORD with the account's user name and password. - -```shell -curl -L -u "YOUR_USER_NAME:YOUR_PASSWORD" 'https://HOSTNAME:ADMIN-PORT/setup/api' -``` - - diff --git a/data/features/pre-security-configurations.yml b/data/features/pre-security-configurations.yml deleted file mode 100644 index 7972aa0e2e2e..000000000000 --- a/data/features/pre-security-configurations.yml +++ /dev/null @@ -1,3 +0,0 @@ -# Reference: #13288 and #15768 -versions: - ghes: '>3.9 <3.15' diff --git a/data/features/security-configurations-beta-and-pre-beta.yml b/data/features/security-configurations-beta-and-pre-beta.yml deleted file mode 100644 index ae1bd4dac717..000000000000 --- a/data/features/security-configurations-beta-and-pre-beta.yml +++ /dev/null @@ -1,3 +0,0 @@ -# Reference: #13288 -versions: - ghes: '>3.8 <3.15' diff --git a/data/release-notes/enterprise-server/3-14/0-rc1.yml b/data/release-notes/enterprise-server/3-14/0-rc1.yml deleted file mode 100644 index 2160d9f77a29..000000000000 --- a/data/release-notes/enterprise-server/3-14/0-rc1.yml +++ /dev/null @@ -1,226 +0,0 @@ -date: '2024-08-07' -release_candidate: true -deprecated: true -intro: | - > [!NOTE] Release candidate (RC) builds are intended solely for use in a test environment. Do not install an RC in a production environment. - > - > Do not upgrade to an RC from a supported, earlier version. - > - > If {% data variables.location.product_location %} is running an RC, you cannot upgrade to the general availability (GA) release. You also cannot upgrade with a hotpatch. - - For upgrade instructions, see [Upgrading {% data variables.product.prodname_ghe_server %}](/admin/upgrading-your-instance/preparing-to-upgrade/overview-of-the-upgrade-process). -sections: - - features: - - heading: Instance administration - notes: - # https://github.com/github/releases/issues/4262 - - | - On an instance with multiple replica nodes, to start or stop replication for all nodes in a single configuration run, administrators can use the `ghe-repl-start-all` and `ghe-repl-stop-all` commands. - - - heading: Instance services - notes: - # https://github.com/github/releases/issues/4178 - - | - Administrators can scale the appliance using generation 2 virtual machines, with support for booting in UEFI mode. This requires deploying a new instance and restoring data onto it. See [AUTOTITLE](/admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/using-generation-2-virtual-machines). - # https://github.com/github/releases/issues/4179 - - | - Nomad has been upgraded to 1.5.17 and Consul has been upgraded to 1.17.4. These services are used in {% data variables.product.prodname_ghe_server %} to orchestrate containers and configuration. - - - heading: Identity and access management - notes: - # https://github.com/github/releases/issues/4087 - - | - Automated user provisioning via the System for Cross-domain Identity Management (SCIM) standard is available in public beta. Instances that use SAML authentication can enable SCIM to provision user accounts and manage their lifecycle from an identity provider (IdP). You can configure SCIM using an application for supported IdPs, or using the REST API endpoints for SCIM. See [AUTOTITLE](/admin/managing-iam/provisioning-user-accounts-with-scim/user-provisioning-with-scim-on-ghes). - - * If your instance already uses SAML, you will need to configure a new IdP application that supports automated provisioning via SCIM. - * Existing private beta customers should also reconfigure their implementation with an updated application. - * During the public beta, we recommend testing SCIM support for your identity system in a non-production instance before adding SCIM to your current setup. - # https://github.com/github/releases/issues/3905 - - | - Organization owners can create and assign custom organization roles, delegating administrative duties to trusted teams and users. See [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-organization-roles). - # https://github.com/github/releases/issues/4026 - - | - Users can use the account switcher to switch between multiple accounts. See [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/switching-between-accounts). - # https://github.com/github/releases/issues/4025 - - | - On an instance that uses built-in authentication, users can use passkeys to sign in securely to GitHub, without needing to input their password. See [AUTOTITLE](/authentication/authenticating-with-a-passkey). - # https://github.com/github/releases/issues/3789 - - | - Enterprises that use an SSH certificate authority can allow SSH certificates to be used to access user-owned repositories. See [AUTOTITLE](/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-access-to-user-owned-repositories). - - - heading: Audit logs - notes: - # https://github.com/github/releases/issues/3793 - - | - Every 24 hours, a health check runs for each audit log stream. If a stream is set up incorrectly, an email will be sent to the enterprise owners as notification that their audit log stream is not properly configured. - - - heading: Secret scanning - notes: - # https://github.com/github/releases/issues/3179 - - | - Users can specify which teams or roles have the ability to bypass push protection. This feature is in public beta and subject to change. See [AUTOTITLE](/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection). - # https://github.com/github/releases/issues/3567 - - | - Secret scanning detects secrets leaked in discussions and in pull request titles, bodies, and comments. This feature is in public beta and subject to change. See [AUTOTITLE](/code-security/secret-scanning/about-secret-scanning). - # https://github.com/github/releases/issues/3740 - - | - Secret scanning blocks contributors from uploading files with detected secrets if push protection is enabled for a repository. This feature is in public beta and subject to change. - # https://github.com/github/releases/issues/3741 - - | - Audit log events are created when secret scanning non-provider patterns are enabled or disabled at the repository, organization, or enterprise level. - - - heading: Code scanning - notes: - # https://github.com/github/releases/issues/3707 - - | - Users can create a dedicated code scanning rule to block pull request merges, instead of relying on status checks. This feature is in public beta and subject to change. See [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/set-code-scanning-merge-protection). - # https://github.com/github/releases/issues/3734 - - | - Users can use CodeQL threat model settings for C# to adapt CodeQL's code scanning analysis to detect the most relevant security vulnerabilities in their code. This feature is in public beta and subject to change. See [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup#including-local-sources-of-tainted-data-in-default-setup). - # https://github.com/github/releases/issues/3936 - - | - Organizations that use default setup for code scanning can use organization-level model packs to extend the coverage of multiple repositories. This feature is in public beta and subject to change. See [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup#extending-codeql-coverage-with-codeql-model-packs-in-default-setup). - # https://github.com/github/releases/issues/3663 - - | - CodeQL can scan Java projects without a build. This feature is in public beta and subject to change. - # https://github.com/github/releases/issues/3865 - - | - This release comes installed with version **2.17.6** of the CodeQL CLI, used in the CodeQL action for code scanning. Significant updates since the default version installed on GitHub Enterprise Server 3.13 include: - - * Support for Java 22, Swift 5.10, TS 5.4, and C# 12 - * New queries for C/C++, Go, Java, and Ruby: - * `cpp/type-confusion`: Detects casts to invalid types - * `cpp/iterator-to-expired-container`: Detects the creation of iterators owned by temporary objects that are about to be destroyed - * `go/uncontrolled-allocation-size`: Detects slice memory allocation with excessive size value - * `java/unvalidated-url-forward`: Prevents information disclosure caused by unsafe URL construction - * `rb/insecure-mass-assignment`: Detects instances of mass assignment operations accepting arbitrary parameters - * `rb/csrf-protection-not-enabled`: Detects cases where Cross-Site Request Forgery protection is not enabled in Ruby on Rails controllers - - - heading: Dependabot - notes: - # https://github.com/github/releases/issues/3344 - - | - Users can consolidate Dependabot pull requests by enabling grouped security updates for related dependencies in a package ecosystem. See [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates#about-grouped-security-updates). - # https://github.com/github/releases/issues/3839 - - | - Dependabot can access Cargo private registries to provide updates to Rust dependencies. See [AUTOTITLE](/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot#about-configuring-private-registries-for-dependabot). - # https://github.com/github/releases/issues/3848 - - | - Dependabot pauses scheduled jobs after 15 failures. This gives an earlier indication of potential issues while still ensuring that critical security updates continue to be applied without interruption. - # https://github.com/github/releases/issues/3850 - - | - Dependabot uses private registry configurations specified in the `dependabot.yml` file as expected, even if there is a configuration with `target-branch`. This ensures that security updates are applied correctly, regardless of your repository's configuration settings. See [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot). - - - heading: Code security - notes: - # https://github.com/github/releases/issues/4036 - - | - The security overview dashboard, with the ability to view secret scanning metrics and trending data for the enablement of security features, is available at the enterprise level. See [AUTOTITLE](/code-security/security-overview/viewing-security-insights). - # https://github.com/github/releases/issues/4212 - - | - The security overview dashboard for organizations is now generally available. - # https://github.com/github/releases/issues/3913 - - | - On the security overview dashboard, users can view alert trends grouped by tool. The group-by option is designed to improve the ability to track and analyze the effectiveness of scanning tools, enabling more strategic decision-making. See [AUTOTITLE](/code-security/security-overview/viewing-security-insights#viewing-the-security-overview-dashboard-for-your-organization). - # https://github.com/github/releases/issues/3912 - - | - On the security overview dashboard, users can filter by security tool. This feature is in public beta and subject to change. - # https://github.com/github/releases/issues/4115 - - | - In the dependency graph, a software bill of materials (SBOM) generated for a package now includes the package URL for more packages. Previously, the package URL was not included if the manifest file referenced a package with a version range. - - - heading: GitHub Actions - notes: - # Required Actions Runner version - - | - {% data reusables.actions.actions-runner-release-note %} - # https://github.com/github/releases/issues/3866 - - | - Deployment views across environments are now generally available. Users can pin environments and use additional filters to filter the views. See [AUTOTITLE](/actions/deployment/managing-your-deployments/viewing-deployment-history). - - - heading: GitHub Pages - notes: - # https://github.com/github/releases/issues/3872 - - | - Users can configure custom GitHub Actions workflows to build and deploy sites on GitHub Pages. See [AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow). - - - heading: Repositories - notes: - # https://github.com/github/releases/issues/3947 - - | - Users can enhance security by adding deploy keys as a bypass type to rulesets. See [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository#granting-bypass-permissions-for-your-branch-or-tag-ruleset). - # https://github.com/github/releases/issues/3826 - - | - Users can select Dependabot in the bypass list of a ruleset. See [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository#granting-bypass-permissions-for-your-push-ruleset). - - - heading: Projects - notes: - # https://github.com/github/releases/issues/3910 - - | - Users can use the auto-close issue workflow to automatically close issues when a project item moves to a specific "completed" status. See [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-built-in-automations). - - - heading: Integrations and extensions - notes: - # https://github.com/github/releases/issues/3679 - # https://github.com/github/releases/issues/4047 - - | - When authenticating to a native GitHub App or OAuth app, users will be prompted to select which account they want to sign in to using an account picker. Developers of apps can append `?prompt=select_account` to their login flow to show users the account picker. - # https://github.com/github/releases/issues/3898 - - | - When using a JSON Web Token (JWT) to authenticate or request an installation token, developers of GitHub Apps can use the app's client ID for the JWT's `iss` claim. The application ID remains valid, but is considered deprecated. - - changes: - # https://github.com/github/releases/issues/3927 - - | - Pushes that update over 5,000 branches no longer trigger webhooks or GitHub Actions workflows. - - known_issues: - - | - **Note:** This list is not complete. Any new known issues that are identified for the 3.14 release will be added between now and the GA. - - | - Custom firewall rules are removed during the upgrade process. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Repositories originally imported using ghe-migrator will not correctly track Advanced Security contributions. - - | - When log forwarding is enabled, some forwarded log entries may be duplicated. - - | - REST API endpoints for admin stats may time out on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the steps for [Replacing the primary MySQL node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-mysql-node), step 14 (running `ghe-cluster-config-apply`) might fail with errors. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shut down the node and repeat the steps. - - | - If a hotpatch upgrade requires the `haproxy-frontend` service to be restarted, the restart will hang if there are existing long-lived connections, such as browser web sockets or Git operations. No new connections will be accepted for up to 5 minutes. Any existing unfinished connections at this time will be disconnected. - - | - When restoring data originally backed up from a 3.13 appliance, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - The global search bar does not have suggestions enabled due to the redesigned navigation and pending new search experience. - - | - Upgrades include an error concerning `Error deregistering job` for `consul-template`. This message does not indicate any problems with your install and can be safely ignored. - - | - Some links to GitHub Docs from GitHub Enterprise Server may lead to a "Page not found," because an `enterprise-cloud@latest` portion is incorrectly added to the URL. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - {% data reusables.release-notes.2024-11-ghe-repl-promote-primary-down %} - - [Updated: 2024-11-29] - - deprecations: - - | - The Manage GHES API reached feature parity with the Management Console API in GHES 3.12. As a result, we will remove the Management Console API in GitHub Enterprise Server 3.15. For information about updating tooling that relies on the Management Console API, see [AUTOTITLE](/rest/enterprise-admin/management-console). diff --git a/data/release-notes/enterprise-server/3-14/0.yml b/data/release-notes/enterprise-server/3-14/0.yml deleted file mode 100644 index c08f36ae6ee5..000000000000 --- a/data/release-notes/enterprise-server/3-14/0.yml +++ /dev/null @@ -1,254 +0,0 @@ -date: '2024-08-27' -release_candidate: false -deprecated: false -intro: | - For upgrade instructions, see [Upgrading {% data variables.product.prodname_ghe_server %}](/admin/upgrading-your-instance/preparing-to-upgrade/overview-of-the-upgrade-process). - -sections: - - features: - - heading: Instance administration - notes: - # https://github.com/github/releases/issues/4262 - - | - On an instance with multiple replica nodes, to start or stop replication for all nodes in a single configuration run, administrators can use the `ghe-repl-start-all` and `ghe-repl-stop-all` commands. - - - heading: Instance services - notes: - # https://github.com/github/releases/issues/4178 - - | - Administrators can scale the appliance using generation 2 virtual machines, with support for booting in UEFI mode. This requires deploying a new instance and restoring data onto it. See [AUTOTITLE](/admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/using-generation-2-virtual-machines). - # https://github.com/github/releases/issues/4179 - - | - Nomad has been upgraded to 1.5.17 and Consul has been upgraded to 1.17.4. These services are used in {% data variables.product.prodname_ghe_server %} to orchestrate containers and configuration. - - - heading: Identity and access management - notes: - # https://github.com/github/releases/issues/4087 - - | - Automated user provisioning via the System for Cross-domain Identity Management (SCIM) standard is available in public beta. Instances that use SAML authentication can enable SCIM to provision user accounts and manage their lifecycle from an identity provider (IdP). You can configure SCIM using an application for supported IdPs, or using the REST API endpoints for SCIM. See [AUTOTITLE](/admin/managing-iam/provisioning-user-accounts-with-scim/user-provisioning-with-scim-on-ghes). - - * If your instance already uses SAML, you will need to configure a new IdP application that supports automated provisioning via SCIM. - * Existing private beta customers should also reconfigure their implementation with an updated application. - * During the public beta, we recommend testing SCIM support for your identity system in a non-production instance before adding SCIM to your current setup. - # https://github.com/github/releases/issues/3905 - - | - Organization owners can create and assign custom organization roles, delegating administrative duties to trusted teams and users. See [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-organization-roles). - # https://github.com/github/releases/issues/4026 - - | - Users can use the account switcher to switch between multiple accounts. See [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/switching-between-accounts). - # https://github.com/github/releases/issues/4025 - - | - On an instance that uses built-in authentication, users can use passkeys to sign in securely to GitHub, without needing to input their password. See [AUTOTITLE](/authentication/authenticating-with-a-passkey). - # https://github.com/github/releases/issues/3789 - - | - Enterprises that use an SSH certificate authority can allow SSH certificates to be used to access user-owned repositories. See [AUTOTITLE](/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-access-to-user-owned-repositories). - - - heading: Audit logs - notes: - # https://github.com/github/releases/issues/3793 - - | - Every 24 hours, a health check runs for each audit log stream. If a stream is set up incorrectly, an email will be sent to the enterprise owners as notification that their audit log stream is not properly configured. - - - heading: Secret scanning - notes: - # https://github.com/github/releases/issues/3179 - - | - Users can specify which teams or roles have the ability to bypass push protection. This feature is in public beta and subject to change. See [AUTOTITLE](/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection). - # https://github.com/github/releases/issues/3567 - - | - Secret scanning detects secrets leaked in discussions and in pull request titles, bodies, and comments. This feature is in public beta and subject to change. See [AUTOTITLE](/code-security/secret-scanning/about-secret-scanning). - # https://github.com/github/releases/issues/3740 - - | - Secret scanning blocks contributors from uploading files with detected secrets if push protection is enabled for a repository. This feature is in public beta and subject to change. - # https://github.com/github/releases/issues/3741 - - | - Audit log events are created when secret scanning non-provider patterns are enabled or disabled at the repository, organization, or enterprise level. - - - heading: Code scanning - notes: - # https://github.com/github/releases/issues/3707 - - | - Users can create a dedicated code scanning rule to block pull request merges, instead of relying on status checks. This feature is in public beta and subject to change. See [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/set-code-scanning-merge-protection). - # https://github.com/github/releases/issues/3734 - - | - Users can use CodeQL threat model settings for C# to adapt CodeQL's code scanning analysis to detect the most relevant security vulnerabilities in their code. This feature is in public beta and subject to change. See [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup#including-local-sources-of-tainted-data-in-default-setup). - # https://github.com/github/releases/issues/3936 - - | - Organizations that use default setup for code scanning can use organization-level model packs to extend the coverage of multiple repositories. This feature is in public beta and subject to change. See [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup#extending-codeql-coverage-with-codeql-model-packs-in-default-setup). - # https://github.com/github/releases/issues/3663 - - | - CodeQL can scan Java projects without a build. This feature is in public beta and subject to change. - # https://github.com/github/releases/issues/3865 - - | - This release comes installed with version **2.17.6** of the CodeQL CLI, used in the CodeQL action for code scanning. Significant updates since the default version installed on GitHub Enterprise Server 3.13 include: - - * Support for Java 22, Swift 5.10, TS 5.4, and C# 12 - * New queries for C/C++, Go, Java, and Ruby: - * `cpp/type-confusion`: Detects casts to invalid types - * `cpp/iterator-to-expired-container`: Detects the creation of iterators owned by temporary objects that are about to be destroyed - * `go/uncontrolled-allocation-size`: Detects slice memory allocation with excessive size value - * `java/unvalidated-url-forward`: Prevents information disclosure caused by unsafe URL construction - * `rb/insecure-mass-assignment`: Detects instances of mass assignment operations accepting arbitrary parameters - * `rb/csrf-protection-not-enabled`: Detects cases where Cross-Site Request Forgery protection is not enabled in Ruby on Rails controllers - - - heading: Dependabot - notes: - # https://github.com/github/releases/issues/3344 - - | - Users can consolidate Dependabot pull requests by enabling grouped security updates for related dependencies in a package ecosystem. See [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates#about-grouped-security-updates). - # https://github.com/github/releases/issues/3839 - - | - Dependabot can access Cargo private registries to provide updates to Rust dependencies. See [AUTOTITLE](/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot#about-configuring-private-registries-for-dependabot). - # https://github.com/github/releases/issues/3848 - - | - Dependabot pauses scheduled jobs after 15 failures. This gives an earlier indication of potential issues while still ensuring that critical security updates continue to be applied without interruption. - # https://github.com/github/releases/issues/3850 - - | - Dependabot uses private registry configurations specified in the `dependabot.yml` file as expected, even if there is a configuration with `target-branch`. This ensures that security updates are applied correctly, regardless of your repository's configuration settings. See [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot). - # https://github.com/github/releases/issues/4118 - - | - In the `dependabot.yml` file, users can apply the same configuration to manifest files from multiple directories using the `directories` key. Direct strings, glob syntax, and wildcards (`*`) are all supported for targeting directories. See [AUTOTITLE](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#directories-or-directory--). [Updated: 2024-10-07] - - - heading: Code security - notes: - # https://github.com/github/releases/issues/4036 - - | - The security overview dashboard, with the ability to view secret scanning metrics and trending data for the enablement of security features, is available at the enterprise level. See [AUTOTITLE](/code-security/security-overview/viewing-security-insights). - # https://github.com/github/releases/issues/4212 - - | - The security overview dashboard for organizations is now generally available. - # https://github.com/github/releases/issues/3913 - - | - On the security overview dashboard, users can view alert trends grouped by tool. The group-by option is designed to improve the ability to track and analyze the effectiveness of scanning tools, enabling more strategic decision-making. See [AUTOTITLE](/code-security/security-overview/viewing-security-insights#viewing-the-security-overview-dashboard-for-your-organization). - # https://github.com/github/releases/issues/3912 - - | - On the security overview dashboard, users can filter by security tool. This feature is in public beta and subject to change. - # https://github.com/github/releases/issues/4115 - - | - In the dependency graph, a software bill of materials (SBOM) generated for a package now includes the package URL for more packages. Previously, the package URL was not included if the manifest file referenced a package with a version range. - - - heading: GitHub Actions - notes: - # Required Actions Runner version - - | - {% data reusables.actions.actions-runner-release-note %} - # https://github.com/github/releases/issues/3866 - - | - Deployment views across environments are now generally available. Users can pin environments and use additional filters to filter the views. See [AUTOTITLE](/actions/deployment/managing-your-deployments/viewing-deployment-history). - - - heading: GitHub Pages - notes: - # https://github.com/github/releases/issues/3872 - - | - Users can configure custom GitHub Actions workflows to build and deploy sites on GitHub Pages. See [AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow). - - - heading: Repositories - notes: - # https://github.com/github/releases/issues/3947 - - | - Users can enhance security by adding deploy keys as a bypass type to rulesets. See [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository#granting-bypass-permissions-for-your-branch-or-tag-ruleset). - # https://github.com/github/releases/issues/3826 - - | - Users can select Dependabot in the bypass list of a ruleset. See [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository#granting-bypass-permissions-for-your-push-ruleset). - - - heading: Projects - notes: - # https://github.com/github/releases/issues/3910 - - | - Users can use the auto-close issue workflow to automatically close issues when a project item moves to a specific "completed" status. See [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-built-in-automations). - - - heading: Integrations and extensions - notes: - # https://github.com/github/releases/issues/3679 - # https://github.com/github/releases/issues/4047 - - | - When authenticating to a native GitHub App or OAuth app, users will be prompted to select which account they want to sign in to using an account picker. Developers of apps can append `?prompt=select_account` to their login flow to show users the account picker. - # https://github.com/github/releases/issues/3898 - - | - When using a JSON Web Token (JWT) to authenticate or request an installation token, developers of GitHub Apps can use the app's client ID for the JWT's `iss` claim. The application ID remains valid, but is considered deprecated. - - changes: - - | - The API endpoint for setting and removing organization membership for a user (`PUT /orgs/{org}/memberships/{username}` and `DELETE /orgs/{org}/memberships/{username}`) requires `admin:org` permissions for classic tokens. Previously, the changes were allowed with the `read:org, repo` permissions. [Updated: 2025-07-16] - - known_issues: - - | - Complete SCIM payloads are written to the audit log, including SCIM attributes that are not required or supported per [API docs](/rest/enterprise-admin/scim?apiVersion=2022-11-28#supported-scim-user-attributes). Customers using Okta with SCIM may notice that a placeholder password attribute is among the data passed to audit logs in its current configuration. This placeholder data is associated with Okta’s password synchronization feature that is not expected or required by GitHub. See [okta-scim](https://developer.okta.com/docs/api/openapi/okta-scim/guides/scim-20/#create-the-user) for more information. - - | - Custom firewall rules are removed during the upgrade process. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - REST API endpoints for admin stats may time out on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the steps for [Replacing the primary MySQL node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-mysql-node), step 14 (running `ghe-cluster-config-apply`) might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shut down the node and repeat the steps. - - | - If a hotpatch upgrade requires the `haproxy-frontend` service to be restarted, the restart will hang if there are existing long-lived connections, such as browser web sockets or Git operations. No new connections will be accepted for up to 5 minutes. Any existing unfinished connections at this time will be disconnected. - - | - When restoring data originally backed up from a 3.13 appliance, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - The global search bar does not have suggestions enabled due to the redesigned navigation and pending new search experience. - - | - Upgrades include an error concerning `Error deregistering job` for `consul-template`. This message does not indicate any problems with your install and can be safely ignored. - - | - Some links to GitHub Docs from GitHub Enterprise Server may lead to a "Page not found," because an `enterprise-cloud@latest` portion is incorrectly added to the URL. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - {% data reusables.release-notes.2024-08-resolvconf-wont-start %} - - | - Services may respond with a 503 status due to an out of date haproxy configuration. This can usually be resolved with a `ghe-config-apply` run. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - Following an upgrade, Elasticsearch search migrations are sometimes incorrectly reported as failing in the audit log, even though the migrations completed successfully. [Updated: 2024-09-27] - - | - Images embedded in wiki pages may stop rendering shortly after being published. [Updated: 2024-10-16] - - | - {% data reusables.release-notes.2024-11-ghe-repl-promote-primary-down %} - - [Updated: 2024-11-29] - - | - {% data reusables.release-notes.2025-03-03-elasticsearch-data-loss %} - - [Updated: 2025-03-12] - - deprecations: - - | - The Manage GHES API reached feature parity with the Management Console API in GHES 3.12. As a result, we will remove the Management Console API in GitHub Enterprise Server 3.15. For information about updating tooling that relies on the Management Console API, see [AUTOTITLE](/rest/enterprise-admin/management-console). - - | - Team discussions have been removed from {% data variables.product.prodname_ghe_server %}. The sunset of this feature was announced in 2023. See the [GitHub Blog post](https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/). [Updated: 2025-02-13] - - | - Node 16 support ended in September 2023. Actions that used Node 16 now default to Node 20. Running a workflow that uses Node 16 results in a warning on the workflow summary page. [Updated: 2025-04-02] - - errata: - - | - These release notes previously indicated as a known issue that on GitHub Enterprise Server 3.14.0 when log forwarding is enabled, some forwarded log entries may be duplicated. - The fix for this problem was already included prior to the release of GitHub Enterprise Server 3.14.0. [Updated: 2024-09-16] - - | - These release notes did not include a note for support of the `directories` key in `dependabot.yml` files. [Updated: 2024-10-07] - - | - The "Changes" section indicated that "Pushes that update over 5,000 branches no longer trigger webhooks or GitHub Actions workflows." The change instead affects GitHub Enterprise Server version 3.15. [Updated: 2024-10-30] - - | - These release notes previously did not include a note for the deprecation of team discussions. - - | - These release notes previously indicated as a known issue that on GitHub Enterprise Server 3.14.0, repositories originally imported using `ghe-migrator` will not correctly track Advanced Security contributions. - - The fix for this problem was already included in GitHub Enterprise Server [3.12](/admin/release-notes#3.12.0-bugs). [Updated: 2025-04-11] - - | - The release notes previously did not include a note for the change in permissions required for managing user organization membership. [Updated: 2025-07-16] diff --git a/data/release-notes/enterprise-server/3-14/1.yml b/data/release-notes/enterprise-server/3-14/1.yml deleted file mode 100644 index 6d516c9b2a7e..000000000000 --- a/data/release-notes/enterprise-server/3-14/1.yml +++ /dev/null @@ -1,88 +0,0 @@ -date: '2024-09-23' -sections: - security_fixes: - - | - **MEDIUM:** An attacker could steal sensitive information by exploiting a Cross-Site Scripting vulnerability in the repository transfer feature. This exploitation would require social engineering. GitHub has requested CVE ID [CVE-2024-8770](https://www.cve.org/cverecord?id=CVE-2024-8770) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - - | - **HIGH:** A GitHub App installed in organizations could upgrade some permissions from read to write access without approval from an organization administrator. An attacker would require an account with administrator access to install a malicious GitHub App. GitHub has requested [CVE ID CVE-2024-8810](https://www.cve.org/cverecord?id=CVE-2024-8810) for this vulnerability, which was reported via the [GitHub Bug Bounty Program](https://bounty.github.com/). [Updated: 2024-11-07] - bugs: - - | - On an instance with GitHub Actions enabled, due to an insufficient wait time, MS SQL and MySQL replication could fail with the error message `Failed to start nomad service!`. - - | - `ghe-storage-find` was sometimes unable to identify a data disk. - - | - After upgrading the relevant GHES version, the `resolvconf` service failed to start due to a missing directory. - - | - Some pre-receive hooks using the `faccessat2` system call, such as those using Alpine Linux as the base, failed unexpectedly. - - | - When configuring a high availability replica and during the database seeding of a MySQL replica node, restarting the nomad service could time out. Consequently, when MySQL replication attempted to start an error was reported, and setting up replication failed. - - | - On an instance in a cluster configuration, the `ghe-cluster-status` command returned an error if a soft-deleted repository had a checksum mismatch. - - | - Fixes and improvements for the git core module. - - | - Some repositories could miss spokes information after restoring in a clustering topology due to unrescued exceptions. - - | - In organizations with a large number of repositories, when an administrator used repository properties to target repositories in an organization ruleset, the ruleset index page timed out. - - | - After a user created a Projects Insights chart with time as the X-axis, the chart became hidden and inaccessible. - - | - Fixes a known issue where some links to GitHub Docs from GitHub Enterprise Server may lead to a “Page not found.” Previously, the links incorrectly added `enterprise-cloud@latest` to the URL. - - | - A bug introduced in 3.12 which prevented the search input in the global navigation from displaying a dropdown of search suggestions has been fixed. The search input functionality prior to 3.12 has been restored, and users are once again able to see and submit suggested search queries, including scope suggestions. - - | - Custom links to other repositories displayed incorrect breadcrumbs. - - | - The Secret Scanning Push Protection custom resource link set at the Enterprise level was not being displayed to users being blocked when pushing secrets to a repository using git through the command line interface. - - | - Following an upgrade, Elasticsearch search migrations are sometimes incorrectly reported as failing in the audit log, even though the migrations completed successfully. [Updated: 2024-09-27] - changes: - - | - For instances deployed on Amazon Web Services (AWS), site administrators can configure regional AWS STS endpoints for OIDC from the Management Console. - - | - Site administrators can now configure the instance with NUMA optimizations. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as `127.0.0.1`. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the instructions for [Replacing the primary database node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-database-node-mysql-or-mysql-and-mssql), `ghe-cluster-config-apply` might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 appliance onto a 3.13 appliance, the elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - Services may respond with a `503` status due to an out of date `haproxy` configuration. This can usually be resolved with a `ghe-config-apply` run. - - | - Images embedded in wiki pages may stop rendering shortly after being published. [Updated: 2024-10-16] - - | - {% data reusables.release-notes.2024-11-ghe-repl-promote-primary-down %} - - [Updated: 2024-11-29] - - | - {% data reusables.release-notes.2025-03-03-elasticsearch-data-loss %} - - [Updated: 2025-03-12] - - errata: - - | - These release notes previously indicated as a known issue that on GitHub Enterprise Server 3.14.1, repositories originally imported using `ghe-migrator` will not correctly track Advanced Security contributions. - - The fix for this problem was already included in GitHub Enterprise Server [3.12](/admin/release-notes#3.12.0-bugs). [Updated: 2025-04-11] diff --git a/data/release-notes/enterprise-server/3-14/10.yml b/data/release-notes/enterprise-server/3-14/10.yml deleted file mode 100644 index 780f6b1d842d..000000000000 --- a/data/release-notes/enterprise-server/3-14/10.yml +++ /dev/null @@ -1,58 +0,0 @@ -date: '2025-03-25' -sections: - security_fixes: - - | - Packages have been updated to the latest security versions. - bugs: - - | - The `ghe-upgrade` command returned a zero exit code despite encountering errors. - - | - When performing an upgrade with an upgrade package, the process did not terminate when an invalid target partition was provided with the `-t` flag. - - | - Users could not use the `/manage/v1/config/apply` API endpoint to trigger the first configuration run on an instance. - - | - For instances in a high availability configuration, Elasticsearch indices were deleted on failover and when `ghe-repl-teardown REPLICA_HOSTNAME` was run from the primary instance. All indices are recoverable except audit log indices, whose source of truth is Elasticsearch itself. - - | - Restoring from a backup did not always apply the latest data from GitHub Actions. All GitHub Actions data is now restored with a backup. - - | - In Azure environments, running `ghe-single-config-apply` or `ghe-repl-setup` resulted in "Permission denied" errors during the pre-flight check. - - | - On instances with a GitHub Advanced Security license, some secret scanning alerts were opened incorrectly despite the relevant folders or files being excluded from secret scanning. - - | - For appliances in a high availability configuration, Elasticsearch indices were deleted either on failover, or when running `ghe-repl-teardown ` from the primary instance. - changes: - - | - Elasticsearch shards are excluded from the replica node when stopping replication via `ghe-repl-stop`. To prevent Elasticsearch from being stopped before all shards have been removed, Elasticsearch is polled until the shard count on the replica node is zero instead of waiting for a maximum timeout of 30 seconds. - - | - Update the bundled `actions/setup-dotnet` with the latest versions from https://github.com/actions/setup-dotnet. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the instructions for [Replacing the primary database node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-database-node-mysql-or-mysql-and-mssql), `ghe-cluster-config-apply` might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 or greater appliance version, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - After a restore, existing outside collaborators cannot be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance. - - | - After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the actions workflow of a repository does not have any suggested workflows. diff --git a/data/release-notes/enterprise-server/3-14/11.yml b/data/release-notes/enterprise-server/3-14/11.yml deleted file mode 100644 index 470ab2e3d0d6..000000000000 --- a/data/release-notes/enterprise-server/3-14/11.yml +++ /dev/null @@ -1,60 +0,0 @@ -date: '2025-04-17' -sections: - security_fixes: - - | - **MEDIUM:** An attacker could view private repository names, which the signed-in user is not authorized to see, in the GitHub Advanced Security Overview. This was due to a missing authorization check and occurred when filtering with _only_ `archived:`. GitHub has requested CVE ID [CVE-2025-3124](https://www.cve.org/CVERecord?id=CVE-2025-3124) for this vulnerability. - bugs: - - | - When restarting babeld, most commonly as part of upgrades between 3.14.x point releases, the old and new babeld processes could have a port conflict resulting in the babeld service stopping unexpectedly minutes or hours later. - - | - Pruning unreachable Git objects on a single replica could cause increased CPU load due to many Git checksum recalculations. - - | - In the commit author filter dropdown on the commit history page for a repository, users could not search for a specific author (such as `foo`) if their search query had already returned a similar username (such as `foobar`). - - | - Various repository content API endpoints were unable to parse revisions containing invalid UTF-8 byte sequences, triggering `500 Internal Server Error` responses. - - | - The "Get allowed actions and reusable workflows" APIs for enterprises, organizations, and repositories did not include the `verified_allowed` response field. - changes: - - | - Upgrading using a hot patch package will fail if the Elasticsearch status is not green. To help prevent post-upgrade problems when the Elasticsearch status is red, usually in a high-availability configuration, a check has been added. - - | - Merging a pull request using the "Rebase and merge" option is now limited to 100 commits. If you have a pull request with more than 100 commits, you need to either create a merge commit, or squash and merge, or split the commits up into multiple pull requests. - - | - The `spokesctl info` and `spokesctl repos` commands now also show wikis that are part of a network. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the instructions for [Replacing the primary database node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-database-node-mysql-or-mysql-and-mssql), `ghe-cluster-config-apply` might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 or greater appliance version, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - Services may respond with a `503` status due to an out of date `haproxy` configuration. This can usually be resolved with a `ghe-config-apply` run. - - | - After a restore, existing outside collaborators cannot be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance. - - | - After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the actions workflow of a repository does not have any suggested workflows. - - | - Repository Cache Replicas return `Repository not found` when changes have been pushed to the Primary instance that have not yet synchronized to the Cache Replica. This issue can also occur in all previous patches of this release. - - | - Unexpected elements may appear in the UI on the repo overview page for locked repositories. diff --git a/data/release-notes/enterprise-server/3-14/12.yml b/data/release-notes/enterprise-server/3-14/12.yml deleted file mode 100644 index da6edd70c2c2..000000000000 --- a/data/release-notes/enterprise-server/3-14/12.yml +++ /dev/null @@ -1,93 +0,0 @@ -date: '2025-05-27' -sections: - security_fixes: - - | - **MEDIUM:** An attacker could inject HTML in the instances web UI because the web commit dialog did not properly sanitize repository rule violation messages. This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - - | - Packages have been updated to the latest security versions. - bugs: - - | - Ephemeral runner registrations for GitHub Actions were not fully cleaned up after deletion. - - | - The alive process intermittently experienced segmentation faults (SIGSEGV) due to a `panic: runtime error: invalid memory address or nil pointer dereference` in the alive daemon during restore operations. These crashes caused services, such as mps, to appear unhealthy, leading to restore operation failures after 20 attempts. - - | - For instances in a high availability configuration, because there was no Nomad job for the `aqueduct-lite` service on replica nodes, generating a support bundle from the command line on a replica would result in the error `ERROR: Failed to get elastomer index build progress` being incorrectly reported. - - | - A pre-receive hook could fail due to blocked system calls. - - | - After updating the TLS certificate from the Management Console, users encountered 502 errors when creating releases and uploading artifacts. Running `ghe-config-apply` did not resolve the issue, as the alambic service required a manual restart. - - | - The sidebar menu did not display on the "Retired namespaces" page on the site admin dashboard. - - | - Site administrators could encounter a failure to load domain entries in the "Verified & Approved Domains" section of the site admin dashboard when one or more authoritative nameservers for the affected domain were unreachable or unresponsive due to inefficient DNS queries. - - | - When migrating from an instance with S3 on AWS Gov Cloud, an incorrect URL was generated. - - | - Images embedded in Markdown tables did not display correctly. - - | - Deleted discussions could potentially prevent a repository from being exported using the export API or `ghe-migrator`. - - | - During an import, missing assignee models caused incomplete imports of issues, pull requests, and their dependent models. - - | - When the GitHub Enterprise Server application attempted to create an Elasticsearch index that already existed but lacked a routing configuration, the operation failed. This resulted in a state where the index appeared to exist, but the application could not write documents to it. - - | - Enterprise customers in very large organizations experienced performance issues with the GitHub API when making multiple API requests to retrieve Dependabot alerts for their enterprise. - - | - Instances using Azure for migration API storage without a proxy configured could not export migration archives because the system incorrectly attempted to route requests through a proxy. - - | - When administrators downloaded large Advanced Security committer CSV files, the operation would fail due to insufficient timeout settings. The timeout duration has been increased to ensure successful downloads. - - | - The "Grouped security updates" button was not being displayed in the Dependabot settings at the organization and repository levels. - - | - Actions workflows were not able to access up to 1,000 organization variables when the total size of all variables was under 10 MB. - - | - Fetches from repository caches returned a "Repository not found" error when the cache is out of sync. - - | - Secret scanning alerts would sometimes incorrectly identify the location of a secret in a file after a custom pattern was edited. - changes: - - | - Support tools now redact proxy credentials from their outputs in the admin terminal during connectivity checks. - - | - Live updates to the GitHub site were sometimes blocked by per-IP address rate limits, especially in environments where users accessed a GitHub Enterprise Server instance through a proxy. - - | - Merging a pull request using the "Rebase and merge" option is now limited to 100 commits. If you have a pull request with more than 100 commits, you can create a merge commit, or squash and merge, or split the commits into multiple pull requests. - closing_down: - - | - Microsoft Exchange Online is retiring SMTP basic authentication during March-April 2026. If your GitHub Enterprise Server instance uses this method to send email, delivery may fail after the retirement date. Microsoft recommends switching to a supported alternative. As another option, you may consider using an SMTP OAuth proxy such as [email-oauth2-proxy](https://github.com/simonrob/email-oauth2-proxy), though this is not officially supported. For details and configuration guidance, see the [Microsoft announcement](https://techcommunity.microsoft.com/blog/exchange/exchange-online-to-retire-basic-auth-for-client-submission-smtp-auth/4114750) and the proxy’s [documentation](https://github.com/simonrob/email-oauth2-proxy/blob/main/emailproxy.config). [Updated: 2025-09-03] - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the instructions for [Replacing the primary database node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-database-node-mysql-or-mysql-and-mssql), `ghe-cluster-config-apply` might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running `ghe-cluster-config-apply` as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 or greater appliance version, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. The reindexing can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - After a restore, existing outside collaborators cannot be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance. - - | - After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the actions workflow of a repository does not have any suggested workflows. - - | - Unexpected elements may appear in the UI on the repository overview page for locked repositories. - - errata: - - | - The [Known issues](/admin/release-notes#3.14.12-known-issues) section previously indicated that `repository cache replicas return "Repository not found" when changes have been pushed to the primary instance that have not yet synchronized to the cache replica` is still an issue. The issue is resolved and is documented in the [Bug fixes](/admin/release-notes#3.14.12-bugs) section. [Updated: 2025-06-19] diff --git a/data/release-notes/enterprise-server/3-14/13.yml b/data/release-notes/enterprise-server/3-14/13.yml deleted file mode 100644 index 1fa1020ea99c..000000000000 --- a/data/release-notes/enterprise-server/3-14/13.yml +++ /dev/null @@ -1,63 +0,0 @@ -date: '2025-06-18' -sections: - security_fixes: - - | - **HIGH:** An attacker could execute arbitrary code, potentially leading to privilege escalation and system compromise, by exploiting the pre-receive hook functionality to bind to dynamically allocated ports that become temporarily available (for example, during a hot patch upgrade). This vulnerability is only exploitable under specific operational conditions, such as during the hot patching process, and requires either site administrator permissions or a user with privileges to modify repositories containing pre-receive hooks. The initial fix for this issue was found to be incomplete, leaving the vulnerability exploitable in some cases. GitHub has requested CVE ID: [CVE-2025-3509](https://www.cve.org/CVERecord?id=CVE-2025-3509) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - - | - Packages have been updated to the latest security versions. - bugs: - - | - On an instance with GitHub Actions configured to connect to Azure OIDC storage through a proxy, Actions logs and artifacts would not be properly stored. - - | - Site administrators and auditors reviewing audit logs saw the `mc_actor` field was empty when a user signed out, because audit logging occurred after the user was removed from session state. - - | - During hotpatching, site administrators could encounter issues with the kernel partition table not updating correctly when running `ghe-partition-setup`. These users had to manually intervene in order to complete the upgrade process. - - | - Users of GitHub Actions could not view or manage Actions artifacts and logs if the global AWS STS endpoint was unavailable, because Actions did not use the configured regional STS endpoint. - - | - On instances with a large number of code scanning users, running `ghe-config-apply` previously resulted in slow performance. - - | - Organization owners had no audit log events to track organization announcements displayed on banners in the UI. - - | - If an Enterprise Managed User (EMU) pushed to their personal repository with both secret scanning and push protection enabled, the custom patterns defined at enterprise level were not being applied during the push protection scan. - - | - In some situations, the kafka-lite service could cause client timeouts when processing consumer group membership sessions and expirations. [Updated: 2025-07-14] - changes: - - | - Site administrators can now set rate limits for the WebSockets controller used for live updates, with `ghe-config app.github.web-sockets-rate-limit`. For more information, see [Controlling the rate for the live update service](/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-rate-limits#controlling-the-rate-for-the-live-update-service). - closing_down: - - | - Site administrators who manage dependencies with the base-pinned image should no longer rely on the vulcanizer CLI, as it is in the process of being retired and replaced with vulcancli. Transition to vulcancli to ensure continued support and compatibility. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the instructions for [Replacing the primary database node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-database-node-mysql-or-mysql-and-mssql), `ghe-cluster-config-apply` might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 or greater appliance version, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - After a restore, existing outside collaborators cannot be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance. - - | - After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the actions workflow of a repository does not have any suggested workflows. - - | - Unexpected elements may appear in the UI on the repo overview page for locked repositories. diff --git a/data/release-notes/enterprise-server/3-14/14.yml b/data/release-notes/enterprise-server/3-14/14.yml deleted file mode 100644 index 7d003d386263..000000000000 --- a/data/release-notes/enterprise-server/3-14/14.yml +++ /dev/null @@ -1,52 +0,0 @@ -date: '2025-07-01' -sections: - security_fixes: - - | - Packages have been updated to the latest security versions. - bugs: - - | - The Management Console would become unresponsive when saving settings after a failed config apply run. - - | - Users sometimes received a JSON response instead of a web page when clicking "Back" after viewing files in raw format. - - | - Pull requests were blocked from merging due to unhandled merge attempt timeouts. - - | - Pull requests were temporarily blocked from merging due to delayed purging of failed background jobs. - changes: - - | - The babeld service no longer reports log messages about some common client-induced networking errors, reducing noise in the logs. - known_issues: - - | - Applying a new GitHub Enterprise Server license using the Management Console can sometimes fail with an HTTP 500 error. - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the instructions for [Replacing the primary database node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-database-node-mysql-or-mysql-and-mssql), `ghe-cluster-config-apply` might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 or greater appliance version, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - After a restore, existing outside collaborators cannot be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance. - - | - After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the actions workflow of a repository does not have any suggested workflows. - - | - Unexpected elements may appear in the UI on the repo overview page for locked repositories. diff --git a/data/release-notes/enterprise-server/3-14/15.yml b/data/release-notes/enterprise-server/3-14/15.yml deleted file mode 100644 index 67e28da404ea..000000000000 --- a/data/release-notes/enterprise-server/3-14/15.yml +++ /dev/null @@ -1,48 +0,0 @@ -date: '2025-07-15' -sections: - security_fixes: - - | - **HIGH**: An incorrect authorization vulnerability allowed unauthorized read access to the contents of internal repositories for contractor accounts when the Contractors API feature was enabled. The Contractors API is a rarely-enabled feature in private preview. Following this fix, contractor account access to internal repositories via the API will be correctly blocked unless they have an alternate grant. GitHub has requested CVE ID [CVE-2025-6981](https://www.cve.org/cverecord?id=CVE-2025-6981) for this vulnerability. - - | - Packages have been updated to the latest security versions. - bugs: - - | - Applying a new GitHub Enterprise Server license using the Management Console would sometimes fail with a HTTP 500 error. - - | - During Git push operations in a HA configuration, it was possible under rare circumstances for the primary voting replica of a repository to become incorrectly marked as out of sync with the other replicas and in need of repair, causing the repository to become unavailable. - changes: - - | - Site administrators can now set `innodb_buffer_pool_size` in megabytes for MySQL using `ghe-config mysql.innodb-buffer-pool-size VALUE`. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the instructions for [Replacing the primary database node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-database-node-mysql-or-mysql-and-mssql), `ghe-cluster-config-apply` might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 or greater appliance version, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - After a restore, existing outside collaborators cannot be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance. - - | - After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the actions workflow of a repository does not have any suggested workflows. - - | - Unexpected elements may appear in the UI on the repo overview page for locked repositories. diff --git a/data/release-notes/enterprise-server/3-14/16.yml b/data/release-notes/enterprise-server/3-14/16.yml deleted file mode 100644 index d52891b30eb0..000000000000 --- a/data/release-notes/enterprise-server/3-14/16.yml +++ /dev/null @@ -1,49 +0,0 @@ -date: '2025-07-29' -sections: - security_fixes: - - | - Packages have been updated to the latest security versions. - bugs: - - | - Administrators would occasionally encounter timeouts when downloading diagnostics via the Management Console. - - | - In full cluster topologies, some expensive stats queries are skipped during `ghe-cluster-support-bundle` to prevent overloading the nodes with identical requests. - - | - Unsuccessful attempts to sign in to the Management Console were reported in the audit log and were indistinguishable from successful attempts. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the instructions for [Replacing the primary database node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-database-node-mysql-or-mysql-and-mssql), `ghe-cluster-config-apply` might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 or greater appliance version, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - After a restore, existing outside collaborators cannot be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance. - - | - After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the actions workflow of a repository does not have any suggested workflows. - - | - Unexpected elements may appear in the UI on the repo overview page for locked repositories. - - | - The autolink references feature is missing from the repository settings page. - - | - When attempting to open a pull request as a draft in a private or internal repository, users are incorrectly prompted to upgrade their plan.[Updated: 2025-08-11] diff --git a/data/release-notes/enterprise-server/3-14/17.yml b/data/release-notes/enterprise-server/3-14/17.yml deleted file mode 100644 index 951b432357fd..000000000000 --- a/data/release-notes/enterprise-server/3-14/17.yml +++ /dev/null @@ -1,50 +0,0 @@ -date: '2025-08-25' -sections: - security_fixes: - - | - **HIGH:** An improper access control vulnerability was identified in GitHub Enterprise Server that allowed users with access to any repository to retrieve limited code content from another repository by creating a diff between the repositories. To exploit this vulnerability, an attacker needed to know the name of a private repository along with its branches, tags, or commit SHAs that they could use to trigger compare/diff functionality and retrieve limited code without proper authorization. This vulnerability has been assigned [CVE-2025-8447](https://www.cve.org/cverecord?id=CVE-2025-8447) and was reported through the [GitHub Bug Bounty program](https://bounty.github.com/). - - | - Packages have been updated to the latest security versions. - - | - Elasticsearch packages have been updated to the 8.18.0 security version. - bugs: - - | - After enabling GitHub Actions or performing an upgrade with GitHub Actions enabled, administrators experienced a delay of approximately 10 minutes longer than they should have due to a faulty connection check. This is fixed for future enablement and upgrades. - - | - After upgrading to GHES 3.14.16, GHES 3.15.11, GHES 3.16.7, or GHES 3.17.4, administrators found that draft pull requests and autolink references for private repositories were no longer available. [Updated: 2025-11-11] - changes: - - | - When administrators run the `ghe-support-bundle` command on an unconfigured node, the output clearly states that metadata collection was skipped, instead of producing misleading `curl` errors. This improves the clarity of support bundle diagnostics. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the steps for [Replacing the primary MySQL node](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-mysql-node), step 14 (running `ghe-cluster-config-apply`) may fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running `ghe-cluster-config-apply` as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 or greater appliance version, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - After a restore, existing outside collaborators cannot be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance. - - | - After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the actions workflow of a repository does not have any suggested workflows. - - | - Unexpected elements may appear in the UI on the repository overview page for locked repositories. diff --git a/data/release-notes/enterprise-server/3-14/18.yml b/data/release-notes/enterprise-server/3-14/18.yml deleted file mode 100644 index 2df790b09c1a..000000000000 --- a/data/release-notes/enterprise-server/3-14/18.yml +++ /dev/null @@ -1,52 +0,0 @@ -date: '2025-09-09' -sections: - security_fixes: - - | - Packages have been updated to the latest security versions. - bugs: - - | - When generating a support bundle, site administrators could encounter errors if character escaping caused the bundle script to omit the URL parameter for `curl`. - - | - In some environments, `syslog-ng` could write excessive logs to a regular file named `tty10`, continuously filling disk space. - - | - Secret scanning backfills for pull requests and discussions did not run as expected during backfills of new secret types. Site administrators and security teams may have noticed incomplete secret scanning coverage or unworked queues after upgrading. - - | - Administrators saw daily `SignalException` errors in `github-stream-processors` when log rotation happened. Log rotation using "copytruncate" no longer sends SIGUSR1, preventing these errors and improving log management stability. No administrator action is required. - - | - Maintenance periods scheduled more than a week in advance were triggered on the first occurrence of the scheduled day-of-week rather than the intended specific date. - changes: - - | - For administrators managing logs, log folders are more consistently accessible from the administrative account without the need to use `sudo`. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the instructions for [Replacing the primary database node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-database-node-mysql-or-mysql-and-mssql), `ghe-cluster-config-apply` might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 or greater appliance version, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - After a restore, existing outside collaborators cannot be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance. - - | - After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the actions workflow of a repository does not have any suggested workflows. - - | - Unexpected elements may appear in the UI on the repo overview page for locked repositories. diff --git a/data/release-notes/enterprise-server/3-14/19.yml b/data/release-notes/enterprise-server/3-14/19.yml deleted file mode 100644 index 053051930c1a..000000000000 --- a/data/release-notes/enterprise-server/3-14/19.yml +++ /dev/null @@ -1,52 +0,0 @@ -date: '2025-11-10' -sections: - security_fixes: - - | - **CRITICAL:** Redis has been upgraded to version 6.2.20 to address CVE-2025-49844 (also known as RediShell). Administrators should apply this update promptly to mitigate potential security risks. - - | - **HIGH:** An attacker could execute arbitrary code in the context of other users' browsers by supplying a malicious `label:` value that was injected into the DOM without proper sanitization. This could be triggered when a user visits a crafted Issues search URL, enabling session hijacking, account takeover, and recovery code exfiltration. GitHub has requested CVE ID [CVE-2025-11892](https://www.cve.org/cverecord?id=CVE-2025-11892) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - - | - Packages have been updated to the latest security versions. - bugs: - - | - Users applying a new license file received an HTTP 500 error. - - | - SVG files stored in Git Large File Storage (LFS) failed to render on the web interface. - - | - On the "Scheduled workflows" page in the site admin dashboard, actors attributed to workflows appeared as "Not found". - changes: - - | - Elasticsearch deprecation warnings, which are logged to index files in new versions of Elasticsearch, have been disabled. These warnings provided no value to administrators, and in some cases could block upgrades of instances in high-availability or cluster configurations. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the steps for [Replacing the primary MySQL node](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-mysql-node), step 14 (running `ghe-cluster-config-apply`) might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shut down the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 or greater appliance version, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. You can also trigger the reindexing by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - After a restore, existing outside collaborators cannot be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance. - - | - After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the actions workflow of a repository does not have any suggested workflows. - - | - Unexpected elements may appear in the UI on the repository overview page for locked repositories. diff --git a/data/release-notes/enterprise-server/3-14/2.yml b/data/release-notes/enterprise-server/3-14/2.yml deleted file mode 100644 index 3727c1e4c9e6..000000000000 --- a/data/release-notes/enterprise-server/3-14/2.yml +++ /dev/null @@ -1,96 +0,0 @@ -date: '2024-10-10' -sections: - security_fixes: - - | - A sensitive data exposure in HTML forms was possible in the management console. To mitigate this issue, the "Copy Storage Setting from Actions" functionality was removed from the management console. - - | - **MEDIUM**: Malicious URLs for SVG assets provided information about a victim user who clicked the URL, allowing an attacker to retrieve metadata belonging to the user and use it to generate a convincing phishing page. This required the attacker to upload malicious SVGs and phish a victim user to click the URL for the uploaded asset. GitHub has requested CVE ID [CVE-2024-9539](https://www.cve.org/cverecord?id=CVE-2024-9539). This vulnerability was reported via the [GitHub Bug Bounty](https://bounty.github.com/) program. - - | - **HIGH**: An attacker could bypass SAML single sign-on (SSO) authentication with the optional encrypted assertions feature, allowing unauthorized provisioning of users and access to the instance, by exploiting an improper verification of cryptographic signatures vulnerability in GitHub Enterprise Server. This was a regression introduced as part of follow-up remediation from [CVE-2024-4985](https://www.cve.org/cverecord?id=CVE-2024-4985), which resulted in a new variant of the vulnerability. Please note that encrypted assertions are not enabled by default. Instances not utilizing SAML SSO, or utilizing SAML SSO authentication without encrypted assertions, are not impacted. Additionally, an attacker would require direct network access as well as a signed SAML response or metadata document. GitHub has requested CVE ID [CVE-2024-9487](https://www.cve.org/cverecord?id=CVE-2024-9487). This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - bugs: - - | - A missing configuration value would cause Dependabot to be unable to create group update pull requests. - - | - HAProxy reloading was failure prone, which could lead to failed Git operations. This reloading process has been replaced with a more resilient Systemd process. - - | - This error message `mbind: Operation not permitted` was repeatedly showing in the `/var/log/mysql/mysql.err` MySQL logs. - - | - The backup of audit logs could take longer after upgrading to Elasticsearch 8. - - | - An unhandled nil value when configuring Actions storage with AWS S3 via OIDC configuration in the terminal could cause an error. - - | - Users were unable to sign out from gist pages. - - | - On an instance with secret scanning enabled, the custom pattern page would not load because dry run results were tied to a deleted repository. - - | - Suspended users were not always correctly routed to the correct "suspended" page. - - | - The "List teams" API endpoint returned duplicate results when paginating. - - | - When managing the organization permissions required for {% data variables.product.pat_v2_plural %}, for custom properties or projects, the `Admin` access level could not be selected. - - | - A model with no URL could cause a `ghe-migrator` import to fail. - - | - The `ghe-spokesctl status` command showed repaired repositories as broken if their network ID changed during the repair (for example, when the repository was detached from it's original network). - - | - Missing URLs on import could lead to migration failures without logging or explanation. - - | - On the security overview dashboard, data initialization could fail when creating new organizations or changing GitHub Advanced Security licensing. - - | - Restore could fail when restoring MySQL using backup-utils. - - | - The help documentation for the Actions Workflow editor was not loading correctly. [Updated: 2025-02-18] - changes: - - | - `ghe-remove-node` will display the log file location when running in quiet mode. - - | - Pre-receive hook environments can use the `clone3()` system call. - - | - The creation, deletion, or change in visibility of a gist has been added to the audit log. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - The admin stats REST API endpoints may time out on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the instructions for [Replacing the primary database node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-database-node-mysql-or-mysql-and-mssql), `ghe-cluster-config-apply` might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 appliance onto a 3.13 appliance, the elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - Images embedded in wiki pages may stop rendering shortly after being published. [Updated: 2024-10-16] - - | - {% data reusables.release-notes.2024-11-ghe-repl-promote-primary-down %} - - [Updated: 2024-11-29] - - | - {% data reusables.release-notes.2025-03-03-elasticsearch-data-loss %} - - [Updated: 2025-03-12] - - deprecations: - - | - The option to "copy Storage settings from Actions" in the Management Console ("GitHub Packages" > "Packages Storage Settings") has been removed. [Updated: 2024-11-20] - - errata: - - | - These release notes previously indicated as a known issue that on GitHub Enterprise Server 3.14.2, repositories originally imported using `ghe-migrator` will not correctly track Advanced Security contributions. - - The fix for this problem was already included in GitHub Enterprise Server [3.12](/admin/release-notes#3.12.0-bugs). [Updated: 2025-04-11] diff --git a/data/release-notes/enterprise-server/3-14/20.yml b/data/release-notes/enterprise-server/3-14/20.yml deleted file mode 100644 index c64ffc7c0f59..000000000000 --- a/data/release-notes/enterprise-server/3-14/20.yml +++ /dev/null @@ -1,64 +0,0 @@ -date: '2025-12-02' -sections: - security_fixes: - - | - **HIGH:** An attacker could execute code within a victim's browser, potentially accessing sensitive information, by causing malicious HTML to be injected into the DOM when content is rendered by the Filter component found across GitHub. GitHub has requested CVE ID [CVE-2025-13744](https://www.cve.org/cverecord?id=CVE-2025-13744) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). [Updated: 2026-01-06] - - | - **HIGH:** A privilege escalation vulnerability was identified in GitHub Enterprise Server that allowed an authenticated Enterprise admin to gain root SSH access to the appliance by exploiting a symlink escape in pre-receive hook environments. By crafting a malicious repository and environment, an attacker could replace system binaries during hook cleanup and execute a payload that adds their own SSH key to the root user’s authorized keys—thereby granting themselves root SSH access to the server. To exploit this vulnerability, the attacker needed to have enterprise admin privileges. This vulnerability has been assigned [CVE-2025-11578](https://nvd.nist.gov/vuln/detail/CVE-2025-11578) and was reported through the GitHub Bug Bounty program. - - | - Packages have been updated to the latest security versions. - bugs: - - | - Administrators may have experienced delays with configuration runs after a reboot if `ghe-reconfigure.service` was still activating, impacting run performance and stability. - - | - On instances with a "No Proxy" setting configured for GitHub Actions with MinIO or AWS remote blob providers, administrators sometimes experienced failures reading or writing Actions logs, artifacts, or caches because some traffic was incorrectly routed through the instance's proxy. - - | - New Microsoft Teams integrations failed to set up because the required `tenant_id` field was missing from the configuration, following Microsoft's deprecation of multi-tenant bot creation. - - | - An "Invite member" button intended only for GitHub.com was displayed on the enterprise "People" tab. - - | - Audit log searches could temporarily miss recent events or show incomplete results right after new index creation at the start of a month. Administrators now experience reduced lag between the creation of monthly audit log search indexes and their availability for searches and write operations. - - | - When new Elasticsearch indexes were created, index routing memos could go to a read-only MySQL replica and fail, causing delays in audit log indexing after monthly rollovers. The memos are now written to the primary database rather than a read-only replica. - changes: - - | - A new weekly job automatically disables Elasticsearch deprecation logging and removes existing deprecation logs every Saturday at midnight. This helps administrators manage disk space by regularly cleaning up deprecation data streams and log indices that are no longer needed. - - | - Administrators can add security key-backed (SK) SSH certificate authorities. - - | - Administrators and users experience faster and more efficient searching of GitHub Actions workflow runs, with lower compute and networking resource usage. Searches for workflow runs within a repository are now always scoped to an associated repository. - - | - `ghe-repl-start` can now be executed without requiring a maintenance window when setting up a new replica, as long as `ghe-repl-setup` is immediately followed by `ghe-config-apply`. [Updated: 2025-12-17] - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. See "[AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account)." - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the steps for [Replacing the primary MySQL node](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-mysql-node), step 14 (running `ghe-cluster-config-apply`) might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 or greater appliance version, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - After a restore, existing outside collaborators cannot be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance. - - | - After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the Actions workflow of a repository does not have any suggested workflows. - - | - Unexpected elements may appear in the UI on the repository overview page for locked repositories. diff --git a/data/release-notes/enterprise-server/3-14/21.yml b/data/release-notes/enterprise-server/3-14/21.yml deleted file mode 100644 index 3e901c642458..000000000000 --- a/data/release-notes/enterprise-server/3-14/21.yml +++ /dev/null @@ -1,41 +0,0 @@ -date: '2025-12-09' -sections: - security_fixes: - - | - **HIGH:** An attacker could inject HTML elements with IDs that collided with server-initialized data islands due to insufficient sanitization. When a privileged user viewed crafted content in certain Project views, these injected elements could overwrite critical application state objects, resulting in unintended server-side POST requests or other unauthorized backend interactions. GitHub has requested CVE ID [CVE-2025-14046](https://www.cve.org/cverecord?id=CVE-2025-14046) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - bugs: - - | - Due to a regression in a recent patch release, Dependabot did not respond to some commands on pull requests, such as rebases, because webhook deliveries to loopback addresses were blocked. Webhook deliveries to the Dependabot endpoint now succeed, although deliveries to other endpoints on loopback addresses are still blocked. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see "[AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account)." - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the steps for [Replacing the primary MySQL node](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-mysql-node), step 14 (running `ghe-cluster-config-apply`) might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 or greater appliance version, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - After a restore, existing outside collaborators cannot be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance. - - | - After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the actions workflow of a repository does not have any suggested workflows. - - | - Unexpected elements may appear in the UI on the repo overview page for locked repositories. diff --git a/data/release-notes/enterprise-server/3-14/22.yml b/data/release-notes/enterprise-server/3-14/22.yml deleted file mode 100644 index e99e5be7499a..000000000000 --- a/data/release-notes/enterprise-server/3-14/22.yml +++ /dev/null @@ -1,54 +0,0 @@ -date: '2026-01-06' -sections: - security_fixes: - - | - **HIGH:** An authenticated attacker with permission to configure webhooks could perform SSRF to access internal-only services on the instance, potentially disrupting background job processing. Exploitation required webhook configuration privileges and the ability to craft valid service requests. GitHub has requested CVE ID [CVE-2026-1999](https://www.cve.org/cverecord?id=CVE-2026-1999) for this vulnerability, which was reported via the [GitHub Bug Bounty](https://bounty.github.com/) program. - bugs: - - | - On instances with GitHub Actions enabled, when administrators deleted a self-hosted runner from the service, the runner process continued running on the host and did not exit automatically. - - | - Input validation wasnt correctly being applied to the "Password and authentication policies" section on the Management Console, allowing administrators to specify invalid values for "Login attempt limit for all users" and "Lockout time for Management Console users". - - | - The highlighted section on the sidebar of the Management Console settings page would not always accurately show what content was currently scrolled into view for an administrator. - - | - Site administrators could not easily identify when a configuration run for their instance failed in the Management Console. Failed runs were indicated only by a header and steps could remain in a "pending" state. - - | - Administrators who set the `ELASTOMER_INDEX_LOCK_BACKOFF_ATTEMPTS` environment variable to configure Elasticsearch index lock backoff attempts saw no effect, as the instance required the ` ENTERPRISE_ ` prefix for this variable. - - | - Commit authors who ignored notifications from a repository did not receive secret scanning alert emails when their credentials were detected in that repository. - changes: - - | - Administrators can capture distributed tracing data for Nomad job allocations using the `usr/local/share/enterprise/ghe-capture-trace-data` command to help diagnose performance issues. This feature is available only on standalone instances and should be run with guidance from GitHub Support. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may time out on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the steps for [Replacing the primary MySQL node](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-mysql-node), step 14 (running `ghe-cluster-config-apply`) might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shut down the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 or greater appliance version, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - After a restore, existing outside collaborators cannot be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance. - - | - After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the actions workflow of a repository does not have any suggested workflows. - - | - Unexpected elements may appear in the UI on the repository page for locked repositories. diff --git a/data/release-notes/enterprise-server/3-14/23.yml b/data/release-notes/enterprise-server/3-14/23.yml deleted file mode 100644 index 38867900c7db..000000000000 --- a/data/release-notes/enterprise-server/3-14/23.yml +++ /dev/null @@ -1,52 +0,0 @@ -date: '2026-02-10' -sections: - security_fixes: - - | - **MEDIUM:** By supplying the migration identifier, an attacker could upload unauthorized content to another user’s repository migration export due to a missing authorization check. This could cause victims to download attacker-controlled migration archives, potentially impacting the integrity of downstream repository imports. GitHub has requested a CVE ID [CVE-2026-1355](https://www.cve.org/cverecord?id=CVE-2026-1355) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - - | - **HIGH:** An authenticated attacker could exploit a URL redirection vulnerability in GitHub Enterprise Server to leak privileged authorization tokens by redirecting requests to an attacker-controlled domain. This could allow exfiltration of the `Actions.ManageOrgs` JWT and potential remote code execution. This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - bugs: - - | - Running `ghe-config-apply` could fail if Redis experienced transient connectivity issues during the configuration process. - - | - On an instance configured behind a load balancer, users received unexpected secondary rate limit warnings during authentication when the `X-Forwarded-For` header included port numbers. This occurred because the system incorrectly ignored the header values containing ports, preventing proper client IP address identification. - - | - On instances with GitHub Actions enabled, Actions workflow runs could be silently skipped when creating many issues rapidly via the API. Previously, some "issue opened" webhooks were processed before the new issue was saved to the database, causing the event to be dropped and the workflow to not start. After this fix, workflow runs start reliably for all rapid issue creations, regardless of timing. - - | - Users could only view webhook deliveries from the previous three days. - changes: - - | - Administrators can configure database connection pool limits for the authentication and authorization services to improve performance on instances experiencing high concurrent request volumes. The limits can be adjusted using `ghe-config` keys: `app.authnd.mysql-max-open-conns`, `app.authnd.mysql-max-idle-conns`, `app.authzd.db-resolver-max-open-conns`, and `app.authzd.db-resolver-max-idle-conns`. The default values remain unchanged (authnd: 100 max open and 100 max idle connections; authzd: 100 max open and 15 max idle connections). These settings should only be adjusted with guidance from GitHub Support. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [Troubleshooting access to the Management Console](/admin/administering-your-instance/administering-your-instance-from-the-web-ui/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the steps for [Replacing the primary MySQL node](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-mysql-node), step 14 (running `ghe-cluster-config-apply`) might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 or greater appliance version, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - After a restore, existing outside collaborators cannot be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance. - - | - After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the actions workflow of a repository does not have any suggested workflows. - - | - Unexpected elements may appear in the UI on the repo overview page for locked repositories. diff --git a/data/release-notes/enterprise-server/3-14/24.yml b/data/release-notes/enterprise-server/3-14/24.yml deleted file mode 100644 index 0f5edaeea49e..000000000000 --- a/data/release-notes/enterprise-server/3-14/24.yml +++ /dev/null @@ -1,66 +0,0 @@ -date: '2026-03-10' -intro: | - {% warning %} - - **Warning**: {% data variables.product.prodname_ghe_server %} 3.14.24 has been unpublished due to mismatched Git versions between containers. Please use the most recent available patch release of 3.14. [Updated: 2026-03-13] - - {% endwarning %} -sections: - security_fixes: - - | - **HIGH**: An attacker with push access to a repository could execute arbitrary code on the instance by injecting malicious values into Git push options. The push options were not properly sanitized before being included in internal headers used for Git operations, allowing the attacker to override internal metadata fields and achieve remote code execution. GitHub has requested CVE ID [CVE-2026-3854](https://www.cve.org/cverecord?id=CVE-2026-3854) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - - | - **MEDIUM**: An attacker with read access to a repository and write access to a project could bypass repository write permissions to modify issue and pull request labels, assignees, and other metadata by adding duplicate items to the project. GitHub has requested CVE ID [CVE-2026-3306](https://www.cve.org/cverecord?id=CVE-2026-3306) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - bugs: - - | - Users experienced delays or failures when performing Git operations over HTTP. The operations could hang indefinitely due to a deadlock in the babeld service. - - | - When administrators applied configuration changes via the Management Console, the state shown would occasionally briefly flicker to a failure before being marked as successful causing confusion as to whether the configuration had succeeded. - - | - After an upgrade, `ghe-config-apply` could fail to remove some pre-upgrade Docker images and report `Error response from daemon: conflict: unable to delete `. - - | - Administrators for instances using the collectd metrics stack saw empty `git fetch caching` graphs on the Management Console monitoring page. - - | - After upgrading, `ghe-config-apply` failed to start services including HAProxy and Redis. Docker images were incorrectly removed during the upgrade process, preventing services from starting. - - | - Users experienced failures when migrating repositories with releases using GitHub Enterprise Importer. Migrations failed to import release assets that were incompletely uploaded at the time of export, as the export archive referenced assets without including the corresponding files. - changes: - - | - To improve performance on large instances, HAProxy automatically scales its thread count based on available CPUs and uses higher connection limits for high-traffic backend services including GitHub Actions, database connections, job queues, and package registry. Administrators can override the thread count using `ghe-config haproxy-nbthread` if needed. - known_issues: - - | - The Git version included in the release did not match the version used by the gitrpcd service due to incorrect version determination during the build process. [Updated: 2026-03-13] - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. See [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-web-ui/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may time out on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the steps for [Replacing the primary MySQL node](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-mysql-node), step 14 (running `ghe-cluster-config-apply`) might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running `ghe-config-apply` as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 or greater appliance version, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - After a restore, existing outside collaborators cannot be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance. - - | - After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the Actions workflow of a repository does not have any suggested workflows. - - | - Unexpected elements may appear in the UI on the repository overview page for locked repositories. - - | - On an instance hosted on Azure, commenting on an issue via email means the comment is not added to the issue. diff --git a/data/release-notes/enterprise-server/3-14/25.yml b/data/release-notes/enterprise-server/3-14/25.yml deleted file mode 100644 index 38f753238c2a..000000000000 --- a/data/release-notes/enterprise-server/3-14/25.yml +++ /dev/null @@ -1,60 +0,0 @@ -date: '2026-03-12' -sections: - security_fixes: - - | - **HIGH**: An attacker with push access to a repository could execute arbitrary code on the instance by injecting malicious values into Git push options. The push options were not properly sanitized before being included in internal headers used for Git operations, allowing the attacker to override internal metadata fields and achieve remote code execution. GitHub has requested CVE ID [CVE-2026-3854](https://www.cve.org/cverecord?id=CVE-2026-3854) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - - | - **MEDIUM**: An attacker with read access to a repository and write access to a project could bypass repository write permissions to modify issue and pull request labels, assignees, and other metadata by adding duplicate items to the project. GitHub has requested CVE ID [CVE-2026-3306](https://www.cve.org/cverecord?id=CVE-2026-3306) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - bugs: - - | - The Git version included in the release did not match the version used by the gitrpcd service due to incorrect version determination during the build process. - - | - Users experienced delays or failures when performing Git operations over HTTP. The operations could hang indefinitely due to a deadlock in the babeld service. - - | - When administrators applied configuration changes via the Management Console, the state shown would occasionally briefly flicker to a failure before being marked as successful causing confusion as to whether the configuration had succeeded. - - | - After an upgrade, `ghe-config-apply` could fail to remove some pre-upgrade Docker images and report `Error response from daemon: conflict: unable to delete `. - - | - Administrators for instances using the collectd metrics stack saw empty `git fetch caching` graphs on the Management Console monitoring page. - - | - After upgrading, `ghe-config-apply` failed to start services including HAProxy and Redis. Docker images were incorrectly removed during the upgrade process, preventing services from starting. - - | - Users experienced failures when migrating repositories with releases using GitHub Enterprise Importer. Migrations failed to import release assets that were incompletely uploaded at the time of export, as the export archive referenced assets without including the corresponding files. - changes: - - | - To improve performance on large instances, HAProxy automatically scales its thread count based on available CPUs and uses higher connection limits for high-traffic backend services including GitHub Actions, database connections, job queues, and package registry. Administrators can override the thread count using `ghe-config haproxy-nbthread` if needed. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. See [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-web-ui/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may time out on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the steps for [Replacing the primary MySQL node](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-mysql-node), step 14 (running `ghe-cluster-config-apply`) might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running `ghe-config-apply` as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 or greater appliance version, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - After a restore, existing outside collaborators cannot be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance. - - | - After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the Actions workflow of a repository does not have any suggested workflows. - - | - Unexpected elements may appear in the UI on the repository overview page for locked repositories. - - | - On an instance hosted on Azure, commenting on an issue via email means the comment is not added to the issue. diff --git a/data/release-notes/enterprise-server/3-14/26.yml b/data/release-notes/enterprise-server/3-14/26.yml deleted file mode 100644 index 6f32b61ac5cd..000000000000 --- a/data/release-notes/enterprise-server/3-14/26.yml +++ /dev/null @@ -1,67 +0,0 @@ -date: '2026-04-21' -sections: - security_fixes: - - | - **HIGH**: An attacker could gain unauthorized access to private repositories by abusing scoped user-to-server (`ghu_`) tokens after their associated GitHub App installation was revoked or deleted. In certain cases, the authorization layer could incorrectly fall back to a global installation context instead of rejecting the request, allowing the token to access resources outside its intended installation or repository scope. This issue could be chained with weaknesses in token revocation timing and SSH push attribution to obtain a victim-scoped token and read private repository contents without victim interaction. GitHub has requested CVE ID [CVE-2026-5845](https://www.cve.org/cverecord?id=CVE-2026-5845) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - - | - **HIGH**: An attacker could extract sensitive environment variables from a GitHub Enterprise Server instance through a timing side-channel attack against the notebook rendering service. When private mode was disabled, the notebook viewer followed HTTP redirects without revalidating the destination host, enabling an unauthenticated Server-Side Request Forgery (SSRF) to internal services. By measuring response time differences, an attacker could infer secret values character by character. GitHub has requested CVE ID [CVE-2026-5921](https://www.cve.org/cverecord?id=CVE-2026-5921) for this vulnerability, which was reported via the [GitHub Bug Bounty](https://bounty.github.com/) program. - - | - **HIGH**: A Management Console administrator could inject shell metacharacters into configuration fields via the Management Console configuration API, leading to arbitrary command execution on the appliance as the admin OS user. GitHub has requested CVE ID [CVE-2026-4821](https://www.cve.org/cverecord?id=CVE-2026-4821) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - - | - **HIGH**: An attacker with knowledge of a target application's registered OAuth callback URL could gain unauthorized access to user accounts by exploiting incorrect regular expression matching in callback URL validation. GitHub has requested CVE ID [CVE-2026-4296](https://www.cve.org/cverecord?id=CVE-2026-4296) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - - | - **MEDIUM**: An attacker with permission to manage secret scanning push protection settings in one repository could add or remove delegated bypass reviewers in a different repository by exploiting an incorrect authorization check in the `/settings/security_analysis/bypass_reviewers` endpoints. Authorization was checked against the repository in the URL route, but the action was applied to a different repository specified in the request body. The impact is limited to assigning existing trusted users as bypass reviewers. GitHub has requested CVE ID [CVE-2026-3307](https://www.cve.org/cverecord?id=CVE-2026-3307) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - - | - **MEDIUM**: An authenticated attacker could determine the names of private repositories by their numeric ID through the mobile upload policy API endpoint, which returned repository names in validation error messages without verifying the caller's access. GitHub has requested [CVE ID CVE-2026-5512](https://www.cve.org/cverecord?id=CVE-2026-5512) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - bugs: - - | - On an instance with GitHub Actions enabled, diagnostic log files for storage connectivity checks did not persist to disk when site administrators clicked **Test storage settings** in the Management Console or ran `ghe-config-apply` to apply configuration changes. This made storage connection failures difficult to troubleshoot because logs were unavailable in support bundles. - - | - When Consul replication failed to start, a misleading error message `exit: check_consul_replication: numeric argument required` was emitted to `ghe-config.log`. - - | - Consul replication would sometimes fail to start and would repeatedly display an error message `WARNING: Consul KV Replication Error` before terminating. - - | - On instances with Dependabot enabled, hotpatch upgrades could lock the Nomad jobs queue. - - | - The site admin bar displayed debugging information used by GitHub. - - | - On an instance with busy databases, online schema migrations using gh-ost failed because the cut-over lock timeout defaulted to 3 seconds, which was insufficient to acquire an exclusive table lock under continuous traffic. - known_issues: - - | - First time setups of GitHub Actions with OpenID Connect (OIDC) fail with an error on the `Update Servicing Resources` step. This problem does not affect instances where GitHub Actions is already enabled. - - As a workaround, you can enable Actions without OIDC, then enable OIDC **immediately** once the process completes. You should do this immediately because enabling OIDC will remove all access to existing Actions logs and artifacts. - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [Troubleshooting access to the Management Console](/admin/administering-your-instance/administering-your-instance-from-the-web-ui/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the steps for [Replacing the primary MySQL node](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-mysql-node), step 14 (running `ghe-cluster-config-apply`) might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 or greater appliance version, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - After a restore, existing outside collaborators cannot be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance. - - | - After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the actions workflow of a repository does not have any suggested workflows. - - | - Unexpected elements may appear in the UI on the repo overview page for locked repositories. - - | - GitHub Enterprise Server releases shipped with mismatched Git versions between containers. diff --git a/data/release-notes/enterprise-server/3-14/3.yml b/data/release-notes/enterprise-server/3-14/3.yml deleted file mode 100644 index 74c5ac97c2ea..000000000000 --- a/data/release-notes/enterprise-server/3-14/3.yml +++ /dev/null @@ -1,90 +0,0 @@ -date: '2024-11-07' -sections: - security_fixes: - - | - Elasticsearch packages have been updated to the latest security versions. - - | - Packages have been updated to the latest security version. - - | - **HIGH**: An attacker could bypass SAML single sign-on (SSO) authentication with the optional encrypted assertions feature, allowing unauthorized provisioning of users and access to the instance, by exploiting an improper verification of cryptographic signatures vulnerability in GitHub Enterprise Server. This is a follow up fix for [CVE-2024-9487](https://www.cve.org/cverecord?id=CVE-2024-9487) to further harden the encrypted assertions feature against this type of attack. Please note that encrypted assertions are not enabled by default. Instances not utilizing SAML SSO, or utilizing SAML SSO authentication without encrypted assertions, are not impacted. Additionally, an attacker would require direct network access as well as a signed SAML response or metadata document to exploit this vulnerability. - - | - **HIGH**: An attacker with Enterprise Administrator access to the GitHub Enterprise Server instance could escalate privileges to SSH root access. This is achieved by exploiting the pre-receive hook environment to bypass symlink checks in the `ghe-firejail` path and execute malicious scripts. GitHub has requested CVE ID [CVE-2024-10007](https://www.cve.org/cverecord?id=CVE-2024-10007) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). [Updated: 2024-11-07] - - | - **HIGH**: An attacker could leak sensitive data from the DOM by injecting malicious input through the `identity` parameter in `querySelector` handling. This allows the attacker to dynamically embed a hidden iframe on the page and exfiltrate data from DOM attributes. To execute the attack, the victim must be logged into GitHub and interact with the attacker controlled malicious webpage containing the hidden iframe. GitHub has requested CVE ID [CVE-2024-10001](https://www.cve.org/cverecord?id=CVE-2024-10001) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). [Updated: 2025-01-27] - bugs: - - | - When saving settings in the Management Console, the configuration run would stop if the `enterprise-manage` process was restarted. - - | - On an instance with GitHub Actions enabled, some maintenance tasks could fail due to incomplete upgrade steps during previous upgrades to new releases of GitHub Enterprise Server. - - | - A repeated error message concerning connectivity to port 6002 was emitted to the system logs when GitHub Actions was enabled. - - | - The initial setup certificate generation in AWS took longer than expected due to fallback to private IPs. The time for this fallback has been reduced. - - | - The `ghe-support-bundle` generation would fail when the `aqueduct-lite` service is down. - - | - If the primary instance was unreachable, running `ghe-repl-stop --force` on a replica would fail during the config apply run. - - | - Administrators in the SCIM private beta (versions < 3.14) that decided to upgrade their private beta appliance see an incorrectly checked box in the "SCIM Configuration" section of the Enterprise settings authentication security page in 3.14. - - | - Certain URLs may have caused a 500 error on instances that use the mandatory message feature logging. - - | - When restoring from a backup, repositories that had been deleted in the last 90 days were not completely restored. - - | - For instances that use secret scanning, custom messages for push protection set by the enterprise did not display to users. - - | - Restoring Git repositories using `backup-utils` occasionally failed. - - | - Enterprise installations experienced unpredictable repository search results due to the default 4,000 repository limit. A relaxed repository filter mode, which includes all single-tenant organization repositories and bypasses the limit, has been introduced. Administrators can enable this mode using `ghe-config app.github.enterprise-repo-search-filter-enabled true && ghe-config-apply`. - - | - Running `config-apply` became stuck under certain circumstances due to a misconfiguration with Packages and Elasticsearch. - - | - Audit log events for secret scanning alerts incorrectly displayed a blank secret type when generated for a custom pattern. - - | - Some customers upgrading to 3.14 experienced issues with undecryptable records during the upgrade. This issue has now been resolved. A diagnostic script will run to assess impact, if no records are affected the message "SUCCESS: Encrypted records OK." will print to the console and can be ignored. If the error message "WARN: Error reading encrypted records!" is output, we recommend you read [Undecryptable records](/admin/upgrading-your-instance/troubleshooting-upgrades/known-issues-with-upgrades-to-your-instance#undecryptable-records). [Updated: 2024-01-22] - changes: - - | - When connecting to an appliance via SSH, a notification about upcoming root disk changes displays. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. See [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the instructions for [Replacing the primary database node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-database-node-mysql-or-mysql-and-mssql), `ghe-cluster-config-apply` might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a `config apply` as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 appliance onto a 3.13 appliance, the Elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - Customers doing feature version upgrade to 3.14.3 may experience issues with database migrations due to data issues during database conversions. [Added: 2024-11-08] - - | - {% data reusables.release-notes.2024-11-ghe-repl-promote-primary-down %} - - [Updated: 2024-11-29] - - | - {% data reusables.release-notes.2025-03-03-elasticsearch-data-loss %} - - [Updated: 2025-03-12] - - errata: - - | - These release notes previously indicated as a known issue that on GitHub Enterprise Server 3.14.3, repositories originally imported using `ghe-migrator` will not correctly track Advanced Security contributions. - - The fix for this problem was already included in GitHub Enterprise Server [3.12](/admin/release-notes#3.12.0-bugs). [Updated: 2025-04-11] diff --git a/data/release-notes/enterprise-server/3-14/4.yml b/data/release-notes/enterprise-server/3-14/4.yml deleted file mode 100644 index 03a93091de0b..000000000000 --- a/data/release-notes/enterprise-server/3-14/4.yml +++ /dev/null @@ -1,48 +0,0 @@ -date: '2024-11-12' -sections: - bugs: - - | - Customers performing a feature version upgrade to 3.13.6 or 3.14.3 may experience issues with database migrations due to data issues during database conversions. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the instructions for [Replacing the primary database node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-database-node-mysql-or-mysql-and-mssql), `ghe-cluster-config-apply` might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 appliance onto a 3.13 appliance, the elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - Attempting to stop replications after stopping GitHub Actions on a GHES instance would fail, reporting that MSSQL was not responding. This can be avoided by starting MSSQL prior to stopping replication `/usr/local/share/enterprise/ghe-nomad-jobs queue /etc/nomad-jobs/mssql/mssql.hcl`. - - | - {% data reusables.release-notes.2024-11-ghe-repl-promote-primary-down %} - - [Updated: 2024-11-29] - - | - {% data reusables.release-notes.2025-03-03-elasticsearch-data-loss %} - - [Updated: 2025-03-12] - - errata: - - | - These release notes previously indicated as a known issue that on GitHub Enterprise Server 3.14.4, repositories originally imported using `ghe-migrator` will not correctly track Advanced Security contributions. - - The fix for this problem was already included in GitHub Enterprise Server [3.12](/admin/release-notes#3.12.0-bugs). [Updated: 2025-04-11] diff --git a/data/release-notes/enterprise-server/3-14/5.yml b/data/release-notes/enterprise-server/3-14/5.yml deleted file mode 100644 index 2b92dd93e7fc..000000000000 --- a/data/release-notes/enterprise-server/3-14/5.yml +++ /dev/null @@ -1,49 +0,0 @@ -date: '2024-12-03' -sections: - security_fixes: - - | - **LOW**: Instance administrators could see tokens used to authenticate against gitauth in plaintext in`/var/log/github-audit.log`. - - | - Packages have been updated to the latest security versions. - bugs: - - | - Embedded images in wiki pages were broken. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the instructions for [Replacing the primary database node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-database-node-mysql-or-mysql-and-mssql), `ghe-cluster-config-apply` might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 appliance onto a 3.13 appliance, the elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - Attempting to stop replications after stopping GitHub Actions on a GitHub Enterprise Server instance would fail, reporting that MSSQL was not responding. This can be avoided by starting MSSQL prior to stopping replication `/usr/local/share/enterprise/ghe-nomad-jobs queue /etc/nomad-jobs/mssql/mssql.hcl` - - | - {% data reusables.release-notes.2025-03-03-elasticsearch-data-loss %} - - [Updated: 2025-03-12] - - errata: - - | - These release notes previously indicated as a known issue that on GitHub Enterprise Server 3.14.5, repositories originally imported using `ghe-migrator` will not correctly track Advanced Security contributions. - - The fix for this problem was already included in GitHub Enterprise Server [3.12](/admin/release-notes#3.12.0-bugs). [Updated: 2025-04-11] diff --git a/data/release-notes/enterprise-server/3-14/6.yml b/data/release-notes/enterprise-server/3-14/6.yml deleted file mode 100644 index f7470037cd85..000000000000 --- a/data/release-notes/enterprise-server/3-14/6.yml +++ /dev/null @@ -1,84 +0,0 @@ -date: '2024-12-17' -sections: - security_fixes: - - | - Packages have been updated to the latest security versions. - bugs: - - | - On an instance in a cluster configuration, `ghe-repl-promote` failed if the primary node was unavailable. - - | - In a high availability configuration, with GitHub Actions, replication would fail on nodes where MSSQL was not configured to run. - - | - The `--no-async` flag was not implemented for the `ghe-cluster-support-bundle` command, leading to a potentially increased load. - - | - Pre-receive hook environments with shared memory enabled could not access shared memory at runtime. - - | - For instances hosted on Azure, if a pre-upgrade check failed due to insufficient user disk size, the Management Console displayed an internal server error. - - | - The Enterprise Overview page incorrectly displayed a Beta label, even though it is generally available. - - | - After a user made changes to the isolated subdomain setting, some user assets did not display properly. - - | - On an instance with secret scanning enabled, when selecting repositories for a dry run of an enterprise-level custom pattern, searches for full repository names (`ORGANIZATION/REPOSITORY`) did not return results. - - | - When adding bypass permissions to a ruleset, the dropdown menu failed to load if one of the suggested actors was an invalid integration. - - | - When creating a pre-receive hook environment, attempts to include an image URL over 255 characters failed with a database error. The maximum length is still 255 characters, but the URL length is now validated before the process starts. - - | - On an instance with GitHub Actions disabled, status check icons on a repositorys commit list failed to render. - - | - Site administrators were unable to use the "Disable repository access" functionality on the site admin dashboard. - - | - Attempting to access the code security settings page for a non-existent enterprise returned a 500 error instead of a 404 error. - - | - Performing a browser back navigation to a pull request now displays up-to-date status checks. - - | - Jekyll-build tooling for GitHub pages could fail when using the `jekyll-relative-links` plugin, see [Failure details](https://github.com/jekyll/jekyll/issues/9544). - - | - The removal rate of issues from Git repositories was slower than necessary. - changes: - - | - Log output for git maintenance now includes the time taken to complete the maintenance process. - - | - When exporting repositories to blob storage using the migrations REST API endpoint to start an organization migration, the maximum compressed archive size is limited to 90 GB. This is an increase from 30 GB. - - | - Removes the minimum date for the new commit filter bar. - - | - When exporting repositories using the migrations REST API, prior to blob storage upload the tarball is staged in the root volume. For more disk capacity, the tarball will now be staged in the data volume. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the instructions for [Replacing the primary database node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-database-node-mysql-or-mysql-and-mssql), `ghe-cluster-config-apply` might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 appliance onto a 3.13 appliance, the elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - {% data reusables.release-notes.2025-03-03-elasticsearch-data-loss %} - - [Updated: 2025-03-12] - - errata: - - | - These release notes previously indicated as a known issue that on GitHub Enterprise Server 3.14.6, repositories originally imported using `ghe-migrator` will not correctly track Advanced Security contributions. - - The fix for this problem was already included in GitHub Enterprise Server [3.12](/admin/release-notes#3.12.0-bugs). [Updated: 2025-04-11] diff --git a/data/release-notes/enterprise-server/3-14/7.yml b/data/release-notes/enterprise-server/3-14/7.yml deleted file mode 100644 index 2d0369646867..000000000000 --- a/data/release-notes/enterprise-server/3-14/7.yml +++ /dev/null @@ -1,70 +0,0 @@ -date: '2025-01-21' -sections: - security_fixes: - - | - **HIGH:** An attacker could forge a SAML response to provision and/or gain access to an account with administrator privileges for GitHub Enterprise Server instances that use SAML single sign-on authentication. Instances not utilizing SAML single sign-on or where the attacker is not already an existing user are not impacted. Exploitation of this vulnerability would allow for signature spoofing by improper validation. GitHub has requested CVE ID [CVE-2025-23369](https://www.cve.org/cverecord?id=CVE-2025-23369) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - - | - Packages have been updated to the latest security versions. - bugs: - - | - Restore failed silently on incremental MySQL backups. - - | - On an instance with GitHub Actions enabled, a configuration run could hang if the blob storage was inaccessible. - - | - Site administrators using `ghe-config-apply` saw `rm cannot remove DIRECTORY` errors. Old log directories are now removed without reporting errors. - - | - After an initial reboot, the appliance sometimes altered the ownership permissions of `gitmon` directories. As a result, the Management Console could hang at the "Starting" phase. - - | - The view for a repository's "top contributors" failed to render when when it received invalid parameters. - - | - Repository archive exports failed when the archive was more than 5 GiB. - - | - When users bypassed push protections for a file upload but did not re-add the file after the bypass was created, an incorrect error message displayed. - - | - The SAML SSO and SCIM identity of the user (actor) who performed the action, `external_identity_nameid`, was omitted from the metadata for audit log entries. - - | - If you unarchived a repository with secret scanning enabled and then enabled GitHub Advanced Security, the feature settings were incorrectly reported by security overview. Secret scanning was shown as disabled. - - | - `ghe-migrator` imports could fail due to attachments with invalid model types. - changes: - - | - To avoid service disruption, the bundled action `actions/setup-dotnet` uses new .NET CDN URLs. See https://github.com/dotnet/core/issues/9671. - - | - To avoid unnecessary error messages when users attempt to create a ruleset in evaluate mode in a repository that is user owned, we removed the evaluate mode option on the ruleset. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the instructions for [Replacing the primary database node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-database-node-mysql-or-mysql-and-mssql), `ghe-cluster-config-apply` might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 appliance onto a 3.13 appliance, the elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - {% data reusables.release-notes.2025-03-03-elasticsearch-data-loss %} - - [Updated: 2025-03-12] - - errata: - - | - These release notes previously indicated as a known issue that on GitHub Enterprise Server 3.14.7, repositories originally imported using `ghe-migrator` will not correctly track Advanced Security contributions. - - The fix for this problem was already included in GitHub Enterprise Server [3.12](/admin/release-notes#3.12.0-bugs). [Updated: 2025-04-11] diff --git a/data/release-notes/enterprise-server/3-14/8.yml b/data/release-notes/enterprise-server/3-14/8.yml deleted file mode 100644 index e3948b20b2fe..000000000000 --- a/data/release-notes/enterprise-server/3-14/8.yml +++ /dev/null @@ -1,91 +0,0 @@ -date: '2025-02-18' -intro: | - {% warning %} - - **Warning**: For instances installed on Google Cloud Platform (GCP), hotpatches to GitHub Enterprise Server version `3.14.8` will result in errors being reported in the upgrade log. We recommend hotpatching to a newer 3.14 version instead. [Updated: 2025-03-11] - - {% endwarning %} -sections: - security_fixes: - - | - **HIGH**: An attacker could access environment variables in the debug artifacts uploaded by the CodeQL action after a failed code scanning workflow run. This includes any secrets that were exposed to the workflow as environment variables. The attacker requires read access to the repository to access the debug artifact. Users who do not have debug logging enabled are unaffected. The impact to GitHub Enterprise Server users is limited to internal actors. To mitigate this issue, GitHub no longer logs the complete environment by default. GitHub has requested [CVE-2025-24362](https://www.cve.org/CVERecord?id=CVE-2025-24362) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). - - | - Packages have been updated to the latest security versions. - bugs: - - | - In some cluster configurations, it was not possible to enable GitHub Advanced Security in bulk. - - | - In certain cases, on an instance in a cluster configuration, secret scanning would fail to run due to misconfiguration of a Kafka service. - - | - In an instance in a high-availability or cluster configuration, administrators who updated the instance's license did not see the change reflected on the "Licenses" page in the UI. - - | - Audit log indices from 2018 could occasionally fail to be created when migrating to Elasticsearch 8. - - | - In some cases, a file in the code view would appear as JSON instead of HTML. - - | - Attachment records were not created when JWT tokens were included in user asset URLs on issues. - - | - When an administrator suspended a user from the site admin dashboard, the form required them to complete Digital Services Act (DSA) fields that are not relevant on GitHub Enterprise Server. - - | - Enterprise owners could not modify the "Outside collaborators" policy. Instead a `404 Not Found` response was returned. - - | - In cluster environments, API rate limits were calculated using the cluster node IP address instead of the client IP address. This could lead to incorrect rate limiting and the wrong IP address being recorded in audit log entries. - - | - The relative date for commits was sometimes incorrectly displayed in the web UI. - - | - Users were unable to open issues where the events timeline contained references to projects that were not moved over during a migration. Instead, the `500` error page was displayed. - - | - Users who had authenticated to multiple accounts, then logged out of one account, were unable to switch to a different account on the platform. - - | - Certain search terms for repositories and wikis did not return all valid results. - - | - In some cluster configurations, secret scanning failed to run normally due to connection failures. - - | - Images were not migrated properly when using {% data variables.product.prodname_importer %} to import repositories from {% data variables.product.prodname_ghe_server %}. - changes: - - | - Log files on the appliance root disk are compressed immediately upon rotation daily instead of after a 24 hour delay. You can revert to the previous `delaycompress` behavior by signing in as an SSH admin user, setting `ghe-config logrotate.delaycompress true` and then running `ghe-config-apply`. - - | - The CodeQL Action has been updated to v3.28.6 to enable uploading artifacts in debug mode without logging the complete environment when running CodeQL CLI v2.20.3+. - - | - The `ghe-live-migrations --init-target` command fails with a descriptive error message if the specified upgrade path is not supported. - known_issues: - - | - {% data reusables.release-notes.2025-02-gcp-hotpatch-bug %} [Updated: 2025-03-11] - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the instructions for [Replacing the primary database node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-database-node-mysql-or-mysql-and-mssql), `ghe-cluster-config-apply` might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 appliance onto a 3.13 appliance, the elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - {% data reusables.release-notes.2025-03-03-elasticsearch-data-loss %} - - [Updated: 2025-03-12] - errata: - - | - The warning and known issues section have been updated to accurately reflect that instances installed on GCP will face issues while hotpatching to 3.14.8. Previously, the warning and known issue indicated that customers would face issues either while upgrading or hotpatching to version 3.14.8. [Updated: 2025-03-11] - - | - These release notes previously indicated as a known issue that on GitHub Enterprise Server 3.14.1, repositories originally imported using `ghe-migrator` will not correctly track Advanced Security contributions. - - The fix for this problem was already included in GitHub Enterprise Server [3.12](/admin/release-notes#3.12.0-bugs). [Updated: 2025-04-11] diff --git a/data/release-notes/enterprise-server/3-14/9.yml b/data/release-notes/enterprise-server/3-14/9.yml deleted file mode 100644 index dd637edbed3a..000000000000 --- a/data/release-notes/enterprise-server/3-14/9.yml +++ /dev/null @@ -1,70 +0,0 @@ -date: '2025-03-04' -sections: - features: - - | - Running {% data variables.product.prodname_ghe_server %} on the VMware ESXi 8.0 hypervisor is supported. If your installation is on VMware ESXi 7.x or earlier versions, you can now use the ESXi 8.0 hypervisor. [Updated: 2025-04-03] - security_fixes: - - | - Permissions and ownership of `/etc/ssh/sshd_config` are now enforced so that the `root` identity is the only one able to read or write to the file. - - | - Packages have been updated to the latest security versions. - bugs: - - | - Some instances with self-signed certificates encountered duplicated IP and DNS entries in their certificate. - - | - During an upgrade, encrypted record diagnostics would incorrectly flag 2FA records without associated users as undecryptable, causing misleading or unactionable error messages. In addition, in a high-availability or cluster configuration, encrypted record diagnostics were run unnecessarily on nodes other than the MySQL primary, and the resulting prompt from these diagnostics did not honor the `-y` flag. - - | - An issue with the webhook delivery system could cause missing commits on pull requests and stop GitHub Actions workflows from running reliably on certain triggers. A database replication delay in the webhook delivery system has been removed. - - | - When a pre-receive hook blocked users from making a commit in the UI, the error message did not display any `echo` messages specified in the pre-receive hook script. - - | - When users requested large amounts of data from certain API endpoints, such as [List organization repositories](/rest/repos/repos#list-organization-repositories), they sometimes received a `500` error. - - | - Domain entries could fail to load in the "Verified & Approves Domains" section of the site admin dashboard if one or more authoritative nameservers for the affected domain was unreachable or unresponsive. - - | - Team avatars and descriptions did not always appear on the team's page. - - | - Some packages failed to install when a hotpatch was applied to instances hosted on Google Cloud Platform. - changes: - - | - The `ghe-check-disk-usage` command has been updated to provide more valuable insights into troubleshooting disk space issues on the root and data disks. - - | - A graph for visualizing the status of repository maintenance has been added to the management console. - known_issues: - - | - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. - - | - If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account). - - | - On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. - - | - {% data reusables.release-notes.large-adoc-files-issue %} - - | - Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. - - | - When following the instructions for [Replacing the primary database node](/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-database-node-mysql-or-mysql-and-mssql), `ghe-cluster-config-apply` might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. - - | - Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. - - | - {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} - - | - When restoring data originally backed up from a 3.13 or greater appliance version, the elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. - - | - An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. - - | - In the header bar displayed to site administrators, some icons are not available. - - | - When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. - - | - When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. - - | - {% data reusables.release-notes.2025-03-03-elasticsearch-data-loss %} - - [Updated: 2025-03-19] - - | - After a restore, existing outside collaborators are unable to be added to repositories in a new organization. This issue can be resolved by running `/usr/local/share/enterprise/ghe-es-search-repair` on the appliance. - - | - After a geo-replica is promoted to be a primary by running `ghe-repl-promote`, the actions workflow of a repository does not have any suggested workflows. - errata: - - | - The release notes previously did not mention VMware ESXi 8.0 support. [Updated: 2025-04-02] diff --git a/data/reusables/advanced-security/secret-scanning-new-custom-pattern-org.md b/data/reusables/advanced-security/secret-scanning-new-custom-pattern-org.md index 70698ffe0f69..0a6304db4da0 100644 --- a/data/reusables/advanced-security/secret-scanning-new-custom-pattern-org.md +++ b/data/reusables/advanced-security/secret-scanning-new-custom-pattern-org.md @@ -1 +1 @@ -{% ifversion security-configurations %}1. Under "Custom patterns", click **New pattern**.{% else %}1. Under "Secret scanning", under "Custom patterns", click **New pattern**.{% endif %} +1. Under "Custom patterns", click **New pattern**. diff --git a/data/reusables/dependabot/dependabot-grouped-security-updates-how-enable.md b/data/reusables/dependabot/dependabot-grouped-security-updates-how-enable.md index bfe12e081dce..b031848a2e02 100644 --- a/data/reusables/dependabot/dependabot-grouped-security-updates-how-enable.md +++ b/data/reusables/dependabot/dependabot-grouped-security-updates-how-enable.md @@ -1,4 +1,4 @@ You can enable grouped pull requests for {% data variables.product.prodname_dependabot_security_updates %} in one, or both, of the following ways. -* To group as many available security updates together as possible, across directories and per ecosystem, enable grouping in the "{% data variables.product.UI_advanced_security %}" settings for your repository{% ifversion pre-security-configurations %}or organization{% elsif security-configurations %}, or in "Global settings" under {% data variables.product.UI_advanced_security %} for your organization{% endif %}. +* To group as many available security updates together as possible, across directories and per ecosystem, enable grouping in the "{% data variables.product.UI_advanced_security %}" settings for your repository, or in "Global settings" under {% data variables.product.UI_advanced_security %} for your organization. * For more granular control of grouping, such as grouping by package name, development/production dependencies, SemVer level, or across multiple directories per ecosystem, add configuration options to the `dependabot.yml` configuration file in your repository. diff --git a/data/reusables/dependabot/supported-package-managers.md b/data/reusables/dependabot/supported-package-managers.md index b99fc30672cc..60cc2a7865ac 100644 --- a/data/reusables/dependabot/supported-package-managers.md +++ b/data/reusables/dependabot/supported-package-managers.md @@ -8,9 +8,9 @@ Bazel | `bazel` | v7, v8, v9 | {% octicon "check" aria-labe | {% ifversion dependabot-bun-support %} | [Bun](#bun) | `bun` | >=v1.1.39 | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | | {% endif %} | -Bundler | `bundler` | {% ifversion ghes < 3.15 %}v1, {% endif %}v2 | {% octicon "check" aria-label="Supported" %}| {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | +Bundler | `bundler` | v2 | {% octicon "check" aria-label="Supported" %}| {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | [Cargo](#cargo) | `cargo` | v1 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | -Composer | `composer` | {% ifversion dependabot-updates-composerv1-closing-down %}v2{% else %}v1, v2{% endif %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | +Composer | `composer` | v2 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | | {% ifversion dependabot-conda-support %} | [Conda](#conda) | `conda` | Not applicable | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | | {% endif %} | @@ -37,14 +37,14 @@ Go modules | `gomod` | v1 | {% octicon "check" aria-l [Nix](#nix) | `nix` | Not applicable | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | Not applicable | Not applicable | | {% endif %} | npm | `npm` | v7, v8, v9, v10, v11 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | -[NuGet](#nuget-cli) | `nuget` | {% ifversion fpt or ghec or ghes > 3.14 %}<=6.12.0{% endif %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | +[NuGet](#nuget-cli) | `nuget` | <=6.12.0 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | | {% ifversion dependabot-opentofu-support %} | [OpenTofu](#opentofu) | `opentofu` | Not applicable | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | Not applicable | | {% endif %} | [pip](#pip-and-pip-compile) | `pip` | 24.2 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | pipenv | `pip` | 2024.4.1 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | [pip-compile](#pip-and-pip-compile) | `pip` | 7.5.3 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | -| {% ifversion dependabot-updates-pnpmv9-support %}pnpm{% else %}[pnpm](#pnpm){% endif %} | `npm` | v7, v8, v9, v10 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} {% ifversion dependabot-updates-pnpmv9-support %}{% else %}(v7 and v8 only){% endif %}| {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | +| pnpm | `npm` | v7, v8, v9, v10 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | [poetry](#poetry) | `pip` | v2 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | | {% ifversion dependabot-pre-commit-support %} | [pre-commit](#pre-commit) | `pre-commit` | Not applicable | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | @@ -187,15 +187,6 @@ When configuring {% data variables.product.prodname_dependabot %} for Helm chart In addition, {% data variables.product.prodname_dependabot %} supports updates to `pyproject.toml` files if they follow the PEP 621 standard. -{% ifversion dependabot-updates-pnpmv9-support %} - -{% else %} - -### pnpm - -pnpm is supported for {% data variables.product.prodname_dependabot_version_updates %} (on v7, v8, v9, v10) and {% data variables.product.prodname_dependabot_security_updates %} (on v7 and v8 only). -{% endif %} - ### poetry {% data variables.product.prodname_dependabot %} supports Poetry v2.{% ifversion dependabot-poetry-pep621 %}{% else %} The PEP 621 `project` section isn't currently supported for `poetry`.{% endif %} diff --git a/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md b/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md index 228485cc4c86..c3986e83f4f1 100644 --- a/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md +++ b/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md @@ -6,7 +6,7 @@ We recommend different hardware configurations depending on the number of user licenses for {% data variables.location.product_location %}. If you provision more resources than the minimum recommended requirements, your instance will perform and scale better. -{% ifversion ghes > 3.14 %}{% data reusables.enterprise_installation.hardware-rec-table %}{% else %}{% data reusables.enterprise_installation.hardware-rec-table-legacy %}{% endif %} +{% ifversion ghes %}{% data reusables.enterprise_installation.hardware-rec-table %}{% else %}{% data reusables.enterprise_installation.hardware-rec-table-legacy %}{% endif %} {% data reusables.actions.more-resources-for-ghes %} @@ -21,7 +21,7 @@ We recommend a high-performance SSD with high input/output operations per second Your instance requires a persistent data disk separate from the root disk. For more information, see [AUTOTITLE](/admin/overview/system-overview). >[!WARNING] ->Root storage refers to the total size of your instance's root disk. When the instance is booted you will see {% ifversion ghes > 3.14 %}200GB available on the root filesystem. The remaining 200GB{% else %}100GB available on the root filesystem. The remaining 100GB{% endif %} is reserved for upgrades. For more information, see [AUTOTITLE](/admin/overview/system-overview#storage-architecture). +>Root storage refers to the total size of your instance's root disk. When the instance is booted you will see {% ifversion ghes %}200GB available on the root filesystem. The remaining 200GB{% else %}100GB available on the root filesystem. The remaining 100GB{% endif %} is reserved for upgrades. For more information, see [AUTOTITLE](/admin/overview/system-overview#storage-architecture). {% ifversion ghes %} diff --git a/data/reusables/github-connect/rate-limit-live-dotcom-requests.md b/data/reusables/github-connect/rate-limit-live-dotcom-requests.md index bce14877ac2e..9d4b50a5f956 100644 --- a/data/reusables/github-connect/rate-limit-live-dotcom-requests.md +++ b/data/reusables/github-connect/rate-limit-live-dotcom-requests.md @@ -2,7 +2,6 @@ The `app.github.web-sockets-rate-limit` configuration setting was introduced in -{%- ifversion ghes = 3.14 %} **3.14.13**{%- endif %} {%- ifversion ghes = 3.15 %} **3.15.8**{%- endif %} {%- ifversion ghes = 3.16 %} **3.16.4**{%- endif %} {%- ifversion ghes = 3.17 %} **3.17.1**{%- endif %}. diff --git a/data/reusables/github-connect/what-is-available-ghecom.md b/data/reusables/github-connect/what-is-available-ghecom.md index 58de1991215a..0222d6f7e7dc 100644 --- a/data/reusables/github-connect/what-is-available-ghecom.md +++ b/data/reusables/github-connect/what-is-available-ghecom.md @@ -2,7 +2,5 @@ If you're connecting to an enterprise on **{% data variables.enterprise.data_residency_site %}**: * Server Statistics is not available. * {% data variables.product.prodname_dotcom_the_website %} actions are not available. -{%- ifversion ghes < 3.15 %} -* To use automatic user license sync, you must upgrade to {% data variables.product.prodname_ghe_server %} version 3.15 or later. -{%- endif %} + {% endif %} diff --git a/data/reusables/organizations/custom-org-roles-settings-step.md b/data/reusables/organizations/custom-org-roles-settings-step.md index f55e801afea4..71a49d2ad74d 100644 --- a/data/reusables/organizations/custom-org-roles-settings-step.md +++ b/data/reusables/organizations/custom-org-roles-settings-step.md @@ -1 +1 @@ -1. In the "Access" section of the sidebar, click **{% octicon "organization" aria-hidden="true" aria-label="organization" %} Organization roles**, then click {% ifversion org-pre-defined-roles %}**Role management**{% else %}**Custom roles**{% endif %}. +1. In the "Access" section of the sidebar, click **{% octicon "organization" aria-hidden="true" aria-label="organization" %} Organization roles**, then click **Role management**. diff --git a/data/reusables/secret-scanning/beta-prs-discussions-wikis-scanned.md b/data/reusables/secret-scanning/beta-prs-discussions-wikis-scanned.md deleted file mode 100644 index 858d24fb8b3c..000000000000 --- a/data/reusables/secret-scanning/beta-prs-discussions-wikis-scanned.md +++ /dev/null @@ -1,6 +0,0 @@ -{% ifversion ghes < 3.15 %} - -> [!NOTE] -> The scanning of content in pull requests and {% data variables.product.prodname_discussions %} is currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endif %} diff --git a/data/reusables/secret-scanning/what-is-scanned.md b/data/reusables/secret-scanning/what-is-scanned.md index 340d7f98cf20..c69bcbfd86b9 100644 --- a/data/reusables/secret-scanning/what-is-scanned.md +++ b/data/reusables/secret-scanning/what-is-scanned.md @@ -5,4 +5,3 @@ * Wikis{% endif %} * Secret gists -{% data reusables.secret-scanning.beta-prs-discussions-wikis-scanned %} diff --git a/data/reusables/security/note-securing-your-org.md b/data/reusables/security/note-securing-your-org.md index 0a476d84341a..2f66f633d012 100644 --- a/data/reusables/security/note-securing-your-org.md +++ b/data/reusables/security/note-securing-your-org.md @@ -1 +1 @@ -For more information about enabling security features across an organization, see {% ifversion security-configurations %}[AUTOTITLE](/code-security/securing-your-organization).{% else %}[AUTOTITLE](/code-security/getting-started/quickstart-for-securing-your-organization).{% endif %} +For more information about enabling security features across an organization, see [AUTOTITLE](/code-security/securing-your-organization). diff --git a/data/variables/code-scanning.yml b/data/variables/code-scanning.yml index a8dcb48b8935..cfba35db13f2 100644 --- a/data/variables/code-scanning.yml +++ b/data/variables/code-scanning.yml @@ -7,7 +7,7 @@ codeql_workflow: 'CodeQL analysis workflow' tool_status_page: 'tool status page' # List of compiled languages supported for `no-build` extraction -no_build_support: '{% ifversion codeql-no-build-c-cpp %}C/C++, {% endif %}{% ifversion codeql-no-build-csharp %}C#{% ifversion codeql-rust-available %},{% else %} and{% endif %}{% endif %} Java{% ifversion codeql-rust-available %} and Rust{% endif %}' +no_build_support: '{% ifversion codeql-no-build-c-cpp %}C/C++, {% endif %}C#{% ifversion codeql-rust-available %},{% else %} and{% endif %} Java{% ifversion codeql-rust-available %} and Rust{% endif %}' # All compiled languages supported for `autobuild` extraction autobuild_support: 'C/C++, C#, Go, Java, Kotlin, and Swift' @@ -22,7 +22,7 @@ compiled_languages: 'C/C++, C#, Go, Java, Kotlin, {% ifversion codeql-rust-avail codeql_model_packs_support: 'C/C++, C#, Java/Kotlin, Python, {% ifversion codeql-rust-available %}Ruby, and Rust{% else %}and Ruby{% endif %}' # List of languages that the model editor in the CodeQL extension for VS Code supports -codeql_model_editor_support: '{% ifversion fpt or ghec or ghes > 3.14 %} C#, Java/Kotlin, Python, and Ruby{% elsif ghes %}C#, Java/Kotlin, and Ruby{% endif %}' +codeql_model_editor_support: 'C#, Java/Kotlin, Python, and Ruby' # List of that allow threat models to be configurable for code scanning code_scanning_threat_model_support: 'Java/Kotlin and C#' diff --git a/data/variables/product.yml b/data/variables/product.yml index 73083b3329c6..b0f41e1461f9 100644 --- a/data/variables/product.yml +++ b/data/variables/product.yml @@ -96,7 +96,7 @@ prodname_codeql_cli: 'CodeQL CLI' # CodeQL usually bumps its minor version for each minor version of GHES. # Update this whenever a new enterprise version of CodeQL is being prepared. codeql_cli_ghes_recommended_version: >- - {% ifversion ghes < 3.15 %}2.17.6{% elsif ghes < 3.16 %}2.18.4{% elsif ghes < 3.17 %}2.20.3{% elsif ghes < 3.18 %}2.20.7{% elsif ghes < 3.19 %}2.21.4{% elsif ghes < 3.20 %}2.22.4{% elsif ghes < 3.21 %}2.23.9{% endif %} + {% ifversion ghes < 3.16 %}2.18.4{% elsif ghes < 3.17 %}2.20.3{% elsif ghes < 3.18 %}2.20.7{% elsif ghes < 3.19 %}2.21.4{% elsif ghes < 3.20 %}2.22.4{% elsif ghes < 3.21 %}2.23.9{% endif %} codeql_cli_version_min_version_create_bundle: '2.17.6' # Projects v2 prodname_projects_v2: 'Projects' @@ -149,7 +149,7 @@ prodname_unfurls: 'Content Attachments' prodname_actions: 'GitHub Actions' prodname_actions_runner_controller: 'Actions Runner Controller' runner_required_version: >- - {% ifversion ghes < 3.15 %}2.317.0{% elsif ghes < 3.16 %}2.319.1{% elsif ghes < 3.17 %}2.321.0{% elsif ghes < 3.18 %}2.322.0{% elsif ghes < 3.19 %}2.324.0{% elsif ghes < 3.20 %}2.328.0{% elsif ghes < 3.21 %}2.330.0{% endif %} + {% ifversion ghes < 3.16 %}2.319.1{% elsif ghes < 3.17 %}2.321.0{% elsif ghes < 3.18 %}2.322.0{% elsif ghes < 3.19 %}2.324.0{% elsif ghes < 3.20 %}2.328.0{% elsif ghes < 3.21 %}2.330.0{% endif %} # GitHub Debug prodname_debug: 'GitHub Debug' diff --git a/src/audit-logs/data/ghes-3.14/enterprise.json b/src/audit-logs/data/ghes-3.14/enterprise.json deleted file mode 100644 index ce1e81f99085..000000000000 --- a/src/audit-logs/data/ghes-3.14/enterprise.json +++ /dev/null @@ -1,24512 +0,0 @@ -[ - { - "action": "account.billing_date_change", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "account.plan_change", - "description": "The account's plan changed.", - "docs_reference_links": "/billing/managing-the-plan-for-your-github-account/about-billing-for-plans", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "How GitHub billing works" - }, - { - "action": "account_recovery_token.confirm", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "account_recovery_token.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "account_recovery_token.recover", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "actions_cache.delete", - "description": "A GitHub Actions cache was deleted using the REST API.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "actions_cache_id", - "actions_cache_key", - "actions_cache_version", - "actions_cache_scope", - "created_at", - "operation_type" - ] - }, - { - "action": "api.request", - "description": "An API request was made to an endpoint for the enterprise, or an enterprise owned resource. This event is only included if API Request Events is enabled in the enterprise's audit log settings. This event is only available via audit log streaming.", - "docs_reference_links": "/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise#enabling-audit-log-streaming-of-api-requests", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "request_method", - "query_string", - "request_body", - "status_code", - "url_path", - "public_repo", - "created_at", - "operation_type", - "route", - "rate_limit_remaining", - "actor_is_bot" - ], - "docs_reference_titles": "Streaming the audit log for your enterprise" - }, - { - "action": "artifact.destroy", - "description": "A workflow run artifact was manually deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "audit_log_streaming.check", - "description": "A manual check of the endpoint configured for audit log streaming was performed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "audit_log_stream_result", - "created_at", - "operation_type", - "audit_log_stream_sink_details" - ] - }, - { - "action": "audit_log_streaming.create", - "description": "An endpoint was added for audit log streaming.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "audit_log_stream_sink", - "created_at", - "operation_type", - "audit_log_stream_id" - ] - }, - { - "action": "audit_log_streaming.destroy", - "description": "An audit log streaming endpoint was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "audit_log_stream_id", - "audit_log_stream_sink_details" - ] - }, - { - "action": "audit_log_streaming.update", - "description": "An endpoint configuration was updated for audit log streaming, such as the stream was paused, enabled, or disabled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "audit_log_stream_enabled", - "audit_log_stream_sink", - "created_at", - "operation_type", - "new_s3_bucket", - "old_s3_bucket", - "secrets_updated", - "new_s3_arn_role", - "old_s3_arn_role", - "new_azure_blob_container", - "old_azure_blob_container", - "new_event_hub_instance", - "old_event_hub_instance", - "new_splunk_domain", - "old_splunk_domain", - "ssl_verify", - "old_gc_bucket" - ] - }, - { - "action": "billing.change_billing_type", - "description": "The way the account pays for GitHub was changed.", - "docs_reference_links": "/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing your payment and billing information" - }, - { - "action": "billing.change_email", - "description": "The billing email address changed.", - "docs_reference_links": "/billing/managing-your-github-billing-settings/setting-your-billing-email", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "email" - ], - "docs_reference_titles": "Managing your payment and billing information" - }, - { - "action": "billing.lock", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "operation_type", - "created_at" - ] - }, - { - "action": "billing.unlock", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "billing.update_bill_cycle_day", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "business.add_admin", - "description": "An enterprise owner was added to an enterprise.", - "docs_reference_links": "/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Inviting people to manage your enterprise" - }, - { - "action": "business.add_organization", - "description": "An organization was added to an enterprise.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "name", - "created_at", - "organization_upgrade" - ] - }, - { - "action": "business_advanced_security.disabled", - "description": "GitHub Advanced Security was disabled for your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business_advanced_security.disabled_for_new_repos", - "description": "GitHub Advanced Security was disabled for new repositories in your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business_advanced_security.disabled_for_new_user_namespace_repos", - "description": "GitHub Advanced Security was disabled for new user namespace repositories in your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business_advanced_security.enabled", - "description": "GitHub Advanced Security was enabled for your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business_advanced_security.enabled_for_new_repos", - "description": "GitHub Advanced Security was enabled for new repositories in your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business_advanced_security.enabled_for_new_user_namespace_repos", - "description": "GitHub Advanced Security was enabled for new user namespace repositories in your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business.advanced_security_policy_update", - "description": "An enterprise owner created, updated, or removed a policy for GitHub Advanced Security.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "new_policy", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Enforcing policies for code security and analysis for your enterprise" - }, - { - "action": "business.advanced_security_repo_admin_enablement_policy_update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "new_policy", - "created_at", - "operation_type" - ] - }, - { - "action": "business_advanced_security.user_namespace_repos_disabled", - "description": "GitHub Advanced Security was disabled for user namespace repositories in your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business_advanced_security.user_namespace_repos_enabled", - "description": "GitHub Advanced Security was enabled for user namespace repositories in your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business.clear_actions_settings", - "description": "An enterprise owner or site administrator cleared GitHub Actions policy settings for an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Enforcing policies for GitHub Actions in your enterprise" - }, - { - "action": "business.clear_default_repository_permission", - "description": "An enterprise owner cleared the base repository permission policy setting for an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-base-repository-permissions", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Enforcing repository management policies in your enterprise" - }, - { - "action": "business.clear_members_can_create_repos", - "description": "An enterprise owner cleared a restriction on repository creation in organizations in the enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#setting-a-policy-for-repository-creation", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "visibility", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enforcing repository management policies in your enterprise" - }, - { - "action": "business.code_scanning_autofix_policy_update", - "description": "The policy for Code scanning autofix was updated for an enterprise.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "new_policy", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "business.create", - "description": "An enterprise was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at" - ] - }, - { - "action": "business_dependabot_alerts_new_repos.disable", - "description": "Dependabot alerts were disabled for new repositories in your enterprise.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "business_dependabot_alerts_new_repos.enable", - "description": "Dependabot alerts were enabled for new repositories in your enterprise.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "business.dependabot_alerts_repo_admin_enablement_policy_update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "new_policy", - "created_at", - "operation_type" - ] - }, - { - "action": "business.disable_open_scim", - "description": "SCIM provisioning for custom integrations that use the REST API was disabled for the enterprise.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "business.disable_source_ip_disclosure", - "description": "Display of IP addresses within audit log events for the enterprise was disabled.", - "docs_reference_links": "/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Displaying IP addresses in the audit log for your enterprise" - }, - { - "action": "business.disable_two_factor_requirement", - "description": "The requirement for members to have two-factor authentication enabled to access an enterprise was disabled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "name" - ] - }, - { - "action": "business.enable_open_scim", - "description": "SCIM provisioning for custom integrations that use the REST API was enabled for the enterprise.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "business.enable_source_ip_disclosure", - "description": "Display of IP addresses within audit log events for the enterprise was enabled.", - "docs_reference_links": "/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Displaying IP addresses in the audit log for your enterprise" - }, - { - "action": "business.enable_two_factor_requirement", - "description": "The requirement for members to have two-factor authentication enabled to access an enterprise was enabled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "name" - ] - }, - { - "action": "business.members_can_update_protected_branches.clear", - "description": "An enterprise owner unset a policy for whether members of an enterprise can update protected branches on repositories for individual organizations. Organization owners can choose whether to allow updating protected branches settings.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "name", - "operation_type" - ] - }, - { - "action": "business.members_can_update_protected_branches.disable", - "description": "The ability for enterprise members to update branch protection rules was disabled. Only enterprise owners can update protected branches.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at" - ] - }, - { - "action": "business.members_can_update_protected_branches.enable", - "description": "The ability for enterprise members to update branch protection rules was enabled. Enterprise owners and members can update protected branches.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at" - ] - }, - { - "action": "business.remove_admin", - "description": "An enterprise owner was removed from an enterprise.", - "docs_reference_links": "/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "name" - ], - "docs_reference_titles": "Inviting people to manage your enterprise" - }, - { - "action": "business.remove_organization", - "description": "An organization was removed from an enterprise.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "name" - ] - }, - { - "action": "business.rename_slug", - "description": "The slug for the enterprise URL was renamed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at" - ] - }, - { - "action": "business.revoke_sso_session", - "description": "The SAML single sign-on session for a member in an enterprise was revoked.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "name", - "created_at" - ] - }, - { - "action": "business_secret_scanning_automatic_validity_checks.disabled", - "description": "Automatic partner validation checks have been disabled at the business level", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise#managing-advanced-security-features", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business_secret_scanning_automatic_validity_checks.enabled", - "description": "Automatic partner validation checks have been enabled at the business level", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise#managing-advanced-security-features", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business_secret_scanning_custom_pattern.create", - "description": "An enterprise-level custom pattern was created for secret scanning.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-enterprise-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "business_secret_scanning_custom_pattern.delete", - "description": "An enterprise-level custom pattern was removed from secret scanning.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "business_secret_scanning_custom_pattern.publish", - "description": "An enterprise-level custom pattern was published for secret scanning.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "business_secret_scanning_custom_pattern_push_protection.disabled", - "description": "Push protection for a custom pattern for secret scanning was disabled for your enterprise.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-enterprise-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "business_secret_scanning_custom_pattern_push_protection.enabled", - "description": "Push protection for a custom pattern for secret scanning was enabled for your enterprise.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-enterprise-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "business_secret_scanning_custom_pattern.update", - "description": "Changes to an enterprise-level custom pattern were saved and a dry run was executed for secret scanning.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "business_secret_scanning.disable", - "description": "Secret scanning was disabled for your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business_secret_scanning.disabled_for_new_repos", - "description": "Secret scanning was disabled for new repositories in your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business_secret_scanning.enable", - "description": "Secret scanning was enabled for your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business_secret_scanning.enabled_for_new_repos", - "description": "Secret scanning was enabled for new repositories in your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business_secret_scanning_non_provider_patterns.disabled", - "description": "Secret scanning for non-provider patterns was disabled at the enterprise level.", - "docs_reference_links": "/code-security/secret-scanning/secret-scanning-patterns#non-provider-patterns", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Supported secret scanning patterns" - }, - { - "action": "business_secret_scanning_non_provider_patterns.enabled", - "description": "Secret scanning for non-provider patterns was enabled at the enterprise level.", - "docs_reference_links": "/code-security/secret-scanning/secret-scanning-patterns#non-provider-patterns", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Supported secret scanning patterns" - }, - { - "action": "business_secret_scanning_push_protection_custom_message.disable", - "description": "The custom message triggered by an attempted push to a push-protected repository was disabled for your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business_secret_scanning_push_protection_custom_message.enable", - "description": "The custom message triggered by an attempted push to a push-protected repository was enabled for your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business_secret_scanning_push_protection_custom_message.update", - "description": "The custom message triggered by an attempted push to a push-protected repository was updated for your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business_secret_scanning_push_protection.disable", - "description": "Push protection for secret scanning was disabled for your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business_secret_scanning_push_protection.disabled_for_new_repos", - "description": "Push protection for secret scanning was disabled for new repositories in your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business_secret_scanning_push_protection.enable", - "description": "Push protection for secret scanning was enabled for your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business_secret_scanning_push_protection.enabled_for_new_repos", - "description": "Push protection for secret scanning was enabled for new repositories in your enterprise.", - "docs_reference_links": "/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing GitHub Advanced Security features for your enterprise" - }, - { - "action": "business.secret_scanning_repo_admin_settings_policy_update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "new_policy", - "created_at", - "operation_type" - ] - }, - { - "action": "business.set_actions_fork_pr_approvals_policy", - "description": "The policy for requiring approvals for workflows from public forks was changed for an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-fork-pull-requests-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "policy", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enforcing policies for GitHub Actions in your enterprise" - }, - { - "action": "business.set_actions_private_fork_pr_approvals_policy", - "description": "The policy for requiring approval for fork pull request workflows from collaborators without write access to private repos was changed for an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-fork-pull-requests-in-private-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "policy", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enforcing policies for GitHub Actions in your enterprise" - }, - { - "action": "business.set_actions_retention_limit", - "description": "The retention period for GitHub Actions artifacts and logs was changed for an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-artifact-and-log-retention-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "limit", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Enforcing policies for GitHub Actions in your enterprise" - }, - { - "action": "business.set_default_workflow_permissions", - "description": "The default permissions granted to the GITHUB_TOKEN when running workflows were changed for an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enforcing policies for GitHub Actions in your enterprise" - }, - { - "action": "business.set_fork_pr_workflows_policy", - "description": "The policy for fork pull request workflows was changed for an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-fork-pull-requests-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "policy", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Enforcing policies for GitHub Actions in your enterprise" - }, - { - "action": "business.set_workflow_permission_can_approve_pr", - "description": "The policy for allowing GitHub Actions to create and approve pull requests was changed for an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#preventing-github-actions-from-creating-or-approving-pull-requests", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enforcing policies for GitHub Actions in your enterprise" - }, - { - "action": "business.sso_response", - "description": "A SAML single sign-on (SSO) response was generated when a member attempted to authenticate with your enterprise. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "issuer", - "name", - "created_at", - "operation_type" - ] - }, - { - "action": "business.update_actions_settings", - "description": "An enterprise owner or site administrator updated GitHub Actions policy settings for an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at", - "updated_github_owned_allowed", - "updated_verified_allowed", - "updated_patterns", - "new_policy", - "old_policy", - "updated_access_policy" - ], - "docs_reference_titles": "Enforcing policies for GitHub Actions in your enterprise" - }, - { - "action": "business.update_default_repository_permission", - "description": "The base repository permission setting was updated for all organizations in an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-base-repository-permissions", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "permission", - "created_at", - "name", - "old_permission" - ], - "docs_reference_titles": "Enforcing repository management policies in your enterprise" - }, - { - "action": "business.update_member_repository_creation_permission", - "description": "The repository creation setting was updated for an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-repository-creation", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "name", - "operation_type", - "permission", - "visibility" - ], - "docs_reference_titles": "Enforcing repository management policies in your enterprise" - }, - { - "action": "business.update_member_repository_invitation_permission", - "description": "The policy setting for enterprise members inviting outside collaborators to repositories was updated.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "permission", - "name" - ], - "docs_reference_titles": "Enforcing repository management policies in your enterprise" - }, - { - "action": "checks.auto_trigger_disabled", - "description": "Automatic creation of check suites was disabled on a repository in the organization or enterprise.", - "docs_reference_links": "/rest/checks#update-repository-preferences-for-check-suites", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/rest/checks#update-repository-preferences-for-check-suites" - }, - { - "action": "checks.auto_trigger_enabled", - "description": "Automatic creation of check suites was enabled on a repository in the organization or enterprise.", - "docs_reference_links": "/rest/checks#update-repository-preferences-for-check-suites", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "/rest/checks#update-repository-preferences-for-check-suites" - }, - { - "action": "checks.delete_logs", - "description": "Logs in a check suite were deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "codespaces.allow_permissions", - "description": "A codespace using custom permissions from its devcontainer.json file was launched.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "origin_repository", - "created_at", - "operation_type" - ] - }, - { - "action": "codespaces.connect", - "description": "Credentials for a codespace were refreshed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "owner", - "name", - "operation_type", - "created_at", - "public_repo", - "actor_is_bot", - "machine_type", - "devcontainer_path" - ] - }, - { - "action": "codespaces.create", - "description": "A codespace was created", - "docs_reference_links": "/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "owner", - "name", - "operation_type", - "created_at", - "actor_is_bot", - "machine_type", - "devcontainer_path" - ], - "docs_reference_titles": "Creating a codespace for a repository" - }, - { - "action": "codespaces.destroy", - "description": "A user deleted a codespace.", - "docs_reference_links": "/codespaces/developing-in-codespaces/deleting-a-codespace", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "owner", - "name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Deleting a codespace" - }, - { - "action": "codespaces.export_environment", - "description": "A codespace was exported to a branch on GitHub.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "owner", - "created_at", - "operation_type", - "public_repo" - ] - }, - { - "action": "codespaces.restore", - "description": "A codespace was restored.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "codespaces.start_environment", - "description": "A codespace was started.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "owner", - "pull_request_id", - "machine_type", - "devcontainer_path", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "codespaces.suspend_environment", - "description": "A codespace was stopped.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "codespaces.trusted_repositories_access_update", - "description": "A personal account's access and security setting for Codespaces were updated.", - "docs_reference_links": "/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing access to other repositories within your codespace" - }, - { - "action": "copilot.cfb_seat_added", - "description": "A Copilot Business or Copilot Enterprise seat was added for a user and they have received access to GitHub Copilot. This can occur as the result of directly assigning a seat for a user, assigning a seat for a team, or setting the organization to allow access for all members.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "copilot.cfb_seat_assignment_created", - "description": "A Copilot Business or Copilot Enterprise seat assignment was newly created for a user or a team, and seats are being created.", - "docs_reference_links": "/copilot/overview-of-github-copilot/about-github-copilot-for-business", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "What is GitHub Copilot?" - }, - { - "action": "copilot.cfb_seat_assignment_refreshed", - "description": "A seat assignment that was previously pending cancellation was re-assigned and the user will retain access to Copilot.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "copilot.cfb_seat_assignment_reused", - "description": "A Copilot Business or Copilot Enterprise seat assignment was re-created for a user who already had a seat with no pending cancellation date, and the user will retain access to Copilot.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "copilot.cfb_seat_assignment_unassigned", - "description": "A user or team's Copilot Business or Copilot Enterprise seat assignment was unassigned, and the user(s) will lose access to Copilot at the end of the current billing cycle.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "copilot.cfb_seat_cancelled", - "description": "A user's Copilot Business or Copilot Enterprise seat was canceled, and the user no longer has access to Copilot.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "seat_assignment" - ] - }, - { - "action": "copilot.cfb_seat_cancelled_by_staff", - "description": "A user's Copilot Business or Copilot Enterprise seat was canceled manually by GitHub staff, and the user no longer has access to Copilot.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "custom_hosted_runner.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "runner_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "custom_hosted_runner.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "custom_hosted_runner.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "runner_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "custom_property_definition.create", - "description": "A new custom property definition was created.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "property_name", - "created_at", - "operation_type", - "value_type", - "required", - "default_value", - "definition_id" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization" - }, - { - "action": "custom_property_definition.destroy", - "description": "A custom property definition was deleted.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "property_name", - "created_at", - "operation_type", - "value_type", - "required", - "default_value", - "definition_id", - "allowed_values" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization" - }, - { - "action": "custom_property_definition.update", - "description": "A custom property definition was updated.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "property_name", - "created_at", - "operation_type", - "value_type", - "required", - "default_value", - "old_allowed_values", - "allowed_values", - "definition_id", - "old_required", - "old_default_value", - "old_value_type", - "old_values_editable_by", - "values_editable_by" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization" - }, - { - "action": "custom_property_value.create", - "description": "A repository's custom property value was manually set for the first time.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "definition_id", - "property_name", - "value", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization" - }, - { - "action": "custom_property_value.destroy", - "description": "A repository's custom property value was deleted.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization" - }, - { - "action": "custom_property_value.update", - "description": "A repository's custom property value was updated.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "definition_id" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization" - }, - { - "action": "dependabot_alerts.disable", - "description": "Dependabot alerts were disabled for all existing repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories" - }, - { - "action": "dependabot_alerts.enable", - "description": "Dependabot alerts were enabled for all existing repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories" - }, - { - "action": "dependabot_alerts_new_repos.disable", - "description": "Dependabot alerts were disabled for all new repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-automatically-when-new-repositories-are-added", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-automatically-when-new-repositories-are-added" - }, - { - "action": "dependabot_alerts_new_repos.enable", - "description": "Dependabot alerts were enabled for all new repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-automatically-when-new-repositories-are-added", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-automatically-when-new-repositories-are-added" - }, - { - "action": "dependabot_repository_access.repositories_updated", - "description": "The repositories that Dependabot can access were updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "dependabot_security_updates.disable", - "description": "Dependabot security updates were disabled for all existing repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization" - }, - { - "action": "dependabot_security_updates.enable", - "description": "Dependabot security updates were enabled for all existing repositories.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "dependabot_security_updates_new_repos.disable", - "description": " Dependabot security updates were disabled for all new repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization" - }, - { - "action": "dependabot_security_updates_new_repos.enable", - "description": "Dependabot security updates were enabled for all new repositories.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "dependency_graph.disable", - "description": "The dependency graph was disabled for all existing repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization" - }, - { - "action": "dependency_graph.enable", - "description": "The dependency graph was enabled for all existing repositories.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "dependency_graph_new_repos.disable", - "description": "The dependency graph was disabled for all new repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization" - }, - { - "action": "dependency_graph_new_repos.enable", - "description": "The dependency graph was enabled for all new repositories.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "discussion_post.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "created_at", - "number", - "title", - "operation_type" - ] - }, - { - "action": "discussion_post_reply.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "number", - "created_at" - ] - }, - { - "action": "discussion_post_reply.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "number", - "team", - "created_at" - ] - }, - { - "action": "discussion_post.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "title", - "operation_type", - "team", - "number" - ] - }, - { - "action": "enterprise_announcement.create", - "description": "A global announcement banner was created for the enterprise.", - "docs_reference_links": "/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "owner_type", - "message", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Customizing user messages for your enterprise" - }, - { - "action": "enterprise_announcement.destroy", - "description": "A global announcement banner was removed from the enterprise.", - "docs_reference_links": "/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "owner_type", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Customizing user messages for your enterprise" - }, - { - "action": "enterprise_announcement.update", - "description": "A global announcement banner was updated for the enterprise.", - "docs_reference_links": "/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "owner_type", - "message", - "old_message", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Customizing user messages for your enterprise" - }, - { - "action": "enterprise.configure_self_hosted_jit_runner", - "description": "A new just-in-time GitHub Actions self-hosted runner was configured", - "docs_reference_links": "/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise" - }, - { - "action": "enterprise_domain.approve", - "description": "A domain was approved for an enterprise.", - "docs_reference_links": "/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise#approving-a-domain-for-your-enterprise-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner_type", - "domain_name", - "owner", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Verifying or approving a domain for your enterprise" - }, - { - "action": "enterprise_domain.create", - "description": "A domain was added to an enterprise.", - "docs_reference_links": "/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise#verifying-a-domain-for-your-enterprise-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "owner_type", - "domain_name", - "owner", - "operation_type" - ], - "docs_reference_titles": "Verifying or approving a domain for your enterprise" - }, - { - "action": "enterprise_domain.destroy", - "description": "A domain was removed from an enterprise.", - "docs_reference_links": "/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise#removing-an-approved-or-verified-domain", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "owner_type", - "domain_name", - "owner", - "operation_type" - ], - "docs_reference_titles": "Verifying or approving a domain for your enterprise" - }, - { - "action": "enterprise_domain.verify", - "description": "A domain was verified for an enterprise.", - "docs_reference_links": "/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise#verifying-a-domain-for-your-enterprise-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner_type", - "domain_name", - "owner", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Verifying or approving a domain for your enterprise" - }, - { - "action": "enterprise.register_self_hosted_runner", - "description": "A new GitHub Actions self-hosted runner was registered.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Adding self-hosted runners" - }, - { - "action": "enterprise.remove_self_hosted_runner", - "description": "A GitHub Actions self-hosted runner was removed.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Removing self-hosted runners" - }, - { - "action": "enterprise.runner_group_created", - "description": "A GitHub Actions self-hosted runner group was created.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_group_id", - "operation_type", - "created_at", - "runner_group_restricted_to_workflows" - ], - "docs_reference_titles": "Removing self-hosted runners" - }, - { - "action": "enterprise.runner_group_removed", - "description": "A GitHub Actions self-hosted runner group was removed.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_group_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing access to self-hosted runners using groups" - }, - { - "action": "enterprise.runner_group_runner_removed", - "description": "The REST API was used to remove a GitHub Actions self-hosted runner from a group.", - "docs_reference_links": "/rest/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "runner_group_id", - "runner_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/rest/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization" - }, - { - "action": "enterprise.runner_group_runners_added", - "description": "A GitHub Actions self-hosted runner was added to a group.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_group_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing access to self-hosted runners using groups" - }, - { - "action": "enterprise.runner_group_runners_updated", - "description": "A GitHub Actions runner group's list of members was updated.", - "docs_reference_links": "/rest/actions#set-self-hosted-runners-in-a-group-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "runner_group_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/rest/actions#set-self-hosted-runners-in-a-group-for-an-organization" - }, - { - "action": "enterprise.runner_group_updated", - "description": "The configuration of a GitHub Actions self-hosted runner group was changed.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_group_id", - "runner_group_name", - "runner_group_allow_public", - "operation_type", - "created_at", - "runner_group_restricted_to_workflows", - "runner_group_selected_workflow_refs", - "network_configuration_id" - ], - "docs_reference_titles": "Managing access to self-hosted runners using groups" - }, - { - "action": "enterprise.self_hosted_runner_offline", - "description": "The GitHub Actions runner application was stopped. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_id", - "runner_name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Monitoring and troubleshooting self-hosted runners" - }, - { - "action": "enterprise.self_hosted_runner_online", - "description": "The GitHub Actions runner application was started. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_id", - "runner_name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Monitoring and troubleshooting self-hosted runners" - }, - { - "action": "enterprise.self_hosted_runner_updated", - "description": "The GitHub Actions runner application was updated. This event is not included in the JSON/CSV export.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#about-self-hosted-runners", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_id", - "runner_name", - "source_version", - "target_version", - "runner_group_id", - "runner_group_name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Self-hosted runners" - }, - { - "action": "enterprise_team.add_member", - "description": "A new member was added to the enterprise team or an IdP group linked to an enterprise team, or an IdP group was linked to an enterprise team.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "enterprise_team_id", - "enterprise_team", - "created_at", - "operation_type" - ] - }, - { - "action": "enterprise_team.copilot_assignment", - "description": "A license for GitHub Copilot was assigned to an enterprise team.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "enterprise_team_id", - "enterprise_team", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "enterprise_team.copilot_unassignment", - "description": "A license for GitHub Copilot was unassigned from an enterprise team.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "enterprise_team_id", - "enterprise_team", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "enterprise_team.create", - "description": "A new enterprise team was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "enterprise_team_id", - "enterprise_team", - "created_at", - "operation_type" - ] - }, - { - "action": "enterprise_team.destroy", - "description": "An enterprise team was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "enterprise_team_id", - "enterprise_team", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "enterprise_team.remove_member", - "description": "A member was removed from the enterprise team or an IdP group linked to an enterprise team, or an IdP group was unlinked from an enterprise team.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "enterprise_team_id", - "enterprise_team", - "created_at", - "operation_type" - ] - }, - { - "action": "enterprise_team.rename", - "description": "The name of an enterprise team was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "enterprise_team_id", - "enterprise_team", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "environment.add_protection_rule", - "description": "A GitHub Actions deployment protection rule was created via the API.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "environment.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "environment_name", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "environment.create_actions_secret", - "description": "A secret was created for a GitHub Actions environment.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "key", - "visibility", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "environment.create_actions_variable", - "description": "A variable was created for a GitHub Actions environment.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-an-environment", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "environment_name", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "environment.delete", - "description": "An environment was deleted.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#deleting-an-environment", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at", - "public_repo", - "actor_is_bot" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "environment.remove_actions_secret", - "description": "A secret was deleted for a GitHub Actions environment.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "key", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "environment.remove_actions_variable", - "description": "A variable was deleted for a GitHub Actions environment.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-an-environment", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "environment_name", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "environment.remove_protection_rule", - "description": "A GitHub Actions deployment protection rule was deleted via the API.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "environment.update_actions_secret", - "description": "A secret was updated for a GitHub Actions environment.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "key", - "visibility", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "environment.update_actions_variable", - "description": "A variable was updated for a GitHub Actions environment.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-an-environment", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "environment_name", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "environment.update_protection_rule", - "description": "A GitHub Actions deployment protection rule was updated via the API.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "new_value", - "approvers_was", - "approvers", - "can_admins_bypass", - "prevent_self_review" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "external_group.add_member", - "description": "A user was added to an external group.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "external_group", - "external_group_id", - "created_at", - "operation_type", - "scim_group_id" - ] - }, - { - "action": "external_group.delete", - "description": "An external group was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "operation_type", - "created_at", - "scim_group_id" - ] - }, - { - "action": "external_group.link", - "description": "An external group was linked to a GitHub team.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "external_group_id", - "operation_type", - "created_at", - "external_group", - "scim_group_id" - ] - }, - { - "action": "external_group.provision", - "description": "An external group was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "operation_type", - "created_at" - ] - }, - { - "action": "external_group.remove_member", - "description": "A user was removed from an external group.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "external_group", - "external_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "external_group.scim_api_failure", - "description": "Failed external group SCIM API request.", - "docs_reference_links": "/rest/scim/scim", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "request_method", - "query_string", - "api_request_body", - "route", - "status_code", - "url_path", - "scim_group_id", - "message", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "REST API endpoints for SCIM" - }, - { - "action": "external_group.scim_api_success", - "description": "Successful external group SCIM API request. Excludes GET API requests.", - "docs_reference_links": "/rest/scim/scim", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "request_method", - "query_string", - "api_request_body", - "route", - "status_code", - "url_path", - "scim_group_id", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "REST API endpoints for SCIM" - }, - { - "action": "external_group.unlink", - "description": "An external group was unlinked to a GitHub team.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "external_group_id", - "operation_type", - "created_at", - "external_group" - ] - }, - { - "action": "external_group.update", - "description": "An external group was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "operation_type", - "created_at", - "scim_group_id" - ] - }, - { - "action": "external_group.update_display_name", - "description": "An external group's display name was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "external_group_id", - "external_group", - "created_at", - "operation_type", - "scim_group_id" - ] - }, - { - "action": "external_identity.deprovision", - "description": "An external identity was deprovisioned, suspending the linked GitHub user.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "operation_type", - "created_at" - ] - }, - { - "action": "external_identity.provision", - "description": "An external identity was created and linked to a GitHub user.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "scim_user_id" - ] - }, - { - "action": "external_identity.scim_api_failure", - "description": "Failed external identity SCIM API request.", - "docs_reference_links": "/rest/scim/scim", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "request_method", - "query_string", - "api_request_body", - "route", - "status_code", - "url_path", - "scim_user_id", - "message", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "REST API endpoints for SCIM" - }, - { - "action": "external_identity.scim_api_success", - "description": "Successful external identity SCIM API request. Excludes GET API requests.", - "docs_reference_links": "/rest/scim/scim", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "request_method", - "query_string", - "api_request_body", - "route", - "status_code", - "url_path", - "scim_user_id", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "REST API endpoints for SCIM" - }, - { - "action": "external_identity.update", - "description": "An external identity was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "scim_user_id" - ] - }, - { - "action": "gist.create", - "description": "A gist was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "gist_id", - "created_at", - "operation_type", - "visibility" - ] - }, - { - "action": "gist.destroy", - "description": "A gist was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "gist_id", - "visibility", - "created_at", - "operation_type" - ] - }, - { - "action": "gist.visibility_change", - "description": "The visibility of a gist was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "gist_id", - "visibility", - "created_at" - ] - }, - { - "action": "git.clone", - "description": "A repository was cloned. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "transport_protocol", - "repository_public", - "transport_protocol_name" - ] - }, - { - "action": "git.fetch", - "description": "Changes were fetched from a repository. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "transport_protocol", - "repository_public", - "transport_protocol_name" - ] - }, - { - "action": "git.push", - "description": "Changes were pushed to a repository. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "transport_protocol", - "repository_public", - "transport_protocol_name" - ] - }, - { - "action": "git_signing_ssh_public_key.create", - "description": "An SSH key was added to a user account as a Git commit signing key.", - "docs_reference_links": "/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "title", - "key", - "fingerprint", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key" - }, - { - "action": "git_signing_ssh_public_key.delete", - "description": "An SSH key was removed from a user account as a Git commit signing key.", - "docs_reference_links": "/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "title", - "key", - "fingerprint", - "explanation", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key" - }, - { - "action": "github_hosted_runner.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "runner_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "github_hosted_runner.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "github_hosted_runner.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "runner_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "gpg_key.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "gpg_key.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "hook.active_changed", - "description": "A hook's active status was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "name", - "events", - "active", - "active_was", - "hook_id", - "operation_type" - ] - }, - { - "action": "hook.config_changed", - "description": "A hook's configuration was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "name", - "hook_id", - "created_at", - "oauth_application_id", - "events" - ] - }, - { - "action": "hook.create", - "description": "A new hook was added.", - "docs_reference_links": "/get-started/exploring-integrations/about-webhooks", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application", - "oauth_application_id", - "hook_id", - "events", - "operation_type", - "name", - "created_at" - ], - "docs_reference_titles": "About webhooks" - }, - { - "action": "hook.destroy", - "description": "A hook was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "events", - "created_at", - "name", - "operation_type", - "oauth_application_id", - "hook_id" - ] - }, - { - "action": "hook.events_changed", - "description": "A hook's configured events were changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "events", - "operation_type", - "name", - "events_were", - "created_at", - "hook_id", - "oauth_application_id" - ] - }, - { - "action": "integration.create", - "description": "A GitHub App was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "name", - "integration", - "created_at", - "application_client_id" - ] - }, - { - "action": "integration.destroy", - "description": "A GitHub App was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "operation_type", - "created_at" - ] - }, - { - "action": "integration.generate_client_secret", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "operation_type", - "created_at", - "application_client_id" - ] - }, - { - "action": "integration_installation.create", - "description": "A GitHub App was installed.", - "docs_reference_links": "/apps/using-github-apps/authorizing-github-apps", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "name", - "repository_selection", - "created_at", - "integration", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/authorizing-github-apps" - }, - { - "action": "integration_installation.destroy", - "description": "A GitHub App was uninstalled.", - "docs_reference_links": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "repository_selection", - "integration", - "operation_type", - "name", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access" - }, - { - "action": "integration_installation.repositories_added", - "description": "Repositories were added to a GitHub App.", - "docs_reference_links": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#modifying-repository-access", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "repository_selection", - "name", - "integration", - "operation_type", - "repositories_added", - "created_at", - "repositories_added_names", - "actor_is_bot", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#modifying-repository-access" - }, - { - "action": "integration_installation.repositories_removed", - "description": "Repositories were removed from a GitHub App.", - "docs_reference_links": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#modifying-repository-access", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "repository_selection", - "repositories_removed", - "integration", - "created_at", - "name", - "repositories_removed_names", - "actor_is_bot", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#modifying-repository-access" - }, - { - "action": "integration_installation.suspend", - "description": "A GitHub App was suspended.", - "docs_reference_links": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "repository_selection", - "integration", - "operation_type", - "created_at", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access" - }, - { - "action": "integration_installation.unsuspend", - "description": "A GitHub App was unsuspended.", - "docs_reference_links": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "repository_selection", - "integration", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access" - }, - { - "action": "integration_installation.version_updated", - "description": "Permissions for a GitHub App were updated.", - "docs_reference_links": "/apps/using-github-apps/approving-updated-permissions-for-a-github-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "integration", - "name", - "operation_type", - "created_at", - "repository_selection", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/approving-updated-permissions-for-a-github-app" - }, - { - "action": "integration.manager_added", - "description": "A member of an enterprise or organization was added as a GitHub App manager.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/adding-and-removing-github-app-managers-in-your-organization#giving-someone-the-ability-to-manage-all-github-apps-owned-by-the-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "name", - "manager", - "operation_type", - "integration" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/adding-and-removing-github-app-managers-in-your-organization#giving-someone-the-ability-to-manage-all-github-apps-owned-by-the-organization" - }, - { - "action": "integration.manager_removed", - "description": "A member of an enterprise or organization was removed from being a GitHub App manager.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/adding-and-removing-github-app-managers-in-your-organization#removing-a-github-app-managers-permissions-for-the-entire-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "integration", - "name", - "created_at", - "manager" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/adding-and-removing-github-app-managers-in-your-organization#removing-a-github-app-managers-permissions-for-the-entire-organization" - }, - { - "action": "integration.remove_client_secret", - "description": "A client secret for a GitHub App was removed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "operation_type", - "created_at" - ] - }, - { - "action": "integration.revoke_all_tokens", - "description": "All user tokens for a GitHub App were requested to be revoked.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "operation_type", - "created_at", - "application_client_id" - ] - }, - { - "action": "integration.revoke_tokens", - "description": "Token(s) for a GitHub App were revoked.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "operation_type", - "created_at", - "application_client_id" - ] - }, - { - "action": "integration.suspend", - "description": "A GitHub App was suspended.", - "docs_reference_links": "/apps/maintaining-github-apps/suspending-a-github-app-installation", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "created_at", - "operation_type", - "application_client_id" - ], - "docs_reference_titles": "/apps/maintaining-github-apps/suspending-a-github-app-installation" - }, - { - "action": "integration.transfer", - "description": "Ownership of a GitHub App was transferred to another user or organization.", - "docs_reference_links": "/apps/maintaining-github-apps/transferring-ownership-of-a-github-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "transfer_to_id", - "requester", - "requester_id", - "created_at", - "transfer_to", - "operation_type", - "integration", - "transfer_from", - "transfer_from_id", - "transfer_from_type", - "transfer_to_type" - ], - "docs_reference_titles": "/apps/maintaining-github-apps/transferring-ownership-of-a-github-app" - }, - { - "action": "integration.unsuspend", - "description": "A GitHub App was unsuspended.", - "docs_reference_links": "/apps/maintaining-github-apps/suspending-a-github-app-installation", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "created_at", - "operation_type", - "application_client_id" - ], - "docs_reference_titles": "/apps/maintaining-github-apps/suspending-a-github-app-installation" - }, - { - "action": "ip_allow_list.disable", - "description": "An IP allow list was disabled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "ip_allow_list.disable_for_installed_apps", - "description": "An IP allow list was disabled for installed GitHub Apps.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "ip_allow_list.disable_user_level_enforcement", - "description": "IP allow list user level enforcement was disabled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "ip_allow_list.enable", - "description": "An IP allow list was enabled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "ip_allow_list.enable_for_installed_apps", - "description": "An IP allow list was enabled for installed GitHub Apps.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "ip_allow_list.enable_user_level_enforcement", - "description": "IP allow list user level enforcement was enabled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "ip_allow_list_entry.create", - "description": "An IP address was added to an IP allow list.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "active", - "ip_allow_list_entry", - "operation_type", - "created_at" - ] - }, - { - "action": "ip_allow_list_entry.destroy", - "description": "An IP address was deleted from an IP allow list.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "ip_allow_list_entry", - "operation_type", - "created_at", - "active" - ] - }, - { - "action": "ip_allow_list_entry.update", - "description": "An IP address or its description was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "ip_allow_list_entry", - "active" - ] - }, - { - "action": "marketplace_agreement_signature.create", - "description": "The GitHub Marketplace Developer Agreement was signed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "marketplace_listing.approve", - "description": "A listing was approved for inclusion in GitHub Marketplace.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "secondary_category", - "primary_category", - "operation_type", - "created_at", - "marketplace_listing", - "integration" - ] - }, - { - "action": "marketplace_listing.change_category", - "description": "A category for a listing for an app in GitHub Marketplace was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "primary_category", - "marketplace_listing", - "integration", - "secondary_category", - "operation_type", - "created_at" - ] - }, - { - "action": "marketplace_listing.create", - "description": "A listing for an app in GitHub Marketplace was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "primary_category", - "created_at", - "oauth_application", - "marketplace_listing", - "secondary_category", - "oauth_application_id", - "operation_type" - ] - }, - { - "action": "marketplace_listing.delist", - "description": "A listing was removed from GitHub Marketplace.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "secondary_category", - "operation_type", - "marketplace_listing", - "primary_category", - "integration" - ] - }, - { - "action": "marketplace_listing_plan.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "marketplace_listing", - "has_free_trial", - "yearly_price_in_cents", - "description", - "bullets", - "monthly_price_in_cents", - "marketplace_listing_plan" - ] - }, - { - "action": "marketplace_listing_plan.publish", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "marketplace_listing_plan", - "marketplace_listing", - "description", - "bullets", - "has_free_trial", - "created_at", - "operation_type", - "monthly_price_in_cents", - "yearly_price_in_cents" - ] - }, - { - "action": "marketplace_listing_plan.retire", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "marketplace_listing_plan", - "description", - "yearly_price_in_cents", - "created_at", - "bullets", - "has_free_trial", - "marketplace_listing", - "monthly_price_in_cents", - "operation_type" - ] - }, - { - "action": "marketplace_listing_plan.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "monthly_price_in_cents", - "marketplace_listing", - "description", - "bullets", - "yearly_price_in_cents", - "has_free_trial", - "marketplace_listing_plan", - "operation_type", - "created_at" - ] - }, - { - "action": "marketplace_listing.redraft", - "description": "A listing was sent back to draft state.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "secondary_category", - "oauth_application_id", - "operation_type", - "oauth_application", - "created_at", - "marketplace_listing", - "primary_category" - ] - }, - { - "action": "marketplace_listing.reject", - "description": "A listing was not accepted for inclusion in GitHub Marketplace.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "primary_category", - "secondary_category", - "marketplace_listing", - "oauth_application", - "oauth_application_id", - "operation_type", - "created_at" - ] - }, - { - "action": "merge_queue.pull_request_dequeued", - "description": "A pull request was removed from a merge queue.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "merge_queue.pull_request_queue_jump", - "description": "A pull request was moved ahead in a merge queue.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "merge_queue.queue_cleared", - "description": "A merge queue was cleared.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "merge_queue.update_settings", - "description": "The settings for a merge queue were updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "max_entries_to_build", - "min_entries_to_merge", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "metered_billing_configuration.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "metered_billing_configuration.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "metered_billing_configuration.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "migration.create", - "description": "A migration file was created for transferring data from a source location (such as a GitHub.com organization or a GitHub Enterprise Server instance) to a target GitHub Enterprise Server instance.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "oauth_access.create", - "description": "An OAuth access token was generated.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps, /authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "oauth_application_name" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps, Managing your personal access tokens" - }, - { - "action": "oauth_access.destroy", - "description": "An OAuth access token was deleted.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "explanation", - "oauth_application_name" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps" - }, - { - "action": "oauth_access.regenerate", - "description": "An OAuth access token was regenerated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "oauth_application_name" - ] - }, - { - "action": "oauth_access.update", - "description": "An OAuth access token was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "oauth_application.create", - "description": "An OAuth application was created.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "oauth_application_id", - "operation_type", - "oauth_application" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.destroy", - "description": "An OAuth application was deleted.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "oauth_application_id", - "operation_type", - "oauth_application" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.generate_client_secret", - "description": "An OAuth application's secret key was generated.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application", - "oauth_application_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.remove_client_secret", - "description": "An OAuth application's secret key was deleted.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application", - "oauth_application_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.reset_secret", - "description": "The secret key for an OAuth application was reset.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application", - "operation_type", - "created_at", - "oauth_application_id" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.revoke_all_tokens", - "description": "All user tokens for an OAuth application were requested to be revoked.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application", - "oauth_application_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.revoke_tokens", - "description": "Token(s) for an OAuth application were revoked.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "oauth_application", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.suspend", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "oauth_application_id", - "created_at", - "oauth_application" - ] - }, - { - "action": "oauth_application.transfer", - "description": "An OAuth application was transferred from one account to another.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "oauth_application", - "oauth_application_id" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.unsuspend", - "description": "An OAuth application was unsuspended for a user or organization account.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "oauth_application_id", - "oauth_application", - "created_at" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_authorization.create", - "description": "An authorization for an OAuth application was created.", - "docs_reference_links": "/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "actor_is_bot", - "oauth_application_name" - ], - "docs_reference_titles": "/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps" - }, - { - "action": "oauth_authorization.destroy", - "description": "An authorization for an OAuth application was deleted.", - "docs_reference_links": "/apps/using-github-apps/reviewing-your-authorized-integrations", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "explanation", - "actor_is_bot", - "oauth_application_name" - ], - "docs_reference_titles": "Reviewing and revoking authorization of GitHub Apps" - }, - { - "action": "oauth_authorization.update", - "description": "An authorization for an OAuth application was updated.", - "docs_reference_links": "/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "actor_is_bot", - "oauth_application_name" - ], - "docs_reference_titles": "/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps" - }, - { - "action": "org.accept_business_invitation", - "description": "An invitation sent to an organization to join an enterprise was accepted.", - "docs_reference_links": "/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise#inviting-an-organization-to-join-your-enterprise-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Adding organizations to your enterprise" - }, - { - "action": "org.add_billing_manager", - "description": "A billing manager was added to an organization.", - "docs_reference_links": "/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization" - }, - { - "action": "org.add_member", - "description": "A user joined an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "permission", - "operation_type", - "created_at", - "actor_is_bot" - ] - }, - { - "action": "org.add_outside_collaborator", - "description": "An outside collaborator was added to a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "inviter", - "public_repo", - "permission", - "invitee", - "created_at", - "operation_type" - ] - }, - { - "action": "org.add_security_manager", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "created_at", - "operation_type" - ] - }, - { - "action": "org.advanced_security_disabled_for_new_repos", - "description": "GitHub Advanced Security was disabled for new repositories in an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.advanced_security_disabled_on_all_repos", - "description": "GitHub Advanced Security was disabled for all repositories in an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.advanced_security_enabled_for_new_repos", - "description": "GitHub Advanced Security was enabled for new repositories in an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.advanced_security_enabled_on_all_repos", - "description": "GitHub Advanced Security was enabled for all repositories in an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.advanced_security_policy_selected_member_disabled", - "description": "An enterprise owner prevented GitHub Advanced Security features from being enabled for repositories owned by the organization.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Enforcing policies for code security and analysis for your enterprise" - }, - { - "action": "org.advanced_security_policy_selected_member_enabled", - "description": "An enterprise owner allowed GitHub Advanced Security features to be enabled for repositories owned by the organization.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "actor_is_bot" - ], - "docs_reference_titles": "Enforcing policies for code security and analysis for your enterprise" - }, - { - "action": "org.async_delete", - "description": "A user initiated a background job to delete an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.billing_signup_error", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.block_user", - "description": "An organization owner blocked a user from accessing the organization's repositories.", - "docs_reference_links": "/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "blocked_user", - "operation_type" - ], - "docs_reference_titles": "/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization" - }, - { - "action": "org.cancel_business_invitation", - "description": "An invitation for an organization to join an enterprise was revoked", - "docs_reference_links": "/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise#inviting-an-organization-to-join-your-enterprise-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "initiated_from" - ], - "docs_reference_titles": "Adding organizations to your enterprise" - }, - { - "action": "org.cancel_invitation", - "description": "An invitation sent to a user to join an organization was revoked.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "email", - "operation_type", - "invitation_id", - "created_at", - "invitee_email" - ] - }, - { - "action": "org.clear_custom_invitation_rate_limit", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.code_scanning_autofix_disabled", - "description": "Autofix for code scanning alerts was disabled for an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "org.code_scanning_autofix_enabled", - "description": "Autofix for code scanning alerts was enabled for an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "org.code_scanning_scan_inactive_repos_disabled", - "description": "Scanning inactive repositories was disabled for an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "org.code_scanning_scan_inactive_repos_enabled", - "description": "Scanning inactive repositories was enabled for an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "org.codeql_disabled", - "description": "Code scanning using the default setup was disabled for an organization.", - "docs_reference_links": "/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Configuring default setup for code scanning at scale" - }, - { - "action": "org.codeql_enabled", - "description": "Code scanning using the default setup was enabled for an organization.", - "docs_reference_links": "/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Configuring default setup for code scanning at scale" - }, - { - "action": "org.config.disable_collaborators_only", - "description": "The interaction limit for collaborators only for an organization was disabled.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization" - }, - { - "action": "org.config.disable_contributors_only", - "description": "The interaction limit for prior contributors only for an organization was disabled.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization" - }, - { - "action": "org.config.disable_sockpuppet_disallowed", - "description": "The interaction limit for existing users only for an organization was disabled.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization" - }, - { - "action": "org.config.enable_collaborators_only", - "description": "The interaction limit for collaborators only for an organization was enabled.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization" - }, - { - "action": "org.config.enable_contributors_only", - "description": "The interaction limit for prior contributors only for an organization was enabled.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization" - }, - { - "action": "org.config.enable_sockpuppet_disallowed", - "description": "The interaction limit for existing users only for an organization was enabled.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization" - }, - { - "action": "org.configure_self_hosted_jit_runner", - "description": "A new just-in-time GitHub Actions self-hosted runner was configured", - "docs_reference_links": "/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" - }, - { - "action": "org.confirm_business_invitation", - "description": "An invitation for an organization to join an enterprise was confirmed.", - "docs_reference_links": "/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise#inviting-an-organization-to-join-your-enterprise-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Adding organizations to your enterprise" - }, - { - "action": "org.create", - "description": "An organization was created.", - "docs_reference_links": "/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch" - }, - { - "action": "org.delete", - "description": "An organization was deleted by a user or staff.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.disable_member_team_creation_permission", - "description": "Team creation was limited to owners.", - "docs_reference_links": "/organizations/managing-organization-settings/setting-team-creation-permissions-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/setting-team-creation-permissions-in-your-organization" - }, - { - "action": "org.disable_reader_discussion_creation_permission", - "description": "An organization owner limited discussion creation to users with at least triage permission in an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization" - }, - { - "action": "org.disable_saml", - "description": "SAML single sign-on was disabled for an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sso_url", - "issuer", - "created_at", - "operation_type" - ] - }, - { - "action": "org.disable_two_factor_requirement", - "description": "A two-factor authentication requirement was disabled for the organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.display_commenter_full_name_disabled", - "description": "An organization owner disabled the display of a commenter's full name in an organization. Members cannot see a comment author's full name.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.display_commenter_full_name_enabled", - "description": "An organization owner enabled the display of a commenter's full name in an organization. Members can see a comment author's full name.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.enable_member_team_creation_permission", - "description": "Team creation by members was allowed.", - "docs_reference_links": "/organizations/managing-organization-settings/setting-team-creation-permissions-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/setting-team-creation-permissions-in-your-organization" - }, - { - "action": "org.enable_reader_discussion_creation_permission", - "description": "An organization owner allowed users with read access to create discussions in an organization", - "docs_reference_links": "/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization" - }, - { - "action": "org.enable_saml", - "description": "SAML single sign-on was enabled for the organization.", - "docs_reference_links": "/organizations/managing-saml-single-sign-on-for-your-organization/enabling-and-testing-saml-single-sign-on-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "sso_url", - "created_at", - "issuer" - ], - "docs_reference_titles": "Enabling and testing SAML single sign-on for your organization" - }, - { - "action": "org.enable_two_factor_requirement", - "description": "Two-factor authentication is now required for the organization.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization" - }, - { - "action": "org.integration_manager_added", - "description": "An organization owner granted a member access to manage all GitHub Apps owned by an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "manager", - "operation_type", - "created_at" - ] - }, - { - "action": "org.integration_manager_removed", - "description": "An organization owner removed access to manage all GitHub Apps owned by an organization from an organization member.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "manager", - "operation_type", - "created_at" - ] - }, - { - "action": "org.invite_member", - "description": "A new user was invited to join an organization.", - "docs_reference_links": "/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "invitation_id", - "operation_type", - "created_at", - "invitee_email" - ], - "docs_reference_titles": "/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization" - }, - { - "action": "org.invite_to_business", - "description": "An organization was invited to join an enterprise.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.members_can_update_protected_branches.disable", - "description": "The ability for enterprise members to update protected branches was disabled. Only enterprise owners can update protected branches.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.members_can_update_protected_branches.enable", - "description": "The ability for enterprise members to update protected branches was enabled. Members of an organization can update protected branches.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.rate_limited_invites", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.recreate", - "description": "An organization was restored.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.register_self_hosted_runner", - "description": "A new self-hosted runner was registered.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "actor_is_bot" - ], - "docs_reference_titles": "Adding self-hosted runners" - }, - { - "action": "org.remove_billing_manager", - "description": "A billing manager was removed from an organization, either manually or due to a two-factor authentication requirement.", - "docs_reference_links": "/organizations/managing-peoples-access-to-your-organization-with-roles/removing-a-billing-manager-from-your-organization, /organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-peoples-access-to-your-organization-with-roles/removing-a-billing-manager-from-your-organization, /organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization" - }, - { - "action": "org.remove_member", - "description": "A member was removed from an organization, either manually or due to a two-factor authentication requirement.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.remove_outside_collaborator", - "description": "An outside collaborator was removed from an organization, either manually or due to a two-factor authentication requirement.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.remove_security_manager", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "created_at", - "operation_type" - ] - }, - { - "action": "org.remove_self_hosted_runner", - "description": "A self-hosted runner was removed.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/removing-self-hosted-runners#removing-a-runner-from-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Removing self-hosted runners" - }, - { - "action": "org.rename", - "description": "An organization was renamed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "old_login", - "operation_type", - "created_at" - ] - }, - { - "action": "org.restore_member", - "description": "An organization member was restored.", - "docs_reference_links": "/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization" - }, - { - "action": "org.runner_group_created", - "description": "A self-hosted runner group was created.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_group_id", - "operation_type", - "created_at", - "runner_group_restricted_to_workflows", - "runner_group_selected_workflow_refs", - "network_configuration_id" - ], - "docs_reference_titles": "Managing access to self-hosted runners using groups" - }, - { - "action": "org.runner_group_removed", - "description": "A self-hosted runner group was removed.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_group_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing access to self-hosted runners using groups" - }, - { - "action": "org.runner_group_runner_removed", - "description": "The REST API was used to remove a self-hosted runner from a group.", - "docs_reference_links": "/rest/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "runner_group_id", - "runner_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/rest/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization" - }, - { - "action": "org.runner_group_runners_added", - "description": "A self-hosted runner was added to a group.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_group_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing access to self-hosted runners using groups" - }, - { - "action": "org.runner_group_runners_updated", - "description": "A runner group's list of members was updated.", - "docs_reference_links": "/rest/actions#set-self-hosted-runners-in-a-group-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "runner_group_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/rest/actions#set-self-hosted-runners-in-a-group-for-an-organization" - }, - { - "action": "org.runner_group_updated", - "description": "The configuration of a self-hosted runner group was changed.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_group_id", - "runner_group_name", - "runner_group_allow_public", - "operation_type", - "created_at", - "runner_group_restricted_to_workflows", - "runner_group_selected_workflow_refs", - "network_configuration_id" - ], - "docs_reference_titles": "Managing access to self-hosted runners using groups" - }, - { - "action": "org_secret_scanning_automatic_validity_checks.disabled", - "description": "Automatic partner validation checks have been disabled at the organization level", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#allowing-validity-checks-for-partner-patterns-in-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#allowing-validity-checks-for-partner-patterns-in-an-organization" - }, - { - "action": "org_secret_scanning_automatic_validity_checks.enabled", - "description": "Automatic partner validation checks have been enabled at the organization level", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#allowing-validity-checks-for-partner-patterns-in-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#allowing-validity-checks-for-partner-patterns-in-an-organization" - }, - { - "action": "org_secret_scanning_custom_pattern.create", - "description": "A custom pattern was created for secret scanning in an organization.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "org_secret_scanning_custom_pattern.delete", - "description": "A custom pattern was removed from secret scanning in an organization.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#removing-a-custom-pattern", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "org_secret_scanning_custom_pattern.publish", - "description": "A custom pattern was published for secret scanning in an organization.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "org.secret_scanning_custom_pattern_push_protection_disabled", - "description": "Push protection for a custom pattern for secret scanning was disabled for an organization.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "org.secret_scanning_custom_pattern_push_protection_enabled", - "description": "Push protection for a custom pattern for secret scanning was enabled for an organization.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "org_secret_scanning_custom_pattern.update", - "description": "Changes to a custom pattern were saved and a dry run was executed for secret scanning in an organization.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#editing-a-custom-pattern", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "org_secret_scanning_non_provider_patterns.disabled", - "description": "Secret scanning for non-provider patterns was disabled at the organization level.", - "docs_reference_links": "/code-security/secret-scanning/secret-scanning-patterns#non-provider-patterns", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Supported secret scanning patterns" - }, - { - "action": "org_secret_scanning_non_provider_patterns.enabled", - "description": "Secret scanning for non-provider patterns was enabled at the organization level.", - "docs_reference_links": "/code-security/secret-scanning/secret-scanning-patterns#non-provider-patterns", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Supported secret scanning patterns" - }, - { - "action": "org_secret_scanning_push_protection_bypass_list.add", - "description": "A role or team was added to the push protection bypass list at the organization level.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org_secret_scanning_push_protection_bypass_list.disable", - "description": "Push protection settings for \"Users who can bypass push protection for secret scanning\" changed from \"Specific roles or teams\" to \"Anyone with write access\" at the organization level.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org_secret_scanning_push_protection_bypass_list.enable", - "description": "Push protection settings for \"Users who can bypass push protection for secret scanning\" changed from \"Anyone with write access\" to \"Specific roles or teams\" at the organization level.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org_secret_scanning_push_protection_bypass_list.remove", - "description": "A role or team was removed from the push protection bypass list at the organization level.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org.secret_scanning_push_protection_custom_message_disabled", - "description": "The custom message triggered by an attempted push to a push-protected repository was disabled for an organization.", - "docs_reference_links": "/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org.secret_scanning_push_protection_custom_message_enabled", - "description": "The custom message triggered by an attempted push to a push-protected repository was enabled for an organization.", - "docs_reference_links": "/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org.secret_scanning_push_protection_custom_message_updated", - "description": "The custom message triggered by an attempted push to a push-protected repository was updated for an organization.", - "docs_reference_links": "/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org.secret_scanning_push_protection_disable", - "description": "Push protection for secret scanning was disabled.", - "docs_reference_links": "/code-security/secret-scanning/protecting-pushes-with-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org.secret_scanning_push_protection_enable", - "description": "Push protection for secret scanning was enabled.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org.secret_scanning_push_protection_new_repos_disable", - "description": "Push protection for secret scanning was disabled for all new repositories in the organization.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org.secret_scanning_push_protection_new_repos_enable", - "description": "Push protection for secret scanning was enabled for all new repositories in the organization.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org.self_hosted_runner_offline", - "description": "The runner application was stopped. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_id", - "runner_name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Monitoring and troubleshooting self-hosted runners" - }, - { - "action": "org.self_hosted_runner_online", - "description": "The runner application was started. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_id", - "runner_name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Monitoring and troubleshooting self-hosted runners" - }, - { - "action": "org.self_hosted_runner_updated", - "description": "The runner application was updated. This event is not included in the JSON/CSV export.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#about-self-hosted-runners", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_id", - "runner_name", - "source_version", - "target_version", - "runner_group_id", - "runner_group_name" - ], - "docs_reference_titles": "Self-hosted runners" - }, - { - "action": "org.set_actions_fork_pr_approvals_policy", - "description": "The setting for requiring approvals for workflows from public forks was changed for an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#requiring-approval-for-workflows-from-public-forks", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "policy", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#requiring-approval-for-workflows-from-public-forks" - }, - { - "action": "org.set_actions_private_fork_pr_approvals_policy", - "description": "The policy for requiring approval for fork pull request workflows from collaborators without write access to private repos was changed for an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#enabling-workflows-for-private-repository-forks", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "policy", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#enabling-workflows-for-private-repository-forks" - }, - { - "action": "org.set_actions_retention_limit", - "description": "The retention period for GitHub Actions artifacts and logs in an organization was changed.", - "docs_reference_links": "/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "limit", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization" - }, - { - "action": "org.set_custom_invitation_rate_limit", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.set_default_workflow_permissions", - "description": "The default permissions granted to the GITHUB_TOKEN when running workflows were changed for an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization" - }, - { - "action": "org.set_fork_pr_workflows_policy", - "description": "The policy for workflows on private repository forks was changed.", - "docs_reference_links": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#enabling-workflows-for-private-repository-forks", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "policy", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#enabling-workflows-for-private-repository-forks" - }, - { - "action": "org.set_workflow_permission_can_approve_pr", - "description": "The policy for allowing GitHub Actions to create and approve pull requests was changed for an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#preventing-github-actions-from-creating-or-approving-pull-requests", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#preventing-github-actions-from-creating-or-approving-pull-requests" - }, - { - "action": "org.sso_response", - "description": "A SAML single sign-on (SSO) response was generated when a member attempted to authenticate with your organization. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "issuer", - "operation_type", - "created_at", - "actor_is_bot" - ] - }, - { - "action": "org.transform", - "description": "A user account was converted into an organization.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "owner" - ], - "docs_reference_titles": "Converting a user into an organization" - }, - { - "action": "org.unblock_user", - "description": "A user was unblocked from an organization.", - "docs_reference_links": "/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "blocked_user", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization" - }, - { - "action": "org.update_actions_settings", - "description": "An organization owner or site administrator updated GitHub Actions policy settings for an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "new_policy", - "updated_allowed_types", - "old_policy", - "updated_access_policy" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization" - }, - { - "action": "org.update_default_repository_permission", - "description": "The default repository permission level for organization members was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "permission", - "old_permission" - ] - }, - { - "action": "org.update_member", - "description": "A person's role was changed from owner to member or member to owner.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "old_permission", - "permission", - "operation_type" - ] - }, - { - "action": "org.update_member_repository_creation_permission", - "description": "The create repository permission for organization members was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "permission", - "created_at", - "visibility", - "operation_type" - ] - }, - { - "action": "org.update_member_repository_invitation_permission", - "description": "An organization owner changed the policy setting for organization members inviting outside collaborators to repositories.", - "docs_reference_links": "/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "permission", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Setting permissions for adding outside collaborators" - }, - { - "action": "org.update_saml_provider_settings", - "description": "An organization's SAML provider settings were updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sso_url", - "operation_type", - "issuer", - "created_at" - ] - }, - { - "action": "org.update_terms_of_service", - "description": "An organization changed between the Standard Terms of Service and the GitHub Customer Agreement.", - "docs_reference_links": "/organizations/managing-organization-settings/upgrading-to-the-github-customer-agreement", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/upgrading-to-the-github-customer-agreement" - }, - { - "action": "organization_domain.approve", - "description": "A domain was approved for an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization#approving-a-domain-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner_type", - "domain_name", - "owner", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization#approving-a-domain-for-your-organization" - }, - { - "action": "organization_domain.create", - "description": "A domain was added to an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization#verifying-a-domain-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "domain_name", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization#verifying-a-domain-for-your-organization" - }, - { - "action": "organization_domain.destroy", - "description": "A domain was removed from an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization#removing-an-approved-or-verified-domain", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "domain_name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization#removing-an-approved-or-verified-domain" - }, - { - "action": "organization_domain.verify", - "description": "A domain was verified for an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization#verifying-a-domain-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "domain_name", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization#verifying-a-domain-for-your-organization" - }, - { - "action": "packages.package_deleted", - "description": "An entire package was deleted.", - "docs_reference_links": "/packages/learn-github-packages/deleting-and-restoring-a-package", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "package", - "operation_type", - "created_at", - "actor_is_bot" - ], - "docs_reference_titles": "/packages/learn-github-packages/deleting-and-restoring-a-package" - }, - { - "action": "packages.package_published", - "description": "A package was published or republished to an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "package", - "ecosystem", - "version_count", - "is_republished", - "operation_type", - "created_at", - "actor_is_bot" - ] - }, - { - "action": "packages.package_version_deleted", - "description": "A specific package version was deleted.", - "docs_reference_links": "/packages/learn-github-packages/deleting-and-restoring-a-package", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "package", - "version", - "operation_type", - "created_at", - "ecosystem", - "actor_is_bot" - ], - "docs_reference_titles": "/packages/learn-github-packages/deleting-and-restoring-a-package" - }, - { - "action": "packages.package_version_published", - "description": "A specific package version was published or republished to a package.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "ecosystem", - "package", - "version", - "is_republished", - "operation_type", - "created_at", - "actor_is_bot" - ] - }, - { - "action": "pages_protected_domain.create", - "description": "A GitHub Pages verified domain was created for an organization or enterprise.", - "docs_reference_links": "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "owner_type", - "domain", - "state", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages" - }, - { - "action": "pages_protected_domain.delete", - "description": "A GitHub Pages verified domain was deleted from an organization or enterprise.", - "docs_reference_links": "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "owner_type", - "domain", - "state", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages" - }, - { - "action": "pages_protected_domain.verify", - "description": "A GitHub Pages domain was verified for an organization or enterprise.", - "docs_reference_links": "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "owner_type", - "domain", - "state", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages" - }, - { - "action": "passkey.register", - "description": "A new passkey was added.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "nickname", - "created_at", - "operation_type" - ] - }, - { - "action": "passkey.remove", - "description": "A new passkey was removed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "nickname", - "created_at", - "operation_type" - ] - }, - { - "action": "payment_method.create", - "description": "A new payment method was added, such as a new credit card or PayPal account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "payment_method.remove", - "description": "A payment method was removed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "payment_method.update", - "description": "An existing payment method was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "personal_access_token.access_granted", - "description": "A fine-grained personal access token was granted access to resources.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_id", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization" - }, - { - "action": "personal_access_token.access_revoked", - "description": "A fine-grained personal access token was revoked. The token can still read public organization resources.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/reviewing-and-revoking-personal-access-tokens-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_id", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/reviewing-and-revoking-personal-access-tokens-in-your-organization" - }, - { - "action": "personal_access_token.create", - "description": "Triggered when you create a fine-grained personal access token.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type" - ] - }, - { - "action": "personal_access_token.credential_regenerated", - "description": "Triggered when you regenerate a fine-grained personal access token.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_name", - "created_at", - "operation_type" - ] - }, - { - "action": "personal_access_token.credential_revoked", - "description": "A fine-grained personal access token was revoked by GitHub Advanced Security.", - "docs_reference_links": "/code-security/getting-started/github-security-features#secret-scanning-alerts-for-users", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_name", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/code-security/getting-started/github-security-features#secret-scanning-alerts-for-users" - }, - { - "action": "personal_access_token.destroy", - "description": "Triggered when you delete a fine-grained personal access token.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_name", - "explanation", - "created_at", - "operation_type" - ] - }, - { - "action": "personal_access_token.request_cancelled", - "description": "A pending request for a fine-grained personal access token to access organization resources was canceled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type", - "user_programmatic_access_request_id" - ] - }, - { - "action": "personal_access_token.request_created", - "description": "Triggered when a fine-grained personal access token was created to access organization resources and the organization requires approval before the token can access organization resources.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_id", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type", - "user_programmatic_access_request_id" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization" - }, - { - "action": "personal_access_token.request_denied", - "description": "A request for a fine-grained personal access token to access organization resources was denied.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type", - "user_programmatic_access_request_id" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization" - }, - { - "action": "personal_access_token.update", - "description": "A fine-grained personal access token was updated.", - "docs_reference_links": "/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#fine-grained-personal-access-tokens", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#fine-grained-personal-access-tokens" - }, - { - "action": "premium_runner.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "runner_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "premium_runner.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "premium_runner.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "runner_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "private_vulnerability_reporting.disable", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "private_vulnerability_reporting.enable", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "private_vulnerability_reporting_new_repos.disable", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "private_vulnerability_reporting_new_repos.enable", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "profile_picture.update", - "description": "A profile picture was updated.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "owner", - "operation_type" - ], - "docs_reference_titles": "Personalize your profile" - }, - { - "action": "project.access", - "description": "A project board visibility was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project.close", - "description": "A project board was closed.", - "docs_reference_links": "/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "project_id", - "project_kind" - ], - "docs_reference_titles": "Closing a project (classic)" - }, - { - "action": "project.create", - "description": "A project board was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project.delete", - "description": "A project board was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project_field.create", - "description": "A field was created in a project board.", - "docs_reference_links": "/issues/planning-and-tracking-with-projects/understanding-fields", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/issues/planning-and-tracking-with-projects/understanding-fields" - }, - { - "action": "project_field.delete", - "description": "A field was deleted in a project board.", - "docs_reference_links": "/issues/planning-and-tracking-with-projects/understanding-fields/deleting-custom-fields", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/issues/planning-and-tracking-with-projects/understanding-fields/deleting-custom-fields" - }, - { - "action": "project.link", - "description": "A repository was linked to a project board.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project.open", - "description": "A project board was reopened.", - "docs_reference_links": "/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "project_id", - "operation_type", - "created_at", - "project_kind", - "project_name" - ], - "docs_reference_titles": "Reopening a closed project (classic)" - }, - { - "action": "project.rename", - "description": "A project board was renamed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "old_name", - "operation_type" - ] - }, - { - "action": "project.unlink", - "description": "A repository was unlinked from a project board.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project.update_org_permission", - "description": "The project's base-level permission for all organization members was changed or removed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project.update_team_permission", - "description": "A team's project board permission level was changed or when a team was added or removed from a project board.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "team" - ] - }, - { - "action": "project.update_user_permission", - "description": "A user was added to or removed from a project board or had their permission level changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project_view.create", - "description": "A view was created in a project board.", - "docs_reference_links": "/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views" - }, - { - "action": "project_view.delete", - "description": "A view was deleted in a project board.", - "docs_reference_links": "/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views" - }, - { - "action": "protected_branch.authorized_users_teams", - "description": "The users, teams, or integrations allowed to bypass a branch protection were changed.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "created_at", - "operation_type", - "oauth_application_id" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches" - }, - { - "action": "protected_branch.branch_allowances", - "description": "A protected branch allowance was given to a specific user, team or integration.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "authorized_actors", - "policy", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "protected_branch.create", - "description": "Branch protection was enabled on a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "name", - "created_at", - "authorized_actor_names", - "required_deployments_enforcement_level", - "merge_queue_enforcement_level", - "create_protected" - ] - }, - { - "action": "protected_branch.destroy", - "description": "Branch protection was disabled on a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at", - "required_deployments_enforcement_level", - "merge_queue_enforcement_level", - "create_protected" - ] - }, - { - "action": "protected_branch.dismiss_stale_reviews", - "description": "Enforcement of dismissing stale pull requests was updated on a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "dismiss_stale_reviews_on_push", - "created_at", - "operation_type", - "name" - ] - }, - { - "action": "protected_branch.dismissal_restricted_users_teams", - "description": "Enforcement of restricting users and/or teams who can dismiss reviews was updated on a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "authorized_actors_only", - "authorized_actors", - "created_at", - "name", - "operation_type" - ] - }, - { - "action": "protected_branch.policy_override", - "description": "A branch protection requirement was overridden by a repository administrator.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "reasons", - "before", - "after", - "operation_type", - "branch", - "overridden_codes", - "referrer", - "deploy_key_fingerprint", - "compliant_pull_request_ids", - "rule_suite_id" - ] - }, - { - "action": "protected_branch.rejected_ref_update", - "description": "A branch update attempt was rejected.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "branch", - "before", - "overridden_codes", - "after", - "reasons", - "deploy_key_fingerprint", - "compliant_pull_request_ids", - "actor_is_bot", - "rule_suite_id" - ] - }, - { - "action": "protected_branch.update_admin_enforced", - "description": "Branch protection was enforced for repository administrators.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "admin_enforced", - "operation_type", - "name", - "created_at" - ] - }, - { - "action": "protected_branch.update_allow_deletions_enforcement_level", - "description": "Branch deletion was enabled or disabled for a protected branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "allow_deletions_enforcement_level", - "created_at" - ] - }, - { - "action": "protected_branch.update_allow_force_pushes_enforcement_level", - "description": "Force pushes were enabled or disabled for a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "allow_force_pushes_enforcement_level", - "created_at" - ] - }, - { - "action": "protected_branch.update_ignore_approvals_from_contributors", - "description": "Ignoring of approvals from contributors to a pull request was enabled or disabled for a branch.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "ignore_approvals_from_contributors", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule" - }, - { - "action": "protected_branch.update_linear_history_requirement_enforcement_level", - "description": "Required linear commit history was enabled or disabled for a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "linear_history_requirement_enforcement_level", - "name", - "created_at" - ] - }, - { - "action": "protected_branch.update_lock_allows_fetch_and_merge", - "description": "Fork syncing was enabled or disabled for a read-only branch", - "docs_reference_links": "repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#lock-branch", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "lock_allows_fetch_and_merge", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#lock-branch" - }, - { - "action": "protected_branch.update_lock_branch_enforcement_level", - "description": "The enforcement of a branch lock was updated.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#lock-branch", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "enforcement_level", - "lock_branch_enforcement_level", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#lock-branch" - }, - { - "action": "protected_branch.update_merge_queue_enforcement_level", - "description": "Enforcement of the merge queue was modified for a branch.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-merge-queue", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "merge_queue_enforcement_level", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-merge-queue" - }, - { - "action": "protected_branch.update_name", - "description": "A branch name pattern was updated for a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "old_name", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "protected_branch.update_pull_request_reviews_enforcement_level", - "description": "Enforcement of required pull request reviews was updated for a branch. Can be 0 (deactivated), 1 (non-admins), or 2 (everyone).", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "pull_request_reviews_enforcement_level", - "created_at", - "operation_type" - ] - }, - { - "action": "protected_branch.update_require_code_owner_review", - "description": "Enforcement of required code owner review was updated for a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "require_code_owner_review", - "operation_type", - "name" - ] - }, - { - "action": "protected_branch.update_require_last_push_approval", - "description": "Someone other than the person who pushed the last code-modifying commit to the branch must approve pull requests for the branch.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-pull-request-reviews-before-merging", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "require_last_push_approval", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-pull-request-reviews-before-merging" - }, - { - "action": "protected_branch.update_required_approving_review_count", - "description": "Enforcement of the required number of approvals before merging was updated on a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "required_approving_review_count", - "created_at", - "operation_type", - "name" - ] - }, - { - "action": "protected_branch.update_required_status_checks_enforcement_level", - "description": "Enforcement of required status checks was updated for a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at", - "required_status_checks_enforcement_level" - ] - }, - { - "action": "protected_branch.update_signature_requirement_enforcement_level", - "description": "Enforcement of required commit signing was updated for a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "name", - "created_at", - "signature_requirement_enforcement_level" - ] - }, - { - "action": "protected_branch.update_strict_required_status_checks_policy", - "description": "Enforcement of required status checks was updated for a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "name", - "operation_type", - "strict_required_status_checks_policy" - ] - }, - { - "action": "public_key.create", - "description": "An SSH key was added to a user account or a deploy key was added to a repository.", - "docs_reference_links": "/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "read_only", - "operation_type", - "created_at", - "key", - "fingerprint", - "title" - ], - "docs_reference_titles": "/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account" - }, - { - "action": "public_key.delete", - "description": "An SSH key was removed from a user account or a deploy key was removed from a repository.", - "docs_reference_links": "/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "fingerprint", - "read_only", - "explanation", - "key", - "operation_type", - "title", - "created_at" - ], - "docs_reference_titles": "/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys" - }, - { - "action": "public_key.unverification_failure", - "description": "A user account's SSH key or a repository's deploy key was unable to be unverified.", - "docs_reference_links": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "title", - "key", - "fingerprint", - "read_only", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys" - }, - { - "action": "public_key.unverify", - "description": "A user account's SSH key or a repository's deploy key was unverified.", - "docs_reference_links": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "title", - "key", - "read_only", - "explanation", - "fingerprint" - ], - "docs_reference_titles": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys" - }, - { - "action": "public_key.update", - "description": "A user account's SSH key or a repository's deploy key was updated.", - "docs_reference_links": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "fingerprint", - "read_only", - "operation_type", - "created_at", - "title" - ], - "docs_reference_titles": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys" - }, - { - "action": "public_key.verification_failure", - "description": "A user account's SSH key or a repository's deploy key was unable to be verified.", - "docs_reference_links": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "fingerprint", - "oauth_application_id", - "title", - "created_at", - "read_only", - "operation_type" - ], - "docs_reference_titles": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys" - }, - { - "action": "public_key.verify", - "description": "A user account's SSH key or a repository's deploy key was verified.", - "docs_reference_links": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "key", - "fingerprint", - "title", - "read_only" - ], - "docs_reference_titles": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys" - }, - { - "action": "pull_request.close", - "description": "A pull request was closed without being merged.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "operation_type", - "created_at", - "pull_request_url", - "actor_is_bot" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request" - }, - { - "action": "pull_request.converted_to_draft", - "description": "A pull request was converted to a draft.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "operation_type", - "created_at", - "pull_request_url" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft" - }, - { - "action": "pull_request.create", - "description": "A pull request was created.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "operation_type", - "created_at", - "pull_request_url", - "actor_is_bot", - "actor_is_agent" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request" - }, - { - "action": "pull_request.create_review_request", - "description": "A review was requested on a pull request.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "reviewer_type", - "reviewer", - "reviewer_id", - "operation_type", - "created_at", - "pull_request_url", - "actor_is_agent" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews" - }, - { - "action": "pull_request.in_progress", - "description": "A pull request was marked as in progress.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "operation_type", - "created_at" - ] - }, - { - "action": "pull_request.indirect_merge", - "description": "A pull request was considered merged because the pull request's commits were merged into the target branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "operation_type", - "created_at", - "pull_request_url" - ] - }, - { - "action": "pull_request.merge", - "description": "A pull request was merged.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "operation_type", - "created_at", - "pull_request_url", - "actor_is_bot" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request" - }, - { - "action": "pull_request.ready_for_review", - "description": "A pull request was marked as ready for review.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#marking-a-pull-request-as-ready-for-review", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "operation_type", - "created_at", - "pull_request_url" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#marking-a-pull-request-as-ready-for-review" - }, - { - "action": "pull_request.rebase", - "description": "A pull request was rebased.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "pull_request_url", - "pull_request_title", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "pull_request.remove_review_request", - "description": "A review request was removed from a pull request.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "reviewer_type", - "reviewer", - "reviewer_id", - "operation_type", - "created_at", - "pull_request_url" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews" - }, - { - "action": "pull_request.reopen", - "description": "A pull request was reopened after previously being closed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "operation_type", - "created_at", - "pull_request_url" - ] - }, - { - "action": "pull_request_review_comment.create", - "description": "A review comment was added to a pull request.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "comment_id", - "operation_type", - "created_at", - "actor_is_agent" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews" - }, - { - "action": "pull_request_review_comment.delete", - "description": "A review comment on a pull request was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "comment_id", - "operation_type" - ] - }, - { - "action": "pull_request_review_comment.update", - "description": "A review comment on a pull request was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "comment_id" - ] - }, - { - "action": "pull_request_review.delete", - "description": "A review on a pull request was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "review_id", - "operation_type", - "created_at", - "pull_request_url" - ] - }, - { - "action": "pull_request_review.dismiss", - "description": "A review on a pull request was dismissed.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "review_id", - "operation_type", - "created_at", - "pull_request_url" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review" - }, - { - "action": "pull_request_review.submit", - "description": "A review on a pull request was submitted.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request#submitting-your-review", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "review_id", - "operation_type", - "created_at", - "pull_request_url", - "actor_is_agent" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request#submitting-your-review" - }, - { - "action": "repo.access", - "description": "The visibility of a repository changed.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "visibility", - "previous_visibility" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility" - }, - { - "action": "repo.actions_enabled", - "description": "GitHub Actions was enabled for a repository.", - "docs_reference_links": "organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#using-the-audit-log-api", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#using-the-audit-log-api" - }, - { - "action": "repo.add_member", - "description": "A collaborator was added to a repository.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "created_at", - "operation_type", - "oauth_application_id" - ], - "docs_reference_titles": "Inviting collaborators to a personal repository" - }, - { - "action": "repo.add_topic", - "description": "A topic was added to a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "topic", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics" - }, - { - "action": "repo.advanced_security_disabled", - "description": "GitHub Advanced Security was disabled for a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository" - }, - { - "action": "repo.advanced_security_enabled", - "description": "GitHub Advanced Security was enabled for a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "public_repo", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository" - }, - { - "action": "repo.archived", - "description": "A repository was archived.", - "docs_reference_links": "/repositories/archiving-a-github-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "visibility" - ], - "docs_reference_titles": "/repositories/archiving-a-github-repository" - }, - { - "action": "repo.change_merge_setting", - "description": "Pull request merge options were changed for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "created_at", - "operation_type", - "public_repo", - "actor_is_bot" - ] - }, - { - "action": "repo.code_scanning_analysis_deleted", - "description": "Code scanning analysis for a repository was deleted.", - "docs_reference_links": "/rest/code-scanning#delete-a-code-scanning-analysis-from-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "operation_type", - "created_at", - "public_repo", - "tool", - "category" - ], - "docs_reference_titles": "/rest/code-scanning#delete-a-code-scanning-analysis-from-a-repository" - }, - { - "action": "repo.code_scanning_autofix_disabled", - "description": "Autofix for code scanning alerts was disabled for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "repo.code_scanning_autofix_enabled", - "description": "Autofix for code scanning alerts was enabled for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "repo.code_scanning_configuration_for_branch_deleted", - "description": "A code scanning configuration for a branch of a repository was deleted.", - "docs_reference_links": "/code-security/code-scanning/managing-code-scanning-alerts/managing-code-scanning-alerts-for-your-repository#removing-stale-configurations-and-alerts-from-a-branch", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "tool", - "branch", - "category", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Resolving code scanning alerts" - }, - { - "action": "repo.codeql_disabled", - "description": "Code scanning using the default setup was disabled for a repository.", - "docs_reference_links": "/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Configuring default setup for code scanning" - }, - { - "action": "repo.codeql_enabled", - "description": "Code scanning using the default setup was enabled for a repository.", - "docs_reference_links": "/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "query_suite", - "threat_model", - "languages" - ], - "docs_reference_titles": "Configuring default setup for code scanning" - }, - { - "action": "repo.codeql_updated", - "description": "Code scanning using the default setup was updated for a repository.", - "docs_reference_links": "/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "query_suite", - "threat_model", - "languages", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Configuring default setup for code scanning" - }, - { - "action": "repo.collaborators_only", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.config.disable_collaborators_only", - "description": "The interaction limit for collaborators only was disabled.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository" - }, - { - "action": "repo.config.disable_contributors_only", - "description": "The interaction limit for prior contributors only was disabled in a repository.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository" - }, - { - "action": "repo.config.disable_sockpuppet_disallowed", - "description": "The interaction limit for existing users only was disabled in a repository.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository" - }, - { - "action": "repo.config.enable_collaborators_only", - "description": "The interaction limit for collaborators only was enabled in a repository Users that are not collaborators or organization members were unable to interact with a repository for a set duration.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository" - }, - { - "action": "repo.config.enable_contributors_only", - "description": "The interaction limit for prior contributors only was enabled in a repository Users that are not prior contributors, collaborators or organization members were unable to interact with a repository for a set duration.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository" - }, - { - "action": "repo.config.enable_sockpuppet_disallowed", - "description": "The interaction limit for existing users was enabled in a repository New users aren't able to interact with a repository for a set duration Existing users of the repository, contributors, collaborators or organization members are able to interact with a repository.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository" - }, - { - "action": "repo.configure_self_hosted_jit_runner", - "description": "A new just-in-time GitHub Actions self-hosted runner was configured", - "docs_reference_links": "/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository" - }, - { - "action": "repo.create", - "description": "A repository was created.", - "docs_reference_links": "/repositories/creating-and-managing-repositories/creating-a-new-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "request_category", - "created_at", - "oauth_application_id", - "request_method", - "public_repo", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/creating-and-managing-repositories/creating-a-new-repository" - }, - { - "action": "repo.create_actions_secret", - "description": "A GitHub Actions secret was created for a repository.", - "docs_reference_links": "/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Using secrets in GitHub Actions" - }, - { - "action": "repo.create_actions_variable", - "description": "A GitHub Actions variable was created for a repository.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "repo.create_integration_secret", - "description": "A Codespaces or Dependabot secret was created for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "integration", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "repo.destroy", - "description": "A repository was deleted.", - "docs_reference_links": "/repositories/creating-and-managing-repositories/deleting-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "request_category", - "visibility", - "created_at", - "request_method", - "oauth_application_id", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/creating-and-managing-repositories/deleting-a-repository" - }, - { - "action": "repo.disk_archive", - "description": "A repository was archived on disk.", - "docs_reference_links": "/repositories/archiving-a-github-repository/archiving-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/repositories/archiving-a-github-repository/archiving-repositories" - }, - { - "action": "repo.download_zip", - "description": "A source code archive of a repository was downloaded as a ZIP file.", - "docs_reference_links": "/repositories/working-with-files/using-files/downloading-source-code-archives", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "created_at", - "operation_type", - "public_repo", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/working-with-files/using-files/downloading-source-code-archives" - }, - { - "action": "repo.hide_from_discovery", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "visibility", - "created_at" - ] - }, - { - "action": "repo.noindex", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "created_at", - "operation_type", - "public_repo" - ] - }, - { - "action": "repo.override_unlock", - "description": "The repository was unlocked.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.pages_build", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "visibility" - ] - }, - { - "action": "repo.pages_cname", - "description": "A GitHub Pages custom domain was modified in a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "cname", - "created_at", - "operation_type", - "old_cname" - ] - }, - { - "action": "repo.pages_create", - "description": "A GitHub Pages site was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.pages_destroy", - "description": "A GitHub Pages site was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "visibility", - "operation_type" - ] - }, - { - "action": "repo.pages_https_redirect_disabled", - "description": "HTTPS redirects were disabled for a GitHub Pages site.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.pages_https_redirect_enabled", - "description": "HTTPS redirects were enabled for a GitHub Pages site.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "visibility", - "operation_type" - ] - }, - { - "action": "repo.pages_private", - "description": "A GitHub Pages site visibility was changed to private.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.pages_public", - "description": "A GitHub Pages site visibility was changed to public.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.pages_soft_delete", - "description": "A GitHub Pages site was soft-deleted because its owner's plan changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "repo.pages_soft_delete_restore", - "description": "A GitHub Pages site that was previously soft-deleted was restored.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "repo.pages_source", - "description": "A GitHub Pages source was modified.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "visibility", - "created_at" - ] - }, - { - "action": "repo.register_self_hosted_runner", - "description": "A new self-hosted runner was registered.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Adding self-hosted runners" - }, - { - "action": "repo.remove_actions_secret", - "description": "A GitHub Actions secret was deleted for a repository.", - "docs_reference_links": "/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Using secrets in GitHub Actions" - }, - { - "action": "repo.remove_actions_variable", - "description": "A GitHub Actions variable was deleted for a repository.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "repo.remove_integration_secret", - "description": "A Codespaces or Dependabot secret was deleted for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "integration", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "repo.remove_member", - "description": "A collaborator was removed from a repository.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "visibility" - ], - "docs_reference_titles": "Removing a collaborator from a personal repository" - }, - { - "action": "repo.remove_self_hosted_runner", - "description": "A self-hosted runner was removed.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Removing self-hosted runners" - }, - { - "action": "repo.remove_topic", - "description": "A topic was removed from a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "topic", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.rename", - "description": "A repository was renamed.", - "docs_reference_links": "/repositories/creating-and-managing-repositories/renaming-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "old_name", - "created_at", - "operation_type", - "visibility" - ], - "docs_reference_titles": "/repositories/creating-and-managing-repositories/renaming-a-repository" - }, - { - "action": "repo.require_login", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "visibility", - "operation_type" - ] - }, - { - "action": "repo.restore", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.self_hosted_runner_offline", - "description": "The runner application was stopped. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_id", - "runner_name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Monitoring and troubleshooting self-hosted runners" - }, - { - "action": "repo.self_hosted_runner_online", - "description": "The runner application was started. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_id", - "runner_name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Monitoring and troubleshooting self-hosted runners" - }, - { - "action": "repo.self_hosted_runner_updated", - "description": "The runner application was updated. This event is not included in the JSON/CSV export.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#about-self-hosted-runners", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_id", - "runner_name", - "source_version", - "target_version", - "runner_group_id", - "runner_group_name" - ], - "docs_reference_titles": "Self-hosted runners" - }, - { - "action": "repo.set_actions_fork_pr_approvals_policy", - "description": "The setting for requiring approvals for workflows from public forks was changed for a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-required-approval-for-workflows-from-public-forks", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "policy", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-required-approval-for-workflows-from-public-forks" - }, - { - "action": "repo.set_actions_private_fork_pr_approvals_policy", - "description": "The policy for requiring approval for fork pull request workflows from collaborators without write access to private repos was changed for a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-forks-of-private-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "policy", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-forks-of-private-repositories" - }, - { - "action": "repo.set_actions_retention_limit", - "description": "The retention period for GitHub Actions artifacts and logs in a repository was changed.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "limit", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository" - }, - { - "action": "repo.set_default_workflow_permissions", - "description": "The default permissions granted to the GITHUB_TOKEN when running workflows were changed for a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository" - }, - { - "action": "repo.set_fork_pr_workflows_policy", - "description": "Triggered when the policy for workflows on private repository forks is changed.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "policy", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks" - }, - { - "action": "repo.set_workflow_permission_can_approve_pr", - "description": "The policy for allowing GitHub Actions to create and approve pull requests was changed for a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#preventing-github-actions-from-creating-or-approving-pull-requests", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#preventing-github-actions-from-creating-or-approving-pull-requests" - }, - { - "action": "repo.staff_unlock", - "description": "An enterprise owner or GitHub staff (with permission from a repository administrator) temporarily unlocked the repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "repo.temporary_access_granted", - "description": "Temporary access was enabled for a repository.", - "docs_reference_links": "/admin/user-management/managing-repositories-in-your-enterprise/accessing-user-owned-repositories-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Accessing user-owned repositories in your enterprise" - }, - { - "action": "repo.transfer", - "description": "A user accepted a request to receive a transferred repository.", - "docs_reference_links": "/repositories/creating-and-managing-repositories/transferring-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "old_user", - "operation_type", - "created_at", - "visibility", - "repo_was" - ], - "docs_reference_titles": "/repositories/creating-and-managing-repositories/transferring-a-repository" - }, - { - "action": "repo.transfer_outgoing", - "description": "A repository was transferred to another repository network.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "new_nwo", - "visibility", - "created_at", - "operation_type", - "public_repo" - ] - }, - { - "action": "repo.transfer_start", - "description": "A user sent a request to transfer a repository to another user or organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "visibility" - ] - }, - { - "action": "repo.unarchived", - "description": "A repository was unarchived.", - "docs_reference_links": "/repositories/archiving-a-github-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "visibility" - ], - "docs_reference_titles": "/repositories/archiving-a-github-repository" - }, - { - "action": "repo.update_actions_access_settings", - "description": "The setting to control how a repository was used by GitHub Actions workflows in other repositories was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "policy", - "old_policy", - "created_at", - "operation_type" - ] - }, - { - "action": "repo.update_actions_secret", - "description": "A GitHub Actions secret was updated for a repository.", - "docs_reference_links": "/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "key", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Using secrets in GitHub Actions" - }, - { - "action": "repo.update_actions_settings", - "description": "A repository administrator changed GitHub Actions policy settings for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at", - "new_policy", - "old_policy", - "updated_access_policy", - "actor_is_bot" - ] - }, - { - "action": "repo.update_actions_variable", - "description": "A GitHub Actions variable was updated for a repository.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "repo.update_default_branch", - "description": "The default branch for a repository was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at", - "actor_is_bot" - ] - }, - { - "action": "repo.update_integration_secret", - "description": "A Codespaces or Dependabot secret was updated for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "integration", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "repo.update_member", - "description": "A user's permission to a repository was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "oauth_application_id", - "operation_type", - "visibility", - "old_permission", - "old_base_role", - "old_repo_permission", - "old_repo_base_role", - "new_repo_base_role", - "new_repo_permission", - "actor_is_bot" - ] - }, - { - "action": "repository_branch_protection_evaluation.disable", - "description": "Branch protections were disabled for the repository.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule" - }, - { - "action": "repository_branch_protection_evaluation.enable", - "description": "Branch protections were enabled for this repository.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule" - }, - { - "action": "repository_image.create", - "description": "An image to represent a repository was uploaded.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "content_type" - ] - }, - { - "action": "repository_image.destroy", - "description": "An image to represent a repository was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "content_type", - "created_at", - "operation_type" - ] - }, - { - "action": "repository_invitation.accept", - "description": "An invitation to join a repository was accepted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "invitee", - "operation_type", - "inviter" - ] - }, - { - "action": "repository_invitation.cancel", - "description": "An invitation to join a repository was canceled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "inviter", - "operation_type", - "invitee", - "created_at" - ] - }, - { - "action": "repository_invitation.create", - "description": "An invitation to join a repository was sent.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "invitee", - "inviter", - "created_at", - "operation_type" - ] - }, - { - "action": "repository_invitation.reject", - "description": "An invitation to join a repository was declined.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "invitee", - "operation_type", - "created_at", - "inviter" - ] - }, - { - "action": "repository_ruleset.create", - "description": "A repository ruleset was created.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "public_repo", - "created_at", - "operation_type", - "ruleset_id", - "ruleset_name", - "ruleset_enforcement", - "ruleset_source_type", - "ruleset_rules", - "ruleset_conditions", - "ruleset_bypass_actors" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository" - }, - { - "action": "repository_ruleset.destroy", - "description": "A repository ruleset was deleted.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#deleting-a-ruleset", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "public_repo", - "created_at", - "operation_type", - "ruleset_id", - "ruleset_name", - "ruleset_enforcement", - "ruleset_source_type", - "ruleset_rules", - "ruleset_bypass_actors" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#deleting-a-ruleset" - }, - { - "action": "repository_ruleset.update", - "description": "A repository ruleset was edited.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#editing-a-ruleset", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "old_name", - "public_repo", - "created_at", - "operation_type", - "ruleset_id", - "ruleset_name", - "ruleset_enforcement", - "ruleset_source_type", - "ruleset_rules_updated", - "ruleset_conditions_added", - "ruleset_conditions_deleted", - "ruleset_old_enforcement", - "ruleset_rules_added", - "ruleset_rules_deleted", - "ruleset_old_name", - "ruleset_conditions_updated", - "ruleset_bypass_actors_added", - "ruleset_bypass_actors_deleted", - "ruleset_bypass_actors_updated", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#editing-a-ruleset" - }, - { - "action": "repository_secret_scanning_automatic_validity_checks.disabled", - "description": "Automatic partner validation checks have been disabled at the repository level", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#allowing-validity-checks-for-partner-patterns-in-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#allowing-validity-checks-for-partner-patterns-in-a-repository" - }, - { - "action": "repository_secret_scanning_automatic_validity_checks.enabled", - "description": "Automatic partner validation checks have been enabled at the repository level", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#allowing-validity-checks-for-partner-patterns-in-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#allowing-validity-checks-for-partner-patterns-in-a-repository" - }, - { - "action": "repository_secret_scanning_custom_pattern.create", - "description": "A custom pattern was created for secret scanning in a repository.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "repository_secret_scanning_custom_pattern.delete", - "description": "A custom pattern was removed from secret scanning in a repository.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#removing-a-custom-pattern", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "repository_secret_scanning_custom_pattern.publish", - "description": "A custom pattern was published for secret scanning in a repository.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "repository_secret_scanning_custom_pattern_push_protection.disabled", - "description": "Push protection for a custom pattern for secret scanning was disabled for your repository.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "repository_secret_scanning_custom_pattern_push_protection.enabled", - "description": "Push protection for a custom pattern for secret scanning was enabled for your repository.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "repository_secret_scanning_custom_pattern.update", - "description": "Changes to a custom pattern were saved and a dry run was executed for secret scanning in a repository.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#editing-a-custom-pattern", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "repository_secret_scanning.disable", - "description": "Secret scanning was disabled for a repository.", - "docs_reference_links": "/code-security/secret-scanning/about-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "About secret scanning" - }, - { - "action": "repository_secret_scanning.enable", - "description": "Secret scanning was enabled for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "repository_secret_scanning_non_provider_patterns.disabled", - "description": "Secret scanning for non-provider patterns was disabled at the repository level.", - "docs_reference_links": "/code-security/secret-scanning/secret-scanning-patterns#non-provider-patterns", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Supported secret scanning patterns" - }, - { - "action": "repository_secret_scanning_non_provider_patterns.enabled", - "description": "Secret scanning for non-provider patterns was enabled at the repository level.", - "docs_reference_links": "/code-security/secret-scanning/secret-scanning-patterns#non-provider-patterns", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Supported secret scanning patterns" - }, - { - "action": "repository_secret_scanning_push_protection_bypass_list.add", - "description": "A role or team was added to the push protection bypass list at the repository level.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "repository_secret_scanning_push_protection_bypass_list.disable", - "description": "Push protection settings for \"Users who can bypass push protection for secret scanning\" changed from \"Specific roles or teams\" to \"Anyone with write access\" at the repository level.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "repository_secret_scanning_push_protection_bypass_list.enable", - "description": "Push protection settings for \"Users who can bypass push protection for secret scanning\" changed from \"Anyone with write access\" to \"Specific roles or teams\" at the repository level.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "repository_secret_scanning_push_protection_bypass_list.remove", - "description": "A role or team was removed from the push protection bypass list at the repository level.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "repository_secret_scanning_push_protection.disable", - "description": "Secret scanning push protection was disabled for a repository.", - "docs_reference_links": "/code-security/secret-scanning/protecting-pushes-with-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "repository_secret_scanning_push_protection.enable", - "description": "Secret scanning push protection was enabled for a repository.", - "docs_reference_links": "/code-security/secret-scanning/protecting-pushes-with-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "restrict_notification_delivery.disable", - "description": "Email notification restrictions for an organization or enterprise were disabled.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization, /admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Restricting email notifications for your organization, Restricting email notifications for your enterprise" - }, - { - "action": "restrict_notification_delivery.enable", - "description": "Email notification restrictions for an organization or enterprise were enabled.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization, /admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Restricting email notifications for your organization, Restricting email notifications for your enterprise" - }, - { - "action": "secret_scanning_alert.create", - "description": "GitHub detected a secret and created a secret scanning alert.", - "docs_reference_links": "/code-security/secret-scanning/managing-alerts-from-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "number", - "secret_type", - "secret_type_display_name", - "publicly_leaked", - "multi_repo" - ], - "docs_reference_titles": "Manage secret scanning alerts" - }, - { - "action": "secret_scanning_alert.reopen", - "description": "A secret scanning alert was reopened.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "number", - "public_repo", - "created_at", - "operation_type", - "secret_type_display_name" - ] - }, - { - "action": "secret_scanning_alert.resolve", - "description": "A secret scanning alert was resolved.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "number", - "resolution", - "public_repo", - "created_at", - "operation_type", - "secret_type", - "secret_type_display_name", - "publicly_leaked", - "multi_repo" - ] - }, - { - "action": "secret_scanning_alert.revoke", - "description": "A secret scanning alert was revoked.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "number", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "secret_scanning_alert.validate", - "description": "A secret scanning alert was validated.", - "docs_reference_links": "/code-security/secret-scanning/managing-alerts-from-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "number", - "created_at", - "previous_validity", - "current_validity", - "secret_type", - "secret_type_display_name", - "publicly_leaked", - "multi_repo" - ], - "docs_reference_titles": "Manage secret scanning alerts" - }, - { - "action": "secret_scanning.disable", - "description": "Secret scanning was disabled for all existing repositories.", - "docs_reference_links": "/code-security/secret-scanning/about-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "About secret scanning" - }, - { - "action": "secret_scanning.enable", - "description": "Secret scanning was enabled for all existing repositories.", - "docs_reference_links": "/code-security/secret-scanning/about-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About secret scanning" - }, - { - "action": "secret_scanning_new_repos.disable", - "description": "Secret scanning was disabled for all new repositories.", - "docs_reference_links": "/code-security/secret-scanning/about-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "About secret scanning" - }, - { - "action": "secret_scanning_new_repos.enable", - "description": "Secret scanning was enabled for all new repositories.", - "docs_reference_links": "/code-security/secret-scanning/about-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About secret scanning" - }, - { - "action": "secret_scanning_push_protection.bypass", - "description": "Triggered when a user bypasses the push protection on a secret detected by secret scanning.", - "docs_reference_links": "/code-security/secret-scanning/protecting-pushes-with-secret-scanning#bypassing-push-protection-for-a-secret", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "number", - "created_at", - "push_protection_bypass_reason", - "secret_type", - "secret_type_display_name", - "publicly_leaked", - "multi_repo", - "request_reviewer", - "request_reviewer_id" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "secret_scanning_push_protection_request.approve", - "description": "A request to bypass secret scanning push protection was approved by a user.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#managing-requests-to-bypass-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "number", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "secret_scanning_push_protection_request.deny", - "description": "A request to bypass secret scanning push protection was denied by a user.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#managing-requests-to-bypass-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "number", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot", - "request_reviewer_comment" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "secret_scanning_push_protection_request.request", - "description": "A user requested to bypass secret scanning push protection.", - "docs_reference_links": "/code-security/secret-scanning/working-with-push-protection#requesting-bypass-privileges-when-working-with-the-command-line", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "number", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "/code-security/secret-scanning/working-with-push-protection#requesting-bypass-privileges-when-working-with-the-command-line" - }, - { - "action": "security_key.register", - "description": "A security key was registered for an account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "security_key.remove", - "description": "A security key was removed from an account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "sponsors.agreement_sign", - "description": "A GitHub Sponsors agreement was signed on behalf of an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "created_at", - "operation_type" - ] - }, - { - "action": "sponsors.custom_amount_settings_change", - "description": "Custom amounts for GitHub Sponsors were enabled or disabled, or the suggested custom amount was changed.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers" - }, - { - "action": "sponsors.fiscal_host_change", - "description": "The fiscal host for a GitHub Sponsors listing was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "created_at", - "operation_type" - ] - }, - { - "action": "sponsors.repo_funding_links_file_action", - "description": "The FUNDING file in a repository was changed.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository" - }, - { - "action": "sponsors.sponsor_sponsorship_cancel", - "description": "A sponsorship was canceled.", - "docs_reference_links": "/billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Downgrading a sponsorship" - }, - { - "action": "sponsors.sponsor_sponsorship_create", - "description": "A sponsorship was created, by sponsoring an account.", - "docs_reference_links": "/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes" - }, - { - "action": "sponsors.sponsor_sponsorship_payment_complete", - "description": "After you sponsor an account and a payment has been processed, the sponsorship payment was marked as complete.", - "docs_reference_links": "/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "active", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes" - }, - { - "action": "sponsors.sponsor_sponsorship_preference_change", - "description": "The option to receive email updates from a sponsored account was changed.", - "docs_reference_links": "/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship" - }, - { - "action": "sponsors.sponsor_sponsorship_tier_change", - "description": "A sponsorship was upgraded or downgraded.", - "docs_reference_links": "/billing/managing-billing-for-github-sponsors/upgrading-a-sponsorship, /billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Upgrading a sponsorship, Downgrading a sponsorship" - }, - { - "action": "sponsors.sponsored_developer_approve", - "description": "A GitHub Sponsors account was approved.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account" - }, - { - "action": "sponsors.sponsored_developer_create", - "description": "A GitHub Sponsors account was created.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account" - }, - { - "action": "sponsors.sponsored_developer_disable", - "description": "A GitHub Sponsors account was disabled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "operation_type", - "created_at" - ] - }, - { - "action": "sponsors.sponsored_developer_profile_update", - "description": "The profile for GitHub Sponsors account was edited.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors" - }, - { - "action": "sponsors.sponsored_developer_redraft", - "description": "A GitHub Sponsors account was returned to draft state from approved state.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "sponsors.sponsored_developer_request_approval", - "description": "An application for GitHub Sponsors was submitted for approval.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account" - }, - { - "action": "sponsors.sponsored_developer_tier_description_update", - "description": "The description for a sponsorship tier was changed.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers" - }, - { - "action": "sponsors.sponsored_developer_update_newsletter_send", - "description": "Triggered when you send an email update to your sponsors.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors" - }, - { - "action": "sponsors.sponsors_patreon_user_create", - "description": "A Patreon account was linked to a user account for use with GitHub Sponsors.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/enabling-sponsorships-through-patreon#linking-your-patreon-account-to-your-github-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "patreon_email", - "patreon_username", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/enabling-sponsorships-through-patreon#linking-your-patreon-account-to-your-github-account" - }, - { - "action": "sponsors.sponsors_patreon_user_destroy", - "description": "A Patreon account for use with GitHub Sponsors was unlinked from a user account.", - "docs_reference_links": "/sponsors/sponsoring-open-source-contributors/unlinking-your-patreon-account-from-your-github-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "patreon_email", - "patreon_username", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Unlinking your Patreon account from GitHub" - }, - { - "action": "sponsors.update_tier_repository", - "description": "A GitHub Sponsors tier changed access for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "created_at", - "operation_type" - ] - }, - { - "action": "sponsors.update_tier_welcome_message", - "description": "The welcome message for a GitHub Sponsors tier for an organization was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "created_at", - "operation_type" - ] - }, - { - "action": "sponsors.waitlist_join", - "description": "You join the waitlist to join GitHub Sponsors.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account" - }, - { - "action": "sponsors.withdraw_agreement_signature", - "description": "A signature was withdrawn from a GitHub Sponsors agreement that applies to an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "created_at", - "operation_type" - ] - }, - { - "action": "ssh_certificate_authority.create", - "description": "An SSH certificate authority for an organization or enterprise was created.", - "docs_reference_links": "/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities, /admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-ssh-certificate-authorities-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "fingerprint", - "operation_type", - "openssh_public_key", - "created_at" - ], - "docs_reference_titles": "Managing your organization's SSH certificate authorities, Enforcing policies for security settings in your enterprise" - }, - { - "action": "ssh_certificate_authority.destroy", - "description": "An SSH certificate authority for an organization or enterprise was deleted.", - "docs_reference_links": "/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities, /admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-ssh-certificate-authorities-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "fingerprint", - "operation_type", - "openssh_public_key" - ], - "docs_reference_titles": "Managing your organization's SSH certificate authorities, Enforcing policies for security settings in your enterprise" - }, - { - "action": "ssh_certificate_requirement.disable", - "description": "The requirement for members to use SSH certificates to access an organization resources was disabled.", - "docs_reference_links": "/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities, /admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-ssh-certificate-authorities-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing your organization's SSH certificate authorities, Enforcing policies for security settings in your enterprise" - }, - { - "action": "ssh_certificate_requirement.enable", - "description": "The requirement for members to use SSH certificates to access an organization resources was enabled.", - "docs_reference_links": "/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities, /admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-ssh-certificate-authorities-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing your organization's SSH certificate authorities, Enforcing policies for security settings in your enterprise" - }, - { - "action": "staff.set_domain_token_expiration", - "description": "The verification code expiry time for an organization or enterprise domain was set.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner_type", - "domain_name", - "token_expires_at", - "owner", - "operation_type", - "created_at" - ] - }, - { - "action": "staff.unverify_domain", - "description": "An organization or enterprise domain was unverified.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "owner_type", - "domain_name", - "owner", - "operation_type" - ] - }, - { - "action": "staff.verify_domain", - "description": "An organization or enterprise domain was verified.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "domain_name", - "operation_type", - "created_at" - ] - }, - { - "action": "successor_invitation.accept", - "description": "Triggered when you accept a succession invitation.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" - }, - { - "action": "successor_invitation.cancel", - "description": "Triggered when you cancel a succession invitation.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" - }, - { - "action": "successor_invitation.create", - "description": "Triggered when you create a succession invitation.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" - }, - { - "action": "successor_invitation.decline", - "description": "Triggered when you decline a succession invitation.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" - }, - { - "action": "successor_invitation.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "successor_invitation.revoke", - "description": "Triggered when you revoke a succession invitation.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" - }, - { - "action": "team.add_member", - "description": "A member of an organization was added to a team.", - "docs_reference_links": "/organizations/organizing-members-into-teams/adding-organization-members-to-a-team", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "created_at", - "operation_type", - "team_type" - ], - "docs_reference_titles": "/organizations/organizing-members-into-teams/adding-organization-members-to-a-team" - }, - { - "action": "team.add_repository", - "description": "A team was given access and permissions to a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "operation_type", - "created_at", - "actor_is_bot" - ] - }, - { - "action": "team.change_parent_team", - "description": "A child team was created or a child team's parent was changed.", - "docs_reference_links": "/organizations/organizing-members-into-teams/moving-a-team-in-your-organizations-hierarchy", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "team", - "operation_type" - ], - "docs_reference_titles": "/organizations/organizing-members-into-teams/moving-a-team-in-your-organizations-hierarchy" - }, - { - "action": "team.change_privacy", - "description": "A team's privacy level was changed.", - "docs_reference_links": "/organizations/organizing-members-into-teams/changing-team-visibility", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "created_at", - "operation_type", - "team_type" - ], - "docs_reference_titles": "/organizations/organizing-members-into-teams/changing-team-visibility" - }, - { - "action": "team.create", - "description": "A new team is created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "operation_type", - "team", - "created_at", - "team_type" - ] - }, - { - "action": "team.demote_maintainer", - "description": "A user was demoted from a team maintainer to a team member.", - "docs_reference_links": "/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member" - }, - { - "action": "team.destroy", - "description": "A team was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "team", - "operation_type", - "team_type" - ] - }, - { - "action": "team_discussions.clear", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "team_discussions.disable", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "team_discussions.enable", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "team.promote_maintainer", - "description": "A user was promoted from a team member to a team maintainer.", - "docs_reference_links": "/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member#promoting-an-organization-member-to-team-maintainer", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member#promoting-an-organization-member-to-team-maintainer" - }, - { - "action": "team.remove_member", - "description": "An organization member was removed from a team.", - "docs_reference_links": "/organizations/organizing-members-into-teams/removing-organization-members-from-a-team", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "team", - "team_type" - ], - "docs_reference_titles": "/organizations/organizing-members-into-teams/removing-organization-members-from-a-team" - }, - { - "action": "team.remove_repository", - "description": "A repository was removed from a team's control.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "team", - "operation_type" - ] - }, - { - "action": "team.rename", - "description": "A team's name was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "created_at", - "team", - "operation_type", - "team_type" - ] - }, - { - "action": "team_sync_tenant.disabled", - "description": "Team synchronization with a tenant was disabled.", - "docs_reference_links": "/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization, /admin/identity-and-access-management/using-saml-for-enterprise-iam/managing-team-synchronization-for-organizations-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing team synchronization for your organization, Managing team synchronization for organizations in your enterprise" - }, - { - "action": "team_sync_tenant.enabled", - "description": "Team synchronization with a tenant was enabled.", - "docs_reference_links": "/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization, /admin/identity-and-access-management/using-saml-for-enterprise-iam/managing-team-synchronization-for-organizations-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing team synchronization for your organization, Managing team synchronization for organizations in your enterprise" - }, - { - "action": "team.update_repository_permission", - "description": "A team's permission to a repository was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "old_permission", - "operation_type", - "created_at", - "permission", - "new_repo_permission", - "new_repo_base_role", - "old_repo_permission", - "old_repo_base_role" - ] - }, - { - "action": "trusted_device.register", - "description": "A new trusted device was added.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "trusted_device.remove", - "description": "A trusted device was removed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "two_factor_account_recovery.abort", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "two_factor_account_recovery.complete", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "two_factor_account_recovery.ignore", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "two_factor_account_recovery.staff_approve", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "two_factor_account_recovery.staff_decline", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "two_factor_account_recovery.start", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "two_factor_account_recovery.two_factor_destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "two_factor_authentication.add_factor", - "description": "A secondary authentication factor was added to a user account.", - "docs_reference_links": "/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication" - }, - { - "action": "two_factor_authentication.disabled", - "description": "Two-factor authentication was disabled for a user account.", - "docs_reference_links": "https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/disabling-two-factor-authentication-for-your-personal-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Disabling two-factor authentication for your personal account" - }, - { - "action": "two_factor_authentication.enabled", - "description": "Two-factor authentication was enabled for a user account.", - "docs_reference_links": "https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Configuring two-factor authentication" - }, - { - "action": "two_factor_authentication.password_reset_fallback_sms", - "description": "A one-time password code was sent to a user account fallback phone number.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "two_factor_authentication.recovery_codes_regenerated", - "description": "Two factor recovery codes were regenerated for a user account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "two_factor_authentication.remove_factor", - "description": "A secondary authentication factor was removed from a user account.", - "docs_reference_links": "/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication" - }, - { - "action": "two_factor_authentication.sign_in_fallback_sms", - "description": "A one-time password code was sent to a user account fallback phone number.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "two_factor_authentication.update_fallback", - "description": "The two-factor authentication fallback for a user account was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.add_email", - "description": "An email address was added to a user account.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "email", - "created_at" - ], - "docs_reference_titles": "Adding an email address to your GitHub account" - }, - { - "action": "user.async_delete", - "description": "An asynchronous job was started to destroy a user account, eventually triggering a user.delete event.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.audit_log_export", - "description": "Audit log entries were exported.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.block_user", - "description": "A user was blocked by another user.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "blocked_user", - "operation_type", - "created_at" - ] - }, - { - "action": "user.change_password", - "description": "A user changed their password.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.codespaces_trusted_repo_access_granted", - "description": "Triggered when you allow the codespaces you create for a repository to access other repositories owned by your personal account.", - "docs_reference_links": "/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing access to other repositories within your codespace" - }, - { - "action": "user.codespaces_trusted_repo_access_revoked", - "description": "Triggered when you disallow the codespaces you create for a repository to access other repositories owned by your personal account.", - "docs_reference_links": "/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing access to other repositories within your codespace" - }, - { - "action": "user.correct_password_from_unrecognized_device", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.correct_password_from_unrecognized_device_and_location", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.correct_password_from_unrecognized_location", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.create", - "description": "A new user account was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "email", - "operation_type", - "created_at" - ] - }, - { - "action": "user.create_integration_secret", - "description": "A user secret for Codespaces was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "integration", - "created_at", - "operation_type" - ] - }, - { - "action": "user.creation_rate_limit_exceeded", - "description": "The rate of creation of user accounts, applications, issues, pull requests or other resources exceeded the configured rate limits, or too many users were followed too quickly.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "oauth_application_id" - ] - }, - { - "action": "user.delete", - "description": "A user account was destroyed by an asynchronous job.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.demote", - "description": "A site administrator was demoted to an ordinary user account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "created_at", - "operation_type" - ] - }, - { - "action": "user.destroy", - "description": "A user deleted his or her account, triggering user.async_delete.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.device_verification_failure", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.device_verification_requested", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.device_verification_success", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.disable_collaborators_only", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.disable_contributors_only", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.disable_sockpuppet_disallowed", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user_email.confirm_claim", - "description": "An enterprise managed user claimed an email address.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "user_email.mark_as_unclaimed", - "description": "N/A", - "docs_reference_links": "An enterprise managed user unclaimed an email address.", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "An, GitHub Help Documentation, managed, user, unclaimed, an, email, address." - }, - { - "action": "user.enable_collaborators_only", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.enable_contributors_only", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.enable_sockpuppet_disallowed", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.failed_login", - "description": "A user tried to sign in with an incorrect username, password, or two-factor authentication code.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.flag_as_large_scale_contributor", - "description": "A user account was flagged as a large scale contributor. Only contributions from public repositories the user owns will be shown in their contribution graph, in order to prevent timeouts.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.forgot_password", - "description": "A user requested a password reset.", - "docs_reference_links": "/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "email", - "created_at" - ], - "docs_reference_titles": "/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials" - }, - { - "action": "user.grant_github_developer", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.hide_private_contributions_count", - "description": "A user changed the visibility of their private contributions. The number of contributions to private repositories on the user's profile are now hidden.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Manage visibility settings for private contributions" - }, - { - "action": "user.login", - "description": "A user signed in.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "passkey_nickname" - ] - }, - { - "action": "user.logout", - "description": "A user signed out.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.minimize_comment", - "description": "A comment made by a user was minimized.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.new_device_used", - "description": "A user signed in from a new device.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.partial_two_factor_email_followup", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.promote", - "description": "An ordinary user account was promoted to a site administrator.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "oauth_application_id", - "operation_type" - ] - }, - { - "action": "user.recreate", - "description": "A user's account was restored.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.remove_email", - "description": "An email address was removed from a user account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "email" - ] - }, - { - "action": "user.remove_integration_secret", - "description": "A user secret for Codespaces was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "integration", - "created_at", - "operation_type" - ] - }, - { - "action": "user.remove_large_scale_contributor_flag", - "description": "A user account was no longer flagged as a large scale contributor.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.rename", - "description": "A username was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "old_login", - "created_at", - "operation_type" - ] - }, - { - "action": "user.report_abuse", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.report_content", - "description": "Triggered when you report an issue or pull request, or a comment on an issue, pull request, or commit.", - "docs_reference_links": "/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam" - }, - { - "action": "user.reset_password", - "description": "A user reset their account password.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user_session.country_change", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.show_private_contributions_count", - "description": "A user changed the visibility of their private contributions. The number of contributions to private repositories on the user's profile are now shown.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Manage visibility settings for private contributions" - }, - { - "action": "user.sign_in_from_unrecognized_device", - "description": "A user signed in from an unrecognized device.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.sign_in_from_unrecognized_device_and_location", - "description": "A user signed in from an unrecognized device and location.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.sign_in_from_unrecognized_location", - "description": "A user signed in from an unrecognized location.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user_status.destroy", - "description": "Triggered when you clear the status on your profile.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "message", - "created_at", - "limited_availability", - "emoji", - "operation_type" - ] - }, - { - "action": "user_status.update", - "description": "Triggered when you set or change the status on your profile.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "limited_availability", - "message", - "created_at", - "emoji", - "operation_type" - ], - "docs_reference_titles": "Personalize your profile" - }, - { - "action": "user.suspend", - "description": "A user account was suspended.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "operation_type", - "created_at" - ] - }, - { - "action": "user.toggle_warn_private_email", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.two_factor_challenge_failure", - "description": "A 2FA challenge issued for a user account failed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.two_factor_challenge_success", - "description": "A 2FA challenge issued for a user account succeeded.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.two_factor_recover", - "description": "A user used their 2FA recovery codes.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.two_factor_recovery_codes_downloaded", - "description": "A user downloaded 2FA recovery codes for their account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.two_factor_recovery_codes_printed", - "description": "A user printed 2FA recovery codes for their account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.two_factor_recovery_codes_viewed", - "description": "A user viewed 2FA recovery codes for their account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.two_factor_requested", - "description": "A user was prompted for a two-factor authentication code.", - "docs_reference_links": "/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication" - }, - { - "action": "user.unblock_user", - "description": "A user was unblocked by another user.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "blocked_user", - "operation_type", - "created_at" - ] - }, - { - "action": "user.unminimize_comment", - "description": "A comment made by a user was unminimized.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.unsuspend", - "description": "A user account was unsuspended.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "operation_type", - "created_at" - ] - }, - { - "action": "user.update_integration_secret", - "description": "A user secret for Codespaces was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "integration", - "created_at", - "operation_type" - ] - }, - { - "action": "user.update_new_repository_default_branch_setting", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "workflows.approve_workflow_job", - "description": "A workflow job was approved.", - "docs_reference_links": "/actions/managing-workflow-runs/reviewing-deployments", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_run_id", - "run_number", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "Reviewing deployments" - }, - { - "action": "workflows.bypass_protection_rules", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_run_id", - "run_number", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "workflows.cancel_workflow_run", - "description": "A workflow run was cancelled.", - "docs_reference_links": "/actions/managing-workflow-runs/canceling-a-workflow", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "started_at", - "event", - "name", - "workflow_run_id", - "head_branch", - "head_sha", - "run_number", - "cancelled_at", - "workflow_id", - "operation_type", - "trigger_id", - "public_repo" - ], - "docs_reference_titles": "Canceling a workflow run" - }, - { - "action": "workflows.comment_workflow_job", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_run_id", - "run_number", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "workflows.completed_workflow_run", - "description": "A workflow status changed to completed. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "started_at", - "event", - "name", - "workflow_run_id", - "head_branch", - "head_sha", - "completed_at", - "conclusion", - "run_number", - "workflow_id", - "operation_type", - "trigger_id", - "run_attempt", - "actor_is_bot", - "actor_is_agent" - ], - "docs_reference_titles": "Viewing workflow run history" - }, - { - "action": "workflows.created_workflow_run", - "description": "A workflow run was create. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "/actions/learn-github-actions/understanding-github-actions#create-an-example-workflow", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "started_at", - "event", - "name", - "workflow_run_id", - "head_branch", - "head_sha", - "workflow_id", - "operation_type", - "trigger_id", - "public_repo", - "actor_is_bot", - "actor_is_agent" - ], - "docs_reference_titles": "Understanding GitHub Actions" - }, - { - "action": "workflows.delete_workflow_run", - "description": "A workflow run was deleted.", - "docs_reference_links": "/actions/managing-workflow-runs/deleting-a-workflow-run", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "workflow_run_id", - "started_at", - "head_branch", - "head_sha", - "trigger_id" - ], - "docs_reference_titles": "Deleting a workflow run" - }, - { - "action": "workflows.disable_workflow", - "description": "A workflow was disabled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_id", - "operation_type", - "created_at", - "public_repo", - "actor_is_bot" - ] - }, - { - "action": "workflows.enable_workflow", - "description": "A workflow was enabled, after previously being disabled by disable_workflow.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_id", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "workflows.pin_workflow", - "description": "A workflow was pinned.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "workflow_id", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "workflows.prepared_workflow_job", - "description": "A workflow job was started. Includes the list of secrets that were provided to the job. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "/actions/using-workflows/events-that-trigger-workflows", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_run_id", - "job_name", - "runner_labels", - "is_hosted_runner", - "environment_name", - "secrets_passed", - "operation_type", - "created_at", - "runner_owner_type", - "job_workflow_ref", - "calling_workflow_refs", - "calling_workflow_shas", - "imposer_repo" - ], - "docs_reference_titles": "Events that trigger workflows" - }, - { - "action": "workflows.reject_workflow_job", - "description": "A workflow job was rejected.", - "docs_reference_links": "/actions/managing-workflow-runs/reviewing-deployments", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_run_id", - "run_number", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "Reviewing deployments" - }, - { - "action": "workflows.rerun_workflow_run", - "description": "A workflow run was re-run.", - "docs_reference_links": "/actions/managing-workflow-runs/re-running-workflows-and-jobs", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "started_at", - "event", - "name", - "workflow_run_id", - "head_branch", - "head_sha", - "run_number", - "workflow_id", - "operation_type", - "trigger_id", - "run_attempt", - "rerun_type", - "check_run_id", - "actor_is_bot" - ], - "docs_reference_titles": "Re-running workflows and jobs" - }, - { - "action": "workflows.unpin_workflow", - "description": "A workflow was unpinned after previously being pinned.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "workflow_id", - "created_at", - "operation_type", - "actor_is_bot" - ] - } -] \ No newline at end of file diff --git a/src/audit-logs/data/ghes-3.14/organization.json b/src/audit-logs/data/ghes-3.14/organization.json deleted file mode 100644 index 75b575cceb28..000000000000 --- a/src/audit-logs/data/ghes-3.14/organization.json +++ /dev/null @@ -1,22542 +0,0 @@ -[ - { - "action": "account.billing_date_change", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "account.plan_change", - "description": "The account's plan changed.", - "docs_reference_links": "/billing/managing-the-plan-for-your-github-account/about-billing-for-plans", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "How GitHub billing works" - }, - { - "action": "actions_cache.delete", - "description": "A GitHub Actions cache was deleted using the REST API.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "actions_cache_id", - "actions_cache_key", - "actions_cache_version", - "actions_cache_scope", - "created_at", - "operation_type" - ] - }, - { - "action": "advisory_credit.accept", - "description": "Credit was accepted for a security advisory.", - "docs_reference_links": "/code-security/security-advisories/working-with-repository-security-advisories/editing-a-repository-security-advisory", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "ghsa_id", - "recipient", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Editing a repository security advisory" - }, - { - "action": "advisory_credit.create", - "description": "Someone was added to the credit section of a security advisory.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "ghsa_id", - "recipient", - "operation_type", - "created_at" - ] - }, - { - "action": "advisory_credit.decline", - "description": "Credit was declined for a security advisory.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "ghsa_id", - "recipient", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "advisory_credit.destroy", - "description": "Someone was removed from the credit section of a security advisory.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "ghsa_id", - "recipient", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "artifact.destroy", - "description": "A workflow run artifact was manually deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "auto_approve_personal_access_token_requests.disable", - "description": "Triggered when the organization must approve fine-grained personal access tokens before the tokens can access organization resources. See also: personal_access_token.auto_approve_grant_requests_disabled", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization" - }, - { - "action": "auto_approve_personal_access_token_requests.enable", - "description": "Triggered when fine-grained personal access tokens can access organization resources without prior approval. See also: personal_access_token.auto_approve_grant_requests_enabled", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization" - }, - { - "action": "billing.change_billing_type", - "description": "The way the account pays for GitHub was changed.", - "docs_reference_links": "/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing your payment and billing information" - }, - { - "action": "billing.change_email", - "description": "The billing email address changed.", - "docs_reference_links": "/billing/managing-your-github-billing-settings/setting-your-billing-email", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "email" - ], - "docs_reference_titles": "Managing your payment and billing information" - }, - { - "action": "billing.lock", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "operation_type", - "created_at" - ] - }, - { - "action": "billing.unlock", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "checks.auto_trigger_disabled", - "description": "Automatic creation of check suites was disabled on a repository in the organization or enterprise.", - "docs_reference_links": "/rest/checks#update-repository-preferences-for-check-suites", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/rest/checks#update-repository-preferences-for-check-suites" - }, - { - "action": "checks.auto_trigger_enabled", - "description": "Automatic creation of check suites was enabled on a repository in the organization or enterprise.", - "docs_reference_links": "/rest/checks#update-repository-preferences-for-check-suites", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "/rest/checks#update-repository-preferences-for-check-suites" - }, - { - "action": "checks.delete_logs", - "description": "Logs in a check suite were deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "codespaces.allow_permissions", - "description": "A codespace using custom permissions from its devcontainer.json file was launched.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "origin_repository", - "created_at", - "operation_type" - ] - }, - { - "action": "codespaces.attempted_to_create_from_prebuild", - "description": "An attempt to create a codespace from a prebuild was made.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "owner", - "pull_request_id", - "created_at", - "operation_type", - "public_repo" - ] - }, - { - "action": "codespaces.business_enablement_updated", - "description": "Enterprise setting for Codespaces ownership was updated.", - "docs_reference_links": "/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "enablement", - "organization_names", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization" - }, - { - "action": "codespaces.connect", - "description": "Credentials for a codespace were refreshed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "owner", - "name", - "operation_type", - "created_at", - "public_repo", - "actor_is_bot", - "machine_type", - "devcontainer_path" - ] - }, - { - "action": "codespaces.create", - "description": "A codespace was created", - "docs_reference_links": "/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "owner", - "name", - "operation_type", - "created_at", - "actor_is_bot", - "machine_type", - "devcontainer_path" - ], - "docs_reference_titles": "Creating a codespace for a repository" - }, - { - "action": "codespaces.destroy", - "description": "A user deleted a codespace.", - "docs_reference_links": "/codespaces/developing-in-codespaces/deleting-a-codespace", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "owner", - "name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Deleting a codespace" - }, - { - "action": "codespaces.export_environment", - "description": "A codespace was exported to a branch on GitHub.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "owner", - "created_at", - "operation_type", - "public_repo" - ] - }, - { - "action": "codespaces.policy_group_created", - "description": "Policies were applied to codespaces in an organization or enterprise.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "codespaces.policy_group_deleted", - "description": "Policies were removed from codespaces in an organization or enterprise.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "codespaces.policy_group_updated", - "description": "Policies were updated for codespaces in an organization or enterprise.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "codespaces.restore", - "description": "A codespace was restored.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "codespaces.start_environment", - "description": "A codespace was started.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "owner", - "pull_request_id", - "machine_type", - "devcontainer_path", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "codespaces.suspend_environment", - "description": "A codespace was stopped.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "codespaces.trusted_repositories_access_update", - "description": "A personal account's access and security setting for Codespaces were updated.", - "docs_reference_links": "/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing access to other repositories within your codespace" - }, - { - "action": "commit_comment.destroy", - "description": "A commit comment was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "commit_comment.update", - "description": "A commit comment was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "copilot.access_revoked", - "description": "Copilot access was revoked for the organization or enterprise due to its Copilot subscription ending, an issue with billing the entity, the entity being marked spammy, or the entity being suspended.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "reason", - "plan", - "owner", - "created_at", - "operation_type" - ] - }, - { - "action": "copilot.cfb_org_settings_changed", - "description": "Copilot feature settings were changed at the organization level.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "copilot.cfb_seat_added", - "description": "A Copilot Business or Copilot Enterprise seat was added for a user and they have received access to GitHub Copilot. This can occur as the result of directly assigning a seat for a user, assigning a seat for a team, or setting the organization to allow access for all members.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "copilot.cfb_seat_assignment_created", - "description": "A Copilot Business or Copilot Enterprise seat assignment was newly created for a user or a team, and seats are being created.", - "docs_reference_links": "/copilot/overview-of-github-copilot/about-github-copilot-for-business", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "What is GitHub Copilot?" - }, - { - "action": "copilot.cfb_seat_assignment_refreshed", - "description": "A seat assignment that was previously pending cancellation was re-assigned and the user will retain access to Copilot.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "copilot.cfb_seat_assignment_reused", - "description": "A Copilot Business or Copilot Enterprise seat assignment was re-created for a user who already had a seat with no pending cancellation date, and the user will retain access to Copilot.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "copilot.cfb_seat_assignment_unassigned", - "description": "A user or team's Copilot Business or Copilot Enterprise seat assignment was unassigned, and the user(s) will lose access to Copilot at the end of the current billing cycle.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "copilot.cfb_seat_cancelled", - "description": "A user's Copilot Business or Copilot Enterprise seat was canceled, and the user no longer has access to Copilot.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "seat_assignment" - ] - }, - { - "action": "copilot.cfb_seat_cancelled_by_staff", - "description": "A user's Copilot Business or Copilot Enterprise seat was canceled manually by GitHub staff, and the user no longer has access to Copilot.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "copilot.cfb_seat_management_changed", - "description": "The seat management setting was changed at the organization level to either enable or disable Copilot access for all members of the organization, or to enable Copilot access for selected members or teams.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "old_value", - "new_value", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "copilot.content_exclusion_changed", - "description": "The excluded paths for GitHub Copilot were updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "excluded_paths", - "owner_type", - "created_at", - "operation_type" - ] - }, - { - "action": "copilot.knowledge_base_created", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "copilot.knowledge_base_deleted", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "copilot.knowledge_base_updated", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "copilot.plan_changed", - "description": "The plan for GitHub Copilot was updated.", - "docs_reference_links": "/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "old_plan", - "plan", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "GitHub Copilot licenses" - }, - { - "action": "custom_hosted_runner.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "runner_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "custom_hosted_runner.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "custom_hosted_runner.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "runner_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "custom_property_definition.create", - "description": "A new custom property definition was created.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "property_name", - "created_at", - "operation_type", - "value_type", - "required", - "default_value", - "definition_id" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization" - }, - { - "action": "custom_property_definition.destroy", - "description": "A custom property definition was deleted.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "property_name", - "created_at", - "operation_type", - "value_type", - "required", - "default_value", - "definition_id", - "allowed_values" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization" - }, - { - "action": "custom_property_definition.update", - "description": "A custom property definition was updated.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "property_name", - "created_at", - "operation_type", - "value_type", - "required", - "default_value", - "old_allowed_values", - "allowed_values", - "definition_id", - "old_required", - "old_default_value", - "old_value_type", - "old_values_editable_by", - "values_editable_by" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization" - }, - { - "action": "custom_property_value.create", - "description": "A repository's custom property value was manually set for the first time.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "definition_id", - "property_name", - "value", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization" - }, - { - "action": "custom_property_value.destroy", - "description": "A repository's custom property value was deleted.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization" - }, - { - "action": "custom_property_value.update", - "description": "A repository's custom property value was updated.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "definition_id" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization" - }, - { - "action": "dependabot_alerts.disable", - "description": "Dependabot alerts were disabled for all existing repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories" - }, - { - "action": "dependabot_alerts.enable", - "description": "Dependabot alerts were enabled for all existing repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories" - }, - { - "action": "dependabot_alerts_new_repos.disable", - "description": "Dependabot alerts were disabled for all new repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-automatically-when-new-repositories-are-added", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-automatically-when-new-repositories-are-added" - }, - { - "action": "dependabot_alerts_new_repos.enable", - "description": "Dependabot alerts were enabled for all new repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-automatically-when-new-repositories-are-added", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-automatically-when-new-repositories-are-added" - }, - { - "action": "dependabot_repository_access.repositories_updated", - "description": "The repositories that Dependabot can access were updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "dependabot_security_updates.disable", - "description": "Dependabot security updates were disabled for all existing repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization" - }, - { - "action": "dependabot_security_updates.enable", - "description": "Dependabot security updates were enabled for all existing repositories.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "dependabot_security_updates_new_repos.disable", - "description": " Dependabot security updates were disabled for all new repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization" - }, - { - "action": "dependabot_security_updates_new_repos.enable", - "description": "Dependabot security updates were enabled for all new repositories.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "dependency_graph.disable", - "description": "The dependency graph was disabled for all existing repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization" - }, - { - "action": "dependency_graph.enable", - "description": "The dependency graph was enabled for all existing repositories.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "dependency_graph_new_repos.disable", - "description": "The dependency graph was disabled for all new repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization" - }, - { - "action": "dependency_graph_new_repos.enable", - "description": "The dependency graph was enabled for all new repositories.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "discussion_comment.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "discussion_comment.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "discussion.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "title", - "created_at" - ] - }, - { - "action": "discussion_post.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "created_at", - "number", - "title", - "operation_type" - ] - }, - { - "action": "discussion_post_reply.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "number", - "created_at" - ] - }, - { - "action": "discussion_post_reply.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "number", - "team", - "created_at" - ] - }, - { - "action": "discussion_post.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "title", - "operation_type", - "team", - "number" - ] - }, - { - "action": "enterprise_announcement.create", - "description": "A global announcement banner was created for the enterprise.", - "docs_reference_links": "/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "owner_type", - "message", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Customizing user messages for your enterprise" - }, - { - "action": "enterprise_announcement.destroy", - "description": "A global announcement banner was removed from the enterprise.", - "docs_reference_links": "/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "owner_type", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Customizing user messages for your enterprise" - }, - { - "action": "enterprise_announcement.update", - "description": "A global announcement banner was updated for the enterprise.", - "docs_reference_links": "/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "owner_type", - "message", - "old_message", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Customizing user messages for your enterprise" - }, - { - "action": "enterprise_installation.create", - "description": "The GitHub App associated with a GitHub Connect connection was created.", - "docs_reference_links": "/admin/configuration/configuring-github-connect/managing-github-connect", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enabling GitHub Connect for GitHub.com" - }, - { - "action": "enterprise_installation.destroy", - "description": "The GitHub App associated with a GitHub Connect connection was deleted.", - "docs_reference_links": "/admin/configuration/configuring-github-connect/managing-github-connect", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enabling GitHub Connect for GitHub.com" - }, - { - "action": "environment.add_protection_rule", - "description": "A GitHub Actions deployment protection rule was created via the API.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "environment.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "environment_name", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "environment.create_actions_secret", - "description": "A secret was created for a GitHub Actions environment.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "key", - "visibility", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "environment.create_actions_variable", - "description": "A variable was created for a GitHub Actions environment.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-an-environment", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "environment_name", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "environment.delete", - "description": "An environment was deleted.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#deleting-an-environment", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at", - "public_repo", - "actor_is_bot" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "environment.remove_actions_secret", - "description": "A secret was deleted for a GitHub Actions environment.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "key", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "environment.remove_actions_variable", - "description": "A variable was deleted for a GitHub Actions environment.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-an-environment", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "environment_name", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "environment.remove_protection_rule", - "description": "A GitHub Actions deployment protection rule was deleted via the API.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "environment.update_actions_secret", - "description": "A secret was updated for a GitHub Actions environment.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "key", - "visibility", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "environment.update_actions_variable", - "description": "A variable was updated for a GitHub Actions environment.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-an-environment", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "environment_name", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "environment.update_protection_rule", - "description": "A GitHub Actions deployment protection rule was updated via the API.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "new_value", - "approvers_was", - "approvers", - "can_admins_bypass", - "prevent_self_review" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "git.clone", - "description": "A repository was cloned. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "transport_protocol", - "repository_public", - "transport_protocol_name" - ] - }, - { - "action": "git.fetch", - "description": "Changes were fetched from a repository. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "transport_protocol", - "repository_public", - "transport_protocol_name" - ] - }, - { - "action": "git.push", - "description": "Changes were pushed to a repository. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "transport_protocol", - "repository_public", - "transport_protocol_name" - ] - }, - { - "action": "github_hosted_runner.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "runner_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "github_hosted_runner.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "github_hosted_runner.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "runner_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "hook.active_changed", - "description": "A hook's active status was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "name", - "events", - "active", - "active_was", - "hook_id", - "operation_type" - ] - }, - { - "action": "hook.config_changed", - "description": "A hook's configuration was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "name", - "hook_id", - "created_at", - "oauth_application_id", - "events" - ] - }, - { - "action": "hook.create", - "description": "A new hook was added.", - "docs_reference_links": "/get-started/exploring-integrations/about-webhooks", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application", - "oauth_application_id", - "hook_id", - "events", - "operation_type", - "name", - "created_at" - ], - "docs_reference_titles": "About webhooks" - }, - { - "action": "hook.destroy", - "description": "A hook was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "events", - "created_at", - "name", - "operation_type", - "oauth_application_id", - "hook_id" - ] - }, - { - "action": "hook.events_changed", - "description": "A hook's configured events were changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "events", - "operation_type", - "name", - "events_were", - "created_at", - "hook_id", - "oauth_application_id" - ] - }, - { - "action": "integration.create", - "description": "A GitHub App was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "name", - "integration", - "created_at", - "application_client_id" - ] - }, - { - "action": "integration.destroy", - "description": "A GitHub App was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "operation_type", - "created_at" - ] - }, - { - "action": "integration.generate_client_secret", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "operation_type", - "created_at", - "application_client_id" - ] - }, - { - "action": "integration_installation.create", - "description": "A GitHub App was installed.", - "docs_reference_links": "/apps/using-github-apps/authorizing-github-apps", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "name", - "repository_selection", - "created_at", - "integration", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/authorizing-github-apps" - }, - { - "action": "integration_installation.destroy", - "description": "A GitHub App was uninstalled.", - "docs_reference_links": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "repository_selection", - "integration", - "operation_type", - "name", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access" - }, - { - "action": "integration_installation.repositories_added", - "description": "Repositories were added to a GitHub App.", - "docs_reference_links": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#modifying-repository-access", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "repository_selection", - "name", - "integration", - "operation_type", - "repositories_added", - "created_at", - "repositories_added_names", - "actor_is_bot", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#modifying-repository-access" - }, - { - "action": "integration_installation.repositories_removed", - "description": "Repositories were removed from a GitHub App.", - "docs_reference_links": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#modifying-repository-access", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "repository_selection", - "repositories_removed", - "integration", - "created_at", - "name", - "repositories_removed_names", - "actor_is_bot", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#modifying-repository-access" - }, - { - "action": "integration_installation_request.close", - "description": "A request to install a GitHub App was either approved or denied by an owner, or canceled by the member who opened the request.", - "docs_reference_links": "/apps/using-github-apps/requesting-a-github-app-from-your-organization-owner", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "url", - "created_at", - "operation_type", - "integration", - "reason", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/requesting-a-github-app-from-your-organization-owner" - }, - { - "action": "integration_installation_request.create", - "description": "A member requested that an owner install a GitHub App.", - "docs_reference_links": "/apps/using-github-apps/requesting-a-github-app-from-your-organization-owner", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "requester", - "created_at", - "url", - "operation_type", - "integration", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/requesting-a-github-app-from-your-organization-owner" - }, - { - "action": "integration_installation.suspend", - "description": "A GitHub App was suspended.", - "docs_reference_links": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "repository_selection", - "integration", - "operation_type", - "created_at", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access" - }, - { - "action": "integration_installation.unsuspend", - "description": "A GitHub App was unsuspended.", - "docs_reference_links": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "repository_selection", - "integration", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access" - }, - { - "action": "integration_installation.version_updated", - "description": "Permissions for a GitHub App were updated.", - "docs_reference_links": "/apps/using-github-apps/approving-updated-permissions-for-a-github-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "integration", - "name", - "operation_type", - "created_at", - "repository_selection", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/approving-updated-permissions-for-a-github-app" - }, - { - "action": "integration.manager_added", - "description": "A member of an enterprise or organization was added as a GitHub App manager.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/adding-and-removing-github-app-managers-in-your-organization#giving-someone-the-ability-to-manage-all-github-apps-owned-by-the-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "name", - "manager", - "operation_type", - "integration" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/adding-and-removing-github-app-managers-in-your-organization#giving-someone-the-ability-to-manage-all-github-apps-owned-by-the-organization" - }, - { - "action": "integration.manager_removed", - "description": "A member of an enterprise or organization was removed from being a GitHub App manager.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/adding-and-removing-github-app-managers-in-your-organization#removing-a-github-app-managers-permissions-for-the-entire-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "integration", - "name", - "created_at", - "manager" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/adding-and-removing-github-app-managers-in-your-organization#removing-a-github-app-managers-permissions-for-the-entire-organization" - }, - { - "action": "integration.remove_client_secret", - "description": "A client secret for a GitHub App was removed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "operation_type", - "created_at" - ] - }, - { - "action": "integration.revoke_all_tokens", - "description": "All user tokens for a GitHub App were requested to be revoked.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "operation_type", - "created_at", - "application_client_id" - ] - }, - { - "action": "integration.revoke_tokens", - "description": "Token(s) for a GitHub App were revoked.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "operation_type", - "created_at", - "application_client_id" - ] - }, - { - "action": "integration.suspend", - "description": "A GitHub App was suspended.", - "docs_reference_links": "/apps/maintaining-github-apps/suspending-a-github-app-installation", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "created_at", - "operation_type", - "application_client_id" - ], - "docs_reference_titles": "/apps/maintaining-github-apps/suspending-a-github-app-installation" - }, - { - "action": "integration.transfer", - "description": "Ownership of a GitHub App was transferred to another user or organization.", - "docs_reference_links": "/apps/maintaining-github-apps/transferring-ownership-of-a-github-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "transfer_to_id", - "requester", - "requester_id", - "created_at", - "transfer_to", - "operation_type", - "integration", - "transfer_from", - "transfer_from_id", - "transfer_from_type", - "transfer_to_type" - ], - "docs_reference_titles": "/apps/maintaining-github-apps/transferring-ownership-of-a-github-app" - }, - { - "action": "integration.unsuspend", - "description": "A GitHub App was unsuspended.", - "docs_reference_links": "/apps/maintaining-github-apps/suspending-a-github-app-installation", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "created_at", - "operation_type", - "application_client_id" - ], - "docs_reference_titles": "/apps/maintaining-github-apps/suspending-a-github-app-installation" - }, - { - "action": "ip_allow_list.disable", - "description": "An IP allow list was disabled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "ip_allow_list.disable_for_installed_apps", - "description": "An IP allow list was disabled for installed GitHub Apps.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "ip_allow_list.enable", - "description": "An IP allow list was enabled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "ip_allow_list.enable_for_installed_apps", - "description": "An IP allow list was enabled for installed GitHub Apps.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "ip_allow_list_entry.create", - "description": "An IP address was added to an IP allow list.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "active", - "ip_allow_list_entry", - "operation_type", - "created_at" - ] - }, - { - "action": "ip_allow_list_entry.destroy", - "description": "An IP address was deleted from an IP allow list.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "ip_allow_list_entry", - "operation_type", - "created_at", - "active" - ] - }, - { - "action": "ip_allow_list_entry.update", - "description": "An IP address or its description was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "ip_allow_list_entry", - "active" - ] - }, - { - "action": "issue_comment.destroy", - "description": "A comment on an issue was deleted from the repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "oauth_application_id" - ] - }, - { - "action": "issue_comment.pinned", - "description": "A comment on an issue was pinned to a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "issue_comment.unpinned", - "description": "A comment on an issue was unpinned from a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "issue_comment.update", - "description": "A comment on an issue (other than the initial one) changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "oauth_application_id" - ] - }, - { - "action": "issue.destroy", - "description": "An issue was deleted from the repository.", - "docs_reference_links": "/issues/tracking-your-work-with-issues/deleting-an-issue", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "title", - "operation_type" - ], - "docs_reference_titles": "Deleting an issue" - }, - { - "action": "issue.pinned", - "description": "An issue was pinned to a repository.", - "docs_reference_links": "/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "owner_type", - "number", - "event" - ], - "docs_reference_titles": "Pinning an issue to your repository" - }, - { - "action": "issue.transfer", - "description": "An issue was transferred to another repository.", - "docs_reference_links": "/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner_type", - "number", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Transferring an issue to another repository" - }, - { - "action": "issue.unpinned", - "description": "An issue was unpinned from a repository.", - "docs_reference_links": "/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "event", - "created_at", - "operation_type", - "number", - "owner_type" - ], - "docs_reference_titles": "Pinning an issue to your repository" - }, - { - "action": "issues.deletes_disabled", - "description": "The ability for enterprise members to delete issues was disabled Members cannot delete issues in any organizations in an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-deleting-issues", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Enforcing repository management policies in your enterprise" - }, - { - "action": "issues.deletes_enabled", - "description": "The ability for enterprise members to delete issues was enabled Members can delete issues in any organizations in an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-deleting-issues", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enforcing repository management policies in your enterprise" - }, - { - "action": "issues.deletes_policy_cleared", - "description": "An enterprise owner cleared the policy setting for allowing members to delete issues in an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-deleting-issues", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Enforcing repository management policies in your enterprise" - }, - { - "action": "marketplace_agreement_signature.create", - "description": "The GitHub Marketplace Developer Agreement was signed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "marketplace_listing.approve", - "description": "A listing was approved for inclusion in GitHub Marketplace.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "secondary_category", - "primary_category", - "operation_type", - "created_at", - "marketplace_listing", - "integration" - ] - }, - { - "action": "marketplace_listing.change_category", - "description": "A category for a listing for an app in GitHub Marketplace was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "primary_category", - "marketplace_listing", - "integration", - "secondary_category", - "operation_type", - "created_at" - ] - }, - { - "action": "marketplace_listing.create", - "description": "A listing for an app in GitHub Marketplace was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "primary_category", - "created_at", - "oauth_application", - "marketplace_listing", - "secondary_category", - "oauth_application_id", - "operation_type" - ] - }, - { - "action": "marketplace_listing.delist", - "description": "A listing was removed from GitHub Marketplace.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "secondary_category", - "operation_type", - "marketplace_listing", - "primary_category", - "integration" - ] - }, - { - "action": "marketplace_listing.redraft", - "description": "A listing was sent back to draft state.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "secondary_category", - "oauth_application_id", - "operation_type", - "oauth_application", - "created_at", - "marketplace_listing", - "primary_category" - ] - }, - { - "action": "marketplace_listing.reject", - "description": "A listing was not accepted for inclusion in GitHub Marketplace.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "primary_category", - "secondary_category", - "marketplace_listing", - "oauth_application", - "oauth_application_id", - "operation_type", - "created_at" - ] - }, - { - "action": "members_can_create_pages.disable", - "description": "The ability for members to publish GitHub Pages sites was disabled.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization" - }, - { - "action": "members_can_create_pages.enable", - "description": "The ability for members to publish GitHub Pages sites was enabled.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization" - }, - { - "action": "members_can_create_private_pages.disable", - "description": "The ability for members to publish private GitHub Pages was disabled Members cannot publish private GitHub Pages in an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization" - }, - { - "action": "members_can_create_private_pages.enable", - "description": "The ability for members to publish private GitHub Pages was enabled Members can publish private GitHub Pages in an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization" - }, - { - "action": "members_can_create_public_pages.disable", - "description": "The ability for members to publish public GitHub Pages was disabled Members cannot publish public GitHub Pages in an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization" - }, - { - "action": "members_can_create_public_pages.enable", - "description": "The ability for members to publish public GitHub Pages was enabled Members can publish public GitHub Pages in an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization" - }, - { - "action": "members_can_delete_repos.clear", - "description": "An enterprise owner cleared the policy setting for deleting or transferring repositories in any organizations in an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-repository-deletion-and-transfer", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Enforcing repository management policies in your enterprise" - }, - { - "action": "members_can_delete_repos.disable", - "description": "The ability for enterprise members to delete repositories was disabled Members cannot delete or transfer repositories in any organizations in an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-repository-deletion-and-transfer", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Enforcing repository management policies in your enterprise" - }, - { - "action": "members_can_delete_repos.enable", - "description": "The ability for enterprise members to delete repositories was enabled Members can delete or transfer repositories in any organizations in an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-repository-deletion-and-transfer", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enforcing repository management policies in your enterprise" - }, - { - "action": "members_can_view_dependency_insights.clear", - "description": "An enterprise owner cleared the policy setting for viewing dependency insights in any organizations in an enterprise.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "members_can_view_dependency_insights.disable", - "description": "The ability for enterprise members to view dependency insights was disabled. Members cannot view dependency insights in any organizations in an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-dependency-insights-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enforcing policies for code security and analysis for your enterprise" - }, - { - "action": "members_can_view_dependency_insights.enable", - "description": "The ability for enterprise members to view dependency insights was enabled. Members can view dependency insights in any organizations in an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-dependency-insights-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enforcing policies for code security and analysis for your enterprise" - }, - { - "action": "merge_queue.pull_request_dequeued", - "description": "A pull request was removed from a merge queue.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "merge_queue.pull_request_queue_jump", - "description": "A pull request was moved ahead in a merge queue.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "merge_queue.queue_cleared", - "description": "A merge queue was cleared.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "merge_queue.update_settings", - "description": "The settings for a merge queue were updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "max_entries_to_build", - "min_entries_to_merge", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "metered_billing_configuration.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "metered_billing_configuration.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "metered_billing_configuration.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "migration.create", - "description": "A migration file was created for transferring data from a source location (such as a GitHub.com organization or a GitHub Enterprise Server instance) to a target GitHub Enterprise Server instance.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "migration.destroy_file", - "description": "A migration file for transferring data from a source location (such as a GitHub.com organization or a GitHub Enterprise Server instance) to a target GitHub Enterprise Server instance was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "migration.download", - "description": "A migration file for transferring data from a source location (such as a GitHub.com organization or a GitHub Enterprise Server instance) to a target GitHub Enterprise Server instance was downloaded.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "operation_type", - "created_at", - "actor_is_bot" - ] - }, - { - "action": "network_configuration.create", - "description": "A network configuration for a hosted compute service was created.", - "docs_reference_links": "/admin/configuration/configuring-private-networking-for-hosted-compute-products/about-networking-for-hosted-compute-products", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot", - "selected_service", - "network_settings_ids", - "previous_settings_ids", - "network_configuration_id", - "failover_network_settings_ids", - "failover_network_enabled" - ], - "docs_reference_titles": "About networking for hosted compute products in your enterprise" - }, - { - "action": "network_configuration.delete", - "description": "A network configuration for a hosted compute service was deleted.", - "docs_reference_links": "/admin/configuration/configuring-private-networking-for-hosted-compute-products/about-networking-for-hosted-compute-products", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot", - "network_configuration_id" - ], - "docs_reference_titles": "About networking for hosted compute products in your enterprise" - }, - { - "action": "network_configuration.update", - "description": "A network configuration for a hosted compute service was updated.", - "docs_reference_links": "/admin/configuration/configuring-private-networking-for-hosted-compute-products/about-networking-for-hosted-compute-products", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot", - "selected_service", - "network_settings_ids", - "previous_settings_ids", - "failover_network_settings_ids", - "failover_network_enabled" - ], - "docs_reference_titles": "About networking for hosted compute products in your enterprise" - }, - { - "action": "oauth_application.create", - "description": "An OAuth application was created.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "oauth_application_id", - "operation_type", - "oauth_application" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.destroy", - "description": "An OAuth application was deleted.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "oauth_application_id", - "operation_type", - "oauth_application" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.generate_client_secret", - "description": "An OAuth application's secret key was generated.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application", - "oauth_application_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.remove_client_secret", - "description": "An OAuth application's secret key was deleted.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application", - "oauth_application_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.reset_secret", - "description": "The secret key for an OAuth application was reset.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application", - "operation_type", - "created_at", - "oauth_application_id" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.revoke_all_tokens", - "description": "All user tokens for an OAuth application were requested to be revoked.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application", - "oauth_application_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.revoke_tokens", - "description": "Token(s) for an OAuth application were revoked.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "oauth_application", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.transfer", - "description": "An OAuth application was transferred from one account to another.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "oauth_application", - "oauth_application_id" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "org.accept_business_invitation", - "description": "An invitation sent to an organization to join an enterprise was accepted.", - "docs_reference_links": "/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise#inviting-an-organization-to-join-your-enterprise-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Adding organizations to your enterprise" - }, - { - "action": "org.add_billing_manager", - "description": "A billing manager was added to an organization.", - "docs_reference_links": "/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization" - }, - { - "action": "org.add_member", - "description": "A user joined an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "permission", - "operation_type", - "created_at", - "actor_is_bot" - ] - }, - { - "action": "org.add_outside_collaborator", - "description": "An outside collaborator was added to a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "inviter", - "public_repo", - "permission", - "invitee", - "created_at", - "operation_type" - ] - }, - { - "action": "org.add_security_manager", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "created_at", - "operation_type" - ] - }, - { - "action": "org.advanced_security_disabled_for_new_repos", - "description": "GitHub Advanced Security was disabled for new repositories in an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.advanced_security_disabled_on_all_repos", - "description": "GitHub Advanced Security was disabled for all repositories in an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.advanced_security_enabled_for_new_repos", - "description": "GitHub Advanced Security was enabled for new repositories in an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.advanced_security_enabled_on_all_repos", - "description": "GitHub Advanced Security was enabled for all repositories in an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.advanced_security_policy_selected_member_disabled", - "description": "An enterprise owner prevented GitHub Advanced Security features from being enabled for repositories owned by the organization.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Enforcing policies for code security and analysis for your enterprise" - }, - { - "action": "org.advanced_security_policy_selected_member_enabled", - "description": "An enterprise owner allowed GitHub Advanced Security features to be enabled for repositories owned by the organization.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "actor_is_bot" - ], - "docs_reference_titles": "Enforcing policies for code security and analysis for your enterprise" - }, - { - "action": "org.allow_third_party_access_requests_from_outside_collaborators_disabled", - "description": "Third-party application access for outside collaborators was disabled for the organization.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/limiting-oauth-app-and-github-app-access-requests#enabling-or-disabling-integration-access-requests", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Limiting OAuth app and GitHub App access requests and installations" - }, - { - "action": "org.allow_third_party_access_requests_from_outside_collaborators_enabled", - "description": "Third-party application access for outside collaborators was enabled for the organization.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/limiting-oauth-app-and-github-app-access-requests-and-installations#enabling-or-disabling-app-access-requests", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/limiting-oauth-app-and-github-app-access-requests-and-installations#enabling-or-disabling-app-access-requests" - }, - { - "action": "org.archive", - "description": "The organization was archived.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.audit_log_export", - "description": "An export of the organization audit log was created. If the export included a query, the log will list the query used and the number of audit log entries matching that query.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#exporting-the-audit-log", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#exporting-the-audit-log" - }, - { - "action": "org.audit_log_git_event_export", - "description": "An export of the organization's Git events was created.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "start", - "end", - "operation_type" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization" - }, - { - "action": "org.billing_signup_error", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.block_user", - "description": "An organization owner blocked a user from accessing the organization's repositories.", - "docs_reference_links": "/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "blocked_user", - "operation_type" - ], - "docs_reference_titles": "/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization" - }, - { - "action": "org.cancel_business_invitation", - "description": "An invitation for an organization to join an enterprise was revoked", - "docs_reference_links": "/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise#inviting-an-organization-to-join-your-enterprise-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "initiated_from" - ], - "docs_reference_titles": "Adding organizations to your enterprise" - }, - { - "action": "org.cancel_invitation", - "description": "An invitation sent to a user to join an organization was revoked.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "email", - "operation_type", - "invitation_id", - "created_at", - "invitee_email" - ] - }, - { - "action": "org.clear_custom_invitation_rate_limit", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.code_scanning_autofix_disabled", - "description": "Autofix for code scanning alerts was disabled for an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "org.code_scanning_autofix_enabled", - "description": "Autofix for code scanning alerts was enabled for an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "org.code_scanning_scan_inactive_repos_disabled", - "description": "Scanning inactive repositories was disabled for an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "org.code_scanning_scan_inactive_repos_enabled", - "description": "Scanning inactive repositories was enabled for an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "org.codeql_disabled", - "description": "Code scanning using the default setup was disabled for an organization.", - "docs_reference_links": "/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Configuring default setup for code scanning at scale" - }, - { - "action": "org.codeql_enabled", - "description": "Code scanning using the default setup was enabled for an organization.", - "docs_reference_links": "/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Configuring default setup for code scanning at scale" - }, - { - "action": "org.codespaces_access_updated", - "description": "Access to use Codespaces on internal and private repositories was updated for an organization.", - "docs_reference_links": "/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "enablement", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization" - }, - { - "action": "org.codespaces_ownership_updated", - "description": "Ownership and payment for codespaces was updated for an organization.", - "docs_reference_links": "/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner_type", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization" - }, - { - "action": "org.codespaces_team_access_allowed", - "description": "A team has been allowed to use Codespaces for an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "created_at", - "operation_type" - ] - }, - { - "action": "org.codespaces_team_access_revoked", - "description": "A team has been prevented from using Codespaces for an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "created_at", - "operation_type" - ] - }, - { - "action": "org.codespaces_trusted_repo_access_granted", - "description": "GitHub Codespaces was granted trusted repository access to all other repositories in an organization.", - "docs_reference_links": "/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing access to other repositories within your codespace" - }, - { - "action": "org.codespaces_trusted_repo_access_revoked", - "description": "GitHub Codespaces trusted repository access to all other repositories in an organization was revoked.", - "docs_reference_links": "/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing access to other repositories within your codespace" - }, - { - "action": "org.codespaces_user_access_allowed", - "description": "A user has been allowed to use Codespaces for an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.codespaces_user_access_revoked", - "description": "A user has been prevented from using Codespaces for an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.config.disable_collaborators_only", - "description": "The interaction limit for collaborators only for an organization was disabled.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization" - }, - { - "action": "org.config.disable_contributors_only", - "description": "The interaction limit for prior contributors only for an organization was disabled.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization" - }, - { - "action": "org.config.disable_sockpuppet_disallowed", - "description": "The interaction limit for existing users only for an organization was disabled.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization" - }, - { - "action": "org.config.enable_collaborators_only", - "description": "The interaction limit for collaborators only for an organization was enabled.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization" - }, - { - "action": "org.config.enable_contributors_only", - "description": "The interaction limit for prior contributors only for an organization was enabled.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization" - }, - { - "action": "org.config.enable_sockpuppet_disallowed", - "description": "The interaction limit for existing users only for an organization was enabled.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization#limiting-interactions-in-your-organization" - }, - { - "action": "org.configure_self_hosted_jit_runner", - "description": "A new just-in-time GitHub Actions self-hosted runner was configured", - "docs_reference_links": "/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" - }, - { - "action": "org.confirm_business_invitation", - "description": "An invitation for an organization to join an enterprise was confirmed.", - "docs_reference_links": "/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise#inviting-an-organization-to-join-your-enterprise-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Adding organizations to your enterprise" - }, - { - "action": "org.connect_usage_metrics_export", - "description": "Server statistics were exported for the organization.", - "docs_reference_links": "/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/exporting-server-statistics", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Exporting Server Statistics" - }, - { - "action": "org.create", - "description": "An organization was created.", - "docs_reference_links": "/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch" - }, - { - "action": "org.create_actions_secret", - "description": "A GitHub Actions secret was created for an organization.", - "docs_reference_links": "/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Using secrets in GitHub Actions" - }, - { - "action": "org.create_actions_variable", - "description": "A GitHub Actions variable was created for an organization.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "org.create_integration_secret", - "description": "A Codespaces or Dependabot secret was created for an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "integration", - "operation_type", - "created_at" - ] - }, - { - "action": "org_credential_authorization.deauthorize", - "description": "A member removed the SSO (SAML or OIDC) authorization from a credential that had access to your organization.", - "docs_reference_links": "/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "actor_is_bot", - "oauth_credential_type", - "managed_oauth_access_id", - "managed_token_id", - "managed_oauth_scopes", - "managed_token_scopes", - "managed_hashed_token" - ], - "docs_reference_titles": "Authorizing a personal access token for use with single sign-on" - }, - { - "action": "org_credential_authorization.grant", - "description": "A member authorized credentials for use with SAML or OIDC single sign-on.", - "docs_reference_links": "/authentication/authenticating-with-saml-single-sign-on", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot", - "oauth_credential_type", - "managed_oauth_access_id", - "managed_token_id", - "managed_oauth_scopes", - "managed_token_scopes", - "managed_hashed_token" - ], - "docs_reference_titles": "Authenticating with single sign-on" - }, - { - "action": "org_credential_authorization.revoke", - "description": "An owner revoked authorized credentials.", - "docs_reference_links": "/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "oauth_application_id", - "operation_type", - "created_at", - "oauth_credential_type", - "managed_oauth_access_id", - "managed_token_id", - "managed_oauth_scopes", - "managed_token_scopes", - "managed_hashed_token" - ], - "docs_reference_titles": "Viewing and managing a member's SAML access to your organization" - }, - { - "action": "org.disable_member_team_creation_permission", - "description": "Team creation was limited to owners.", - "docs_reference_links": "/organizations/managing-organization-settings/setting-team-creation-permissions-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/setting-team-creation-permissions-in-your-organization" - }, - { - "action": "org.disable_oauth_app_restrictions", - "description": "Third-party application access restrictions for an organization were disabled.", - "docs_reference_links": "/organizations/managing-oauth-access-to-your-organizations-data/disabling-oauth-app-access-restrictions-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-oauth-access-to-your-organizations-data/disabling-oauth-app-access-restrictions-for-your-organization" - }, - { - "action": "org.disable_reader_discussion_creation_permission", - "description": "An organization owner limited discussion creation to users with at least triage permission in an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization" - }, - { - "action": "org.disable_saml", - "description": "SAML single sign-on was disabled for an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sso_url", - "issuer", - "created_at", - "operation_type" - ] - }, - { - "action": "org.disable_source_ip_disclosure", - "description": "Display of IP addresses within audit log events for the organization was disabled.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/displaying-ip-addresses-in-the-audit-log-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/displaying-ip-addresses-in-the-audit-log-for-your-organization" - }, - { - "action": "org.disable_two_factor_requirement", - "description": "A two-factor authentication requirement was disabled for the organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.display_commenter_full_name_disabled", - "description": "An organization owner disabled the display of a commenter's full name in an organization. Members cannot see a comment author's full name.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.display_commenter_full_name_enabled", - "description": "An organization owner enabled the display of a commenter's full name in an organization. Members can see a comment author's full name.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.enable_member_team_creation_permission", - "description": "Team creation by members was allowed.", - "docs_reference_links": "/organizations/managing-organization-settings/setting-team-creation-permissions-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/setting-team-creation-permissions-in-your-organization" - }, - { - "action": "org.enable_oauth_app_restrictions", - "description": "Third-party application access restrictions for an organization were enabled.", - "docs_reference_links": "/organizations/managing-oauth-access-to-your-organizations-data/enabling-oauth-app-access-restrictions-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-oauth-access-to-your-organizations-data/enabling-oauth-app-access-restrictions-for-your-organization" - }, - { - "action": "org.enable_reader_discussion_creation_permission", - "description": "An organization owner allowed users with read access to create discussions in an organization", - "docs_reference_links": "/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization" - }, - { - "action": "org.enable_saml", - "description": "SAML single sign-on was enabled for the organization.", - "docs_reference_links": "/organizations/managing-saml-single-sign-on-for-your-organization/enabling-and-testing-saml-single-sign-on-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "sso_url", - "created_at", - "issuer" - ], - "docs_reference_titles": "Enabling and testing SAML single sign-on for your organization" - }, - { - "action": "org.enable_source_ip_disclosure", - "description": "Display of IP addresses within audit log events for the organization was enabled.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/displaying-ip-addresses-in-the-audit-log-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/displaying-ip-addresses-in-the-audit-log-for-your-organization" - }, - { - "action": "org.enable_two_factor_requirement", - "description": "Two-factor authentication is now required for the organization.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization" - }, - { - "action": "org.integration_manager_added", - "description": "An organization owner granted a member access to manage all GitHub Apps owned by an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "manager", - "operation_type", - "created_at" - ] - }, - { - "action": "org.integration_manager_removed", - "description": "An organization owner removed access to manage all GitHub Apps owned by an organization from an organization member.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "manager", - "operation_type", - "created_at" - ] - }, - { - "action": "org.invite_member", - "description": "A new user was invited to join an organization.", - "docs_reference_links": "/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "invitation_id", - "operation_type", - "created_at", - "invitee_email" - ], - "docs_reference_titles": "/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization" - }, - { - "action": "org.invite_to_business", - "description": "An organization was invited to join an enterprise.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.members_can_update_protected_branches.disable", - "description": "The ability for enterprise members to update protected branches was disabled. Only enterprise owners can update protected branches.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.members_can_update_protected_branches.enable", - "description": "The ability for enterprise members to update protected branches was enabled. Members of an organization can update protected branches.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.oauth_app_access_approved", - "description": "Access to an organization was granted for an OAuth App.", - "docs_reference_links": "/organizations/managing-oauth-access-to-your-organizations-data/approving-oauth-apps-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "url", - "operation_type", - "created_at", - "oauth_application_name" - ], - "docs_reference_titles": "/organizations/managing-oauth-access-to-your-organizations-data/approving-oauth-apps-for-your-organization" - }, - { - "action": "org.oauth_app_access_blocked", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "url", - "created_at", - "operation_type", - "oauth_application_name" - ] - }, - { - "action": "org.oauth_app_access_denied", - "description": "Access was disabled for an OAuth App that was previously approved.", - "docs_reference_links": "/organizations/managing-oauth-access-to-your-organizations-data/denying-access-to-a-previously-approved-oauth-app-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "url", - "created_at", - "operation_type", - "oauth_application_name" - ], - "docs_reference_titles": "/organizations/managing-oauth-access-to-your-organizations-data/denying-access-to-a-previously-approved-oauth-app-for-your-organization" - }, - { - "action": "org.oauth_app_access_requested", - "description": "An organization member requested that an owner grant an OAuth App access to an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "url", - "oauth_application_name" - ] - }, - { - "action": "org.oauth_app_access_unblocked", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "url", - "created_at", - "operation_type", - "oauth_application_name" - ] - }, - { - "action": "org.rate_limited_invites", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.recovery_code_failed", - "description": "An organization owner failed to sign into a organization with an external identity provider (IdP) using a recovery code.", - "docs_reference_links": "/organizations/managing-saml-single-sign-on-for-your-organization/accessing-your-organization-if-your-identity-provider-is-unavailable", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "reason", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Accessing your organization if your identity provider is unavailable" - }, - { - "action": "org.recovery_code_used", - "description": "An organization owner successfully signed into an organization with an external identity provider (IdP) using a recovery code.", - "docs_reference_links": "/organizations/managing-saml-single-sign-on-for-your-organization/accessing-your-organization-if-your-identity-provider-is-unavailable", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Accessing your organization if your identity provider is unavailable" - }, - { - "action": "org.recovery_codes_downloaded", - "description": "An organization owner downloaded the organization's SSO recovery codes.", - "docs_reference_links": "/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Downloading your organization's SAML single sign-on recovery codes" - }, - { - "action": "org.recovery_codes_generated", - "description": "An organization owner generated the organization's SSO recovery codes.", - "docs_reference_links": "/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Downloading your organization's SAML single sign-on recovery codes" - }, - { - "action": "org.recovery_codes_printed", - "description": "An organization owner printed the organization's SSO recovery codes.", - "docs_reference_links": "/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Downloading your organization's SAML single sign-on recovery codes" - }, - { - "action": "org.recovery_codes_viewed", - "description": "An organization owner viewed the organization's SSO recovery codes.", - "docs_reference_links": "/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Downloading your organization's SAML single sign-on recovery codes" - }, - { - "action": "org.register_self_hosted_runner", - "description": "A new self-hosted runner was registered.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "actor_is_bot" - ], - "docs_reference_titles": "Adding self-hosted runners" - }, - { - "action": "org.remove_actions_secret", - "description": "A GitHub Actions secret was removed from an organization.", - "docs_reference_links": "/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Using secrets in GitHub Actions" - }, - { - "action": "org.remove_actions_variable", - "description": "A GitHub Actions variable was removed from an organization.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "org.remove_billing_manager", - "description": "A billing manager was removed from an organization, either manually or due to a two-factor authentication requirement.", - "docs_reference_links": "/organizations/managing-peoples-access-to-your-organization-with-roles/removing-a-billing-manager-from-your-organization, /organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-peoples-access-to-your-organization-with-roles/removing-a-billing-manager-from-your-organization, /organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization" - }, - { - "action": "org.remove_integration_secret", - "description": "A Codespaces or Dependabot secret was removed from an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "integration", - "operation_type", - "created_at" - ] - }, - { - "action": "org.remove_member", - "description": "A member was removed from an organization, either manually or due to a two-factor authentication requirement.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.remove_outside_collaborator", - "description": "An outside collaborator was removed from an organization, either manually or due to a two-factor authentication requirement.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.remove_security_manager", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "created_at", - "operation_type" - ] - }, - { - "action": "org.remove_self_hosted_runner", - "description": "A self-hosted runner was removed.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/removing-self-hosted-runners#removing-a-runner-from-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Removing self-hosted runners" - }, - { - "action": "org.rename", - "description": "An organization was renamed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "old_login", - "operation_type", - "created_at" - ] - }, - { - "action": "org.required_workflow_create", - "description": "Triggered when a required workflow is created.", - "docs_reference_links": "/actions/using-workflows/required-workflows", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/actions/using-workflows/required-workflows" - }, - { - "action": "org.required_workflow_delete", - "description": "Triggered when a required workflow is deleted.", - "docs_reference_links": "/actions/using-workflows/required-workflows", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/actions/using-workflows/required-workflows" - }, - { - "action": "org.required_workflow_update", - "description": "Triggered when a required workflow is updated.", - "docs_reference_links": "/actions/using-workflows/required-workflows", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/actions/using-workflows/required-workflows" - }, - { - "action": "org.restore_member", - "description": "An organization member was restored.", - "docs_reference_links": "/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization" - }, - { - "action": "org.revoke_external_identity", - "description": "A member's linked identity was revoked.", - "docs_reference_links": "/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Viewing and managing a member's SAML access to your organization" - }, - { - "action": "org.revoke_sso_session", - "description": "A member's SAML session was revoked.", - "docs_reference_links": "/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Viewing and managing a member's SAML access to your organization" - }, - { - "action": "org.runner_group_created", - "description": "A self-hosted runner group was created.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_group_id", - "operation_type", - "created_at", - "runner_group_restricted_to_workflows", - "runner_group_selected_workflow_refs", - "network_configuration_id" - ], - "docs_reference_titles": "Managing access to self-hosted runners using groups" - }, - { - "action": "org.runner_group_removed", - "description": "A self-hosted runner group was removed.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_group_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing access to self-hosted runners using groups" - }, - { - "action": "org.runner_group_renamed", - "description": "A self-hosted runner group was renamed.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_group_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing access to self-hosted runners using groups" - }, - { - "action": "org.runner_group_runner_removed", - "description": "The REST API was used to remove a self-hosted runner from a group.", - "docs_reference_links": "/rest/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "runner_group_id", - "runner_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/rest/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization" - }, - { - "action": "org.runner_group_runners_added", - "description": "A self-hosted runner was added to a group.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_group_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing access to self-hosted runners using groups" - }, - { - "action": "org.runner_group_runners_updated", - "description": "A runner group's list of members was updated.", - "docs_reference_links": "/rest/actions#set-self-hosted-runners-in-a-group-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "runner_group_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/rest/actions#set-self-hosted-runners-in-a-group-for-an-organization" - }, - { - "action": "org.runner_group_updated", - "description": "The configuration of a self-hosted runner group was changed.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_group_id", - "runner_group_name", - "runner_group_allow_public", - "operation_type", - "created_at", - "runner_group_restricted_to_workflows", - "runner_group_selected_workflow_refs", - "network_configuration_id" - ], - "docs_reference_titles": "Managing access to self-hosted runners using groups" - }, - { - "action": "org.runner_group_visiblity_updated", - "description": "The visibility of a self-hosted runner group was updated via the REST API.", - "docs_reference_links": "/rest/actions#update-a-self-hosted-runner-group-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_group_id", - "visibility", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/rest/actions#update-a-self-hosted-runner-group-for-an-organization" - }, - { - "action": "org_secret_scanning_automatic_validity_checks.disabled", - "description": "Automatic partner validation checks have been disabled at the organization level", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#allowing-validity-checks-for-partner-patterns-in-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#allowing-validity-checks-for-partner-patterns-in-an-organization" - }, - { - "action": "org_secret_scanning_automatic_validity_checks.enabled", - "description": "Automatic partner validation checks have been enabled at the organization level", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#allowing-validity-checks-for-partner-patterns-in-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#allowing-validity-checks-for-partner-patterns-in-an-organization" - }, - { - "action": "org_secret_scanning_custom_pattern.create", - "description": "A custom pattern was created for secret scanning in an organization.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "org_secret_scanning_custom_pattern.delete", - "description": "A custom pattern was removed from secret scanning in an organization.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#removing-a-custom-pattern", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "org_secret_scanning_custom_pattern.publish", - "description": "A custom pattern was published for secret scanning in an organization.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "org.secret_scanning_custom_pattern_push_protection_disabled", - "description": "Push protection for a custom pattern for secret scanning was disabled for an organization.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "org.secret_scanning_custom_pattern_push_protection_enabled", - "description": "Push protection for a custom pattern for secret scanning was enabled for an organization.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "org_secret_scanning_custom_pattern.update", - "description": "Changes to a custom pattern were saved and a dry run was executed for secret scanning in an organization.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#editing-a-custom-pattern", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "org_secret_scanning_generic_secrets.disabled", - "description": "Generic secrets have been disabled at the organization level", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org_secret_scanning_generic_secrets.enabled", - "description": "Generic secrets have been enabled at the organization level", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org_secret_scanning_non_provider_patterns.disabled", - "description": "Secret scanning for non-provider patterns was disabled at the organization level.", - "docs_reference_links": "/code-security/secret-scanning/secret-scanning-patterns#non-provider-patterns", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Supported secret scanning patterns" - }, - { - "action": "org_secret_scanning_non_provider_patterns.enabled", - "description": "Secret scanning for non-provider patterns was enabled at the organization level.", - "docs_reference_links": "/code-security/secret-scanning/secret-scanning-patterns#non-provider-patterns", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Supported secret scanning patterns" - }, - { - "action": "org_secret_scanning_push_protection_bypass_list.add", - "description": "A role or team was added to the push protection bypass list at the organization level.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org_secret_scanning_push_protection_bypass_list.disable", - "description": "Push protection settings for \"Users who can bypass push protection for secret scanning\" changed from \"Specific roles or teams\" to \"Anyone with write access\" at the organization level.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org_secret_scanning_push_protection_bypass_list.enable", - "description": "Push protection settings for \"Users who can bypass push protection for secret scanning\" changed from \"Anyone with write access\" to \"Specific roles or teams\" at the organization level.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org_secret_scanning_push_protection_bypass_list.remove", - "description": "A role or team was removed from the push protection bypass list at the organization level.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org.secret_scanning_push_protection_custom_message_disabled", - "description": "The custom message triggered by an attempted push to a push-protected repository was disabled for an organization.", - "docs_reference_links": "/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org.secret_scanning_push_protection_custom_message_enabled", - "description": "The custom message triggered by an attempted push to a push-protected repository was enabled for an organization.", - "docs_reference_links": "/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org.secret_scanning_push_protection_custom_message_updated", - "description": "The custom message triggered by an attempted push to a push-protected repository was updated for an organization.", - "docs_reference_links": "/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org.secret_scanning_push_protection_disable", - "description": "Push protection for secret scanning was disabled.", - "docs_reference_links": "/code-security/secret-scanning/protecting-pushes-with-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org.secret_scanning_push_protection_enable", - "description": "Push protection for secret scanning was enabled.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org.secret_scanning_push_protection_new_repos_disable", - "description": "Push protection for secret scanning was disabled for all new repositories in the organization.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org.secret_scanning_push_protection_new_repos_enable", - "description": "Push protection for secret scanning was enabled for all new repositories in the organization.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "org.self_hosted_runner_offline", - "description": "The runner application was stopped. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_id", - "runner_name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Monitoring and troubleshooting self-hosted runners" - }, - { - "action": "org.self_hosted_runner_online", - "description": "The runner application was started. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_id", - "runner_name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Monitoring and troubleshooting self-hosted runners" - }, - { - "action": "org.self_hosted_runner_updated", - "description": "The runner application was updated. This event is not included in the JSON/CSV export.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#about-self-hosted-runners", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_id", - "runner_name", - "source_version", - "target_version", - "runner_group_id", - "runner_group_name" - ], - "docs_reference_titles": "Self-hosted runners" - }, - { - "action": "org.set_actions_fork_pr_approvals_policy", - "description": "The setting for requiring approvals for workflows from public forks was changed for an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#requiring-approval-for-workflows-from-public-forks", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "policy", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#requiring-approval-for-workflows-from-public-forks" - }, - { - "action": "org.set_actions_private_fork_pr_approvals_policy", - "description": "The policy for requiring approval for fork pull request workflows from collaborators without write access to private repos was changed for an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#enabling-workflows-for-private-repository-forks", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "policy", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#enabling-workflows-for-private-repository-forks" - }, - { - "action": "org.set_actions_retention_limit", - "description": "The retention period for GitHub Actions artifacts and logs in an organization was changed.", - "docs_reference_links": "/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "limit", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization" - }, - { - "action": "org.set_custom_invitation_rate_limit", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.set_default_workflow_permissions", - "description": "The default permissions granted to the GITHUB_TOKEN when running workflows were changed for an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization" - }, - { - "action": "org.set_fork_pr_workflows_policy", - "description": "The policy for workflows on private repository forks was changed.", - "docs_reference_links": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#enabling-workflows-for-private-repository-forks", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "policy", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#enabling-workflows-for-private-repository-forks" - }, - { - "action": "org.set_workflow_permission_can_approve_pr", - "description": "The policy for allowing GitHub Actions to create and approve pull requests was changed for an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#preventing-github-actions-from-creating-or-approving-pull-requests", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#preventing-github-actions-from-creating-or-approving-pull-requests" - }, - { - "action": "org.sso_response", - "description": "A SAML single sign-on (SSO) response was generated when a member attempted to authenticate with your organization. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "issuer", - "operation_type", - "created_at", - "actor_is_bot" - ] - }, - { - "action": "org.transfer", - "description": "An organization was transferred between enterprise accounts.", - "docs_reference_links": "/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise#transferring-an-organization-between-enterprise-accounts", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "from_business", - "to_business", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Adding organizations to your enterprise" - }, - { - "action": "org.transfer_outgoing", - "description": "An organization was transferred between enterprise accounts.", - "docs_reference_links": "/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise#transferring-an-organization-between-enterprise-accounts", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "from_business", - "to_business", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Adding organizations to your enterprise" - }, - { - "action": "org.unarchive", - "description": "The organization was unarchived.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.unblock_user", - "description": "A user was unblocked from an organization.", - "docs_reference_links": "/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "blocked_user", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization" - }, - { - "action": "org.update_actions_secret", - "description": "A GitHub Actions secret was updated for an organization.", - "docs_reference_links": "/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "created_at", - "key", - "operation_type" - ], - "docs_reference_titles": "Using secrets in GitHub Actions" - }, - { - "action": "org.update_actions_settings", - "description": "An organization owner or site administrator updated GitHub Actions policy settings for an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "new_policy", - "updated_allowed_types", - "old_policy", - "updated_access_policy" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization" - }, - { - "action": "org.update_actions_variable", - "description": "A GitHub Actions variable was updated for an organization.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "org.update_default_repository_permission", - "description": "The default repository permission level for organization members was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "permission", - "old_permission" - ] - }, - { - "action": "org.update_integration_secret", - "description": "A Codespaces or Dependabot secret was updated for an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "integration", - "operation_type", - "created_at" - ] - }, - { - "action": "org.update_member", - "description": "A person's role was changed from owner to member or member to owner.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "old_permission", - "permission", - "operation_type" - ] - }, - { - "action": "org.update_member_repository_creation_permission", - "description": "The create repository permission for organization members was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "permission", - "created_at", - "visibility", - "operation_type" - ] - }, - { - "action": "org.update_member_repository_invitation_permission", - "description": "An organization owner changed the policy setting for organization members inviting outside collaborators to repositories.", - "docs_reference_links": "/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "permission", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Setting permissions for adding outside collaborators" - }, - { - "action": "org.update_new_repository_default_branch_setting", - "description": "The name of the default branch was changed for new repositories in the organization.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization" - }, - { - "action": "org.update_repo_self_hosted_runners_policy", - "description": "The repository self-hosted runners policy was updated", - "docs_reference_links": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#limiting-the-use-of-self-hosted-runners", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "old_repo_runners_policy", - "new_repo_runners_policy", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#limiting-the-use-of-self-hosted-runners" - }, - { - "action": "org.update_saml_provider_settings", - "description": "An organization's SAML provider settings were updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sso_url", - "operation_type", - "issuer", - "created_at" - ] - }, - { - "action": "org.update_terms_of_service", - "description": "An organization changed between the Standard Terms of Service and the GitHub Customer Agreement.", - "docs_reference_links": "/organizations/managing-organization-settings/upgrading-to-the-github-customer-agreement", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/upgrading-to-the-github-customer-agreement" - }, - { - "action": "organization_default_label.create", - "description": "A default label was created for repositories in an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-default-labels-for-repositories-in-your-organization#creating-a-default-label", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-default-labels-for-repositories-in-your-organization#creating-a-default-label" - }, - { - "action": "organization_default_label.destroy", - "description": "A default label was deleted for repositories in an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-default-labels-for-repositories-in-your-organization#deleting-a-default-label", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-default-labels-for-repositories-in-your-organization#deleting-a-default-label" - }, - { - "action": "organization_default_label.update", - "description": "A default label was edited for repositories in an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/managing-default-labels-for-repositories-in-your-organization#editing-a-default-label", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/managing-default-labels-for-repositories-in-your-organization#editing-a-default-label" - }, - { - "action": "organization_domain.approve", - "description": "A domain was approved for an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization#approving-a-domain-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner_type", - "domain_name", - "owner", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization#approving-a-domain-for-your-organization" - }, - { - "action": "organization_domain.create", - "description": "A domain was added to an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization#verifying-a-domain-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "domain_name", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization#verifying-a-domain-for-your-organization" - }, - { - "action": "organization_domain.destroy", - "description": "A domain was removed from an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization#removing-an-approved-or-verified-domain", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "domain_name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization#removing-an-approved-or-verified-domain" - }, - { - "action": "organization_domain.verify", - "description": "A domain was verified for an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization#verifying-a-domain-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "domain_name", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization#verifying-a-domain-for-your-organization" - }, - { - "action": "organization_moderators.add_team", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "created_at", - "operation_type" - ] - }, - { - "action": "organization_moderators.add_user", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "organization_moderators.remove_team", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "created_at", - "operation_type" - ] - }, - { - "action": "organization_moderators.remove_user", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "organization_projects_change.clear", - "description": "An enterprise owner cleared the policy setting for organization-wide project boards in an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-projects-in-your-enterprise#enforcing-a-policy-for-organization-wide-project-boards", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enforcing policies for projects in your enterprise" - }, - { - "action": "organization_projects_change.disable", - "description": "Organization projects were disabled for all organizations in an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-projects-in-your-enterprise#enforcing-a-policy-for-organization-wide-project-boards", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enforcing policies for projects in your enterprise" - }, - { - "action": "organization_projects_change.enable", - "description": "Organization projects were enabled for all organizations in an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-projects-in-your-enterprise#enforcing-a-policy-for-organization-wide-project-boards", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enforcing policies for projects in your enterprise" - }, - { - "action": "organization_role.assign", - "description": "An organization role was assigned to a user or team.", - "docs_reference_links": "/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "organization_role_id", - "organization_role_name", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Permissions of custom organization roles" - }, - { - "action": "organization_role.create", - "description": "A custom organization role was created in an organization.", - "docs_reference_links": "/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "owner", - "role_permissions", - "base_role", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Permissions of custom organization roles" - }, - { - "action": "organization_role.destroy", - "description": "A custom organization role was deleted in an organization.", - "docs_reference_links": "/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "owner", - "role_permissions", - "base_role", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Permissions of custom organization roles" - }, - { - "action": "organization_role.revoke", - "description": "A user or team was unassigned an organization role.", - "docs_reference_links": "/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "organization_role_id", - "organization_role_name", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Permissions of custom organization roles" - }, - { - "action": "organization_role.update", - "description": "A custom organization role was edited in an organization.", - "docs_reference_links": "/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "owner", - "role_permissions", - "base_role", - "old_role_permissions", - "created_at", - "operation_type", - "actor_is_bot", - "old_base_role" - ], - "docs_reference_titles": "Permissions of custom organization roles" - }, - { - "action": "packages.package_deleted", - "description": "An entire package was deleted.", - "docs_reference_links": "/packages/learn-github-packages/deleting-and-restoring-a-package", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "package", - "operation_type", - "created_at", - "actor_is_bot" - ], - "docs_reference_titles": "/packages/learn-github-packages/deleting-and-restoring-a-package" - }, - { - "action": "packages.package_published", - "description": "A package was published or republished to an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "package", - "ecosystem", - "version_count", - "is_republished", - "operation_type", - "created_at", - "actor_is_bot" - ] - }, - { - "action": "packages.package_version_deleted", - "description": "A specific package version was deleted.", - "docs_reference_links": "/packages/learn-github-packages/deleting-and-restoring-a-package", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "package", - "version", - "operation_type", - "created_at", - "ecosystem", - "actor_is_bot" - ], - "docs_reference_titles": "/packages/learn-github-packages/deleting-and-restoring-a-package" - }, - { - "action": "packages.package_version_published", - "description": "A specific package version was published or republished to a package.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "ecosystem", - "package", - "version", - "is_republished", - "operation_type", - "created_at", - "actor_is_bot" - ] - }, - { - "action": "pages_protected_domain.create", - "description": "A GitHub Pages verified domain was created for an organization or enterprise.", - "docs_reference_links": "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "owner_type", - "domain", - "state", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages" - }, - { - "action": "pages_protected_domain.delete", - "description": "A GitHub Pages verified domain was deleted from an organization or enterprise.", - "docs_reference_links": "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "owner_type", - "domain", - "state", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages" - }, - { - "action": "pages_protected_domain.verify", - "description": "A GitHub Pages domain was verified for an organization or enterprise.", - "docs_reference_links": "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "owner_type", - "domain", - "state", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages" - }, - { - "action": "payment_method.create", - "description": "A new payment method was added, such as a new credit card or PayPal account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "payment_method.remove", - "description": "A payment method was removed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "payment_method.update", - "description": "An existing payment method was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "personal_access_token.access_granted", - "description": "A fine-grained personal access token was granted access to resources.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_id", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization" - }, - { - "action": "personal_access_token.access_revoked", - "description": "A fine-grained personal access token was revoked. The token can still read public organization resources.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/reviewing-and-revoking-personal-access-tokens-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_id", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/reviewing-and-revoking-personal-access-tokens-in-your-organization" - }, - { - "action": "personal_access_token.request_cancelled", - "description": "A pending request for a fine-grained personal access token to access organization resources was canceled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type", - "user_programmatic_access_request_id" - ] - }, - { - "action": "personal_access_token.request_created", - "description": "Triggered when a fine-grained personal access token was created to access organization resources and the organization requires approval before the token can access organization resources.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_id", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type", - "user_programmatic_access_request_id" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization" - }, - { - "action": "personal_access_token.request_denied", - "description": "A request for a fine-grained personal access token to access organization resources was denied.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type", - "user_programmatic_access_request_id" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization" - }, - { - "action": "prebuild_configuration.create", - "description": "A GitHub Codespaces prebuild configuration for a repository was created.", - "docs_reference_links": "/codespaces/prebuilding-your-codespaces/about-github-codespaces-prebuilds", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "branch", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "/codespaces/prebuilding-your-codespaces/about-github-codespaces-prebuilds" - }, - { - "action": "prebuild_configuration.destroy", - "description": "A GitHub Codespaces prebuild configuration for a repository was deleted.", - "docs_reference_links": "/codespaces/prebuilding-your-codespaces/about-github-codespaces-prebuilds", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "branch", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "/codespaces/prebuilding-your-codespaces/about-github-codespaces-prebuilds" - }, - { - "action": "prebuild_configuration.run_triggered", - "description": "A user initiated a run of a GitHub Codespaces prebuild configuration for a repository branch.", - "docs_reference_links": "/codespaces/prebuilding-your-codespaces/about-github-codespaces-prebuilds", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "branch", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "/codespaces/prebuilding-your-codespaces/about-github-codespaces-prebuilds" - }, - { - "action": "prebuild_configuration.update", - "description": "A GitHub Codespaces prebuild configuration for a repository was edited.", - "docs_reference_links": "/codespaces/prebuilding-your-codespaces/about-github-codespaces-prebuilds", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "branch", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "/codespaces/prebuilding-your-codespaces/about-github-codespaces-prebuilds" - }, - { - "action": "premium_runner.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "runner_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "premium_runner.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "premium_runner.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "runner_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "private_repository_forking.clear", - "description": "An enterprise owner cleared the policy setting for allowing forks of private and internal repositories, for a repository, organization or enterprise.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "private_repository_forking.disable", - "description": "An enterprise owner disabled the policy setting for allowing forks of private and internal repositories, for a repository, organization or enterprise. Private and internal repositories are never allowed to be forked.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "private_repository_forking.enable", - "description": "An enterprise owner enabled the policy setting for allowing forks of private and internal repositories, for a repository, organization or enterprise. Private and internal repositories are always allowed to be forked.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "private_vulnerability_reporting.disable", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "private_vulnerability_reporting.enable", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "private_vulnerability_reporting_new_repos.disable", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "private_vulnerability_reporting_new_repos.enable", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "profile_picture.update", - "description": "A profile picture was updated.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "owner", - "operation_type" - ], - "docs_reference_titles": "Personalize your profile" - }, - { - "action": "project.access", - "description": "A project board visibility was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project.close", - "description": "A project board was closed.", - "docs_reference_links": "/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "project_id", - "project_kind" - ], - "docs_reference_titles": "Closing a project (classic)" - }, - { - "action": "project.create", - "description": "A project board was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project.delete", - "description": "A project board was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project_field.create", - "description": "A field was created in a project board.", - "docs_reference_links": "/issues/planning-and-tracking-with-projects/understanding-fields", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/issues/planning-and-tracking-with-projects/understanding-fields" - }, - { - "action": "project_field.delete", - "description": "A field was deleted in a project board.", - "docs_reference_links": "/issues/planning-and-tracking-with-projects/understanding-fields/deleting-custom-fields", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/issues/planning-and-tracking-with-projects/understanding-fields/deleting-custom-fields" - }, - { - "action": "project.link", - "description": "A repository was linked to a project board.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project.open", - "description": "A project board was reopened.", - "docs_reference_links": "/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "project_id", - "operation_type", - "created_at", - "project_kind", - "project_name" - ], - "docs_reference_titles": "Reopening a closed project (classic)" - }, - { - "action": "project.rename", - "description": "A project board was renamed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "old_name", - "operation_type" - ] - }, - { - "action": "project.unlink", - "description": "A repository was unlinked from a project board.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project.update_org_permission", - "description": "The project's base-level permission for all organization members was changed or removed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project.update_team_permission", - "description": "A team's project board permission level was changed or when a team was added or removed from a project board.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "team" - ] - }, - { - "action": "project.update_user_permission", - "description": "A user was added to or removed from a project board or had their permission level changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project_view.create", - "description": "A view was created in a project board.", - "docs_reference_links": "/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views" - }, - { - "action": "project_view.delete", - "description": "A view was deleted in a project board.", - "docs_reference_links": "/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views" - }, - { - "action": "protected_branch.authorized_users_teams", - "description": "The users, teams, or integrations allowed to bypass a branch protection were changed.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "created_at", - "operation_type", - "oauth_application_id" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches" - }, - { - "action": "protected_branch.branch_allowances", - "description": "A protected branch allowance was given to a specific user, team or integration.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "authorized_actors", - "policy", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "protected_branch.create", - "description": "Branch protection was enabled on a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "name", - "created_at", - "authorized_actor_names", - "required_deployments_enforcement_level", - "merge_queue_enforcement_level", - "create_protected" - ] - }, - { - "action": "protected_branch.destroy", - "description": "Branch protection was disabled on a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at", - "required_deployments_enforcement_level", - "merge_queue_enforcement_level", - "create_protected" - ] - }, - { - "action": "protected_branch.dismiss_stale_reviews", - "description": "Enforcement of dismissing stale pull requests was updated on a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "dismiss_stale_reviews_on_push", - "created_at", - "operation_type", - "name" - ] - }, - { - "action": "protected_branch.dismissal_restricted_users_teams", - "description": "Enforcement of restricting users and/or teams who can dismiss reviews was updated on a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "authorized_actors_only", - "authorized_actors", - "created_at", - "name", - "operation_type" - ] - }, - { - "action": "protected_branch.policy_override", - "description": "A branch protection requirement was overridden by a repository administrator.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "reasons", - "before", - "after", - "operation_type", - "branch", - "overridden_codes", - "referrer", - "deploy_key_fingerprint", - "compliant_pull_request_ids", - "rule_suite_id" - ] - }, - { - "action": "protected_branch.rejected_ref_update", - "description": "A branch update attempt was rejected.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "branch", - "before", - "overridden_codes", - "after", - "reasons", - "deploy_key_fingerprint", - "compliant_pull_request_ids", - "actor_is_bot", - "rule_suite_id" - ] - }, - { - "action": "protected_branch.update_admin_enforced", - "description": "Branch protection was enforced for repository administrators.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "admin_enforced", - "operation_type", - "name", - "created_at" - ] - }, - { - "action": "protected_branch.update_allow_deletions_enforcement_level", - "description": "Branch deletion was enabled or disabled for a protected branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "allow_deletions_enforcement_level", - "created_at" - ] - }, - { - "action": "protected_branch.update_allow_force_pushes_enforcement_level", - "description": "Force pushes were enabled or disabled for a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "allow_force_pushes_enforcement_level", - "created_at" - ] - }, - { - "action": "protected_branch.update_ignore_approvals_from_contributors", - "description": "Ignoring of approvals from contributors to a pull request was enabled or disabled for a branch.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "ignore_approvals_from_contributors", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule" - }, - { - "action": "protected_branch.update_linear_history_requirement_enforcement_level", - "description": "Required linear commit history was enabled or disabled for a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "linear_history_requirement_enforcement_level", - "name", - "created_at" - ] - }, - { - "action": "protected_branch.update_lock_allows_fetch_and_merge", - "description": "Fork syncing was enabled or disabled for a read-only branch", - "docs_reference_links": "repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#lock-branch", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "lock_allows_fetch_and_merge", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#lock-branch" - }, - { - "action": "protected_branch.update_lock_branch_enforcement_level", - "description": "The enforcement of a branch lock was updated.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#lock-branch", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "enforcement_level", - "lock_branch_enforcement_level", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#lock-branch" - }, - { - "action": "protected_branch.update_merge_queue_enforcement_level", - "description": "Enforcement of the merge queue was modified for a branch.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-merge-queue", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "merge_queue_enforcement_level", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-merge-queue" - }, - { - "action": "protected_branch.update_name", - "description": "A branch name pattern was updated for a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "old_name", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "protected_branch.update_pull_request_reviews_enforcement_level", - "description": "Enforcement of required pull request reviews was updated for a branch. Can be 0 (deactivated), 1 (non-admins), or 2 (everyone).", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "pull_request_reviews_enforcement_level", - "created_at", - "operation_type" - ] - }, - { - "action": "protected_branch.update_require_code_owner_review", - "description": "Enforcement of required code owner review was updated for a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "require_code_owner_review", - "operation_type", - "name" - ] - }, - { - "action": "protected_branch.update_require_last_push_approval", - "description": "Someone other than the person who pushed the last code-modifying commit to the branch must approve pull requests for the branch.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-pull-request-reviews-before-merging", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "require_last_push_approval", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-pull-request-reviews-before-merging" - }, - { - "action": "protected_branch.update_required_approving_review_count", - "description": "Enforcement of the required number of approvals before merging was updated on a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "required_approving_review_count", - "created_at", - "operation_type", - "name" - ] - }, - { - "action": "protected_branch.update_required_status_checks_enforcement_level", - "description": "Enforcement of required status checks was updated for a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at", - "required_status_checks_enforcement_level" - ] - }, - { - "action": "protected_branch.update_signature_requirement_enforcement_level", - "description": "Enforcement of required commit signing was updated for a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "name", - "created_at", - "signature_requirement_enforcement_level" - ] - }, - { - "action": "protected_branch.update_strict_required_status_checks_policy", - "description": "Enforcement of required status checks was updated for a branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "name", - "operation_type", - "strict_required_status_checks_policy" - ] - }, - { - "action": "public_key.create", - "description": "An SSH key was added to a user account or a deploy key was added to a repository.", - "docs_reference_links": "/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "read_only", - "operation_type", - "created_at", - "key", - "fingerprint", - "title" - ], - "docs_reference_titles": "/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account" - }, - { - "action": "public_key.delete", - "description": "An SSH key was removed from a user account or a deploy key was removed from a repository.", - "docs_reference_links": "/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "fingerprint", - "read_only", - "explanation", - "key", - "operation_type", - "title", - "created_at" - ], - "docs_reference_titles": "/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys" - }, - { - "action": "public_key.unverification_failure", - "description": "A user account's SSH key or a repository's deploy key was unable to be unverified.", - "docs_reference_links": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "title", - "key", - "fingerprint", - "read_only", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys" - }, - { - "action": "public_key.unverify", - "description": "A user account's SSH key or a repository's deploy key was unverified.", - "docs_reference_links": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "title", - "key", - "read_only", - "explanation", - "fingerprint" - ], - "docs_reference_titles": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys" - }, - { - "action": "public_key.update", - "description": "A user account's SSH key or a repository's deploy key was updated.", - "docs_reference_links": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "fingerprint", - "read_only", - "operation_type", - "created_at", - "title" - ], - "docs_reference_titles": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys" - }, - { - "action": "public_key.verification_failure", - "description": "A user account's SSH key or a repository's deploy key was unable to be verified.", - "docs_reference_links": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "fingerprint", - "oauth_application_id", - "title", - "created_at", - "read_only", - "operation_type" - ], - "docs_reference_titles": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys" - }, - { - "action": "public_key.verify", - "description": "A user account's SSH key or a repository's deploy key was verified.", - "docs_reference_links": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "key", - "fingerprint", - "title", - "read_only" - ], - "docs_reference_titles": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys" - }, - { - "action": "pull_request.close", - "description": "A pull request was closed without being merged.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "operation_type", - "created_at", - "pull_request_url", - "actor_is_bot" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request" - }, - { - "action": "pull_request.converted_to_draft", - "description": "A pull request was converted to a draft.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "operation_type", - "created_at", - "pull_request_url" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft" - }, - { - "action": "pull_request.create", - "description": "A pull request was created.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "operation_type", - "created_at", - "pull_request_url", - "actor_is_bot", - "actor_is_agent" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request" - }, - { - "action": "pull_request.create_review_request", - "description": "A review was requested on a pull request.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "reviewer_type", - "reviewer", - "reviewer_id", - "operation_type", - "created_at", - "pull_request_url", - "actor_is_agent" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews" - }, - { - "action": "pull_request.in_progress", - "description": "A pull request was marked as in progress.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "operation_type", - "created_at" - ] - }, - { - "action": "pull_request.indirect_merge", - "description": "A pull request was considered merged because the pull request's commits were merged into the target branch.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "operation_type", - "created_at", - "pull_request_url" - ] - }, - { - "action": "pull_request.merge", - "description": "A pull request was merged.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "operation_type", - "created_at", - "pull_request_url", - "actor_is_bot" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request" - }, - { - "action": "pull_request.ready_for_review", - "description": "A pull request was marked as ready for review.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#marking-a-pull-request-as-ready-for-review", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "operation_type", - "created_at", - "pull_request_url" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#marking-a-pull-request-as-ready-for-review" - }, - { - "action": "pull_request.rebase", - "description": "A pull request was rebased.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "pull_request_url", - "pull_request_title", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "pull_request.remove_review_request", - "description": "A review request was removed from a pull request.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "reviewer_type", - "reviewer", - "reviewer_id", - "operation_type", - "created_at", - "pull_request_url" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews" - }, - { - "action": "pull_request.reopen", - "description": "A pull request was reopened after previously being closed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "operation_type", - "created_at", - "pull_request_url" - ] - }, - { - "action": "pull_request_review_comment.create", - "description": "A review comment was added to a pull request.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "comment_id", - "operation_type", - "created_at", - "actor_is_agent" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews" - }, - { - "action": "pull_request_review_comment.delete", - "description": "A review comment on a pull request was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "comment_id", - "operation_type" - ] - }, - { - "action": "pull_request_review_comment.update", - "description": "A review comment on a pull request was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "comment_id" - ] - }, - { - "action": "pull_request_review.delete", - "description": "A review on a pull request was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "review_id", - "operation_type", - "created_at", - "pull_request_url" - ] - }, - { - "action": "pull_request_review.dismiss", - "description": "A review on a pull request was dismissed.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "review_id", - "operation_type", - "created_at", - "pull_request_url" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review" - }, - { - "action": "pull_request_review.submit", - "description": "A review on a pull request was submitted.", - "docs_reference_links": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request#submitting-your-review", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "review_id", - "operation_type", - "created_at", - "pull_request_url", - "actor_is_agent" - ], - "docs_reference_titles": "/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request#submitting-your-review" - }, - { - "action": "repo.access", - "description": "The visibility of a repository changed.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "visibility", - "previous_visibility" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility" - }, - { - "action": "repo.actions_enabled", - "description": "GitHub Actions was enabled for a repository.", - "docs_reference_links": "organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#using-the-audit-log-api", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#using-the-audit-log-api" - }, - { - "action": "repo.add_member", - "description": "A collaborator was added to a repository.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "created_at", - "operation_type", - "oauth_application_id" - ], - "docs_reference_titles": "Inviting collaborators to a personal repository" - }, - { - "action": "repo.add_topic", - "description": "A topic was added to a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "topic", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics" - }, - { - "action": "repo.advanced_security_disabled", - "description": "GitHub Advanced Security was disabled for a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository" - }, - { - "action": "repo.advanced_security_enabled", - "description": "GitHub Advanced Security was enabled for a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "public_repo", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository" - }, - { - "action": "repo.archived", - "description": "A repository was archived.", - "docs_reference_links": "/repositories/archiving-a-github-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "visibility" - ], - "docs_reference_titles": "/repositories/archiving-a-github-repository" - }, - { - "action": "repo.change_merge_setting", - "description": "Pull request merge options were changed for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "created_at", - "operation_type", - "public_repo", - "actor_is_bot" - ] - }, - { - "action": "repo.code_scanning_analysis_deleted", - "description": "Code scanning analysis for a repository was deleted.", - "docs_reference_links": "/rest/code-scanning#delete-a-code-scanning-analysis-from-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "operation_type", - "created_at", - "public_repo", - "tool", - "category" - ], - "docs_reference_titles": "/rest/code-scanning#delete-a-code-scanning-analysis-from-a-repository" - }, - { - "action": "repo.code_scanning_autofix_disabled", - "description": "Autofix for code scanning alerts was disabled for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "repo.code_scanning_autofix_enabled", - "description": "Autofix for code scanning alerts was enabled for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "repo.code_scanning_configuration_for_branch_deleted", - "description": "A code scanning configuration for a branch of a repository was deleted.", - "docs_reference_links": "/code-security/code-scanning/managing-code-scanning-alerts/managing-code-scanning-alerts-for-your-repository#removing-stale-configurations-and-alerts-from-a-branch", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "tool", - "branch", - "category", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Resolving code scanning alerts" - }, - { - "action": "repo.codeql_disabled", - "description": "Code scanning using the default setup was disabled for a repository.", - "docs_reference_links": "/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Configuring default setup for code scanning" - }, - { - "action": "repo.codeql_enabled", - "description": "Code scanning using the default setup was enabled for a repository.", - "docs_reference_links": "/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "query_suite", - "threat_model", - "languages" - ], - "docs_reference_titles": "Configuring default setup for code scanning" - }, - { - "action": "repo.codeql_updated", - "description": "Code scanning using the default setup was updated for a repository.", - "docs_reference_links": "/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "query_suite", - "threat_model", - "languages", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Configuring default setup for code scanning" - }, - { - "action": "repo.codespaces_trusted_repo_access_granted", - "description": "GitHub Codespaces was granted trusted repository access to this repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "repo.codespaces_trusted_repo_access_revoked", - "description": "GitHub Codespaces trusted repository access to this repository was revoked.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.config.disable_collaborators_only", - "description": "The interaction limit for collaborators only was disabled.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository" - }, - { - "action": "repo.config.disable_contributors_only", - "description": "The interaction limit for prior contributors only was disabled in a repository.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository" - }, - { - "action": "repo.config.disable_sockpuppet_disallowed", - "description": "The interaction limit for existing users only was disabled in a repository.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository" - }, - { - "action": "repo.config.enable_collaborators_only", - "description": "The interaction limit for collaborators only was enabled in a repository Users that are not collaborators or organization members were unable to interact with a repository for a set duration.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository" - }, - { - "action": "repo.config.enable_contributors_only", - "description": "The interaction limit for prior contributors only was enabled in a repository Users that are not prior contributors, collaborators or organization members were unable to interact with a repository for a set duration.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository" - }, - { - "action": "repo.config.enable_sockpuppet_disallowed", - "description": "The interaction limit for existing users was enabled in a repository New users aren't able to interact with a repository for a set duration Existing users of the repository, contributors, collaborators or organization members are able to interact with a repository.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository" - }, - { - "action": "repo.configure_self_hosted_jit_runner", - "description": "A new just-in-time GitHub Actions self-hosted runner was configured", - "docs_reference_links": "/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository" - }, - { - "action": "repo.create", - "description": "A repository was created.", - "docs_reference_links": "/repositories/creating-and-managing-repositories/creating-a-new-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "request_category", - "created_at", - "oauth_application_id", - "request_method", - "public_repo", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/creating-and-managing-repositories/creating-a-new-repository" - }, - { - "action": "repo.create_actions_secret", - "description": "A GitHub Actions secret was created for a repository.", - "docs_reference_links": "/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Using secrets in GitHub Actions" - }, - { - "action": "repo.create_actions_variable", - "description": "A GitHub Actions variable was created for a repository.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "repo.create_integration_secret", - "description": "A Codespaces or Dependabot secret was created for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "integration", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "repo.destroy", - "description": "A repository was deleted.", - "docs_reference_links": "/repositories/creating-and-managing-repositories/deleting-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "request_category", - "visibility", - "created_at", - "request_method", - "oauth_application_id", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/creating-and-managing-repositories/deleting-a-repository" - }, - { - "action": "repo.download_zip", - "description": "A source code archive of a repository was downloaded as a ZIP file.", - "docs_reference_links": "/repositories/working-with-files/using-files/downloading-source-code-archives", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "created_at", - "operation_type", - "public_repo", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/working-with-files/using-files/downloading-source-code-archives" - }, - { - "action": "repo.pages_cname", - "description": "A GitHub Pages custom domain was modified in a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "cname", - "created_at", - "operation_type", - "old_cname" - ] - }, - { - "action": "repo.pages_create", - "description": "A GitHub Pages site was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.pages_destroy", - "description": "A GitHub Pages site was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "visibility", - "operation_type" - ] - }, - { - "action": "repo.pages_https_redirect_disabled", - "description": "HTTPS redirects were disabled for a GitHub Pages site.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.pages_https_redirect_enabled", - "description": "HTTPS redirects were enabled for a GitHub Pages site.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "visibility", - "operation_type" - ] - }, - { - "action": "repo.pages_private", - "description": "A GitHub Pages site visibility was changed to private.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.pages_public", - "description": "A GitHub Pages site visibility was changed to public.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.pages_soft_delete", - "description": "A GitHub Pages site was soft-deleted because its owner's plan changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "repo.pages_soft_delete_restore", - "description": "A GitHub Pages site that was previously soft-deleted was restored.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "repo.pages_source", - "description": "A GitHub Pages source was modified.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "visibility", - "created_at" - ] - }, - { - "action": "repo.register_self_hosted_runner", - "description": "A new self-hosted runner was registered.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Adding self-hosted runners" - }, - { - "action": "repo.remove_actions_secret", - "description": "A GitHub Actions secret was deleted for a repository.", - "docs_reference_links": "/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Using secrets in GitHub Actions" - }, - { - "action": "repo.remove_actions_variable", - "description": "A GitHub Actions variable was deleted for a repository.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "repo.remove_integration_secret", - "description": "A Codespaces or Dependabot secret was deleted for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "integration", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "repo.remove_member", - "description": "A collaborator was removed from a repository.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "visibility" - ], - "docs_reference_titles": "Removing a collaborator from a personal repository" - }, - { - "action": "repo.remove_self_hosted_runner", - "description": "A self-hosted runner was removed.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Removing self-hosted runners" - }, - { - "action": "repo.remove_topic", - "description": "A topic was removed from a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "topic", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.rename", - "description": "A repository was renamed.", - "docs_reference_links": "/repositories/creating-and-managing-repositories/renaming-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "old_name", - "created_at", - "operation_type", - "visibility" - ], - "docs_reference_titles": "/repositories/creating-and-managing-repositories/renaming-a-repository" - }, - { - "action": "repo.rename_branch", - "description": "A branch was renamed.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "old_branch", - "new_branch", - "default_branch", - "operation_type", - "created_at", - "public_repo", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch" - }, - { - "action": "repo.restore", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.self_hosted_runner_offline", - "description": "The runner application was stopped. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_id", - "runner_name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Monitoring and troubleshooting self-hosted runners" - }, - { - "action": "repo.self_hosted_runner_online", - "description": "The runner application was started. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_id", - "runner_name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Monitoring and troubleshooting self-hosted runners" - }, - { - "action": "repo.self_hosted_runner_updated", - "description": "The runner application was updated. This event is not included in the JSON/CSV export.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#about-self-hosted-runners", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "runner_id", - "runner_name", - "source_version", - "target_version", - "runner_group_id", - "runner_group_name" - ], - "docs_reference_titles": "Self-hosted runners" - }, - { - "action": "repo.set_actions_fork_pr_approvals_policy", - "description": "The setting for requiring approvals for workflows from public forks was changed for a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-required-approval-for-workflows-from-public-forks", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "policy", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-required-approval-for-workflows-from-public-forks" - }, - { - "action": "repo.set_actions_private_fork_pr_approvals_policy", - "description": "The policy for requiring approval for fork pull request workflows from collaborators without write access to private repos was changed for a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-forks-of-private-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "policy", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-forks-of-private-repositories" - }, - { - "action": "repo.set_actions_retention_limit", - "description": "The retention period for GitHub Actions artifacts and logs in a repository was changed.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "limit", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository" - }, - { - "action": "repo.set_default_workflow_permissions", - "description": "The default permissions granted to the GITHUB_TOKEN when running workflows were changed for a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository" - }, - { - "action": "repo.set_fork_pr_workflows_policy", - "description": "Triggered when the policy for workflows on private repository forks is changed.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "policy", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks" - }, - { - "action": "repo.set_workflow_permission_can_approve_pr", - "description": "The policy for allowing GitHub Actions to create and approve pull requests was changed for a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#preventing-github-actions-from-creating-or-approving-pull-requests", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#preventing-github-actions-from-creating-or-approving-pull-requests" - }, - { - "action": "repo.staff_unlock", - "description": "An enterprise owner or GitHub staff (with permission from a repository administrator) temporarily unlocked the repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "repo.transfer", - "description": "A user accepted a request to receive a transferred repository.", - "docs_reference_links": "/repositories/creating-and-managing-repositories/transferring-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "old_user", - "operation_type", - "created_at", - "visibility", - "repo_was" - ], - "docs_reference_titles": "/repositories/creating-and-managing-repositories/transferring-a-repository" - }, - { - "action": "repo.transfer_outgoing", - "description": "A repository was transferred to another repository network.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "new_nwo", - "visibility", - "created_at", - "operation_type", - "public_repo" - ] - }, - { - "action": "repo.transfer_start", - "description": "A user sent a request to transfer a repository to another user or organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "visibility" - ] - }, - { - "action": "repo.unarchived", - "description": "A repository was unarchived.", - "docs_reference_links": "/repositories/archiving-a-github-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "visibility" - ], - "docs_reference_titles": "/repositories/archiving-a-github-repository" - }, - { - "action": "repo.update_actions_access_settings", - "description": "The setting to control how a repository was used by GitHub Actions workflows in other repositories was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "policy", - "old_policy", - "created_at", - "operation_type" - ] - }, - { - "action": "repo.update_actions_secret", - "description": "A GitHub Actions secret was updated for a repository.", - "docs_reference_links": "/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "key", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Using secrets in GitHub Actions" - }, - { - "action": "repo.update_actions_settings", - "description": "A repository administrator changed GitHub Actions policy settings for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at", - "new_policy", - "old_policy", - "updated_access_policy", - "actor_is_bot" - ] - }, - { - "action": "repo.update_actions_variable", - "description": "A GitHub Actions variable was updated for a repository.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "repo.update_default_branch", - "description": "The default branch for a repository was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at", - "actor_is_bot" - ] - }, - { - "action": "repo.update_integration_secret", - "description": "A Codespaces or Dependabot secret was updated for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "integration", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "repo.update_member", - "description": "A user's permission to a repository was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "oauth_application_id", - "operation_type", - "visibility", - "old_permission", - "old_base_role", - "old_repo_permission", - "old_repo_base_role", - "new_repo_base_role", - "new_repo_permission", - "actor_is_bot" - ] - }, - { - "action": "repository_advisory.close", - "description": "Someone closed a security advisory.", - "docs_reference_links": "/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "About repository security advisories" - }, - { - "action": "repository_advisory.cve_request", - "description": "Someone requested a CVE (Common Vulnerabilities and Exposures) number from GitHub for a draft security advisory.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "repository_advisory.github_broadcast", - "description": "GitHub made a security advisory public in the GitHub Advisory Database.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "repository_advisory.github_withdraw", - "description": "GitHub withdrew a security advisory that was published in error.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "repository_advisory.open", - "description": "Someone opened a draft security advisory.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "repository_advisory.publish", - "description": "Someone published a security advisory.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "repository_advisory.reopen", - "description": "Someone reopened as draft security advisory.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "repository_advisory.update", - "description": "Someone edited a draft or published security advisory.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "repository_branch_protection_evaluation.disable", - "description": "Branch protections were disabled for the repository.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule" - }, - { - "action": "repository_branch_protection_evaluation.enable", - "description": "Branch protections were enabled for this repository.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule" - }, - { - "action": "repository_content_analysis.disable", - "description": "Data use settings were disabled for a private repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#enabling-or-disabling-security-and-analysis-features-for-private-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#enabling-or-disabling-security-and-analysis-features-for-private-repositories" - }, - { - "action": "repository_content_analysis.enable", - "description": "Data use settings were enabled for a private repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#enabling-or-disabling-security-and-analysis-features-for-private-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#enabling-or-disabling-security-and-analysis-features-for-private-repositories" - }, - { - "action": "repository_dependency_graph.disable", - "description": "The dependency graph was disabled for a private repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-fea tures-for-your-repository/managing-security-and-analysis-settings-for-your-repository#enabling-or-disabling-security-and-analysis-features-for-private-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-fea, tures-for-your-repository/managing-security-and-analysis-settings-for-your-repository#enabling-or-disabling-security-and-analysis-features-for-private-repositories" - }, - { - "action": "repository_dependency_graph.enable", - "description": "The dependency graph was enabled for a private repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "public_repo", - "actor_is_bot" - ] - }, - { - "action": "repository_image.create", - "description": "An image to represent a repository was uploaded.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "content_type" - ] - }, - { - "action": "repository_image.destroy", - "description": "An image to represent a repository was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "content_type", - "created_at", - "operation_type" - ] - }, - { - "action": "repository_invitation.accept", - "description": "An invitation to join a repository was accepted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "invitee", - "operation_type", - "inviter" - ] - }, - { - "action": "repository_invitation.cancel", - "description": "An invitation to join a repository was canceled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "inviter", - "operation_type", - "invitee", - "created_at" - ] - }, - { - "action": "repository_invitation.create", - "description": "An invitation to join a repository was sent.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "invitee", - "inviter", - "created_at", - "operation_type" - ] - }, - { - "action": "repository_invitation.reject", - "description": "An invitation to join a repository was declined.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "invitee", - "operation_type", - "created_at", - "inviter" - ] - }, - { - "action": "repository_projects_change.clear", - "description": "The repository projects policy was removed for an organization, or all organizations in the enterprise Organization owners can now control their repository projects settings.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-projects-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enforcing policies for projects in your enterprise" - }, - { - "action": "repository_projects_change.disable", - "description": "Repository projects were disabled for a repository, all repositories in an organization, or all organizations in an enterprise.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "repository_projects_change.enable", - "description": "Repository projects were enabled for a repository, all repositories in an organization, or all organizations in an enterprise.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "repository_ruleset.create", - "description": "A repository ruleset was created.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "public_repo", - "created_at", - "operation_type", - "ruleset_id", - "ruleset_name", - "ruleset_enforcement", - "ruleset_source_type", - "ruleset_rules", - "ruleset_conditions", - "ruleset_bypass_actors" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository" - }, - { - "action": "repository_ruleset.destroy", - "description": "A repository ruleset was deleted.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#deleting-a-ruleset", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "public_repo", - "created_at", - "operation_type", - "ruleset_id", - "ruleset_name", - "ruleset_enforcement", - "ruleset_source_type", - "ruleset_rules", - "ruleset_bypass_actors" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#deleting-a-ruleset" - }, - { - "action": "repository_ruleset.update", - "description": "A repository ruleset was edited.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#editing-a-ruleset", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "old_name", - "public_repo", - "created_at", - "operation_type", - "ruleset_id", - "ruleset_name", - "ruleset_enforcement", - "ruleset_source_type", - "ruleset_rules_updated", - "ruleset_conditions_added", - "ruleset_conditions_deleted", - "ruleset_old_enforcement", - "ruleset_rules_added", - "ruleset_rules_deleted", - "ruleset_old_name", - "ruleset_conditions_updated", - "ruleset_bypass_actors_added", - "ruleset_bypass_actors_deleted", - "ruleset_bypass_actors_updated", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#editing-a-ruleset" - }, - { - "action": "repository_secret_scanning_automatic_validity_checks.disabled", - "description": "Automatic partner validation checks have been disabled at the repository level", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#allowing-validity-checks-for-partner-patterns-in-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#allowing-validity-checks-for-partner-patterns-in-a-repository" - }, - { - "action": "repository_secret_scanning_automatic_validity_checks.enabled", - "description": "Automatic partner validation checks have been enabled at the repository level", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#allowing-validity-checks-for-partner-patterns-in-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#allowing-validity-checks-for-partner-patterns-in-a-repository" - }, - { - "action": "repository_secret_scanning_custom_pattern.create", - "description": "A custom pattern was created for secret scanning in a repository.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "repository_secret_scanning_custom_pattern.delete", - "description": "A custom pattern was removed from secret scanning in a repository.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#removing-a-custom-pattern", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "repository_secret_scanning_custom_pattern.publish", - "description": "A custom pattern was published for secret scanning in a repository.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "repository_secret_scanning_custom_pattern_push_protection.disabled", - "description": "Push protection for a custom pattern for secret scanning was disabled for your repository.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "repository_secret_scanning_custom_pattern_push_protection.enabled", - "description": "Push protection for a custom pattern for secret scanning was enabled for your repository.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "repository_secret_scanning_custom_pattern.update", - "description": "Changes to a custom pattern were saved and a dry run was executed for secret scanning in a repository.", - "docs_reference_links": "/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#editing-a-custom-pattern", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "Defining custom patterns for secret scanning" - }, - { - "action": "repository_secret_scanning.disable", - "description": "Secret scanning was disabled for a repository.", - "docs_reference_links": "/code-security/secret-scanning/about-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "About secret scanning" - }, - { - "action": "repository_secret_scanning.enable", - "description": "Secret scanning was enabled for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "repository_secret_scanning_generic_secrets.disabled", - "description": "Generic secrets have been disabled at the repository level", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "repository_secret_scanning_generic_secrets.enabled", - "description": "Generic secrets have been enabled at the repository level", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "repository_secret_scanning_non_provider_patterns.disabled", - "description": "Secret scanning for non-provider patterns was disabled at the repository level.", - "docs_reference_links": "/code-security/secret-scanning/secret-scanning-patterns#non-provider-patterns", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Supported secret scanning patterns" - }, - { - "action": "repository_secret_scanning_non_provider_patterns.enabled", - "description": "Secret scanning for non-provider patterns was enabled at the repository level.", - "docs_reference_links": "/code-security/secret-scanning/secret-scanning-patterns#non-provider-patterns", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Supported secret scanning patterns" - }, - { - "action": "repository_secret_scanning_push_protection_bypass_list.add", - "description": "A role or team was added to the push protection bypass list at the repository level.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "repository_secret_scanning_push_protection_bypass_list.disable", - "description": "Push protection settings for \"Users who can bypass push protection for secret scanning\" changed from \"Specific roles or teams\" to \"Anyone with write access\" at the repository level.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "repository_secret_scanning_push_protection_bypass_list.enable", - "description": "Push protection settings for \"Users who can bypass push protection for secret scanning\" changed from \"Anyone with write access\" to \"Specific roles or teams\" at the repository level.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "repository_secret_scanning_push_protection_bypass_list.remove", - "description": "A role or team was removed from the push protection bypass list at the repository level.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "repository_secret_scanning_push_protection.disable", - "description": "Secret scanning push protection was disabled for a repository.", - "docs_reference_links": "/code-security/secret-scanning/protecting-pushes-with-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "repository_secret_scanning_push_protection.enable", - "description": "Secret scanning push protection was enabled for a repository.", - "docs_reference_links": "/code-security/secret-scanning/protecting-pushes-with-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "repository_visibility_change.clear", - "description": "The repository visibility change setting was cleared for an organization or enterprise.", - "docs_reference_links": "/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization, /admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-changes-to-repository-visibility", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization, Enforcing repository management policies in your enterprise" - }, - { - "action": "repository_visibility_change.disable", - "description": "The ability for enterprise members to update a repository's visibility was disabled. Members are unable to change repository visibilities in an organization, or all organizations in an enterprise.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "repository_visibility_change.enable", - "description": "The ability for enterprise members to update a repository's visibility was enabled. Members are able to change repository visibilities in an organization, or all organizations in an enterprise.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "repository_vulnerability_alert.auto_dismiss", - "description": "A Dependabot alert was automatically dismissed because its metadata matches an enabled Dependabot rule.", - "docs_reference_links": "/code-security/dependabot/dependabot-alerts/using-alert-rules-to-prioritize-dependabot-alerts", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "alert_id", - "alert_number", - "ghsa_id", - "public_repo", - "owner", - "created_at", - "operation_type", - "vulnerability_alert_rule_id", - "vulnerability_alert_rule_name" - ], - "docs_reference_titles": "About Dependabot auto-triage rules" - }, - { - "action": "repository_vulnerability_alert.auto_reopen", - "description": "A previously auto-dismissed Dependabot alert was automatically reopened because its metadata no longer matches an enabled Dependabot rule.", - "docs_reference_links": "/code-security/dependabot/dependabot-alerts/using-alert-rules-to-prioritize-dependabot-alerts", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "alert_id", - "alert_number", - "ghsa_id", - "public_repo", - "owner", - "created_at", - "operation_type", - "vulnerability_alert_rule_id", - "vulnerability_alert_rule_name" - ], - "docs_reference_titles": "About Dependabot auto-triage rules" - }, - { - "action": "repository_vulnerability_alert.create", - "description": "GitHub created a Dependabot alert because the repository uses a vulnerable dependency.", - "docs_reference_links": "/code-security/dependabot/dependabot-alerts/about-dependabot-alerts", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "alert_id", - "created_at", - "alert_number" - ], - "docs_reference_titles": "About Dependabot alerts" - }, - { - "action": "repository_vulnerability_alert.dismiss", - "description": "A Dependabot alert was manually dismissed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "alert_id", - "created_at", - "dismiss_reason", - "dismiss_comment", - "alert_number", - "actor_is_bot" - ] - }, - { - "action": "repository_vulnerability_alert.reintroduce", - "description": "A Dependabot alert was automatically reopened because the repository resumed use of a vulnerable dependency.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "alert_id", - "created_at", - "public_repo", - "owner", - "operation_type", - "alert_number" - ] - }, - { - "action": "repository_vulnerability_alert.reopen", - "description": "A Dependabot alert was manually reopened.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "alert_id", - "created_at", - "owner", - "operation_type", - "public_repo", - "alert_number" - ] - }, - { - "action": "repository_vulnerability_alert.resolve", - "description": "Changes were pushed to update and resolve a Dependabot alert in a project dependency.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "alert_id", - "operation_type", - "created_at", - "alert_number" - ] - }, - { - "action": "repository_vulnerability_alerts.authorized_users_teams", - "description": "The list of people or teams authorized to receive Dependabot alerts for the repository was updated.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts" - }, - { - "action": "repository_vulnerability_alerts_auto_dismissal.disable", - "description": "Automatic dismissal of low-impact Dependabot alerts was disabled for the repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "repository_vulnerability_alerts_auto_dismissal.enable", - "description": "Automatic dismissal of low-impact Dependabot alerts was enabled for the repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "repository_vulnerability_alerts.disable", - "description": "Dependabot alerts was disabled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "repository_vulnerability_alerts.enable", - "description": "Dependabot alerts was enabled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "required_status_check.create", - "description": "A status check was marked as required for a protected branch.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-status-checks-before-merging", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "context", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-status-checks-before-merging" - }, - { - "action": "required_status_check.destroy", - "description": "A status check was no longer marked as required for a protected branch.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-status-checks-before-merging", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "context", - "operation_type" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-status-checks-before-merging" - }, - { - "action": "restrict_notification_delivery.disable", - "description": "Email notification restrictions for an organization or enterprise were disabled.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization, /admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Restricting email notifications for your organization, Restricting email notifications for your enterprise" - }, - { - "action": "restrict_notification_delivery.enable", - "description": "Email notification restrictions for an organization or enterprise were enabled.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization, /admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Restricting email notifications for your organization, Restricting email notifications for your enterprise" - }, - { - "action": "role.create", - "description": "A new custom repository role was created.", - "docs_reference_links": "/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "name", - "owner", - "base_role", - "operation_type", - "role_permissions", - "old_role_permissions" - ], - "docs_reference_titles": "Managing custom repository roles for an organization" - }, - { - "action": "role.destroy", - "description": "A custom repository role was deleted.", - "docs_reference_links": "/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "name", - "owner", - "role_permissions", - "base_role", - "operation_type" - ], - "docs_reference_titles": "Managing custom repository roles for an organization" - }, - { - "action": "role.update", - "description": "A custom repository role was edited.", - "docs_reference_links": "/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "owner", - "role_permissions", - "base_role", - "operation_type", - "created_at", - "old_role_permissions", - "old_base_role" - ], - "docs_reference_titles": "Managing custom repository roles for an organization" - }, - { - "action": "secret_scanning_alert.create", - "description": "GitHub detected a secret and created a secret scanning alert.", - "docs_reference_links": "/code-security/secret-scanning/managing-alerts-from-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "number", - "secret_type", - "secret_type_display_name", - "publicly_leaked", - "multi_repo" - ], - "docs_reference_titles": "Manage secret scanning alerts" - }, - { - "action": "secret_scanning_alert.reopen", - "description": "A secret scanning alert was reopened.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "number", - "public_repo", - "created_at", - "operation_type", - "secret_type_display_name" - ] - }, - { - "action": "secret_scanning_alert.resolve", - "description": "A secret scanning alert was resolved.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "number", - "resolution", - "public_repo", - "created_at", - "operation_type", - "secret_type", - "secret_type_display_name", - "publicly_leaked", - "multi_repo" - ] - }, - { - "action": "secret_scanning_alert.revoke", - "description": "A secret scanning alert was revoked.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "number", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "secret_scanning_alert.validate", - "description": "A secret scanning alert was validated.", - "docs_reference_links": "/code-security/secret-scanning/managing-alerts-from-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "number", - "created_at", - "previous_validity", - "current_validity", - "secret_type", - "secret_type_display_name", - "publicly_leaked", - "multi_repo" - ], - "docs_reference_titles": "Manage secret scanning alerts" - }, - { - "action": "secret_scanning.disable", - "description": "Secret scanning was disabled for all existing repositories.", - "docs_reference_links": "/code-security/secret-scanning/about-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "About secret scanning" - }, - { - "action": "secret_scanning.enable", - "description": "Secret scanning was enabled for all existing repositories.", - "docs_reference_links": "/code-security/secret-scanning/about-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About secret scanning" - }, - { - "action": "secret_scanning_new_repos.disable", - "description": "Secret scanning was disabled for all new repositories.", - "docs_reference_links": "/code-security/secret-scanning/about-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "About secret scanning" - }, - { - "action": "secret_scanning_new_repos.enable", - "description": "Secret scanning was enabled for all new repositories.", - "docs_reference_links": "/code-security/secret-scanning/about-secret-scanning", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "About secret scanning" - }, - { - "action": "secret_scanning_push_protection.bypass", - "description": "Triggered when a user bypasses the push protection on a secret detected by secret scanning.", - "docs_reference_links": "/code-security/secret-scanning/protecting-pushes-with-secret-scanning#bypassing-push-protection-for-a-secret", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "number", - "created_at", - "push_protection_bypass_reason", - "secret_type", - "secret_type_display_name", - "publicly_leaked", - "multi_repo", - "request_reviewer", - "request_reviewer_id" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "secret_scanning_push_protection_request.approve", - "description": "A request to bypass secret scanning push protection was approved by a user.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#managing-requests-to-bypass-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "number", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "secret_scanning_push_protection_request.deny", - "description": "A request to bypass secret scanning push protection was denied by a user.", - "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations#managing-requests-to-bypass-push-protection", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "number", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot", - "request_reviewer_comment" - ], - "docs_reference_titles": "About push protection" - }, - { - "action": "secret_scanning_push_protection_request.request", - "description": "A user requested to bypass secret scanning push protection.", - "docs_reference_links": "/code-security/secret-scanning/working-with-push-protection#requesting-bypass-privileges-when-working-with-the-command-line", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "number", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "/code-security/secret-scanning/working-with-push-protection#requesting-bypass-privileges-when-working-with-the-command-line" - }, - { - "action": "sponsors.agreement_sign", - "description": "A GitHub Sponsors agreement was signed on behalf of an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "created_at", - "operation_type" - ] - }, - { - "action": "sponsors.custom_amount_settings_change", - "description": "Custom amounts for GitHub Sponsors were enabled or disabled, or the suggested custom amount was changed.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers" - }, - { - "action": "sponsors.fiscal_host_change", - "description": "The fiscal host for a GitHub Sponsors listing was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "created_at", - "operation_type" - ] - }, - { - "action": "sponsors.invoiced_agreement_sign", - "description": "An agreement for invoiced billing for GitHub Sponsors was signed.", - "docs_reference_links": "/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice" - }, - { - "action": "sponsors.repo_funding_links_file_action", - "description": "The FUNDING file in a repository was changed.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository" - }, - { - "action": "sponsors.sponsor_sponsorship_cancel", - "description": "A sponsorship was canceled.", - "docs_reference_links": "/billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Downgrading a sponsorship" - }, - { - "action": "sponsors.sponsor_sponsorship_create", - "description": "A sponsorship was created, by sponsoring an account.", - "docs_reference_links": "/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes" - }, - { - "action": "sponsors.sponsor_sponsorship_payment_complete", - "description": "After you sponsor an account and a payment has been processed, the sponsorship payment was marked as complete.", - "docs_reference_links": "/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "active", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes" - }, - { - "action": "sponsors.sponsor_sponsorship_preference_change", - "description": "The option to receive email updates from a sponsored account was changed.", - "docs_reference_links": "/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship" - }, - { - "action": "sponsors.sponsor_sponsorship_tier_change", - "description": "A sponsorship was upgraded or downgraded.", - "docs_reference_links": "/billing/managing-billing-for-github-sponsors/upgrading-a-sponsorship, /billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Upgrading a sponsorship, Downgrading a sponsorship" - }, - { - "action": "sponsors.sponsored_developer_approve", - "description": "A GitHub Sponsors account was approved.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account" - }, - { - "action": "sponsors.sponsored_developer_create", - "description": "A GitHub Sponsors account was created.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account" - }, - { - "action": "sponsors.sponsored_developer_disable", - "description": "A GitHub Sponsors account was disabled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "operation_type", - "created_at" - ] - }, - { - "action": "sponsors.sponsored_developer_profile_update", - "description": "The profile for GitHub Sponsors account was edited.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors" - }, - { - "action": "sponsors.sponsored_developer_redraft", - "description": "A GitHub Sponsors account was returned to draft state from approved state.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "sponsors.sponsored_developer_request_approval", - "description": "An application for GitHub Sponsors was submitted for approval.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account" - }, - { - "action": "sponsors.sponsored_developer_tier_description_update", - "description": "The description for a sponsorship tier was changed.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers" - }, - { - "action": "sponsors.sponsors_patreon_user_create", - "description": "A Patreon account was linked to a user account for use with GitHub Sponsors.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/enabling-sponsorships-through-patreon#linking-your-patreon-account-to-your-github-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "patreon_email", - "patreon_username", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/enabling-sponsorships-through-patreon#linking-your-patreon-account-to-your-github-account" - }, - { - "action": "sponsors.sponsors_patreon_user_destroy", - "description": "A Patreon account for use with GitHub Sponsors was unlinked from a user account.", - "docs_reference_links": "/sponsors/sponsoring-open-source-contributors/unlinking-your-patreon-account-from-your-github-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "patreon_email", - "patreon_username", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Unlinking your Patreon account from GitHub" - }, - { - "action": "sponsors.update_tier_repository", - "description": "A GitHub Sponsors tier changed access for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "created_at", - "operation_type" - ] - }, - { - "action": "sponsors.update_tier_welcome_message", - "description": "The welcome message for a GitHub Sponsors tier for an organization was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "created_at", - "operation_type" - ] - }, - { - "action": "sponsors.withdraw_agreement_signature", - "description": "A signature was withdrawn from a GitHub Sponsors agreement that applies to an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "created_at", - "operation_type" - ] - }, - { - "action": "ssh_certificate_authority.create", - "description": "An SSH certificate authority for an organization or enterprise was created.", - "docs_reference_links": "/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities, /admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-ssh-certificate-authorities-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "fingerprint", - "operation_type", - "openssh_public_key", - "created_at" - ], - "docs_reference_titles": "Managing your organization's SSH certificate authorities, Enforcing policies for security settings in your enterprise" - }, - { - "action": "ssh_certificate_authority.destroy", - "description": "An SSH certificate authority for an organization or enterprise was deleted.", - "docs_reference_links": "/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities, /admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-ssh-certificate-authorities-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "fingerprint", - "operation_type", - "openssh_public_key" - ], - "docs_reference_titles": "Managing your organization's SSH certificate authorities, Enforcing policies for security settings in your enterprise" - }, - { - "action": "ssh_certificate_requirement.disable", - "description": "The requirement for members to use SSH certificates to access an organization resources was disabled.", - "docs_reference_links": "/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities, /admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-ssh-certificate-authorities-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing your organization's SSH certificate authorities, Enforcing policies for security settings in your enterprise" - }, - { - "action": "ssh_certificate_requirement.enable", - "description": "The requirement for members to use SSH certificates to access an organization resources was enabled.", - "docs_reference_links": "/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities, /admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-ssh-certificate-authorities-for-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing your organization's SSH certificate authorities, Enforcing policies for security settings in your enterprise" - }, - { - "action": "staff.dependabot_debug_credentials_generated", - "description": "Dependabot encrypted config was read.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "public_repo" - ] - }, - { - "action": "staff.set_domain_token_expiration", - "description": "The verification code expiry time for an organization or enterprise domain was set.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner_type", - "domain_name", - "token_expires_at", - "owner", - "operation_type", - "created_at" - ] - }, - { - "action": "staff.unverify_domain", - "description": "An organization or enterprise domain was unverified.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "owner_type", - "domain_name", - "owner", - "operation_type" - ] - }, - { - "action": "staff.verify_domain", - "description": "An organization or enterprise domain was verified.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "domain_name", - "operation_type", - "created_at" - ] - }, - { - "action": "team.add_member", - "description": "A member of an organization was added to a team.", - "docs_reference_links": "/organizations/organizing-members-into-teams/adding-organization-members-to-a-team", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "created_at", - "operation_type", - "team_type" - ], - "docs_reference_titles": "/organizations/organizing-members-into-teams/adding-organization-members-to-a-team" - }, - { - "action": "team.add_repository", - "description": "A team was given access and permissions to a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "operation_type", - "created_at", - "actor_is_bot" - ] - }, - { - "action": "team.change_parent_team", - "description": "A child team was created or a child team's parent was changed.", - "docs_reference_links": "/organizations/organizing-members-into-teams/moving-a-team-in-your-organizations-hierarchy", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "team", - "operation_type" - ], - "docs_reference_titles": "/organizations/organizing-members-into-teams/moving-a-team-in-your-organizations-hierarchy" - }, - { - "action": "team.change_privacy", - "description": "A team's privacy level was changed.", - "docs_reference_links": "/organizations/organizing-members-into-teams/changing-team-visibility", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "created_at", - "operation_type", - "team_type" - ], - "docs_reference_titles": "/organizations/organizing-members-into-teams/changing-team-visibility" - }, - { - "action": "team.create", - "description": "A new team is created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "operation_type", - "team", - "created_at", - "team_type" - ] - }, - { - "action": "team.demote_maintainer", - "description": "A user was demoted from a team maintainer to a team member.", - "docs_reference_links": "/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member" - }, - { - "action": "team.destroy", - "description": "A team was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "team", - "operation_type", - "team_type" - ] - }, - { - "action": "team_discussions.clear", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "team_discussions.disable", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "team_discussions.enable", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "team_group_mapping.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "team" - ] - }, - { - "action": "team_group_mapping.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "team", - "created_at" - ] - }, - { - "action": "team_group_mapping.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "operation_type", - "created_at" - ] - }, - { - "action": "team.promote_maintainer", - "description": "A user was promoted from a team member to a team maintainer.", - "docs_reference_links": "/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member#promoting-an-organization-member-to-team-maintainer", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member#promoting-an-organization-member-to-team-maintainer" - }, - { - "action": "team.remove_member", - "description": "An organization member was removed from a team.", - "docs_reference_links": "/organizations/organizing-members-into-teams/removing-organization-members-from-a-team", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "team", - "team_type" - ], - "docs_reference_titles": "/organizations/organizing-members-into-teams/removing-organization-members-from-a-team" - }, - { - "action": "team.remove_repository", - "description": "A repository was removed from a team's control.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "team", - "operation_type" - ] - }, - { - "action": "team.rename", - "description": "A team's name was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "created_at", - "team", - "operation_type", - "team_type" - ] - }, - { - "action": "team_sync_tenant.disabled", - "description": "Team synchronization with a tenant was disabled.", - "docs_reference_links": "/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization, /admin/identity-and-access-management/using-saml-for-enterprise-iam/managing-team-synchronization-for-organizations-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing team synchronization for your organization, Managing team synchronization for organizations in your enterprise" - }, - { - "action": "team_sync_tenant.enabled", - "description": "Team synchronization with a tenant was enabled.", - "docs_reference_links": "/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization, /admin/identity-and-access-management/using-saml-for-enterprise-iam/managing-team-synchronization-for-organizations-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing team synchronization for your organization, Managing team synchronization for organizations in your enterprise" - }, - { - "action": "team_sync_tenant.update_okta_credentials", - "description": "The Okta credentials for team synchronization with a tenant were changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "team.update_repository_permission", - "description": "A team's permission to a repository was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "team", - "old_permission", - "operation_type", - "created_at", - "permission", - "new_repo_permission", - "new_repo_base_role", - "old_repo_permission", - "old_repo_base_role" - ] - }, - { - "action": "vulnerability_alert_rule.create", - "description": "A Dependabot rule was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "vulnerability_alert_rule_id", - "vulnerability_alert_rule_name", - "created_at", - "operation_type" - ] - }, - { - "action": "vulnerability_alert_rule.delete", - "description": "A Dependabot rule was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "vulnerability_alert_rule_id", - "vulnerability_alert_rule_name", - "created_at", - "operation_type" - ] - }, - { - "action": "vulnerability_alert_rule.disable", - "description": "A Dependabot rule was disabled for a single repository or disabled by default for an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "vulnerability_alert_rule_id", - "vulnerability_alert_rule_name", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "vulnerability_alert_rule.enable", - "description": "A Dependabot rule was enabled for a single repository or enabled by default for an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "vulnerability_alert_rule_id", - "vulnerability_alert_rule_name", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "vulnerability_alert_rule.force_disable", - "description": "A Dependabot rule was enabled for an organization and cannot be disabled for its repositories.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "vulnerability_alert_rule_id", - "vulnerability_alert_rule_name", - "created_at", - "operation_type" - ] - }, - { - "action": "vulnerability_alert_rule.force_enable", - "description": "A Dependabot rule was disabled for an organization and cannot be enabled for its repositories.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "vulnerability_alert_rule_id", - "vulnerability_alert_rule_name", - "created_at", - "operation_type" - ] - }, - { - "action": "vulnerability_alert_rule.update", - "description": "A Dependabot rule's conditions, actions, or metadata changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "vulnerability_alert_rule_id", - "vulnerability_alert_rule_name", - "created_at", - "operation_type" - ] - }, - { - "action": "workflows.approve_workflow_job", - "description": "A workflow job was approved.", - "docs_reference_links": "/actions/managing-workflow-runs/reviewing-deployments", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_run_id", - "run_number", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "Reviewing deployments" - }, - { - "action": "workflows.bypass_protection_rules", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_run_id", - "run_number", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "workflows.cancel_workflow_run", - "description": "A workflow run was cancelled.", - "docs_reference_links": "/actions/managing-workflow-runs/canceling-a-workflow", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "started_at", - "event", - "name", - "workflow_run_id", - "head_branch", - "head_sha", - "run_number", - "cancelled_at", - "workflow_id", - "operation_type", - "trigger_id", - "public_repo" - ], - "docs_reference_titles": "Canceling a workflow run" - }, - { - "action": "workflows.comment_workflow_job", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_run_id", - "run_number", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "workflows.completed_workflow_run", - "description": "A workflow status changed to completed. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "started_at", - "event", - "name", - "workflow_run_id", - "head_branch", - "head_sha", - "completed_at", - "conclusion", - "run_number", - "workflow_id", - "operation_type", - "trigger_id", - "run_attempt", - "actor_is_bot", - "actor_is_agent" - ], - "docs_reference_titles": "Viewing workflow run history" - }, - { - "action": "workflows.created_workflow_run", - "description": "A workflow run was create. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "/actions/learn-github-actions/understanding-github-actions#create-an-example-workflow", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "started_at", - "event", - "name", - "workflow_run_id", - "head_branch", - "head_sha", - "workflow_id", - "operation_type", - "trigger_id", - "public_repo", - "actor_is_bot", - "actor_is_agent" - ], - "docs_reference_titles": "Understanding GitHub Actions" - }, - { - "action": "workflows.delete_workflow_run", - "description": "A workflow run was deleted.", - "docs_reference_links": "/actions/managing-workflow-runs/deleting-a-workflow-run", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "workflow_run_id", - "started_at", - "head_branch", - "head_sha", - "trigger_id" - ], - "docs_reference_titles": "Deleting a workflow run" - }, - { - "action": "workflows.disable_workflow", - "description": "A workflow was disabled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_id", - "operation_type", - "created_at", - "public_repo", - "actor_is_bot" - ] - }, - { - "action": "workflows.enable_workflow", - "description": "A workflow was enabled, after previously being disabled by disable_workflow.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_id", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "workflows.pin_workflow", - "description": "A workflow was pinned.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "workflow_id", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "workflows.prepared_workflow_job", - "description": "A workflow job was started. Includes the list of secrets that were provided to the job. This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "docs_reference_links": "/actions/using-workflows/events-that-trigger-workflows", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_run_id", - "job_name", - "runner_labels", - "is_hosted_runner", - "environment_name", - "secrets_passed", - "operation_type", - "created_at", - "runner_owner_type", - "job_workflow_ref", - "calling_workflow_refs", - "calling_workflow_shas", - "imposer_repo" - ], - "docs_reference_titles": "Events that trigger workflows" - }, - { - "action": "workflows.reject_workflow_job", - "description": "A workflow job was rejected.", - "docs_reference_links": "/actions/managing-workflow-runs/reviewing-deployments", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_run_id", - "run_number", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "Reviewing deployments" - }, - { - "action": "workflows.rerun_workflow_run", - "description": "A workflow run was re-run.", - "docs_reference_links": "/actions/managing-workflow-runs/re-running-workflows-and-jobs", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "started_at", - "event", - "name", - "workflow_run_id", - "head_branch", - "head_sha", - "run_number", - "workflow_id", - "operation_type", - "trigger_id", - "run_attempt", - "rerun_type", - "check_run_id", - "actor_is_bot" - ], - "docs_reference_titles": "Re-running workflows and jobs" - }, - { - "action": "workflows.unpin_workflow", - "description": "A workflow was unpinned after previously being pinned.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "workflow_id", - "created_at", - "operation_type", - "actor_is_bot" - ] - } -] \ No newline at end of file diff --git a/src/audit-logs/data/ghes-3.14/user.json b/src/audit-logs/data/ghes-3.14/user.json deleted file mode 100644 index 315369a09f99..000000000000 --- a/src/audit-logs/data/ghes-3.14/user.json +++ /dev/null @@ -1,12477 +0,0 @@ -[ - { - "action": "account.billing_date_change", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "account.plan_change", - "description": "The account's plan changed.", - "docs_reference_links": "/billing/managing-the-plan-for-your-github-account/about-billing-for-plans", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "How GitHub billing works" - }, - { - "action": "account_recovery_token.confirm", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "account_recovery_token.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "account_recovery_token.recover", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "actions_cache.delete", - "description": "A GitHub Actions cache was deleted using the REST API.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "actions_cache_id", - "actions_cache_key", - "actions_cache_version", - "actions_cache_scope", - "created_at", - "operation_type" - ] - }, - { - "action": "artifact.destroy", - "description": "A workflow run artifact was manually deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "billing.change_billing_type", - "description": "The way the account pays for GitHub was changed.", - "docs_reference_links": "/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Managing your payment and billing information" - }, - { - "action": "billing.change_email", - "description": "The billing email address changed.", - "docs_reference_links": "/billing/managing-your-github-billing-settings/setting-your-billing-email", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "email" - ], - "docs_reference_titles": "Managing your payment and billing information" - }, - { - "action": "billing.lock", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "operation_type", - "created_at" - ] - }, - { - "action": "billing.unlock", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "billing.update_bill_cycle_day", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "business.set_actions_fork_pr_approvals_policy", - "description": "The policy for requiring approvals for workflows from public forks was changed for an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-fork-pull-requests-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "policy", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enforcing policies for GitHub Actions in your enterprise" - }, - { - "action": "business.set_actions_private_fork_pr_approvals_policy", - "description": "The policy for requiring approval for fork pull request workflows from collaborators without write access to private repos was changed for an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-fork-pull-requests-in-private-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "policy", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enforcing policies for GitHub Actions in your enterprise" - }, - { - "action": "business.set_actions_retention_limit", - "description": "The retention period for GitHub Actions artifacts and logs was changed for an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-artifact-and-log-retention-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "limit", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Enforcing policies for GitHub Actions in your enterprise" - }, - { - "action": "business.set_default_workflow_permissions", - "description": "The default permissions granted to the GITHUB_TOKEN when running workflows were changed for an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enforcing policies for GitHub Actions in your enterprise" - }, - { - "action": "business.set_fork_pr_workflows_policy", - "description": "The policy for fork pull request workflows was changed for an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-fork-pull-requests-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "policy", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Enforcing policies for GitHub Actions in your enterprise" - }, - { - "action": "business.set_workflow_permission_can_approve_pr", - "description": "The policy for allowing GitHub Actions to create and approve pull requests was changed for an enterprise.", - "docs_reference_links": "/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#preventing-github-actions-from-creating-or-approving-pull-requests", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Enforcing policies for GitHub Actions in your enterprise" - }, - { - "action": "checks.auto_trigger_disabled", - "description": "Automatic creation of check suites was disabled on a repository in the organization or enterprise.", - "docs_reference_links": "/rest/checks#update-repository-preferences-for-check-suites", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/rest/checks#update-repository-preferences-for-check-suites" - }, - { - "action": "checks.auto_trigger_enabled", - "description": "Automatic creation of check suites was enabled on a repository in the organization or enterprise.", - "docs_reference_links": "/rest/checks#update-repository-preferences-for-check-suites", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "/rest/checks#update-repository-preferences-for-check-suites" - }, - { - "action": "checks.delete_logs", - "description": "Logs in a check suite were deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "codespaces.allow_permissions", - "description": "A codespace using custom permissions from its devcontainer.json file was launched.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "origin_repository", - "created_at", - "operation_type" - ] - }, - { - "action": "codespaces.connect", - "description": "Credentials for a codespace were refreshed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "owner", - "name", - "operation_type", - "created_at", - "public_repo", - "actor_is_bot", - "machine_type", - "devcontainer_path" - ] - }, - { - "action": "codespaces.create", - "description": "A codespace was created", - "docs_reference_links": "/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "owner", - "name", - "operation_type", - "created_at", - "actor_is_bot", - "machine_type", - "devcontainer_path" - ], - "docs_reference_titles": "Creating a codespace for a repository" - }, - { - "action": "codespaces.destroy", - "description": "A user deleted a codespace.", - "docs_reference_links": "/codespaces/developing-in-codespaces/deleting-a-codespace", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "pull_request_id", - "owner", - "name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Deleting a codespace" - }, - { - "action": "codespaces.export_environment", - "description": "A codespace was exported to a branch on GitHub.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "owner", - "created_at", - "operation_type", - "public_repo" - ] - }, - { - "action": "codespaces.restore", - "description": "A codespace was restored.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "codespaces.start_environment", - "description": "A codespace was started.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "owner", - "pull_request_id", - "machine_type", - "devcontainer_path", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "codespaces.suspend_environment", - "description": "A codespace was stopped.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "codespaces.trusted_repositories_access_update", - "description": "A personal account's access and security setting for Codespaces were updated.", - "docs_reference_links": "/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing access to other repositories within your codespace" - }, - { - "action": "copilot.cfb_seat_added", - "description": "A Copilot Business or Copilot Enterprise seat was added for a user and they have received access to GitHub Copilot. This can occur as the result of directly assigning a seat for a user, assigning a seat for a team, or setting the organization to allow access for all members.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "copilot.cfb_seat_assignment_created", - "description": "A Copilot Business or Copilot Enterprise seat assignment was newly created for a user or a team, and seats are being created.", - "docs_reference_links": "/copilot/overview-of-github-copilot/about-github-copilot-for-business", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "What is GitHub Copilot?" - }, - { - "action": "copilot.cfb_seat_assignment_refreshed", - "description": "A seat assignment that was previously pending cancellation was re-assigned and the user will retain access to Copilot.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "copilot.cfb_seat_assignment_reused", - "description": "A Copilot Business or Copilot Enterprise seat assignment was re-created for a user who already had a seat with no pending cancellation date, and the user will retain access to Copilot.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "copilot.cfb_seat_assignment_unassigned", - "description": "A user or team's Copilot Business or Copilot Enterprise seat assignment was unassigned, and the user(s) will lose access to Copilot at the end of the current billing cycle.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "copilot.cfb_seat_cancelled", - "description": "A user's Copilot Business or Copilot Enterprise seat was canceled, and the user no longer has access to Copilot.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "seat_assignment" - ] - }, - { - "action": "copilot.cfb_seat_cancelled_by_staff", - "description": "A user's Copilot Business or Copilot Enterprise seat was canceled manually by GitHub staff, and the user no longer has access to Copilot.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "custom_hosted_runner.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "runner_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "custom_hosted_runner.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "custom_hosted_runner.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "runner_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "dependabot_alerts.disable", - "description": "Dependabot alerts were disabled for all existing repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories" - }, - { - "action": "dependabot_alerts.enable", - "description": "Dependabot alerts were enabled for all existing repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories" - }, - { - "action": "dependabot_alerts_new_repos.disable", - "description": "Dependabot alerts were disabled for all new repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-automatically-when-new-repositories-are-added", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-automatically-when-new-repositories-are-added" - }, - { - "action": "dependabot_alerts_new_repos.enable", - "description": "Dependabot alerts were enabled for all new repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-automatically-when-new-repositories-are-added", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-automatically-when-new-repositories-are-added" - }, - { - "action": "dependabot_repository_access.repositories_updated", - "description": "The repositories that Dependabot can access were updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "dependabot_security_updates.disable", - "description": "Dependabot security updates were disabled for all existing repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization" - }, - { - "action": "dependabot_security_updates.enable", - "description": "Dependabot security updates were enabled for all existing repositories.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "dependabot_security_updates_new_repos.disable", - "description": " Dependabot security updates were disabled for all new repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization" - }, - { - "action": "dependabot_security_updates_new_repos.enable", - "description": "Dependabot security updates were enabled for all new repositories.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "dependency_graph.disable", - "description": "The dependency graph was disabled for all existing repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization" - }, - { - "action": "dependency_graph.enable", - "description": "The dependency graph was enabled for all existing repositories.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "dependency_graph_new_repos.disable", - "description": "The dependency graph was disabled for all new repositories.", - "docs_reference_links": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization" - }, - { - "action": "dependency_graph_new_repos.enable", - "description": "The dependency graph was enabled for all new repositories.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "environment.add_protection_rule", - "description": "A GitHub Actions deployment protection rule was created via the API.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "environment.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "environment_name", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "environment.create_actions_secret", - "description": "A secret was created for a GitHub Actions environment.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "key", - "visibility", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "environment.create_actions_variable", - "description": "A variable was created for a GitHub Actions environment.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-an-environment", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "environment_name", - "public_repo", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "environment.delete", - "description": "An environment was deleted.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#deleting-an-environment", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at", - "public_repo", - "actor_is_bot" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "environment.remove_actions_secret", - "description": "A secret was deleted for a GitHub Actions environment.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "key", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "environment.remove_actions_variable", - "description": "A variable was deleted for a GitHub Actions environment.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-an-environment", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "environment_name", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "environment.remove_protection_rule", - "description": "A GitHub Actions deployment protection rule was deleted via the API.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "environment.update_actions_secret", - "description": "A secret was updated for a GitHub Actions environment.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "key", - "visibility", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "environment.update_actions_variable", - "description": "A variable was updated for a GitHub Actions environment.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-an-environment", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "environment_name", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "environment.update_protection_rule", - "description": "A GitHub Actions deployment protection rule was updated via the API.", - "docs_reference_links": "/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "new_value", - "approvers_was", - "approvers", - "can_admins_bypass", - "prevent_self_review" - ], - "docs_reference_titles": "Managing environments for deployment" - }, - { - "action": "gist.create", - "description": "A gist was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "gist_id", - "created_at", - "operation_type", - "visibility" - ] - }, - { - "action": "gist.destroy", - "description": "A gist was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "gist_id", - "visibility", - "created_at", - "operation_type" - ] - }, - { - "action": "gist.visibility_change", - "description": "The visibility of a gist was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "gist_id", - "visibility", - "created_at" - ] - }, - { - "action": "git_signing_ssh_public_key.create", - "description": "An SSH key was added to a user account as a Git commit signing key.", - "docs_reference_links": "/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "title", - "key", - "fingerprint", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key" - }, - { - "action": "git_signing_ssh_public_key.delete", - "description": "An SSH key was removed from a user account as a Git commit signing key.", - "docs_reference_links": "/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "title", - "key", - "fingerprint", - "explanation", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key" - }, - { - "action": "github_hosted_runner.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "runner_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "github_hosted_runner.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "github_hosted_runner.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "runner_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "gpg_key.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "gpg_key.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "hook.active_changed", - "description": "A hook's active status was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "name", - "events", - "active", - "active_was", - "hook_id", - "operation_type" - ] - }, - { - "action": "hook.config_changed", - "description": "A hook's configuration was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "name", - "hook_id", - "created_at", - "oauth_application_id", - "events" - ] - }, - { - "action": "hook.create", - "description": "A new hook was added.", - "docs_reference_links": "/get-started/exploring-integrations/about-webhooks", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application", - "oauth_application_id", - "hook_id", - "events", - "operation_type", - "name", - "created_at" - ], - "docs_reference_titles": "About webhooks" - }, - { - "action": "hook.destroy", - "description": "A hook was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "events", - "created_at", - "name", - "operation_type", - "oauth_application_id", - "hook_id" - ] - }, - { - "action": "hook.events_changed", - "description": "A hook's configured events were changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "events", - "operation_type", - "name", - "events_were", - "created_at", - "hook_id", - "oauth_application_id" - ] - }, - { - "action": "integration.create", - "description": "A GitHub App was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "name", - "integration", - "created_at", - "application_client_id" - ] - }, - { - "action": "integration.destroy", - "description": "A GitHub App was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "operation_type", - "created_at" - ] - }, - { - "action": "integration.generate_client_secret", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "operation_type", - "created_at", - "application_client_id" - ] - }, - { - "action": "integration_installation.create", - "description": "A GitHub App was installed.", - "docs_reference_links": "/apps/using-github-apps/authorizing-github-apps", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "name", - "repository_selection", - "created_at", - "integration", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/authorizing-github-apps" - }, - { - "action": "integration_installation.destroy", - "description": "A GitHub App was uninstalled.", - "docs_reference_links": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "repository_selection", - "integration", - "operation_type", - "name", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access" - }, - { - "action": "integration_installation.repositories_added", - "description": "Repositories were added to a GitHub App.", - "docs_reference_links": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#modifying-repository-access", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "repository_selection", - "name", - "integration", - "operation_type", - "repositories_added", - "created_at", - "repositories_added_names", - "actor_is_bot", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#modifying-repository-access" - }, - { - "action": "integration_installation.repositories_removed", - "description": "Repositories were removed from a GitHub App.", - "docs_reference_links": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#modifying-repository-access", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "repository_selection", - "repositories_removed", - "integration", - "created_at", - "name", - "repositories_removed_names", - "actor_is_bot", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#modifying-repository-access" - }, - { - "action": "integration_installation.suspend", - "description": "A GitHub App was suspended.", - "docs_reference_links": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "repository_selection", - "integration", - "operation_type", - "created_at", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access" - }, - { - "action": "integration_installation.unsuspend", - "description": "A GitHub App was unsuspended.", - "docs_reference_links": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "repository_selection", - "integration", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access" - }, - { - "action": "integration_installation.version_updated", - "description": "Permissions for a GitHub App were updated.", - "docs_reference_links": "/apps/using-github-apps/approving-updated-permissions-for-a-github-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "integration", - "name", - "operation_type", - "created_at", - "repository_selection", - "application_client_id" - ], - "docs_reference_titles": "/apps/using-github-apps/approving-updated-permissions-for-a-github-app" - }, - { - "action": "integration.manager_added", - "description": "A member of an enterprise or organization was added as a GitHub App manager.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/adding-and-removing-github-app-managers-in-your-organization#giving-someone-the-ability-to-manage-all-github-apps-owned-by-the-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "name", - "manager", - "operation_type", - "integration" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/adding-and-removing-github-app-managers-in-your-organization#giving-someone-the-ability-to-manage-all-github-apps-owned-by-the-organization" - }, - { - "action": "integration.manager_removed", - "description": "A member of an enterprise or organization was removed from being a GitHub App manager.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/adding-and-removing-github-app-managers-in-your-organization#removing-a-github-app-managers-permissions-for-the-entire-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "integration", - "name", - "created_at", - "manager" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/adding-and-removing-github-app-managers-in-your-organization#removing-a-github-app-managers-permissions-for-the-entire-organization" - }, - { - "action": "integration.remove_client_secret", - "description": "A client secret for a GitHub App was removed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "operation_type", - "created_at" - ] - }, - { - "action": "integration.revoke_all_tokens", - "description": "All user tokens for a GitHub App were requested to be revoked.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "operation_type", - "created_at", - "application_client_id" - ] - }, - { - "action": "integration.revoke_tokens", - "description": "Token(s) for a GitHub App were revoked.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "operation_type", - "created_at", - "application_client_id" - ] - }, - { - "action": "integration.suspend", - "description": "A GitHub App was suspended.", - "docs_reference_links": "/apps/maintaining-github-apps/suspending-a-github-app-installation", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "created_at", - "operation_type", - "application_client_id" - ], - "docs_reference_titles": "/apps/maintaining-github-apps/suspending-a-github-app-installation" - }, - { - "action": "integration.transfer", - "description": "Ownership of a GitHub App was transferred to another user or organization.", - "docs_reference_links": "/apps/maintaining-github-apps/transferring-ownership-of-a-github-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "transfer_to_id", - "requester", - "requester_id", - "created_at", - "transfer_to", - "operation_type", - "integration", - "transfer_from", - "transfer_from_id", - "transfer_from_type", - "transfer_to_type" - ], - "docs_reference_titles": "/apps/maintaining-github-apps/transferring-ownership-of-a-github-app" - }, - { - "action": "integration.unsuspend", - "description": "A GitHub App was unsuspended.", - "docs_reference_links": "/apps/maintaining-github-apps/suspending-a-github-app-installation", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "integration", - "created_at", - "operation_type", - "application_client_id" - ], - "docs_reference_titles": "/apps/maintaining-github-apps/suspending-a-github-app-installation" - }, - { - "action": "marketplace_agreement_signature.create", - "description": "The GitHub Marketplace Developer Agreement was signed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "marketplace_listing.approve", - "description": "A listing was approved for inclusion in GitHub Marketplace.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "secondary_category", - "primary_category", - "operation_type", - "created_at", - "marketplace_listing", - "integration" - ] - }, - { - "action": "marketplace_listing.change_category", - "description": "A category for a listing for an app in GitHub Marketplace was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "primary_category", - "marketplace_listing", - "integration", - "secondary_category", - "operation_type", - "created_at" - ] - }, - { - "action": "marketplace_listing.create", - "description": "A listing for an app in GitHub Marketplace was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "primary_category", - "created_at", - "oauth_application", - "marketplace_listing", - "secondary_category", - "oauth_application_id", - "operation_type" - ] - }, - { - "action": "marketplace_listing.delist", - "description": "A listing was removed from GitHub Marketplace.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "secondary_category", - "operation_type", - "marketplace_listing", - "primary_category", - "integration" - ] - }, - { - "action": "marketplace_listing_plan.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "marketplace_listing", - "has_free_trial", - "yearly_price_in_cents", - "description", - "bullets", - "monthly_price_in_cents", - "marketplace_listing_plan" - ] - }, - { - "action": "marketplace_listing_plan.publish", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "marketplace_listing_plan", - "marketplace_listing", - "description", - "bullets", - "has_free_trial", - "created_at", - "operation_type", - "monthly_price_in_cents", - "yearly_price_in_cents" - ] - }, - { - "action": "marketplace_listing_plan.retire", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "marketplace_listing_plan", - "description", - "yearly_price_in_cents", - "created_at", - "bullets", - "has_free_trial", - "marketplace_listing", - "monthly_price_in_cents", - "operation_type" - ] - }, - { - "action": "marketplace_listing_plan.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "monthly_price_in_cents", - "marketplace_listing", - "description", - "bullets", - "yearly_price_in_cents", - "has_free_trial", - "marketplace_listing_plan", - "operation_type", - "created_at" - ] - }, - { - "action": "marketplace_listing.redraft", - "description": "A listing was sent back to draft state.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "secondary_category", - "oauth_application_id", - "operation_type", - "oauth_application", - "created_at", - "marketplace_listing", - "primary_category" - ] - }, - { - "action": "marketplace_listing.reject", - "description": "A listing was not accepted for inclusion in GitHub Marketplace.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "primary_category", - "secondary_category", - "marketplace_listing", - "oauth_application", - "oauth_application_id", - "operation_type", - "created_at" - ] - }, - { - "action": "merge_queue.pull_request_dequeued", - "description": "A pull request was removed from a merge queue.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "merge_queue.pull_request_queue_jump", - "description": "A pull request was moved ahead in a merge queue.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "merge_queue.queue_cleared", - "description": "A merge queue was cleared.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "merge_queue.update_settings", - "description": "The settings for a merge queue were updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "max_entries_to_build", - "min_entries_to_merge", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "metered_billing_configuration.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "metered_billing_configuration.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "metered_billing_configuration.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "migration.create", - "description": "A migration file was created for transferring data from a source location (such as a GitHub.com organization or a GitHub Enterprise Server instance) to a target GitHub Enterprise Server instance.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "oauth_access.create", - "description": "An OAuth access token was generated.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps, /authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "oauth_application_name" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps, Managing your personal access tokens" - }, - { - "action": "oauth_access.destroy", - "description": "An OAuth access token was deleted.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "explanation", - "oauth_application_name" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps" - }, - { - "action": "oauth_access.regenerate", - "description": "An OAuth access token was regenerated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "oauth_application_name" - ] - }, - { - "action": "oauth_access.update", - "description": "An OAuth access token was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "oauth_application.create", - "description": "An OAuth application was created.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "oauth_application_id", - "operation_type", - "oauth_application" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.destroy", - "description": "An OAuth application was deleted.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "oauth_application_id", - "operation_type", - "oauth_application" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.generate_client_secret", - "description": "An OAuth application's secret key was generated.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application", - "oauth_application_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.remove_client_secret", - "description": "An OAuth application's secret key was deleted.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application", - "oauth_application_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.reset_secret", - "description": "The secret key for an OAuth application was reset.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application", - "operation_type", - "created_at", - "oauth_application_id" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.revoke_all_tokens", - "description": "All user tokens for an OAuth application were requested to be revoked.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application", - "oauth_application_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.revoke_tokens", - "description": "Token(s) for an OAuth application were revoked.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "oauth_application", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_application.transfer", - "description": "An OAuth application was transferred from one account to another.", - "docs_reference_links": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "oauth_application", - "oauth_application_id" - ], - "docs_reference_titles": "/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app" - }, - { - "action": "oauth_authorization.create", - "description": "An authorization for an OAuth application was created.", - "docs_reference_links": "/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "actor_is_bot", - "oauth_application_name" - ], - "docs_reference_titles": "/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps" - }, - { - "action": "oauth_authorization.destroy", - "description": "An authorization for an OAuth application was deleted.", - "docs_reference_links": "/apps/using-github-apps/reviewing-your-authorized-integrations", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "explanation", - "actor_is_bot", - "oauth_application_name" - ], - "docs_reference_titles": "Reviewing and revoking authorization of GitHub Apps" - }, - { - "action": "org.add_member", - "description": "A user joined an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "permission", - "operation_type", - "created_at", - "actor_is_bot" - ] - }, - { - "action": "org.add_outside_collaborator", - "description": "An outside collaborator was added to a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "inviter", - "public_repo", - "permission", - "invitee", - "created_at", - "operation_type" - ] - }, - { - "action": "org.advanced_security_disabled_for_new_repos", - "description": "GitHub Advanced Security was disabled for new repositories in an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.advanced_security_disabled_on_all_repos", - "description": "GitHub Advanced Security was disabled for all repositories in an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.advanced_security_enabled_for_new_repos", - "description": "GitHub Advanced Security was enabled for new repositories in an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.advanced_security_enabled_on_all_repos", - "description": "GitHub Advanced Security was enabled for all repositories in an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "org.remove_member", - "description": "A member was removed from an organization, either manually or due to a two-factor authentication requirement.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "org.set_actions_fork_pr_approvals_policy", - "description": "The setting for requiring approvals for workflows from public forks was changed for an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#requiring-approval-for-workflows-from-public-forks", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "policy", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#requiring-approval-for-workflows-from-public-forks" - }, - { - "action": "org.set_actions_private_fork_pr_approvals_policy", - "description": "The policy for requiring approval for fork pull request workflows from collaborators without write access to private repos was changed for an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#enabling-workflows-for-private-repository-forks", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "policy", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#enabling-workflows-for-private-repository-forks" - }, - { - "action": "org.set_actions_retention_limit", - "description": "The retention period for GitHub Actions artifacts and logs in an organization was changed.", - "docs_reference_links": "/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "limit", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization" - }, - { - "action": "org.set_default_workflow_permissions", - "description": "The default permissions granted to the GITHUB_TOKEN when running workflows were changed for an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization" - }, - { - "action": "org.set_fork_pr_workflows_policy", - "description": "The policy for workflows on private repository forks was changed.", - "docs_reference_links": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#enabling-workflows-for-private-repository-forks", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "policy", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#enabling-workflows-for-private-repository-forks" - }, - { - "action": "org.set_workflow_permission_can_approve_pr", - "description": "The policy for allowing GitHub Actions to create and approve pull requests was changed for an organization.", - "docs_reference_links": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#preventing-github-actions-from-creating-or-approving-pull-requests", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#preventing-github-actions-from-creating-or-approving-pull-requests" - }, - { - "action": "org.update_member", - "description": "A person's role was changed from owner to member or member to owner.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "old_permission", - "permission", - "operation_type" - ] - }, - { - "action": "org.update_member_repository_creation_permission", - "description": "The create repository permission for organization members was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "permission", - "created_at", - "visibility", - "operation_type" - ] - }, - { - "action": "org.update_member_repository_invitation_permission", - "description": "An organization owner changed the policy setting for organization members inviting outside collaborators to repositories.", - "docs_reference_links": "/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "permission", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Setting permissions for adding outside collaborators" - }, - { - "action": "pages_protected_domain.create", - "description": "A GitHub Pages verified domain was created for an organization or enterprise.", - "docs_reference_links": "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "owner_type", - "domain", - "state", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages" - }, - { - "action": "pages_protected_domain.delete", - "description": "A GitHub Pages verified domain was deleted from an organization or enterprise.", - "docs_reference_links": "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "owner_type", - "domain", - "state", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages" - }, - { - "action": "pages_protected_domain.verify", - "description": "A GitHub Pages domain was verified for an organization or enterprise.", - "docs_reference_links": "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "owner_type", - "domain", - "state", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages" - }, - { - "action": "passkey.register", - "description": "A new passkey was added.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "nickname", - "created_at", - "operation_type" - ] - }, - { - "action": "passkey.remove", - "description": "A new passkey was removed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "nickname", - "created_at", - "operation_type" - ] - }, - { - "action": "payment_method.create", - "description": "A new payment method was added, such as a new credit card or PayPal account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "payment_method.remove", - "description": "A payment method was removed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "payment_method.update", - "description": "An existing payment method was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "personal_access_token.access_granted", - "description": "A fine-grained personal access token was granted access to resources.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_id", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization" - }, - { - "action": "personal_access_token.access_revoked", - "description": "A fine-grained personal access token was revoked. The token can still read public organization resources.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/reviewing-and-revoking-personal-access-tokens-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_id", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/reviewing-and-revoking-personal-access-tokens-in-your-organization" - }, - { - "action": "personal_access_token.create", - "description": "Triggered when you create a fine-grained personal access token.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type" - ] - }, - { - "action": "personal_access_token.credential_regenerated", - "description": "Triggered when you regenerate a fine-grained personal access token.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_name", - "created_at", - "operation_type" - ] - }, - { - "action": "personal_access_token.credential_revoked", - "description": "A fine-grained personal access token was revoked by GitHub Advanced Security.", - "docs_reference_links": "/code-security/getting-started/github-security-features#secret-scanning-alerts-for-users", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_name", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/code-security/getting-started/github-security-features#secret-scanning-alerts-for-users" - }, - { - "action": "personal_access_token.destroy", - "description": "Triggered when you delete a fine-grained personal access token.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_name", - "explanation", - "created_at", - "operation_type" - ] - }, - { - "action": "personal_access_token.request_cancelled", - "description": "A pending request for a fine-grained personal access token to access organization resources was canceled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type", - "user_programmatic_access_request_id" - ] - }, - { - "action": "personal_access_token.request_created", - "description": "Triggered when a fine-grained personal access token was created to access organization resources and the organization requires approval before the token can access organization resources.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_id", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type", - "user_programmatic_access_request_id" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization" - }, - { - "action": "personal_access_token.request_denied", - "description": "A request for a fine-grained personal access token to access organization resources was denied.", - "docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type", - "user_programmatic_access_request_id" - ], - "docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization" - }, - { - "action": "personal_access_token.update", - "description": "A fine-grained personal access token was updated.", - "docs_reference_links": "/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#fine-grained-personal-access-tokens", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "user_programmatic_access_name", - "repository_selection", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#fine-grained-personal-access-tokens" - }, - { - "action": "premium_runner.create", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "runner_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "premium_runner.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "premium_runner.update", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "runner_group_id", - "created_at", - "operation_type" - ] - }, - { - "action": "private_vulnerability_reporting.disable", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "private_vulnerability_reporting.enable", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "private_vulnerability_reporting_new_repos.disable", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "private_vulnerability_reporting_new_repos.enable", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "profile_picture.update", - "description": "A profile picture was updated.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "owner", - "operation_type" - ], - "docs_reference_titles": "Personalize your profile" - }, - { - "action": "project.access", - "description": "A project board visibility was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project.close", - "description": "A project board was closed.", - "docs_reference_links": "/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "project_id", - "project_kind" - ], - "docs_reference_titles": "Closing a project (classic)" - }, - { - "action": "project.create", - "description": "A project board was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project.delete", - "description": "A project board was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project_field.create", - "description": "A field was created in a project board.", - "docs_reference_links": "/issues/planning-and-tracking-with-projects/understanding-fields", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/issues/planning-and-tracking-with-projects/understanding-fields" - }, - { - "action": "project_field.delete", - "description": "A field was deleted in a project board.", - "docs_reference_links": "/issues/planning-and-tracking-with-projects/understanding-fields/deleting-custom-fields", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/issues/planning-and-tracking-with-projects/understanding-fields/deleting-custom-fields" - }, - { - "action": "project.link", - "description": "A repository was linked to a project board.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project.open", - "description": "A project board was reopened.", - "docs_reference_links": "/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "project_id", - "operation_type", - "created_at", - "project_kind", - "project_name" - ], - "docs_reference_titles": "Reopening a closed project (classic)" - }, - { - "action": "project.rename", - "description": "A project board was renamed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "old_name", - "operation_type" - ] - }, - { - "action": "project.unlink", - "description": "A repository was unlinked from a project board.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project.update_org_permission", - "description": "The project's base-level permission for all organization members was changed or removed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project.update_team_permission", - "description": "A team's project board permission level was changed or when a team was added or removed from a project board.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "team" - ] - }, - { - "action": "project.update_user_permission", - "description": "A user was added to or removed from a project board or had their permission level changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "project_view.create", - "description": "A view was created in a project board.", - "docs_reference_links": "/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views" - }, - { - "action": "project_view.delete", - "description": "A view was deleted in a project board.", - "docs_reference_links": "/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views" - }, - { - "action": "protected_branch.update_merge_queue_enforcement_level", - "description": "Enforcement of the merge queue was modified for a branch.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-merge-queue", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "merge_queue_enforcement_level", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-merge-queue" - }, - { - "action": "public_key.create", - "description": "An SSH key was added to a user account or a deploy key was added to a repository.", - "docs_reference_links": "/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "read_only", - "operation_type", - "created_at", - "key", - "fingerprint", - "title" - ], - "docs_reference_titles": "/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account" - }, - { - "action": "public_key.delete", - "description": "An SSH key was removed from a user account or a deploy key was removed from a repository.", - "docs_reference_links": "/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "fingerprint", - "read_only", - "explanation", - "key", - "operation_type", - "title", - "created_at" - ], - "docs_reference_titles": "/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys" - }, - { - "action": "public_key.unverification_failure", - "description": "A user account's SSH key or a repository's deploy key was unable to be unverified.", - "docs_reference_links": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "title", - "key", - "fingerprint", - "read_only", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys" - }, - { - "action": "public_key.unverify", - "description": "A user account's SSH key or a repository's deploy key was unverified.", - "docs_reference_links": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "title", - "key", - "read_only", - "explanation", - "fingerprint" - ], - "docs_reference_titles": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys" - }, - { - "action": "public_key.update", - "description": "A user account's SSH key or a repository's deploy key was updated.", - "docs_reference_links": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "fingerprint", - "read_only", - "operation_type", - "created_at", - "title" - ], - "docs_reference_titles": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys" - }, - { - "action": "public_key.verification_failure", - "description": "A user account's SSH key or a repository's deploy key was unable to be verified.", - "docs_reference_links": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "fingerprint", - "oauth_application_id", - "title", - "created_at", - "read_only", - "operation_type" - ], - "docs_reference_titles": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys" - }, - { - "action": "public_key.verify", - "description": "A user account's SSH key or a repository's deploy key was verified.", - "docs_reference_links": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "key", - "fingerprint", - "title", - "read_only" - ], - "docs_reference_titles": "/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys" - }, - { - "action": "repo.access", - "description": "The visibility of a repository changed.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "visibility", - "previous_visibility" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility" - }, - { - "action": "repo.actions_enabled", - "description": "GitHub Actions was enabled for a repository.", - "docs_reference_links": "organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#using-the-audit-log-api", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#using-the-audit-log-api" - }, - { - "action": "repo.add_member", - "description": "A collaborator was added to a repository.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "created_at", - "operation_type", - "oauth_application_id" - ], - "docs_reference_titles": "Inviting collaborators to a personal repository" - }, - { - "action": "repo.add_topic", - "description": "A topic was added to a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "topic", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics" - }, - { - "action": "repo.advanced_security_disabled", - "description": "GitHub Advanced Security was disabled for a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository" - }, - { - "action": "repo.advanced_security_enabled", - "description": "GitHub Advanced Security was enabled for a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "public_repo", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository" - }, - { - "action": "repo.archived", - "description": "A repository was archived.", - "docs_reference_links": "/repositories/archiving-a-github-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "visibility" - ], - "docs_reference_titles": "/repositories/archiving-a-github-repository" - }, - { - "action": "repo.change_merge_setting", - "description": "Pull request merge options were changed for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "created_at", - "operation_type", - "public_repo", - "actor_is_bot" - ] - }, - { - "action": "repo.code_scanning_analysis_deleted", - "description": "Code scanning analysis for a repository was deleted.", - "docs_reference_links": "/rest/code-scanning#delete-a-code-scanning-analysis-from-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "operation_type", - "created_at", - "public_repo", - "tool", - "category" - ], - "docs_reference_titles": "/rest/code-scanning#delete-a-code-scanning-analysis-from-a-repository" - }, - { - "action": "repo.code_scanning_configuration_for_branch_deleted", - "description": "A code scanning configuration for a branch of a repository was deleted.", - "docs_reference_links": "/code-security/code-scanning/managing-code-scanning-alerts/managing-code-scanning-alerts-for-your-repository#removing-stale-configurations-and-alerts-from-a-branch", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "tool", - "branch", - "category", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Resolving code scanning alerts" - }, - { - "action": "repo.config.disable_collaborators_only", - "description": "The interaction limit for collaborators only was disabled.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository" - }, - { - "action": "repo.config.disable_contributors_only", - "description": "The interaction limit for prior contributors only was disabled in a repository.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository" - }, - { - "action": "repo.config.disable_sockpuppet_disallowed", - "description": "The interaction limit for existing users only was disabled in a repository.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository" - }, - { - "action": "repo.config.enable_collaborators_only", - "description": "The interaction limit for collaborators only was enabled in a repository Users that are not collaborators or organization members were unable to interact with a repository for a set duration.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository" - }, - { - "action": "repo.config.enable_contributors_only", - "description": "The interaction limit for prior contributors only was enabled in a repository Users that are not prior contributors, collaborators or organization members were unable to interact with a repository for a set duration.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository" - }, - { - "action": "repo.config.enable_sockpuppet_disallowed", - "description": "The interaction limit for existing users was enabled in a repository New users aren't able to interact with a repository for a set duration Existing users of the repository, contributors, collaborators or organization members are able to interact with a repository.", - "docs_reference_links": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository" - }, - { - "action": "repo.configure_self_hosted_jit_runner", - "description": "A new just-in-time GitHub Actions self-hosted runner was configured", - "docs_reference_links": "/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository" - }, - { - "action": "repo.create", - "description": "A repository was created.", - "docs_reference_links": "/repositories/creating-and-managing-repositories/creating-a-new-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "request_category", - "created_at", - "oauth_application_id", - "request_method", - "public_repo", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/creating-and-managing-repositories/creating-a-new-repository" - }, - { - "action": "repo.create_actions_secret", - "description": "A GitHub Actions secret was created for a repository.", - "docs_reference_links": "/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Using secrets in GitHub Actions" - }, - { - "action": "repo.create_actions_variable", - "description": "A GitHub Actions variable was created for a repository.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "repo.create_integration_secret", - "description": "A Codespaces or Dependabot secret was created for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "integration", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "repo.destroy", - "description": "A repository was deleted.", - "docs_reference_links": "/repositories/creating-and-managing-repositories/deleting-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "request_category", - "visibility", - "created_at", - "request_method", - "oauth_application_id", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/creating-and-managing-repositories/deleting-a-repository" - }, - { - "action": "repo.pages_cname", - "description": "A GitHub Pages custom domain was modified in a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "cname", - "created_at", - "operation_type", - "old_cname" - ] - }, - { - "action": "repo.pages_create", - "description": "A GitHub Pages site was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.pages_destroy", - "description": "A GitHub Pages site was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "visibility", - "operation_type" - ] - }, - { - "action": "repo.pages_https_redirect_disabled", - "description": "HTTPS redirects were disabled for a GitHub Pages site.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.pages_https_redirect_enabled", - "description": "HTTPS redirects were enabled for a GitHub Pages site.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "visibility", - "operation_type" - ] - }, - { - "action": "repo.pages_private", - "description": "A GitHub Pages site visibility was changed to private.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.pages_public", - "description": "A GitHub Pages site visibility was changed to public.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.pages_soft_delete", - "description": "A GitHub Pages site was soft-deleted because its owner's plan changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "repo.pages_soft_delete_restore", - "description": "A GitHub Pages site that was previously soft-deleted was restored.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "repo.pages_source", - "description": "A GitHub Pages source was modified.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "visibility", - "created_at" - ] - }, - { - "action": "repo.register_self_hosted_runner", - "description": "A new self-hosted runner was registered.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Adding self-hosted runners" - }, - { - "action": "repo.remove_actions_secret", - "description": "A GitHub Actions secret was deleted for a repository.", - "docs_reference_links": "/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Using secrets in GitHub Actions" - }, - { - "action": "repo.remove_actions_variable", - "description": "A GitHub Actions variable was deleted for a repository.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "repo.remove_integration_secret", - "description": "A Codespaces or Dependabot secret was deleted for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "integration", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "repo.remove_member", - "description": "A collaborator was removed from a repository.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "visibility" - ], - "docs_reference_titles": "Removing a collaborator from a personal repository" - }, - { - "action": "repo.remove_self_hosted_runner", - "description": "A self-hosted runner was removed.", - "docs_reference_links": "/actions/hosting-your-own-runners/managing-self-hosted-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Removing self-hosted runners" - }, - { - "action": "repo.remove_topic", - "description": "A topic was removed from a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "topic", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.rename", - "description": "A repository was renamed.", - "docs_reference_links": "/repositories/creating-and-managing-repositories/renaming-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "old_name", - "created_at", - "operation_type", - "visibility" - ], - "docs_reference_titles": "/repositories/creating-and-managing-repositories/renaming-a-repository" - }, - { - "action": "repo.restore", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "repo.set_actions_fork_pr_approvals_policy", - "description": "The setting for requiring approvals for workflows from public forks was changed for a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-required-approval-for-workflows-from-public-forks", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "policy", - "created_at", - "operation_type", - "public_repo" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-required-approval-for-workflows-from-public-forks" - }, - { - "action": "repo.set_actions_private_fork_pr_approvals_policy", - "description": "The policy for requiring approval for fork pull request workflows from collaborators without write access to private repos was changed for a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-forks-of-private-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "policy", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-forks-of-private-repositories" - }, - { - "action": "repo.set_actions_retention_limit", - "description": "The retention period for GitHub Actions artifacts and logs in a repository was changed.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "limit", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository" - }, - { - "action": "repo.set_default_workflow_permissions", - "description": "The default permissions granted to the GITHUB_TOKEN when running workflows were changed for a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository" - }, - { - "action": "repo.set_fork_pr_workflows_policy", - "description": "Triggered when the policy for workflows on private repository forks is changed.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "policy", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks" - }, - { - "action": "repo.set_workflow_permission_can_approve_pr", - "description": "The policy for allowing GitHub Actions to create and approve pull requests was changed for a repository.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#preventing-github-actions-from-creating-or-approving-pull-requests", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#preventing-github-actions-from-creating-or-approving-pull-requests" - }, - { - "action": "repo.staff_unlock", - "description": "An enterprise owner or GitHub staff (with permission from a repository administrator) temporarily unlocked the repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "repo.temporary_access_granted", - "description": "Temporary access was enabled for a repository.", - "docs_reference_links": "/admin/user-management/managing-repositories-in-your-enterprise/accessing-user-owned-repositories-in-your-enterprise", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Accessing user-owned repositories in your enterprise" - }, - { - "action": "repo.transfer", - "description": "A user accepted a request to receive a transferred repository.", - "docs_reference_links": "/repositories/creating-and-managing-repositories/transferring-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "owner", - "old_user", - "operation_type", - "created_at", - "visibility", - "repo_was" - ], - "docs_reference_titles": "/repositories/creating-and-managing-repositories/transferring-a-repository" - }, - { - "action": "repo.transfer_outgoing", - "description": "A repository was transferred to another repository network.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "new_nwo", - "visibility", - "created_at", - "operation_type", - "public_repo" - ] - }, - { - "action": "repo.transfer_start", - "description": "A user sent a request to transfer a repository to another user or organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "visibility" - ] - }, - { - "action": "repo.unarchived", - "description": "A repository was unarchived.", - "docs_reference_links": "/repositories/archiving-a-github-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "visibility" - ], - "docs_reference_titles": "/repositories/archiving-a-github-repository" - }, - { - "action": "repo.update_actions_access_settings", - "description": "The setting to control how a repository was used by GitHub Actions workflows in other repositories was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "policy", - "old_policy", - "created_at", - "operation_type" - ] - }, - { - "action": "repo.update_actions_secret", - "description": "A GitHub Actions secret was updated for a repository.", - "docs_reference_links": "/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "key", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Using secrets in GitHub Actions" - }, - { - "action": "repo.update_actions_settings", - "description": "A repository administrator changed GitHub Actions policy settings for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at", - "new_policy", - "old_policy", - "updated_access_policy", - "actor_is_bot" - ] - }, - { - "action": "repo.update_actions_variable", - "description": "A GitHub Actions variable was updated for a repository.", - "docs_reference_links": "/actions/learn-github-actions/variables#creating-configuration-variables-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "public_repo", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Store information in variables" - }, - { - "action": "repo.update_default_branch", - "description": "The default branch for a repository was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "visibility", - "operation_type", - "created_at", - "actor_is_bot" - ] - }, - { - "action": "repo.update_integration_secret", - "description": "A Codespaces or Dependabot secret was updated for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "integration", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "repo.update_member", - "description": "A user's permission to a repository was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "oauth_application_id", - "operation_type", - "visibility", - "old_permission", - "old_base_role", - "old_repo_permission", - "old_repo_base_role", - "new_repo_base_role", - "new_repo_permission", - "actor_is_bot" - ] - }, - { - "action": "repository_image.create", - "description": "An image to represent a repository was uploaded.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "content_type" - ] - }, - { - "action": "repository_image.destroy", - "description": "An image to represent a repository was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "content_type", - "created_at", - "operation_type" - ] - }, - { - "action": "repository_invitation.accept", - "description": "An invitation to join a repository was accepted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "invitee", - "operation_type", - "inviter" - ] - }, - { - "action": "repository_invitation.cancel", - "description": "An invitation to join a repository was canceled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "inviter", - "operation_type", - "invitee", - "created_at" - ] - }, - { - "action": "repository_invitation.create", - "description": "An invitation to join a repository was sent.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "invitee", - "inviter", - "created_at", - "operation_type" - ] - }, - { - "action": "repository_invitation.reject", - "description": "An invitation to join a repository was declined.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "invitee", - "operation_type", - "created_at", - "inviter" - ] - }, - { - "action": "repository_ruleset.create", - "description": "A repository ruleset was created.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "public_repo", - "created_at", - "operation_type", - "ruleset_id", - "ruleset_name", - "ruleset_enforcement", - "ruleset_source_type", - "ruleset_rules", - "ruleset_conditions", - "ruleset_bypass_actors" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository" - }, - { - "action": "repository_ruleset.destroy", - "description": "A repository ruleset was deleted.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#deleting-a-ruleset", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "name", - "public_repo", - "created_at", - "operation_type", - "ruleset_id", - "ruleset_name", - "ruleset_enforcement", - "ruleset_source_type", - "ruleset_rules", - "ruleset_bypass_actors" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#deleting-a-ruleset" - }, - { - "action": "repository_ruleset.update", - "description": "A repository ruleset was edited.", - "docs_reference_links": "/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#editing-a-ruleset", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "old_name", - "public_repo", - "created_at", - "operation_type", - "ruleset_id", - "ruleset_name", - "ruleset_enforcement", - "ruleset_source_type", - "ruleset_rules_updated", - "ruleset_conditions_added", - "ruleset_conditions_deleted", - "ruleset_old_enforcement", - "ruleset_rules_added", - "ruleset_rules_deleted", - "ruleset_old_name", - "ruleset_conditions_updated", - "ruleset_bypass_actors_added", - "ruleset_bypass_actors_deleted", - "ruleset_bypass_actors_updated", - "actor_is_bot" - ], - "docs_reference_titles": "/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#editing-a-ruleset" - }, - { - "action": "security_key.register", - "description": "A security key was registered for an account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "security_key.remove", - "description": "A security key was removed from an account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "sponsors.agreement_sign", - "description": "A GitHub Sponsors agreement was signed on behalf of an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "created_at", - "operation_type" - ] - }, - { - "action": "sponsors.custom_amount_settings_change", - "description": "Custom amounts for GitHub Sponsors were enabled or disabled, or the suggested custom amount was changed.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers" - }, - { - "action": "sponsors.fiscal_host_change", - "description": "The fiscal host for a GitHub Sponsors listing was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "created_at", - "operation_type" - ] - }, - { - "action": "sponsors.repo_funding_links_file_action", - "description": "The FUNDING file in a repository was changed.", - "docs_reference_links": "/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository" - }, - { - "action": "sponsors.sponsor_sponsorship_cancel", - "description": "A sponsorship was canceled.", - "docs_reference_links": "/billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Downgrading a sponsorship" - }, - { - "action": "sponsors.sponsor_sponsorship_create", - "description": "A sponsorship was created, by sponsoring an account.", - "docs_reference_links": "/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes" - }, - { - "action": "sponsors.sponsor_sponsorship_payment_complete", - "description": "After you sponsor an account and a payment has been processed, the sponsorship payment was marked as complete.", - "docs_reference_links": "/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "active", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes" - }, - { - "action": "sponsors.sponsor_sponsorship_preference_change", - "description": "The option to receive email updates from a sponsored account was changed.", - "docs_reference_links": "/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship" - }, - { - "action": "sponsors.sponsor_sponsorship_tier_change", - "description": "A sponsorship was upgraded or downgraded.", - "docs_reference_links": "/billing/managing-billing-for-github-sponsors/upgrading-a-sponsorship, /billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Upgrading a sponsorship, Downgrading a sponsorship" - }, - { - "action": "sponsors.sponsored_developer_approve", - "description": "A GitHub Sponsors account was approved.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account" - }, - { - "action": "sponsors.sponsored_developer_create", - "description": "A GitHub Sponsors account was created.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account" - }, - { - "action": "sponsors.sponsored_developer_disable", - "description": "A GitHub Sponsors account was disabled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "operation_type", - "created_at" - ] - }, - { - "action": "sponsors.sponsored_developer_profile_update", - "description": "The profile for GitHub Sponsors account was edited.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors" - }, - { - "action": "sponsors.sponsored_developer_redraft", - "description": "A GitHub Sponsors account was returned to draft state from approved state.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "sponsors.sponsored_developer_request_approval", - "description": "An application for GitHub Sponsors was submitted for approval.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account" - }, - { - "action": "sponsors.sponsored_developer_tier_description_update", - "description": "The description for a sponsorship tier was changed.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers" - }, - { - "action": "sponsors.sponsored_developer_update_newsletter_send", - "description": "Triggered when you send an email update to your sponsors.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors" - }, - { - "action": "sponsors.sponsors_patreon_user_create", - "description": "A Patreon account was linked to a user account for use with GitHub Sponsors.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/enabling-sponsorships-through-patreon#linking-your-patreon-account-to-your-github-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "patreon_email", - "patreon_username", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/enabling-sponsorships-through-patreon#linking-your-patreon-account-to-your-github-account" - }, - { - "action": "sponsors.sponsors_patreon_user_destroy", - "description": "A Patreon account for use with GitHub Sponsors was unlinked from a user account.", - "docs_reference_links": "/sponsors/sponsoring-open-source-contributors/unlinking-your-patreon-account-from-your-github-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "patreon_email", - "patreon_username", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Unlinking your Patreon account from GitHub" - }, - { - "action": "sponsors.update_tier_repository", - "description": "A GitHub Sponsors tier changed access for a repository.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "created_at", - "operation_type" - ] - }, - { - "action": "sponsors.update_tier_welcome_message", - "description": "The welcome message for a GitHub Sponsors tier for an organization was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "created_at", - "operation_type" - ] - }, - { - "action": "sponsors.waitlist_join", - "description": "You join the waitlist to join GitHub Sponsors.", - "docs_reference_links": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account" - }, - { - "action": "sponsors.withdraw_agreement_signature", - "description": "A signature was withdrawn from a GitHub Sponsors agreement that applies to an organization.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "sponsors_listing_id", - "created_at", - "operation_type" - ] - }, - { - "action": "successor_invitation.accept", - "description": "Triggered when you accept a succession invitation.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" - }, - { - "action": "successor_invitation.cancel", - "description": "Triggered when you cancel a succession invitation.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" - }, - { - "action": "successor_invitation.create", - "description": "Triggered when you create a succession invitation.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" - }, - { - "action": "successor_invitation.decline", - "description": "Triggered when you decline a succession invitation.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" - }, - { - "action": "successor_invitation.destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "successor_invitation.revoke", - "description": "Triggered when you revoke a succession invitation.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" - }, - { - "action": "trusted_device.register", - "description": "A new trusted device was added.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "trusted_device.remove", - "description": "A trusted device was removed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "two_factor_account_recovery.abort", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "two_factor_account_recovery.complete", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "two_factor_account_recovery.ignore", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "two_factor_account_recovery.staff_approve", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "two_factor_account_recovery.staff_decline", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "two_factor_account_recovery.start", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "two_factor_account_recovery.two_factor_destroy", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "two_factor_authentication.add_factor", - "description": "A secondary authentication factor was added to a user account.", - "docs_reference_links": "/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication" - }, - { - "action": "two_factor_authentication.disabled", - "description": "Two-factor authentication was disabled for a user account.", - "docs_reference_links": "https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/disabling-two-factor-authentication-for-your-personal-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Disabling two-factor authentication for your personal account" - }, - { - "action": "two_factor_authentication.enabled", - "description": "Two-factor authentication was enabled for a user account.", - "docs_reference_links": "https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Configuring two-factor authentication" - }, - { - "action": "two_factor_authentication.password_reset_fallback_sms", - "description": "A one-time password code was sent to a user account fallback phone number.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "two_factor_authentication.recovery_codes_regenerated", - "description": "Two factor recovery codes were regenerated for a user account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "two_factor_authentication.remove_factor", - "description": "A secondary authentication factor was removed from a user account.", - "docs_reference_links": "/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication" - }, - { - "action": "two_factor_authentication.sign_in_fallback_sms", - "description": "A one-time password code was sent to a user account fallback phone number.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "two_factor_authentication.update_fallback", - "description": "The two-factor authentication fallback for a user account was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.add_email", - "description": "An email address was added to a user account.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "email", - "created_at" - ], - "docs_reference_titles": "Adding an email address to your GitHub account" - }, - { - "action": "user.async_delete", - "description": "An asynchronous job was started to destroy a user account, eventually triggering a user.delete event.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.audit_log_export", - "description": "Audit log entries were exported.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.block_user", - "description": "A user was blocked by another user.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "blocked_user", - "operation_type", - "created_at" - ] - }, - { - "action": "user.change_password", - "description": "A user changed their password.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.codespaces_trusted_repo_access_granted", - "description": "Triggered when you allow the codespaces you create for a repository to access other repositories owned by your personal account.", - "docs_reference_links": "/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing access to other repositories within your codespace" - }, - { - "action": "user.codespaces_trusted_repo_access_revoked", - "description": "Triggered when you disallow the codespaces you create for a repository to access other repositories owned by your personal account.", - "docs_reference_links": "/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Managing access to other repositories within your codespace" - }, - { - "action": "user.create", - "description": "A new user account was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "email", - "operation_type", - "created_at" - ] - }, - { - "action": "user.create_integration_secret", - "description": "A user secret for Codespaces was created.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "integration", - "created_at", - "operation_type" - ] - }, - { - "action": "user.creation_rate_limit_exceeded", - "description": "The rate of creation of user accounts, applications, issues, pull requests or other resources exceeded the configured rate limits, or too many users were followed too quickly.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "oauth_application_id" - ] - }, - { - "action": "user.delete", - "description": "A user account was destroyed by an asynchronous job.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.demote", - "description": "A site administrator was demoted to an ordinary user account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "created_at", - "operation_type" - ] - }, - { - "action": "user.destroy", - "description": "A user deleted his or her account, triggering user.async_delete.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.device_verification_failure", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.device_verification_requested", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.device_verification_success", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.disable_collaborators_only", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.disable_contributors_only", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.disable_sockpuppet_disallowed", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user_email.confirm_claim", - "description": "An enterprise managed user claimed an email address.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "user_email.mark_as_unclaimed", - "description": "N/A", - "docs_reference_links": "An enterprise managed user unclaimed an email address.", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type", - "actor_is_bot" - ], - "docs_reference_titles": "An, GitHub Help Documentation, managed, user, unclaimed, an, email, address." - }, - { - "action": "user.enable_collaborators_only", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.enable_contributors_only", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.enable_sockpuppet_disallowed", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.failed_login", - "description": "A user tried to sign in with an incorrect username, password, or two-factor authentication code.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.forgot_password", - "description": "A user requested a password reset.", - "docs_reference_links": "/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "email", - "created_at" - ], - "docs_reference_titles": "/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials" - }, - { - "action": "user.grant_github_developer", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.hide_private_contributions_count", - "description": "A user changed the visibility of their private contributions. The number of contributions to private repositories on the user's profile are now hidden.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "Manage visibility settings for private contributions" - }, - { - "action": "user.login", - "description": "A user signed in.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "passkey_nickname" - ] - }, - { - "action": "user.logout", - "description": "A user signed out.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.new_device_used", - "description": "A user signed in from a new device.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.promote", - "description": "An ordinary user account was promoted to a site administrator.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "oauth_application_id", - "operation_type" - ] - }, - { - "action": "user.recreate", - "description": "A user's account was restored.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.remove_email", - "description": "An email address was removed from a user account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "email" - ] - }, - { - "action": "user.remove_integration_secret", - "description": "A user secret for Codespaces was deleted.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "integration", - "created_at", - "operation_type" - ] - }, - { - "action": "user.rename", - "description": "A username was changed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "old_login", - "created_at", - "operation_type" - ] - }, - { - "action": "user.reset_password", - "description": "A user reset their account password.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user_session.country_change", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.show_private_contributions_count", - "description": "A user changed the visibility of their private contributions. The number of contributions to private repositories on the user's profile are now shown.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ], - "docs_reference_titles": "Manage visibility settings for private contributions" - }, - { - "action": "user.sign_in_from_unrecognized_device", - "description": "A user signed in from an unrecognized device.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.sign_in_from_unrecognized_device_and_location", - "description": "A user signed in from an unrecognized device and location.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user_status.destroy", - "description": "Triggered when you clear the status on your profile.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "message", - "created_at", - "limited_availability", - "emoji", - "operation_type" - ] - }, - { - "action": "user_status.update", - "description": "Triggered when you set or change the status on your profile.", - "docs_reference_links": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "limited_availability", - "message", - "created_at", - "emoji", - "operation_type" - ], - "docs_reference_titles": "Personalize your profile" - }, - { - "action": "user.suspend", - "description": "A user account was suspended.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "operation_type", - "created_at" - ] - }, - { - "action": "user.toggle_warn_private_email", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.two_factor_challenge_failure", - "description": "A 2FA challenge issued for a user account failed.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.two_factor_challenge_success", - "description": "A 2FA challenge issued for a user account succeeded.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.two_factor_recover", - "description": "A user used their 2FA recovery codes.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.two_factor_recovery_codes_downloaded", - "description": "A user downloaded 2FA recovery codes for their account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.two_factor_recovery_codes_printed", - "description": "A user printed 2FA recovery codes for their account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at" - ] - }, - { - "action": "user.two_factor_recovery_codes_viewed", - "description": "A user viewed 2FA recovery codes for their account.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "user.two_factor_requested", - "description": "A user was prompted for a two-factor authentication code.", - "docs_reference_links": "/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ], - "docs_reference_titles": "/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication" - }, - { - "action": "user.unblock_user", - "description": "A user was unblocked by another user.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "blocked_user", - "operation_type", - "created_at" - ] - }, - { - "action": "user.unsuspend", - "description": "A user account was unsuspended.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "oauth_application_id", - "operation_type", - "created_at" - ] - }, - { - "action": "user.update_integration_secret", - "description": "A user secret for Codespaces was updated.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "key", - "visibility", - "integration", - "created_at", - "operation_type" - ] - }, - { - "action": "user.update_new_repository_default_branch_setting", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "created_at", - "operation_type" - ] - }, - { - "action": "workflows.approve_workflow_job", - "description": "A workflow job was approved.", - "docs_reference_links": "/actions/managing-workflow-runs/reviewing-deployments", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_run_id", - "run_number", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "Reviewing deployments" - }, - { - "action": "workflows.bypass_protection_rules", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_run_id", - "run_number", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "workflows.comment_workflow_job", - "description": "N/A", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_run_id", - "run_number", - "public_repo", - "created_at", - "operation_type" - ] - }, - { - "action": "workflows.delete_workflow_run", - "description": "A workflow run was deleted.", - "docs_reference_links": "/actions/managing-workflow-runs/deleting-a-workflow-run", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "operation_type", - "created_at", - "workflow_run_id", - "started_at", - "head_branch", - "head_sha", - "trigger_id" - ], - "docs_reference_titles": "Deleting a workflow run" - }, - { - "action": "workflows.disable_workflow", - "description": "A workflow was disabled.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_id", - "operation_type", - "created_at", - "public_repo", - "actor_is_bot" - ] - }, - { - "action": "workflows.enable_workflow", - "description": "A workflow was enabled, after previously being disabled by disable_workflow.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_id", - "operation_type", - "created_at", - "public_repo" - ] - }, - { - "action": "workflows.pin_workflow", - "description": "A workflow was pinned.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "workflow_id", - "created_at", - "operation_type", - "actor_is_bot" - ] - }, - { - "action": "workflows.reject_workflow_job", - "description": "A workflow job was rejected.", - "docs_reference_links": "/actions/managing-workflow-runs/reviewing-deployments", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "workflow_run_id", - "run_number", - "operation_type", - "created_at", - "public_repo" - ], - "docs_reference_titles": "Reviewing deployments" - }, - { - "action": "workflows.unpin_workflow", - "description": "A workflow was unpinned after previously being pinned.", - "docs_reference_links": "N/A", - "fields": [ - "@timestamp", - "_document_id", - "action", - "actor", - "actor_id", - "business", - "business_id", - "hashed_token", - "org", - "org_id", - "programmatic_access_type", - "repo", - "repo_id", - "repository", - "repository_id", - "request_access_security_header", - "request_id", - "token_id", - "token_scopes", - "user", - "user_id", - "user_agent", - "public_repo", - "workflow_id", - "created_at", - "operation_type", - "actor_is_bot" - ] - } -] \ No newline at end of file diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json deleted file mode 100644 index ba1deb95f2a6..000000000000 --- a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json +++ /dev/null @@ -1,6200 +0,0 @@ -{ - "organization_administration": { - "title": "Administration", - "displayTitle": "Organization permissions for \"Administration\"", - "permissions": [ - { - "category": "orgs", - "slug": "closing-down---list-custom-repository-roles-in-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/organizations/{organization_id}/custom_roles", - "additional-permissions": true, - "access": "read" - }, - { - "category": "orgs", - "slug": "update-an-organization", - "subcategory": "orgs", - "verb": "patch", - "requestPath": "/orgs/{org}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "delete-an-organization", - "subcategory": "orgs", - "verb": "delete", - "requestPath": "/orgs/{org}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "get-github-actions-cache-usage-for-an-organization", - "subcategory": "cache", - "verb": "get", - "requestPath": "/orgs/{org}/actions/cache/usage", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "list-repositories-with-github-actions-cache-usage-for-an-organization", - "subcategory": "cache", - "verb": "get", - "requestPath": "/orgs/{org}/actions/cache/usage-by-repository", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "get-the-customization-template-for-an-oidc-subject-claim-for-an-organization", - "subcategory": "oidc", - "verb": "get", - "requestPath": "/orgs/{org}/actions/oidc/customization/sub", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "set-the-customization-template-for-an-oidc-subject-claim-for-an-organization", - "subcategory": "oidc", - "verb": "put", - "requestPath": "/orgs/{org}/actions/oidc/customization/sub", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "get-github-actions-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "set-github-actions-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "list-selected-repositories-enabled-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/repositories", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "set-selected-repositories-enabled-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "actions", - "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "actions", - "slug": "get-allowed-actions-for-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/selected-actions", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "set-allowed-actions-for-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/selected-actions", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "get-default-workflow-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/workflow", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "set-default-workflow-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/workflow", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "get-the-audit-log-for-an-organization", - "subcategory": "orgs", - "verb": "get", - "requestPath": "/orgs/{org}/audit-log", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "list-custom-repository-roles-in-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/custom-repository-roles", - "additional-permissions": true, - "access": "read" - }, - { - "category": "orgs", - "slug": "get-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "orgs", - "slug": "list-app-installations-for-an-organization", - "subcategory": "orgs", - "verb": "get", - "requestPath": "/orgs/{org}/installations", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "list-repository-fine-grained-permissions-for-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/repository-fine-grained-permissions", - "additional-permissions": true, - "access": "read" - }, - { - "category": "orgs", - "slug": "get-all-organization-repository-rulesets", - "subcategory": "rules", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "create-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "post", - "requestPath": "/orgs/{org}/rulesets", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "list-organization-rule-suites", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets/rule-suites", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "get-an-organization-rule-suite", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "get-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets/{ruleset_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "update-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "put", - "requestPath": "/orgs/{org}/rulesets/{ruleset_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "delete-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "delete", - "requestPath": "/orgs/{org}/rulesets/{ruleset_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "list-security-manager-teams", - "subcategory": "security-managers", - "verb": "get", - "requestPath": "/orgs/{org}/security-managers", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "add-a-security-manager-team", - "subcategory": "security-managers", - "verb": "put", - "requestPath": "/orgs/{org}/security-managers/teams/{team_slug}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "remove-a-security-manager-team", - "subcategory": "security-managers", - "verb": "delete", - "requestPath": "/orgs/{org}/security-managers/teams/{team_slug}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "billing", - "slug": "get-github-advanced-security-active-committers-for-an-organization", - "subcategory": "billing", - "verb": "get", - "requestPath": "/orgs/{org}/settings/billing/advanced-security", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "enable-or-disable-a-security-feature-for-an-organization", - "subcategory": "orgs", - "verb": "post", - "requestPath": "/orgs/{org}/{security_product}/{enablement}", - "additional-permissions": false, - "access": "write" - } - ] - }, - "organization_custom_org_roles": { - "title": "Custom organization roles", - "displayTitle": "Organization permissions for \"Custom organization roles\"", - "permissions": [ - { - "category": "orgs", - "slug": "list-organization-fine-grained-permissions-for-an-organization", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-fine-grained-permissions", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "get-all-organization-roles-for-an-organization", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "create-a-custom-organization-role", - "subcategory": "organization-roles", - "verb": "post", - "requestPath": "/orgs/{org}/organization-roles", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "get-an-organization-role", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles/{role_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "update-a-custom-organization-role", - "subcategory": "organization-roles", - "verb": "patch", - "requestPath": "/orgs/{org}/organization-roles/{role_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "delete-a-custom-organization-role", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/{role_id}", - "additional-permissions": false, - "access": "write" - } - ] - }, - "organization_custom_properties": { - "title": "Custom properties", - "displayTitle": "Organization permissions for \"Custom properties\"", - "permissions": [ - { - "category": "orgs", - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema", - "additional-permissions": false, - "access": "admin" - }, - { - "category": "orgs", - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "admin" - }, - { - "category": "orgs", - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "admin" - }, - { - "category": "orgs", - "slug": "list-custom-property-values-for-organization-repositories", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/values", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "create-or-update-custom-property-values-for-organization-repositories", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/values", - "additional-permissions": false, - "access": "write" - } - ] - }, - "organization_custom_roles": { - "title": "Custom repository roles", - "displayTitle": "Organization permissions for \"Custom repository roles\"", - "permissions": [ - { - "category": "orgs", - "slug": "closing-down---list-custom-repository-roles-in-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/organizations/{organization_id}/custom_roles", - "additional-permissions": true, - "access": "read" - }, - { - "category": "orgs", - "slug": "list-custom-repository-roles-in-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/custom-repository-roles", - "additional-permissions": true, - "access": "read" - }, - { - "category": "orgs", - "slug": "create-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "post", - "requestPath": "/orgs/{org}/custom-repository-roles", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "get-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "orgs", - "slug": "update-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "patch", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "delete-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "list-repository-fine-grained-permissions-for-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/repository-fine-grained-permissions", - "additional-permissions": true, - "access": "read" - } - ] - }, - "organization_events": { - "title": "Events", - "displayTitle": "Organization permissions for \"Events\"", - "permissions": [ - { - "category": "activity", - "slug": "list-organization-events-for-the-authenticated-user", - "subcategory": "events", - "verb": "get", - "requestPath": "/users/{username}/events/orgs/{org}", - "additional-permissions": false, - "access": "read" - } - ] - }, - "members": { - "title": "Members", - "displayTitle": "Organization permissions for \"Members\"", - "permissions": [ - { - "category": "teams", - "slug": "get-an-external-group", - "subcategory": "external-groups", - "verb": "get", - "requestPath": "/orgs/{org}/external-group/{group_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "teams", - "slug": "list-external-groups-available-to-an-organization", - "subcategory": "external-groups", - "verb": "get", - "requestPath": "/orgs/{org}/external-groups", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "list-organization-members", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/members", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "check-organization-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/members/{username}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "remove-an-organization-member", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/members/{username}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "get-organization-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/memberships/{username}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "set-organization-membership-for-a-user", - "subcategory": "members", - "verb": "put", - "requestPath": "/orgs/{org}/memberships/{username}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "remove-organization-membership-for-a-user", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/memberships/{username}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "remove-all-organization-roles-for-a-team", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/teams/{team_slug}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "assign-an-organization-role-to-a-team", - "subcategory": "organization-roles", - "verb": "put", - "requestPath": "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "remove-an-organization-role-from-a-team", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "remove-all-organization-roles-for-a-user", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/users/{username}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "assign-an-organization-role-to-a-user", - "subcategory": "organization-roles", - "verb": "put", - "requestPath": "/orgs/{org}/organization-roles/users/{username}/{role_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "remove-an-organization-role-from-a-user", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/users/{username}/{role_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "list-teams-that-are-assigned-to-an-organization-role", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles/{role_id}/teams", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "list-users-that-are-assigned-to-an-organization-role", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles/{role_id}/users", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "list-outside-collaborators-for-an-organization", - "subcategory": "outside-collaborators", - "verb": "get", - "requestPath": "/orgs/{org}/outside_collaborators", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "convert-an-organization-member-to-outside-collaborator", - "subcategory": "outside-collaborators", - "verb": "put", - "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "remove-outside-collaborator-from-an-organization", - "subcategory": "outside-collaborators", - "verb": "delete", - "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "list-public-organization-members", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/public_members", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "check-public-organization-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/public_members/{username}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "set-public-organization-membership-for-the-authenticated-user", - "subcategory": "members", - "verb": "put", - "requestPath": "/orgs/{org}/public_members/{username}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "remove-public-organization-membership-for-the-authenticated-user", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/public_members/{username}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "teams", - "slug": "list-teams", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams", - "additional-permissions": false, - "access": "read" - }, - { - "category": "teams", - "slug": "create-a-team", - "subcategory": "teams", - "verb": "post", - "requestPath": "/orgs/{org}/teams", - "additional-permissions": false, - "access": "write" - }, - { - "category": "teams", - "slug": "get-a-team-by-name", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "teams", - "slug": "update-a-team", - "subcategory": "teams", - "verb": "patch", - "requestPath": "/orgs/{org}/teams/{team_slug}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "teams", - "slug": "delete-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "teams", - "slug": "list-a-connection-between-an-external-group-and-a-team", - "subcategory": "external-groups", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", - "additional-permissions": false, - "access": "write" - }, - { - "category": "teams", - "slug": "update-the-connection-between-an-external-group-and-a-team", - "subcategory": "external-groups", - "verb": "patch", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", - "additional-permissions": false, - "access": "write" - }, - { - "category": "teams", - "slug": "remove-the-connection-between-an-external-group-and-a-team", - "subcategory": "external-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", - "additional-permissions": false, - "access": "write" - }, - { - "category": "teams", - "slug": "list-team-members", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/members", - "additional-permissions": false, - "access": "read" - }, - { - "category": "teams", - "slug": "get-team-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "teams", - "slug": "add-or-update-team-membership-for-a-user", - "subcategory": "members", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "teams", - "slug": "remove-team-membership-for-a-user", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "teams", - "slug": "list-team-repositories", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos", - "additional-permissions": false, - "access": "read" - }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "list-child-teams", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/teams", - "additional-permissions": false, - "access": "read" - }, - { - "category": "teams", - "slug": "get-a-team-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "teams", - "slug": "update-a-team-legacy", - "subcategory": "teams", - "verb": "patch", - "requestPath": "/teams/{team_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "teams", - "slug": "delete-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "teams", - "slug": "list-team-members-legacy", - "subcategory": "members", - "verb": "get", - "requestPath": "/teams/{team_id}/members", - "additional-permissions": false, - "access": "read" - }, - { - "category": "teams", - "slug": "get-team-member-legacy", - "subcategory": "members", - "verb": "get", - "requestPath": "/teams/{team_id}/members/{username}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "teams", - "slug": "add-team-member-legacy", - "subcategory": "members", - "verb": "put", - "requestPath": "/teams/{team_id}/members/{username}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "teams", - "slug": "remove-team-member-legacy", - "subcategory": "members", - "verb": "delete", - "requestPath": "/teams/{team_id}/members/{username}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "teams", - "slug": "get-team-membership-for-a-user-legacy", - "subcategory": "members", - "verb": "get", - "requestPath": "/teams/{team_id}/memberships/{username}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "teams", - "slug": "add-or-update-team-membership-for-a-user-legacy", - "subcategory": "members", - "verb": "put", - "requestPath": "/teams/{team_id}/memberships/{username}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "teams", - "slug": "remove-team-membership-for-a-user-legacy", - "subcategory": "members", - "verb": "delete", - "requestPath": "/teams/{team_id}/memberships/{username}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "teams", - "slug": "list-team-repositories-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos", - "additional-permissions": false, - "access": "read" - }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "list-child-teams-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/teams", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "get-an-organization-membership-for-the-authenticated-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/user/memberships/orgs/{org}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "update-an-organization-membership-for-the-authenticated-user", - "subcategory": "members", - "verb": "patch", - "requestPath": "/user/memberships/orgs/{org}", - "additional-permissions": false, - "access": "write" - } - ] - }, - "organization_announcement_banners": { - "title": "Organization announcement banners", - "displayTitle": "Organization permissions for \"Organization announcement banners\"", - "permissions": [ - { - "category": "announcement-banners", - "slug": "get-announcement-banner-for-organization", - "subcategory": "organizations", - "verb": "get", - "requestPath": "/orgs/{org}/announcement", - "additional-permissions": false, - "access": "read" - }, - { - "category": "announcement-banners", - "slug": "set-announcement-banner-for-organization", - "subcategory": "organizations", - "verb": "patch", - "requestPath": "/orgs/{org}/announcement", - "additional-permissions": false, - "access": "write" - }, - { - "category": "announcement-banners", - "slug": "remove-announcement-banner-from-organization", - "subcategory": "organizations", - "verb": "delete", - "requestPath": "/orgs/{org}/announcement", - "additional-permissions": false, - "access": "write" - } - ] - }, - "organization_dependabot_secrets": { - "title": "Organization dependabot secrets", - "displayTitle": "Organization permissions for \"Organization dependabot secrets\"", - "permissions": [ - { - "category": "dependabot", - "slug": "list-organization-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets", - "additional-permissions": false, - "access": "read" - }, - { - "category": "dependabot", - "slug": "get-an-organization-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets/public-key", - "additional-permissions": false, - "access": "read" - }, - { - "category": "dependabot", - "slug": "get-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "dependabot", - "slug": "create-or-update-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "dependabot", - "slug": "delete-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "dependabot", - "slug": "list-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories", - "additional-permissions": false, - "access": "read" - }, - { - "category": "dependabot", - "slug": "set-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories", - "additional-permissions": false, - "access": "write" - }, - { - "category": "dependabot", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "dependabot", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "write" - } - ] - }, - "organization_pre_receive_hooks": { - "title": "Organization pre-receive hooks", - "displayTitle": "Organization permissions for \"Organization pre-receive hooks\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-pre-receive-hooks-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks", - "additional-permissions": false, - "access": "read" - }, - { - "category": "enterprise-admin", - "slug": "get-a-pre-receive-hook-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "enterprise-admin", - "slug": "update-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "patch", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "enterprise-admin", - "slug": "remove-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "delete", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "write" - } - ] - }, - "organization_secrets": { - "title": "Secrets", - "displayTitle": "Organization permissions for \"Secrets\"", - "permissions": [ - { - "category": "actions", - "slug": "list-organization-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "get-an-organization-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/public-key", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "get-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "create-or-update-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "delete-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "list-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "set-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "write" - } - ] - }, - "organization_self_hosted_runners": { - "title": "Self-hosted runners", - "displayTitle": "Organization permissions for \"Self-hosted runners\"", - "permissions": [ - { - "category": "actions", - "slug": "list-self-hosted-runner-groups-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "create-a-self-hosted-runner-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runner-groups", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "get-a-self-hosted-runner-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "update-a-self-hosted-runner-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "patch", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "delete-a-self-hosted-runner-group-from-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "list-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "set-repository-access-for-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "actions", - "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "actions", - "slug": "list-self-hosted-runners-in-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "set-self-hosted-runners-in-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "add-a-self-hosted-runner-to-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "remove-a-self-hosted-runner-from-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "list-self-hosted-runners-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "list-runner-applications-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/downloads", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "create-configuration-for-a-just-in-time-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/generate-jitconfig", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "create-a-registration-token-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/registration-token", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "create-a-remove-token-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/remove-token", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "get-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "delete-a-self-hosted-runner-from-an-organization", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "list-labels-for-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "add-custom-labels-to-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "set-custom-labels-for-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "remove-a-custom-label-from-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels/{name}", - "additional-permissions": false, - "access": "write" - } - ] - }, - "organization_actions_variables": { - "title": "Variables", - "displayTitle": "Organization permissions for \"Variables\"", - "permissions": [ - { - "category": "actions", - "slug": "list-organization-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "create-an-organization-variable", - "subcategory": "variables", - "verb": "post", - "requestPath": "/orgs/{org}/actions/variables", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "get-an-organization-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables/{name}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "update-an-organization-variable", - "subcategory": "variables", - "verb": "patch", - "requestPath": "/orgs/{org}/actions/variables/{name}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "delete-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "list-selected-repositories-for-an-organization-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "set-selected-repositories-for-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "write" - } - ] - }, - "organization_hooks": { - "title": "Webhooks", - "displayTitle": "Organization permissions for \"Webhooks\"", - "permissions": [ - { - "category": "orgs", - "slug": "list-organization-webhooks", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "create-an-organization-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/orgs/{org}/hooks", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "get-an-organization-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "update-an-organization-webhook", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/orgs/{org}/hooks/{hook_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "delete-an-organization-webhook", - "subcategory": "webhooks", - "verb": "delete", - "requestPath": "/orgs/{org}/hooks/{hook_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "get-a-webhook-configuration-for-an-organization", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/config", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "update-a-webhook-configuration-for-an-organization", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/orgs/{org}/hooks/{hook_id}/config", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "list-deliveries-for-an-organization-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "get-a-webhook-delivery-for-an-organization-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "redeliver-a-delivery-for-an-organization-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", - "additional-permissions": false, - "access": "write" - }, - { - "category": "orgs", - "slug": "ping-an-organization-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/orgs/{org}/hooks/{hook_id}/pings", - "additional-permissions": false, - "access": "write" - } - ] - }, - "actions": { - "title": "Actions", - "displayTitle": "Repository permissions for \"Actions\"", - "permissions": [ - { - "category": "actions", - "slug": "list-artifacts-for-a-repository", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "get-an-artifact", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "delete-an-artifact", - "subcategory": "artifacts", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "download-an-artifact", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "get-github-actions-cache-usage-for-a-repository", - "subcategory": "cache", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/cache/usage", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "get-github-actions-cache-usage-policy-for-a-repository", - "subcategory": "cache", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/cache/usage-policy", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "list-github-actions-caches-for-a-repository", - "subcategory": "cache", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/caches", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "delete-github-actions-caches-for-a-repository-using-a-cache-key", - "subcategory": "cache", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/caches", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "delete-a-github-actions-cache-for-a-repository-using-a-cache-id", - "subcategory": "cache", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/caches/{cache_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "get-a-job-for-a-workflow-run", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "download-job-logs-for-a-workflow-run", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "re-run-a-job-from-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "get-the-customization-template-for-an-oidc-subject-claim-for-a-repository", - "subcategory": "oidc", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/oidc/customization/sub", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "set-the-customization-template-for-an-oidc-subject-claim-for-a-repository", - "subcategory": "oidc", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/oidc/customization/sub", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "list-workflow-runs-for-a-repository", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "get-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "delete-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "get-the-review-history-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "list-workflow-run-artifacts", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "get-a-workflow-run-attempt", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "list-jobs-for-a-workflow-run-attempt", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "download-workflow-run-attempt-logs", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "cancel-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "force-cancel-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "list-jobs-for-a-workflow-run", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "download-workflow-run-logs", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "delete-workflow-run-logs", - "subcategory": "workflow-runs", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "get-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "re-run-a-workflow", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "re-run-failed-jobs-from-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "list-repository-workflows", - "subcategory": "workflows", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/workflows", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "get-a-workflow", - "subcategory": "workflows", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "disable-a-workflow", - "subcategory": "workflows", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "create-a-workflow-dispatch-event", - "subcategory": "workflows", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "enable-a-workflow", - "subcategory": "workflows", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "list-workflow-runs-for-a-workflow", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", - "additional-permissions": false, - "access": "read" - }, - { - "category": "deployments", - "slug": "list-environments", - "subcategory": "environments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments", - "additional-permissions": false, - "access": "read" - }, - { - "category": "deployments", - "slug": "get-an-environment", - "subcategory": "environments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "deployments", - "slug": "list-deployment-branch-policies", - "subcategory": "branch-policies", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies", - "additional-permissions": false, - "access": "read" - }, - { - "category": "deployments", - "slug": "get-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "deployments", - "slug": "get-all-deployment-protection-rules-for-an-environment", - "subcategory": "protection-rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules", - "additional-permissions": false, - "access": "read" - }, - { - "category": "deployments", - "slug": "get-a-custom-deployment-protection-rule", - "subcategory": "protection-rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}", - "additional-permissions": false, - "access": "read" - } - ] - }, - "administration": { - "title": "Administration", - "displayTitle": "Repository permissions for \"Administration\"", - "permissions": [ - { - "category": "repos", - "slug": "create-an-organization-repository", - "subcategory": "repos", - "verb": "post", - "requestPath": "/orgs/{org}/repos", - "additional-permissions": false, - "access": "write" - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "repos", - "slug": "update-a-repository", - "subcategory": "repos", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "delete-a-repository", - "subcategory": "repos", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "set-github-actions-cache-usage-policy-for-a-repository", - "subcategory": "cache", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/actions/cache/usage-policy", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "get-github-actions-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "set-github-actions-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "get-the-level-of-access-for-workflows-outside-of-the-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/access", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "set-the-level-of-access-for-workflows-outside-of-the-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/access", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "get-allowed-actions-for-a-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "set-allowed-actions-for-a-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "get-default-workflow-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "set-default-workflow-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "list-self-hosted-runners-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "list-runner-applications-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/downloads", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "create-configuration-for-a-just-in-time-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/generate-jitconfig", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "create-a-registration-token-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/registration-token", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "create-a-remove-token-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/remove-token", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "get-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "delete-a-self-hosted-runner-from-a-repository", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "list-labels-for-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "add-custom-labels-to-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "set-custom-labels-for-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "remove-a-custom-label-from-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "get-all-autolinks-of-a-repository", - "subcategory": "autolinks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/autolinks", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "create-an-autolink-reference-for-a-repository", - "subcategory": "autolinks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/autolinks", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "get-an-autolink-reference-of-a-repository", - "subcategory": "autolinks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "delete-an-autolink-reference-from-a-repository", - "subcategory": "autolinks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "check-if-dependabot-security-updates-are-enabled-for-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/automated-security-fixes", - "additional-permissions": false, - "access": "read" - }, - { - "category": "branches", - "slug": "get-branch-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "additional-permissions": false, - "access": "read" - }, - { - "category": "branches", - "slug": "update-branch-protection", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "delete-branch-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "get-admin-branch-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "additional-permissions": false, - "access": "read" - }, - { - "category": "branches", - "slug": "set-admin-branch-protection", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "delete-admin-branch-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "get-pull-request-review-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "additional-permissions": false, - "access": "read" - }, - { - "category": "branches", - "slug": "update-pull-request-review-protection", - "subcategory": "branch-protection", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "delete-pull-request-review-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "get-commit-signature-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "additional-permissions": false, - "access": "read" - }, - { - "category": "branches", - "slug": "create-commit-signature-protection", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "delete-commit-signature-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "get-status-checks-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "additional-permissions": false, - "access": "read" - }, - { - "category": "branches", - "slug": "update-status-check-protection", - "subcategory": "branch-protection", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "remove-status-check-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "get-all-status-check-contexts", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "additional-permissions": false, - "access": "read" - }, - { - "category": "branches", - "slug": "add-status-check-contexts", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "set-status-check-contexts", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "remove-status-check-contexts", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "get-access-restrictions", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "additional-permissions": false, - "access": "read" - }, - { - "category": "branches", - "slug": "delete-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "get-apps-with-access-to-the-protected-branch", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "additional-permissions": false, - "access": "read" - }, - { - "category": "branches", - "slug": "add-app-access-restrictions", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "set-app-access-restrictions", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "remove-app-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "get-teams-with-access-to-the-protected-branch", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "additional-permissions": false, - "access": "read" - }, - { - "category": "branches", - "slug": "add-team-access-restrictions", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "set-team-access-restrictions", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "remove-team-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "get-users-with-access-to-the-protected-branch", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "additional-permissions": false, - "access": "read" - }, - { - "category": "branches", - "slug": "add-user-access-restrictions", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "set-user-access-restrictions", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "remove-user-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "additional-permissions": false, - "access": "write" - }, - { - "category": "code-scanning", - "slug": "get-a-code-scanning-default-setup-configuration", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/default-setup", - "additional-permissions": false, - "access": "read" - }, - { - "category": "code-scanning", - "slug": "update-a-code-scanning-default-setup-configuration", - "subcategory": "code-scanning", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/code-scanning/default-setup", - "additional-permissions": false, - "access": "write" - }, - { - "category": "collaborators", - "slug": "add-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "collaborators", - "slug": "remove-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "deployments", - "slug": "create-or-update-an-environment", - "subcategory": "environments", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "deployments", - "slug": "delete-an-environment", - "subcategory": "environments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "deployments", - "slug": "create-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies", - "additional-permissions": false, - "access": "write" - }, - { - "category": "deployments", - "slug": "update-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "deployments", - "slug": "delete-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "deployments", - "slug": "create-a-custom-deployment-protection-rule-on-an-environment", - "subcategory": "protection-rules", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules", - "additional-permissions": false, - "access": "write" - }, - { - "category": "deployments", - "slug": "list-custom-deployment-rule-integrations-available-for-an-environment", - "subcategory": "protection-rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps", - "additional-permissions": false, - "access": "read" - }, - { - "category": "deployments", - "slug": "disable-a-custom-protection-rule-for-an-environment", - "subcategory": "protection-rules", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "create-a-fork", - "subcategory": "forks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/forks", - "additional-permissions": true, - "access": "write" - }, - { - "category": "collaborators", - "slug": "list-repository-invitations", - "subcategory": "invitations", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/invitations", - "additional-permissions": true, - "access": "read" - }, - { - "category": "collaborators", - "slug": "update-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "collaborators", - "slug": "delete-a-repository-invitation", - "subcategory": "invitations", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "deploy-keys", - "slug": "list-deploy-keys", - "subcategory": "deploy-keys", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/keys", - "additional-permissions": false, - "access": "read" - }, - { - "category": "deploy-keys", - "slug": "create-a-deploy-key", - "subcategory": "deploy-keys", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/keys", - "additional-permissions": false, - "access": "write" - }, - { - "category": "deploy-keys", - "slug": "get-a-deploy-key", - "subcategory": "deploy-keys", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "deploy-keys", - "slug": "delete-a-deploy-key", - "subcategory": "deploy-keys", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "pages", - "slug": "create-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages", - "additional-permissions": true, - "access": "write" - }, - { - "category": "pages", - "slug": "update-information-about-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pages", - "additional-permissions": true, - "access": "write" - }, - { - "category": "pages", - "slug": "delete-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pages", - "additional-permissions": true, - "access": "write" - }, - { - "category": "repos", - "slug": "list-repository-cache-replication-status", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/replicas/caches", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "create-a-repository-ruleset", - "subcategory": "rules", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/rulesets", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "list-repository-rule-suites", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets/rule-suites", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "get-a-repository-rule-suite", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "update-a-repository-ruleset", - "subcategory": "rules", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/rulesets/{ruleset_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "delete-a-repository-ruleset", - "subcategory": "rules", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/rulesets/{ruleset_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "list-repository-teams", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/teams", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "replace-all-repository-topics", - "subcategory": "repos", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/topics", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "check-if-vulnerability-alerts-are-enabled-for-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "enable-vulnerability-alerts", - "subcategory": "repos", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "disable-vulnerability-alerts", - "subcategory": "repos", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "create-a-repository-using-a-template", - "subcategory": "repos", - "verb": "post", - "requestPath": "/repos/{template_owner}/{template_repo}/generate", - "additional-permissions": true, - "access": "write" - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "repos", - "slug": "create-a-repository-for-the-authenticated-user", - "subcategory": "repos", - "verb": "post", - "requestPath": "/user/repos", - "additional-permissions": false, - "access": "write" - }, - { - "category": "collaborators", - "slug": "list-repository-invitations-for-the-authenticated-user", - "subcategory": "invitations", - "verb": "get", - "requestPath": "/user/repository_invitations", - "additional-permissions": false, - "access": "read" - }, - { - "category": "collaborators", - "slug": "decline-a-repository-invitation", - "subcategory": "invitations", - "verb": "delete", - "requestPath": "/user/repository_invitations/{invitation_id}", - "additional-permissions": false, - "access": "write" - } - ] - }, - "security_events": { - "title": "Code scanning alerts", - "displayTitle": "Repository permissions for \"Code scanning alerts\"", - "permissions": [ - { - "category": "code-scanning", - "slug": "list-code-scanning-alerts-for-an-organization", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/orgs/{org}/code-scanning/alerts", - "additional-permissions": false, - "access": "read" - }, - { - "category": "code-scanning", - "slug": "list-code-scanning-alerts-for-a-repository", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts", - "additional-permissions": false, - "access": "read" - }, - { - "category": "code-scanning", - "slug": "get-a-code-scanning-alert", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "code-scanning", - "slug": "update-a-code-scanning-alert", - "subcategory": "code-scanning", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "code-scanning", - "slug": "list-instances-of-a-code-scanning-alert", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", - "additional-permissions": false, - "access": "read" - }, - { - "category": "code-scanning", - "slug": "list-code-scanning-analyses-for-a-repository", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses", - "additional-permissions": false, - "access": "read" - }, - { - "category": "code-scanning", - "slug": "get-a-code-scanning-analysis-for-a-repository", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "code-scanning", - "slug": "delete-a-code-scanning-analysis-from-a-repository", - "subcategory": "code-scanning", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "code-scanning", - "slug": "upload-an-analysis-as-sarif-data", - "subcategory": "code-scanning", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs", - "additional-permissions": false, - "access": "write" - }, - { - "category": "code-scanning", - "slug": "get-information-about-a-sarif-upload", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}", - "additional-permissions": false, - "access": "read" - } - ] - }, - "statuses": { - "title": "Commit statuses", - "displayTitle": "Repository permissions for \"Commit statuses\"", - "permissions": [ - { - "category": "commits", - "slug": "get-the-combined-status-for-a-specific-reference", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/status", - "additional-permissions": false, - "access": "read" - }, - { - "category": "commits", - "slug": "list-commit-statuses-for-a-reference", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/statuses", - "additional-permissions": false, - "access": "read" - }, - { - "category": "commits", - "slug": "create-a-commit-status", - "subcategory": "statuses", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/statuses/{sha}", - "additional-permissions": false, - "access": "write" - } - ] - }, - "contents": { - "title": "Contents", - "displayTitle": "Repository permissions for \"Contents\"", - "permissions": [ - { - "category": "markdown", - "slug": "render-a-markdown-document", - "subcategory": "markdown", - "verb": "post", - "requestPath": "/markdown", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "list-repository-activities", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/activity", - "additional-permissions": false, - "access": "read" - }, - { - "category": "branches", - "slug": "list-branches", - "subcategory": "branches", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches", - "additional-permissions": false, - "access": "read" - }, - { - "category": "branches", - "slug": "get-a-branch", - "subcategory": "branches", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "branches", - "slug": "rename-a-branch", - "subcategory": "branches", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "list-codeowners-errors", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/codeowners/errors", - "additional-permissions": false, - "access": "read" - }, - { - "category": "commits", - "slug": "update-a-commit-comment", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "commits", - "slug": "delete-a-commit-comment", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "reactions", - "slug": "create-reaction-for-a-commit-comment", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "additional-permissions": false, - "access": "write" - }, - { - "category": "reactions", - "slug": "delete-a-commit-comment-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "commits", - "slug": "list-commits", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits", - "additional-permissions": false, - "access": "read" - }, - { - "category": "commits", - "slug": "list-branches-for-head-commit", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", - "additional-permissions": false, - "access": "read" - }, - { - "category": "commits", - "slug": "create-a-commit-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "additional-permissions": false, - "access": "read" - }, - { - "category": "commits", - "slug": "get-a-commit", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "commits", - "slug": "compare-two-commits", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "get-repository-content", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "create-or-update-file-contents", - "subcategory": "contents", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "repos", - "slug": "create-or-update-file-contents", - "subcategory": "contents", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "repos", - "slug": "delete-a-file", - "subcategory": "contents", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "repos", - "slug": "delete-a-file", - "subcategory": "contents", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "dependency-graph", - "slug": "get-a-diff-of-the-dependencies-between-commits", - "subcategory": "dependency-review", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "dependency-graph", - "slug": "export-a-software-bill-of-materials-sbom-for-a-repository", - "subcategory": "sboms", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependency-graph/sbom", - "additional-permissions": false, - "access": "read" - }, - { - "category": "dependency-graph", - "slug": "create-a-snapshot-of-dependencies-for-a-repository", - "subcategory": "dependency-submission", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/dependency-graph/snapshots", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "create-a-repository-dispatch-event", - "subcategory": "repos", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/dispatches", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "create-a-fork", - "subcategory": "forks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/forks", - "additional-permissions": true, - "access": "read" - }, - { - "category": "git", - "slug": "create-a-blob", - "subcategory": "blobs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/blobs", - "additional-permissions": false, - "access": "write" - }, - { - "category": "git", - "slug": "get-a-blob", - "subcategory": "blobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/blobs/{file_sha}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "git", - "slug": "create-a-commit", - "subcategory": "commits", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/commits", - "additional-permissions": false, - "access": "write" - }, - { - "category": "git", - "slug": "get-a-commit-object", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "git", - "slug": "list-matching-references", - "subcategory": "refs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/matching-refs/{ref}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "git", - "slug": "get-a-reference", - "subcategory": "refs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/ref/{ref}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "git", - "slug": "create-a-reference", - "subcategory": "refs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/refs", - "additional-permissions": true, - "access": "write" - }, - { - "category": "git", - "slug": "create-a-reference", - "subcategory": "refs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/refs", - "additional-permissions": true, - "access": "write" - }, - { - "category": "git", - "slug": "update-a-reference", - "subcategory": "refs", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "git", - "slug": "update-a-reference", - "subcategory": "refs", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "git", - "slug": "delete-a-reference", - "subcategory": "refs", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "git", - "slug": "create-a-tag-object", - "subcategory": "tags", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/tags", - "additional-permissions": false, - "access": "write" - }, - { - "category": "git", - "slug": "get-a-tag", - "subcategory": "tags", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/tags/{tag_sha}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "git", - "slug": "create-a-tree", - "subcategory": "trees", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/trees", - "additional-permissions": false, - "access": "write" - }, - { - "category": "git", - "slug": "get-a-tree", - "subcategory": "trees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/trees/{tree_sha}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "branches", - "slug": "sync-a-fork-branch-with-the-upstream-repository", - "subcategory": "branches", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merge-upstream", - "additional-permissions": false, - "access": "write" - }, - { - "category": "branches", - "slug": "merge-a-branch", - "subcategory": "branches", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merges", - "additional-permissions": false, - "access": "write" - }, - { - "category": "pulls", - "slug": "get-a-pull-request", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "pulls", - "slug": "merge-a-pull-request", - "subcategory": "pulls", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "get-a-repository-readme", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/readme", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "get-a-repository-readme-for-a-directory", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/readme/{dir}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "releases", - "slug": "list-releases", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases", - "additional-permissions": false, - "access": "read" - }, - { - "category": "releases", - "slug": "create-a-release", - "subcategory": "releases", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases", - "additional-permissions": true, - "access": "write" - }, - { - "category": "releases", - "slug": "create-a-release", - "subcategory": "releases", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases", - "additional-permissions": true, - "access": "write" - }, - { - "category": "releases", - "slug": "get-a-release-asset", - "subcategory": "assets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "releases", - "slug": "update-a-release-asset", - "subcategory": "assets", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "releases", - "slug": "delete-a-release-asset", - "subcategory": "assets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "releases", - "slug": "generate-release-notes-content-for-a-release", - "subcategory": "releases", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases/generate-notes", - "additional-permissions": false, - "access": "write" - }, - { - "category": "releases", - "slug": "get-the-latest-release", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/latest", - "additional-permissions": false, - "access": "read" - }, - { - "category": "releases", - "slug": "get-a-release-by-tag-name", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "releases", - "slug": "get-a-release", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "releases", - "slug": "update-a-release", - "subcategory": "releases", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "releases", - "slug": "delete-a-release", - "subcategory": "releases", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "releases", - "slug": "list-release-assets", - "subcategory": "assets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "download-a-repository-archive-tar", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/tarball/{ref}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "download-a-repository-archive-zip", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/zipball/{ref}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "create-a-repository-using-a-template", - "subcategory": "repos", - "verb": "post", - "requestPath": "/repos/{template_owner}/{template_repo}/generate", - "additional-permissions": true, - "access": "read" - } - ] - }, - "repository_custom_properties": { - "title": "Custom properties", - "displayTitle": "Repository permissions for \"Custom properties\"", - "permissions": [ - { - "category": "repos", - "slug": "create-or-update-custom-property-values-for-a-repository", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/properties/values", - "additional-permissions": false, - "access": "write" - } - ] - }, - "vulnerability_alerts": { - "title": "Dependabot alerts", - "displayTitle": "Repository permissions for \"Dependabot alerts\"", - "permissions": [ - { - "category": "dependabot", - "slug": "list-dependabot-alerts-for-an-organization", - "subcategory": "alerts", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/alerts", - "additional-permissions": false, - "access": "read" - }, - { - "category": "dependabot", - "slug": "list-dependabot-alerts-for-a-repository", - "subcategory": "alerts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/alerts", - "additional-permissions": false, - "access": "read" - }, - { - "category": "dependabot", - "slug": "get-a-dependabot-alert", - "subcategory": "alerts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "dependabot", - "slug": "update-a-dependabot-alert", - "subcategory": "alerts", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}", - "additional-permissions": false, - "access": "write" - } - ] - }, - "dependabot_secrets": { - "title": "Dependabot secrets", - "displayTitle": "Repository permissions for \"Dependabot secrets\"", - "permissions": [ - { - "category": "dependabot", - "slug": "list-repository-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets", - "additional-permissions": false, - "access": "read" - }, - { - "category": "dependabot", - "slug": "get-a-repository-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/public-key", - "additional-permissions": false, - "access": "read" - }, - { - "category": "dependabot", - "slug": "get-a-repository-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "dependabot", - "slug": "create-or-update-a-repository-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "dependabot", - "slug": "delete-a-repository-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", - "additional-permissions": false, - "access": "write" - } - ] - }, - "deployments": { - "title": "Deployments", - "displayTitle": "Repository permissions for \"Deployments\"", - "permissions": [ - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": false, - "access": "write" - }, - { - "category": "deployments", - "slug": "list-deployments", - "subcategory": "deployments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments", - "additional-permissions": false, - "access": "read" - }, - { - "category": "deployments", - "slug": "create-a-deployment", - "subcategory": "deployments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/deployments", - "additional-permissions": false, - "access": "write" - }, - { - "category": "deployments", - "slug": "get-a-deployment", - "subcategory": "deployments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "deployments", - "slug": "delete-a-deployment", - "subcategory": "deployments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "deployments", - "slug": "list-deployment-statuses", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "additional-permissions": false, - "access": "read" - }, - { - "category": "deployments", - "slug": "create-a-deployment-status", - "subcategory": "statuses", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "additional-permissions": false, - "access": "write" - }, - { - "category": "deployments", - "slug": "get-a-deployment-status", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", - "additional-permissions": false, - "access": "read" - } - ] - }, - "environments": { - "title": "Environments", - "displayTitle": "Repository permissions for \"Environments\"", - "permissions": [ - { - "category": "actions", - "slug": "list-environment-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "get-an-environment-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "get-an-environment-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "create-or-update-an-environment-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "delete-an-environment-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "list-environment-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "create-an-environment-variable", - "subcategory": "variables", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "get-an-environment-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "update-an-environment-variable", - "subcategory": "variables", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "delete-an-environment-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", - "additional-permissions": false, - "access": "write" - } - ] - }, - "issues": { - "title": "Issues", - "displayTitle": "Repository permissions for \"Issues\"", - "permissions": [ - { - "category": "issues", - "slug": "list-assignees", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/assignees", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "check-if-a-user-can-be-assigned", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/assignees/{assignee}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "list-repository-issues", - "subcategory": "issues", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues", - "additional-permissions": false, - "access": "read" - }, - { - "category": "issues", - "slug": "create-an-issue", - "subcategory": "issues", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues", - "additional-permissions": false, - "access": "write" - }, - { - "category": "issues", - "slug": "list-issue-comments-for-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "get-an-issue-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "update-an-issue-comment", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "delete-an-issue-comment", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "reactions", - "slug": "list-reactions-for-an-issue-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "additional-permissions": false, - "access": "read" - }, - { - "category": "reactions", - "slug": "create-reaction-for-an-issue-comment", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "additional-permissions": false, - "access": "write" - }, - { - "category": "reactions", - "slug": "delete-an-issue-comment-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "issues", - "slug": "list-issue-events-for-a-repository", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/events", - "additional-permissions": false, - "access": "read" - }, - { - "category": "issues", - "slug": "get-an-issue-event", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "get-an-issue", - "subcategory": "issues", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "issues", - "slug": "update-an-issue", - "subcategory": "issues", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "add-assignees-to-an-issue", - "subcategory": "assignees", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "remove-assignees-from-an-issue", - "subcategory": "assignees", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "check-if-a-user-can-be-assigned-to-a-issue", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "list-issue-comments", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "create-an-issue-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "list-issue-events", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "list-issue-field-values-for-an-issue", - "subcategory": "issue-field-values", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values", - "additional-permissions": false, - "access": "read" - }, - { - "category": "issues", - "slug": "list-labels-for-an-issue", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "add-labels-to-an-issue", - "subcategory": "labels", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "set-labels-for-an-issue", - "subcategory": "labels", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "remove-all-labels-from-an-issue", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "remove-a-label-from-an-issue", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "lock-an-issue", - "subcategory": "issues", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "unlock-an-issue", - "subcategory": "issues", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "additional-permissions": true, - "access": "write" - }, - { - "category": "reactions", - "slug": "list-reactions-for-an-issue", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "additional-permissions": false, - "access": "read" - }, - { - "category": "reactions", - "slug": "create-reaction-for-an-issue", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "additional-permissions": false, - "access": "write" - }, - { - "category": "reactions", - "slug": "delete-an-issue-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "issues", - "slug": "list-timeline-events-for-an-issue", - "subcategory": "timeline", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "list-labels-for-a-repository", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/labels", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "create-a-label", - "subcategory": "labels", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/labels", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "get-a-label", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "update-a-label", - "subcategory": "labels", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "delete-a-label", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "list-milestones", - "subcategory": "milestones", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "create-a-milestone", - "subcategory": "milestones", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/milestones", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "get-a-milestone", - "subcategory": "milestones", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "update-a-milestone", - "subcategory": "milestones", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "delete-a-milestone", - "subcategory": "milestones", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "list-labels-for-issues-in-a-milestone", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", - "additional-permissions": true, - "access": "read" - } - ] - }, - "metadata": { - "title": "Metadata", - "displayTitle": "Repository permissions for \"Metadata\"", - "permissions": [ - { - "category": "repos", - "slug": "list-organization-repositories", - "subcategory": "repos", - "verb": "get", - "requestPath": "/orgs/{org}/repos", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "get-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "collaborators", - "slug": "list-repository-collaborators", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators", - "additional-permissions": false, - "access": "read" - }, - { - "category": "collaborators", - "slug": "check-if-a-user-is-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "collaborators", - "slug": "get-repository-permissions-for-a-user", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "additional-permissions": false, - "access": "read" - }, - { - "category": "commits", - "slug": "list-commit-comments-for-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments", - "additional-permissions": false, - "access": "read" - }, - { - "category": "commits", - "slug": "get-a-commit-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "reactions", - "slug": "list-reactions-for-a-commit-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "additional-permissions": false, - "access": "read" - }, - { - "category": "commits", - "slug": "list-commit-comments", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "list-repository-contributors", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/contributors", - "additional-permissions": false, - "access": "read" - }, - { - "category": "activity", - "slug": "list-repository-events", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/events", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "list-forks", - "subcategory": "forks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/forks", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "list-repository-languages", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/languages", - "additional-permissions": false, - "access": "read" - }, - { - "category": "licenses", - "slug": "get-the-license-for-a-repository", - "subcategory": "licenses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/license", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "get-all-custom-property-values-for-a-repository", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/properties/values", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "get-rules-for-a-branch", - "subcategory": "rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rules/branches/{branch}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "get-all-repository-rulesets", - "subcategory": "rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "get-a-repository-ruleset", - "subcategory": "rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets/{ruleset_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "activity", - "slug": "list-stargazers", - "subcategory": "starring", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stargazers", - "additional-permissions": false, - "access": "read" - }, - { - "category": "metrics", - "slug": "get-the-weekly-commit-activity", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/code_frequency", - "additional-permissions": false, - "access": "read" - }, - { - "category": "metrics", - "slug": "get-the-last-year-of-commit-activity", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/commit_activity", - "additional-permissions": false, - "access": "read" - }, - { - "category": "metrics", - "slug": "get-all-contributor-commit-activity", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/contributors", - "additional-permissions": false, - "access": "read" - }, - { - "category": "metrics", - "slug": "get-the-weekly-commit-count", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/participation", - "additional-permissions": false, - "access": "read" - }, - { - "category": "metrics", - "slug": "get-the-hourly-commit-count-for-each-day", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/punch_card", - "additional-permissions": false, - "access": "read" - }, - { - "category": "activity", - "slug": "list-watchers", - "subcategory": "watching", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/subscribers", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "list-repository-tags", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/tags", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "get-all-repository-topics", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/topics", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "list-public-repositories", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repositories", - "additional-permissions": false, - "access": "read" - }, - { - "category": "search", - "slug": "search-labels", - "subcategory": "search", - "verb": "get", - "requestPath": "/search/labels", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "list-repositories-for-the-authenticated-user", - "subcategory": "repos", - "verb": "get", - "requestPath": "/user/repos", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "list-repositories-for-a-user", - "subcategory": "repos", - "verb": "get", - "requestPath": "/users/{username}/repos", - "additional-permissions": false, - "access": "read" - } - ] - }, - "pages": { - "title": "Pages", - "displayTitle": "Repository permissions for \"Pages\"", - "permissions": [ - { - "category": "pages", - "slug": "get-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages", - "additional-permissions": false, - "access": "read" - }, - { - "category": "pages", - "slug": "create-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages", - "additional-permissions": true, - "access": "write" - }, - { - "category": "pages", - "slug": "update-information-about-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pages", - "additional-permissions": true, - "access": "write" - }, - { - "category": "pages", - "slug": "delete-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pages", - "additional-permissions": true, - "access": "write" - }, - { - "category": "pages", - "slug": "list-github-enterprise-server-pages-builds", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/builds", - "additional-permissions": false, - "access": "read" - }, - { - "category": "pages", - "slug": "request-a-github-enterprise-server-pages-build", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/builds", - "additional-permissions": false, - "access": "write" - }, - { - "category": "pages", - "slug": "get-latest-pages-build", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/builds/latest", - "additional-permissions": false, - "access": "read" - }, - { - "category": "pages", - "slug": "get-github-enterprise-server-pages-build", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/builds/{build_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "pages", - "slug": "create-a-github-pages-deployment", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployments", - "additional-permissions": false, - "access": "write" - }, - { - "category": "pages", - "slug": "get-the-status-of-a-github-pages-deployment", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "pages", - "slug": "cancel-a-github-pages-deployment", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel", - "additional-permissions": false, - "access": "write" - } - ] - }, - "pull_requests": { - "title": "Pull requests", - "displayTitle": "Repository permissions for \"Pull requests\"", - "permissions": [ - { - "category": "issues", - "slug": "list-assignees", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/assignees", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "check-if-a-user-can-be-assigned", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/assignees/{assignee}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "commits", - "slug": "list-pull-requests-associated-with-a-commit", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", - "additional-permissions": false, - "access": "read" - }, - { - "category": "issues", - "slug": "list-issue-comments-for-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "get-an-issue-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "update-an-issue-comment", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "delete-an-issue-comment", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "get-an-issue-event", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "update-an-issue", - "subcategory": "issues", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "add-assignees-to-an-issue", - "subcategory": "assignees", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "remove-assignees-from-an-issue", - "subcategory": "assignees", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "check-if-a-user-can-be-assigned-to-a-issue", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "list-issue-comments", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "create-an-issue-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "list-issue-events", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "list-labels-for-an-issue", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "add-labels-to-an-issue", - "subcategory": "labels", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "set-labels-for-an-issue", - "subcategory": "labels", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "remove-all-labels-from-an-issue", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "remove-a-label-from-an-issue", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "lock-an-issue", - "subcategory": "issues", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "unlock-an-issue", - "subcategory": "issues", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "list-timeline-events-for-an-issue", - "subcategory": "timeline", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "list-labels-for-a-repository", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/labels", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "create-a-label", - "subcategory": "labels", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/labels", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "get-a-label", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "update-a-label", - "subcategory": "labels", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "delete-a-label", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "list-milestones", - "subcategory": "milestones", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "create-a-milestone", - "subcategory": "milestones", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/milestones", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "get-a-milestone", - "subcategory": "milestones", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "issues", - "slug": "update-a-milestone", - "subcategory": "milestones", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "delete-a-milestone", - "subcategory": "milestones", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "issues", - "slug": "list-labels-for-issues-in-a-milestone", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", - "additional-permissions": true, - "access": "read" - }, - { - "category": "pulls", - "slug": "list-pull-requests", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls", - "additional-permissions": false, - "access": "read" - }, - { - "category": "pulls", - "slug": "create-a-pull-request", - "subcategory": "pulls", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls", - "additional-permissions": false, - "access": "write" - }, - { - "category": "pulls", - "slug": "list-review-comments-in-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/comments", - "additional-permissions": false, - "access": "read" - }, - { - "category": "pulls", - "slug": "get-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "pulls", - "slug": "update-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "pulls", - "slug": "delete-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "reactions", - "slug": "list-reactions-for-a-pull-request-review-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "additional-permissions": false, - "access": "read" - }, - { - "category": "reactions", - "slug": "create-reaction-for-a-pull-request-review-comment", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "additional-permissions": false, - "access": "write" - }, - { - "category": "reactions", - "slug": "delete-a-pull-request-comment-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "pulls", - "slug": "get-a-pull-request", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "pulls", - "slug": "update-a-pull-request", - "subcategory": "pulls", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "pulls", - "slug": "list-review-comments-on-a-pull-request", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "additional-permissions": false, - "access": "read" - }, - { - "category": "pulls", - "slug": "create-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "additional-permissions": false, - "access": "write" - }, - { - "category": "pulls", - "slug": "create-a-reply-for-a-review-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", - "additional-permissions": false, - "access": "write" - }, - { - "category": "pulls", - "slug": "list-commits-on-a-pull-request", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", - "additional-permissions": false, - "access": "read" - }, - { - "category": "pulls", - "slug": "list-pull-requests-files", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/files", - "additional-permissions": false, - "access": "read" - }, - { - "category": "pulls", - "slug": "check-if-a-pull-request-has-been-merged", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "additional-permissions": false, - "access": "read" - }, - { - "category": "pulls", - "slug": "get-all-requested-reviewers-for-a-pull-request", - "subcategory": "review-requests", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "additional-permissions": false, - "access": "read" - }, - { - "category": "pulls", - "slug": "request-reviewers-for-a-pull-request", - "subcategory": "review-requests", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "additional-permissions": false, - "access": "write" - }, - { - "category": "pulls", - "slug": "remove-requested-reviewers-from-a-pull-request", - "subcategory": "review-requests", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "additional-permissions": false, - "access": "write" - }, - { - "category": "pulls", - "slug": "list-reviews-for-a-pull-request", - "subcategory": "reviews", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "additional-permissions": false, - "access": "read" - }, - { - "category": "pulls", - "slug": "create-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "additional-permissions": false, - "access": "write" - }, - { - "category": "pulls", - "slug": "get-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "pulls", - "slug": "update-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "pulls", - "slug": "delete-a-pending-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "pulls", - "slug": "list-comments-for-a-pull-request-review", - "subcategory": "reviews", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", - "additional-permissions": false, - "access": "read" - }, - { - "category": "pulls", - "slug": "dismiss-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", - "additional-permissions": false, - "access": "write" - }, - { - "category": "pulls", - "slug": "submit-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", - "additional-permissions": false, - "access": "write" - }, - { - "category": "pulls", - "slug": "update-a-pull-request-branch", - "subcategory": "pulls", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", - "additional-permissions": false, - "access": "write" - } - ] - }, - "repository_pre_receive_hooks": { - "title": "Repository pre-receive hooks", - "displayTitle": "Repository permissions for \"Repository pre-receive hooks\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-pre-receive-hooks-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", - "additional-permissions": false, - "access": "read" - }, - { - "category": "enterprise-admin", - "slug": "get-a-pre-receive-hook-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "enterprise-admin", - "slug": "update-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "enterprise-admin", - "slug": "remove-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "write" - } - ] - }, - "secret_scanning_alerts": { - "title": "Secret scanning alerts", - "displayTitle": "Repository permissions for \"Secret scanning alerts\"", - "permissions": [ - { - "category": "secret-scanning", - "slug": "list-secret-scanning-alerts-for-an-organization", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/orgs/{org}/secret-scanning/alerts", - "additional-permissions": false, - "access": "read" - }, - { - "category": "secret-scanning", - "slug": "list-secret-scanning-alerts-for-a-repository", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts", - "additional-permissions": false, - "access": "read" - }, - { - "category": "secret-scanning", - "slug": "get-a-secret-scanning-alert", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "secret-scanning", - "slug": "update-a-secret-scanning-alert", - "subcategory": "secret-scanning", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "secret-scanning", - "slug": "list-locations-for-a-secret-scanning-alert", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations", - "additional-permissions": false, - "access": "read" - } - ] - }, - "secrets": { - "title": "Secrets", - "displayTitle": "Repository permissions for \"Secrets\"", - "permissions": [ - { - "category": "actions", - "slug": "list-repository-organization-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/organization-secrets", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "list-repository-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "get-a-repository-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/public-key", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "get-a-repository-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "create-or-update-a-repository-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "delete-a-repository-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "additional-permissions": false, - "access": "write" - } - ] - }, - "actions_variables": { - "title": "Variables", - "displayTitle": "Repository permissions for \"Variables\"", - "permissions": [ - { - "category": "actions", - "slug": "list-repository-organization-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/organization-variables", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "list-repository-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/variables", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "create-a-repository-variable", - "subcategory": "variables", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/variables", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "get-a-repository-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "actions", - "slug": "update-a-repository-variable", - "subcategory": "variables", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "actions", - "slug": "delete-a-repository-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}", - "additional-permissions": false, - "access": "write" - } - ] - }, - "repository_hooks": { - "title": "Webhooks", - "displayTitle": "Repository permissions for \"Webhooks\"", - "permissions": [ - { - "category": "repos", - "slug": "list-repository-webhooks", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "create-a-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "get-a-repository-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "update-a-repository-webhook", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "delete-a-repository-webhook", - "subcategory": "webhooks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "get-a-webhook-configuration-for-a-repository", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "update-a-webhook-configuration-for-a-repository", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "list-deliveries-for-a-repository-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "get-a-delivery-for-a-repository-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "redeliver-a-delivery-for-a-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", - "additional-permissions": false, - "access": "write" - }, - { - "category": "repos", - "slug": "ping-a-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", - "additional-permissions": false, - "access": "read" - }, - { - "category": "repos", - "slug": "test-the-push-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", - "additional-permissions": false, - "access": "read" - } - ] - }, - "workflows": { - "title": "Workflows", - "displayTitle": "Repository permissions for \"Workflows\"", - "permissions": [ - { - "category": "repos", - "slug": "create-or-update-file-contents", - "subcategory": "contents", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "repos", - "slug": "delete-a-file", - "subcategory": "contents", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "git", - "slug": "create-a-reference", - "subcategory": "refs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/refs", - "additional-permissions": true, - "access": "write" - }, - { - "category": "git", - "slug": "update-a-reference", - "subcategory": "refs", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "releases", - "slug": "create-a-release", - "subcategory": "releases", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases", - "additional-permissions": true, - "access": "write" - } - ] - }, - "emails": { - "title": "Email addresses", - "displayTitle": "User permissions for \"Email addresses\"", - "permissions": [ - { - "category": "users", - "slug": "list-email-addresses-for-the-authenticated-user", - "subcategory": "emails", - "verb": "get", - "requestPath": "/user/emails", - "additional-permissions": false, - "access": "read" - }, - { - "category": "users", - "slug": "add-an-email-address-for-the-authenticated-user", - "subcategory": "emails", - "verb": "post", - "requestPath": "/user/emails", - "additional-permissions": false, - "access": "write" - }, - { - "category": "users", - "slug": "delete-an-email-address-for-the-authenticated-user", - "subcategory": "emails", - "verb": "delete", - "requestPath": "/user/emails", - "additional-permissions": false, - "access": "write" - }, - { - "category": "users", - "slug": "list-public-email-addresses-for-the-authenticated-user", - "subcategory": "emails", - "verb": "get", - "requestPath": "/user/public_emails", - "additional-permissions": false, - "access": "read" - } - ] - }, - "followers": { - "title": "Followers", - "displayTitle": "User permissions for \"Followers\"", - "permissions": [ - { - "category": "users", - "slug": "list-followers-of-the-authenticated-user", - "subcategory": "followers", - "verb": "get", - "requestPath": "/user/followers", - "additional-permissions": false, - "access": "read" - }, - { - "category": "users", - "slug": "list-the-people-the-authenticated-user-follows", - "subcategory": "followers", - "verb": "get", - "requestPath": "/user/following", - "additional-permissions": false, - "access": "read" - }, - { - "category": "users", - "slug": "check-if-a-person-is-followed-by-the-authenticated-user", - "subcategory": "followers", - "verb": "get", - "requestPath": "/user/following/{username}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "users", - "slug": "follow-a-user", - "subcategory": "followers", - "verb": "put", - "requestPath": "/user/following/{username}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "users", - "slug": "unfollow-a-user", - "subcategory": "followers", - "verb": "delete", - "requestPath": "/user/following/{username}", - "additional-permissions": false, - "access": "write" - } - ] - }, - "gpg_keys": { - "title": "GPG keys", - "displayTitle": "User permissions for \"GPG keys\"", - "permissions": [ - { - "category": "users", - "slug": "list-gpg-keys-for-the-authenticated-user", - "subcategory": "gpg-keys", - "verb": "get", - "requestPath": "/user/gpg_keys", - "additional-permissions": false, - "access": "read" - }, - { - "category": "users", - "slug": "create-a-gpg-key-for-the-authenticated-user", - "subcategory": "gpg-keys", - "verb": "post", - "requestPath": "/user/gpg_keys", - "additional-permissions": false, - "access": "write" - }, - { - "category": "users", - "slug": "get-a-gpg-key-for-the-authenticated-user", - "subcategory": "gpg-keys", - "verb": "get", - "requestPath": "/user/gpg_keys/{gpg_key_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "users", - "slug": "delete-a-gpg-key-for-the-authenticated-user", - "subcategory": "gpg-keys", - "verb": "delete", - "requestPath": "/user/gpg_keys/{gpg_key_id}", - "additional-permissions": false, - "access": "write" - } - ] - }, - "gists": { - "title": "Gists", - "displayTitle": "User permissions for \"Gists\"", - "permissions": [ - { - "category": "gists", - "slug": "create-a-gist", - "subcategory": "gists", - "verb": "post", - "requestPath": "/gists", - "additional-permissions": false, - "access": "write" - }, - { - "category": "gists", - "slug": "update-a-gist", - "subcategory": "gists", - "verb": "patch", - "requestPath": "/gists/{gist_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "gists", - "slug": "delete-a-gist", - "subcategory": "gists", - "verb": "delete", - "requestPath": "/gists/{gist_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "gists", - "slug": "create-a-gist-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/gists/{gist_id}/comments", - "additional-permissions": false, - "access": "write" - }, - { - "category": "gists", - "slug": "update-a-gist-comment", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "gists", - "slug": "delete-a-gist-comment", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "gists", - "slug": "fork-a-gist", - "subcategory": "gists", - "verb": "post", - "requestPath": "/gists/{gist_id}/forks", - "additional-permissions": false, - "access": "write" - }, - { - "category": "gists", - "slug": "star-a-gist", - "subcategory": "gists", - "verb": "put", - "requestPath": "/gists/{gist_id}/star", - "additional-permissions": false, - "access": "write" - }, - { - "category": "gists", - "slug": "unstar-a-gist", - "subcategory": "gists", - "verb": "delete", - "requestPath": "/gists/{gist_id}/star", - "additional-permissions": false, - "access": "write" - } - ] - }, - "keys": { - "title": "Git SSH keys", - "displayTitle": "User permissions for \"Git SSH keys\"", - "permissions": [ - { - "category": "users", - "slug": "list-public-ssh-keys-for-the-authenticated-user", - "subcategory": "keys", - "verb": "get", - "requestPath": "/user/keys", - "additional-permissions": false, - "access": "read" - }, - { - "category": "users", - "slug": "create-a-public-ssh-key-for-the-authenticated-user", - "subcategory": "keys", - "verb": "post", - "requestPath": "/user/keys", - "additional-permissions": false, - "access": "write" - }, - { - "category": "users", - "slug": "get-a-public-ssh-key-for-the-authenticated-user", - "subcategory": "keys", - "verb": "get", - "requestPath": "/user/keys/{key_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "users", - "slug": "delete-a-public-ssh-key-for-the-authenticated-user", - "subcategory": "keys", - "verb": "delete", - "requestPath": "/user/keys/{key_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "users", - "slug": "list-public-keys-for-a-user", - "subcategory": "keys", - "verb": "get", - "requestPath": "/users/{username}/keys", - "additional-permissions": false, - "access": "read" - } - ] - }, - "private_repository_invitations": { - "title": "Private repository invitations", - "displayTitle": "User permissions for \"Private repository invitations\"", - "permissions": [ - { - "category": "collaborators", - "slug": "list-repository-invitations", - "subcategory": "invitations", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/invitations", - "additional-permissions": true, - "access": "read" - } - ] - }, - "profile": { - "title": "Profile", - "displayTitle": "User permissions for \"Profile\"", - "permissions": [ - { - "category": "users", - "slug": "update-the-authenticated-user", - "subcategory": "users", - "verb": "patch", - "requestPath": "/user", - "additional-permissions": false, - "access": "write" - }, - { - "category": "users", - "slug": "add-social-accounts-for-the-authenticated-user", - "subcategory": "social-accounts", - "verb": "post", - "requestPath": "/user/social_accounts", - "additional-permissions": false, - "access": "write" - }, - { - "category": "users", - "slug": "delete-social-accounts-for-the-authenticated-user", - "subcategory": "social-accounts", - "verb": "delete", - "requestPath": "/user/social_accounts", - "additional-permissions": false, - "access": "write" - } - ] - }, - "git_signing_ssh_public_keys": { - "title": "SSH signing keys", - "displayTitle": "User permissions for \"SSH signing keys\"", - "permissions": [ - { - "category": "users", - "slug": "list-ssh-signing-keys-for-the-authenticated-user", - "subcategory": "ssh-signing-keys", - "verb": "get", - "requestPath": "/user/ssh_signing_keys", - "additional-permissions": false, - "access": "read" - }, - { - "category": "users", - "slug": "create-a-ssh-signing-key-for-the-authenticated-user", - "subcategory": "ssh-signing-keys", - "verb": "post", - "requestPath": "/user/ssh_signing_keys", - "additional-permissions": false, - "access": "write" - }, - { - "category": "users", - "slug": "get-an-ssh-signing-key-for-the-authenticated-user", - "subcategory": "ssh-signing-keys", - "verb": "get", - "requestPath": "/user/ssh_signing_keys/{ssh_signing_key_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "users", - "slug": "delete-an-ssh-signing-key-for-the-authenticated-user", - "subcategory": "ssh-signing-keys", - "verb": "delete", - "requestPath": "/user/ssh_signing_keys/{ssh_signing_key_id}", - "additional-permissions": false, - "access": "write" - } - ] - }, - "starring": { - "title": "Starring", - "displayTitle": "User permissions for \"Starring\"", - "permissions": [ - { - "category": "activity", - "slug": "list-repositories-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred", - "additional-permissions": false, - "access": "read" - }, - { - "category": "activity", - "slug": "check-if-a-repository-is-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "activity", - "slug": "star-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "put", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "activity", - "slug": "unstar-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "delete", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "write" - }, - { - "category": "activity", - "slug": "list-repositories-starred-by-a-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/users/{username}/starred", - "additional-permissions": false, - "access": "read" - } - ] - }, - "watching": { - "title": "Watching", - "displayTitle": "User permissions for \"Watching\"", - "permissions": [ - { - "category": "activity", - "slug": "list-repositories-watched-by-the-authenticated-user", - "subcategory": "watching", - "verb": "get", - "requestPath": "/user/subscriptions", - "additional-permissions": false, - "access": "read" - }, - { - "category": "activity", - "slug": "list-repositories-watched-by-a-user", - "subcategory": "watching", - "verb": "get", - "requestPath": "/users/{username}/subscriptions", - "additional-permissions": false, - "access": "read" - } - ] - } -} \ No newline at end of file diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json deleted file mode 100644 index b177f5307c79..000000000000 --- a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json +++ /dev/null @@ -1,3672 +0,0 @@ -{ - "actions": [ - { - "slug": "get-github-actions-cache-usage-for-an-organization", - "subcategory": "cache", - "verb": "get", - "requestPath": "/orgs/{org}/actions/cache/usage" - }, - { - "slug": "list-repositories-with-github-actions-cache-usage-for-an-organization", - "subcategory": "cache", - "verb": "get", - "requestPath": "/orgs/{org}/actions/cache/usage-by-repository" - }, - { - "slug": "get-the-customization-template-for-an-oidc-subject-claim-for-an-organization", - "subcategory": "oidc", - "verb": "get", - "requestPath": "/orgs/{org}/actions/oidc/customization/sub" - }, - { - "slug": "set-the-customization-template-for-an-oidc-subject-claim-for-an-organization", - "subcategory": "oidc", - "verb": "put", - "requestPath": "/orgs/{org}/actions/oidc/customization/sub" - }, - { - "slug": "get-github-actions-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions" - }, - { - "slug": "set-github-actions-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions" - }, - { - "slug": "list-selected-repositories-enabled-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/repositories" - }, - { - "slug": "set-selected-repositories-enabled-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories" - }, - { - "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}" - }, - { - "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}" - }, - { - "slug": "get-allowed-actions-for-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/selected-actions" - }, - { - "slug": "set-allowed-actions-for-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/selected-actions" - }, - { - "slug": "get-default-workflow-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/workflow" - }, - { - "slug": "set-default-workflow-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/workflow" - }, - { - "slug": "list-self-hosted-runner-groups-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups" - }, - { - "slug": "create-a-self-hosted-runner-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runner-groups" - }, - { - "slug": "get-a-self-hosted-runner-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}" - }, - { - "slug": "update-a-self-hosted-runner-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "patch", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}" - }, - { - "slug": "delete-a-self-hosted-runner-group-from-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}" - }, - { - "slug": "list-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories" - }, - { - "slug": "set-repository-access-for-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories" - }, - { - "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}" - }, - { - "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}" - }, - { - "slug": "list-self-hosted-runners-in-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners" - }, - { - "slug": "set-self-hosted-runners-in-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners" - }, - { - "slug": "add-a-self-hosted-runner-to-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}" - }, - { - "slug": "remove-a-self-hosted-runner-from-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}" - }, - { - "slug": "list-self-hosted-runners-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners" - }, - { - "slug": "list-runner-applications-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/downloads" - }, - { - "slug": "create-configuration-for-a-just-in-time-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/generate-jitconfig" - }, - { - "slug": "create-a-registration-token-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/registration-token" - }, - { - "slug": "create-a-remove-token-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/remove-token" - }, - { - "slug": "get-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}" - }, - { - "slug": "delete-a-self-hosted-runner-from-an-organization", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}" - }, - { - "slug": "list-labels-for-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels" - }, - { - "slug": "add-custom-labels-to-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels" - }, - { - "slug": "set-custom-labels-for-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels" - }, - { - "slug": "remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels" - }, - { - "slug": "remove-a-custom-label-from-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels/{name}" - }, - { - "slug": "list-organization-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets" - }, - { - "slug": "get-an-organization-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/public-key" - }, - { - "slug": "get-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}" - }, - { - "slug": "create-or-update-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}" - }, - { - "slug": "delete-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}" - }, - { - "slug": "list-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories" - }, - { - "slug": "set-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories" - }, - { - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}" - }, - { - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}" - }, - { - "slug": "list-organization-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables" - }, - { - "slug": "create-an-organization-variable", - "subcategory": "variables", - "verb": "post", - "requestPath": "/orgs/{org}/actions/variables" - }, - { - "slug": "get-an-organization-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables/{name}" - }, - { - "slug": "update-an-organization-variable", - "subcategory": "variables", - "verb": "patch", - "requestPath": "/orgs/{org}/actions/variables/{name}" - }, - { - "slug": "delete-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}" - }, - { - "slug": "list-selected-repositories-for-an-organization-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories" - }, - { - "slug": "set-selected-repositories-for-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories" - }, - { - "slug": "add-selected-repository-to-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}" - }, - { - "slug": "remove-selected-repository-from-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}" - }, - { - "slug": "list-artifacts-for-a-repository", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts" - }, - { - "slug": "get-an-artifact", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}" - }, - { - "slug": "delete-an-artifact", - "subcategory": "artifacts", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}" - }, - { - "slug": "download-an-artifact", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}" - }, - { - "slug": "get-github-actions-cache-usage-for-a-repository", - "subcategory": "cache", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/cache/usage" - }, - { - "slug": "get-github-actions-cache-usage-policy-for-a-repository", - "subcategory": "cache", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/cache/usage-policy" - }, - { - "slug": "set-github-actions-cache-usage-policy-for-a-repository", - "subcategory": "cache", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/actions/cache/usage-policy" - }, - { - "slug": "list-github-actions-caches-for-a-repository", - "subcategory": "cache", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/caches" - }, - { - "slug": "delete-github-actions-caches-for-a-repository-using-a-cache-key", - "subcategory": "cache", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/caches" - }, - { - "slug": "delete-a-github-actions-cache-for-a-repository-using-a-cache-id", - "subcategory": "cache", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/caches/{cache_id}" - }, - { - "slug": "get-a-job-for-a-workflow-run", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}" - }, - { - "slug": "download-job-logs-for-a-workflow-run", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs" - }, - { - "slug": "re-run-a-job-from-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun" - }, - { - "slug": "get-the-customization-template-for-an-oidc-subject-claim-for-a-repository", - "subcategory": "oidc", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/oidc/customization/sub" - }, - { - "slug": "set-the-customization-template-for-an-oidc-subject-claim-for-a-repository", - "subcategory": "oidc", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/oidc/customization/sub" - }, - { - "slug": "list-repository-organization-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/organization-secrets" - }, - { - "slug": "list-repository-organization-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/organization-variables" - }, - { - "slug": "get-github-actions-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions" - }, - { - "slug": "set-github-actions-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions" - }, - { - "slug": "get-the-level-of-access-for-workflows-outside-of-the-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/access" - }, - { - "slug": "set-the-level-of-access-for-workflows-outside-of-the-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/access" - }, - { - "slug": "get-allowed-actions-for-a-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions" - }, - { - "slug": "set-allowed-actions-for-a-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions" - }, - { - "slug": "get-default-workflow-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow" - }, - { - "slug": "set-default-workflow-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow" - }, - { - "slug": "list-self-hosted-runners-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners" - }, - { - "slug": "list-runner-applications-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/downloads" - }, - { - "slug": "create-configuration-for-a-just-in-time-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/generate-jitconfig" - }, - { - "slug": "create-a-registration-token-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/registration-token" - }, - { - "slug": "create-a-remove-token-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/remove-token" - }, - { - "slug": "get-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}" - }, - { - "slug": "delete-a-self-hosted-runner-from-a-repository", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}" - }, - { - "slug": "list-labels-for-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels" - }, - { - "slug": "add-custom-labels-to-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels" - }, - { - "slug": "set-custom-labels-for-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels" - }, - { - "slug": "remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels" - }, - { - "slug": "remove-a-custom-label-from-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}" - }, - { - "slug": "list-workflow-runs-for-a-repository", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs" - }, - { - "slug": "get-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}" - }, - { - "slug": "delete-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}" - }, - { - "slug": "get-the-review-history-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals" - }, - { - "slug": "list-workflow-run-artifacts", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts" - }, - { - "slug": "get-a-workflow-run-attempt", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}" - }, - { - "slug": "list-jobs-for-a-workflow-run-attempt", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs" - }, - { - "slug": "download-workflow-run-attempt-logs", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs" - }, - { - "slug": "cancel-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel" - }, - { - "slug": "force-cancel-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel" - }, - { - "slug": "list-jobs-for-a-workflow-run", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs" - }, - { - "slug": "download-workflow-run-logs", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs" - }, - { - "slug": "delete-workflow-run-logs", - "subcategory": "workflow-runs", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs" - }, - { - "slug": "get-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments" - }, - { - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments" - }, - { - "slug": "re-run-a-workflow", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun" - }, - { - "slug": "re-run-failed-jobs-from-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs" - }, - { - "slug": "list-repository-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets" - }, - { - "slug": "get-a-repository-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/public-key" - }, - { - "slug": "get-a-repository-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}" - }, - { - "slug": "create-or-update-a-repository-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}" - }, - { - "slug": "delete-a-repository-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}" - }, - { - "slug": "list-repository-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/variables" - }, - { - "slug": "create-a-repository-variable", - "subcategory": "variables", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/variables" - }, - { - "slug": "get-a-repository-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}" - }, - { - "slug": "update-a-repository-variable", - "subcategory": "variables", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}" - }, - { - "slug": "delete-a-repository-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}" - }, - { - "slug": "list-repository-workflows", - "subcategory": "workflows", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/workflows" - }, - { - "slug": "get-a-workflow", - "subcategory": "workflows", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}" - }, - { - "slug": "disable-a-workflow", - "subcategory": "workflows", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable" - }, - { - "slug": "create-a-workflow-dispatch-event", - "subcategory": "workflows", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches" - }, - { - "slug": "enable-a-workflow", - "subcategory": "workflows", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable" - }, - { - "slug": "list-workflow-runs-for-a-workflow", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs" - }, - { - "slug": "list-environment-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets" - }, - { - "slug": "get-an-environment-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key" - }, - { - "slug": "get-an-environment-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}" - }, - { - "slug": "create-or-update-an-environment-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}" - }, - { - "slug": "delete-an-environment-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}" - }, - { - "slug": "list-environment-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables" - }, - { - "slug": "create-an-environment-variable", - "subcategory": "variables", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables" - }, - { - "slug": "get-an-environment-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}" - }, - { - "slug": "update-an-environment-variable", - "subcategory": "variables", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}" - }, - { - "slug": "delete-an-environment-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}" - } - ], - "activity": [ - { - "slug": "list-repository-events", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/events" - }, - { - "slug": "list-stargazers", - "subcategory": "starring", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stargazers" - }, - { - "slug": "list-watchers", - "subcategory": "watching", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/subscribers" - }, - { - "slug": "list-repositories-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred" - }, - { - "slug": "check-if-a-repository-is-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred/{owner}/{repo}" - }, - { - "slug": "star-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "put", - "requestPath": "/user/starred/{owner}/{repo}" - }, - { - "slug": "unstar-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "delete", - "requestPath": "/user/starred/{owner}/{repo}" - }, - { - "slug": "list-repositories-watched-by-the-authenticated-user", - "subcategory": "watching", - "verb": "get", - "requestPath": "/user/subscriptions" - }, - { - "slug": "list-organization-events-for-the-authenticated-user", - "subcategory": "events", - "verb": "get", - "requestPath": "/users/{username}/events/orgs/{org}" - }, - { - "slug": "list-repositories-starred-by-a-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/users/{username}/starred" - }, - { - "slug": "list-repositories-watched-by-a-user", - "subcategory": "watching", - "verb": "get", - "requestPath": "/users/{username}/subscriptions" - } - ], - "announcement-banners": [ - { - "slug": "get-announcement-banner-for-organization", - "subcategory": "organizations", - "verb": "get", - "requestPath": "/orgs/{org}/announcement" - }, - { - "slug": "set-announcement-banner-for-organization", - "subcategory": "organizations", - "verb": "patch", - "requestPath": "/orgs/{org}/announcement" - }, - { - "slug": "remove-announcement-banner-from-organization", - "subcategory": "organizations", - "verb": "delete", - "requestPath": "/orgs/{org}/announcement" - } - ], - "billing": [ - { - "slug": "get-github-advanced-security-active-committers-for-an-organization", - "subcategory": "billing", - "verb": "get", - "requestPath": "/orgs/{org}/settings/billing/advanced-security" - } - ], - "branches": [ - { - "slug": "list-branches", - "subcategory": "branches", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches" - }, - { - "slug": "get-a-branch", - "subcategory": "branches", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}" - }, - { - "slug": "get-branch-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection" - }, - { - "slug": "update-branch-protection", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection" - }, - { - "slug": "delete-branch-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection" - }, - { - "slug": "get-admin-branch-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins" - }, - { - "slug": "set-admin-branch-protection", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins" - }, - { - "slug": "delete-admin-branch-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins" - }, - { - "slug": "get-pull-request-review-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews" - }, - { - "slug": "update-pull-request-review-protection", - "subcategory": "branch-protection", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews" - }, - { - "slug": "delete-pull-request-review-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews" - }, - { - "slug": "get-commit-signature-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures" - }, - { - "slug": "create-commit-signature-protection", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures" - }, - { - "slug": "delete-commit-signature-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures" - }, - { - "slug": "get-status-checks-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks" - }, - { - "slug": "update-status-check-protection", - "subcategory": "branch-protection", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks" - }, - { - "slug": "remove-status-check-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks" - }, - { - "slug": "get-all-status-check-contexts", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts" - }, - { - "slug": "add-status-check-contexts", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts" - }, - { - "slug": "set-status-check-contexts", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts" - }, - { - "slug": "remove-status-check-contexts", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts" - }, - { - "slug": "get-access-restrictions", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions" - }, - { - "slug": "delete-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions" - }, - { - "slug": "get-apps-with-access-to-the-protected-branch", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps" - }, - { - "slug": "add-app-access-restrictions", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps" - }, - { - "slug": "set-app-access-restrictions", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps" - }, - { - "slug": "remove-app-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps" - }, - { - "slug": "get-teams-with-access-to-the-protected-branch", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams" - }, - { - "slug": "add-team-access-restrictions", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams" - }, - { - "slug": "set-team-access-restrictions", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams" - }, - { - "slug": "remove-team-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams" - }, - { - "slug": "get-users-with-access-to-the-protected-branch", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users" - }, - { - "slug": "add-user-access-restrictions", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users" - }, - { - "slug": "set-user-access-restrictions", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users" - }, - { - "slug": "remove-user-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users" - }, - { - "slug": "rename-a-branch", - "subcategory": "branches", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename" - }, - { - "slug": "sync-a-fork-branch-with-the-upstream-repository", - "subcategory": "branches", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merge-upstream" - }, - { - "slug": "merge-a-branch", - "subcategory": "branches", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merges" - } - ], - "code-scanning": [ - { - "slug": "list-code-scanning-alerts-for-an-organization", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/orgs/{org}/code-scanning/alerts" - }, - { - "slug": "list-code-scanning-alerts-for-a-repository", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts" - }, - { - "slug": "get-a-code-scanning-alert", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}" - }, - { - "slug": "update-a-code-scanning-alert", - "subcategory": "code-scanning", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}" - }, - { - "slug": "list-instances-of-a-code-scanning-alert", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances" - }, - { - "slug": "list-code-scanning-analyses-for-a-repository", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses" - }, - { - "slug": "get-a-code-scanning-analysis-for-a-repository", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}" - }, - { - "slug": "delete-a-code-scanning-analysis-from-a-repository", - "subcategory": "code-scanning", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}" - }, - { - "slug": "get-a-code-scanning-default-setup-configuration", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/default-setup" - }, - { - "slug": "update-a-code-scanning-default-setup-configuration", - "subcategory": "code-scanning", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/code-scanning/default-setup" - }, - { - "slug": "upload-an-analysis-as-sarif-data", - "subcategory": "code-scanning", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs" - }, - { - "slug": "get-information-about-a-sarif-upload", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}" - } - ], - "collaborators": [ - { - "slug": "list-repository-collaborators", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators" - }, - { - "slug": "check-if-a-user-is-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}" - }, - { - "slug": "add-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}" - }, - { - "slug": "remove-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}" - }, - { - "slug": "get-repository-permissions-for-a-user", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission" - }, - { - "slug": "list-repository-invitations", - "subcategory": "invitations", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/invitations" - }, - { - "slug": "update-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}" - }, - { - "slug": "delete-a-repository-invitation", - "subcategory": "invitations", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}" - }, - { - "slug": "list-repository-invitations-for-the-authenticated-user", - "subcategory": "invitations", - "verb": "get", - "requestPath": "/user/repository_invitations" - }, - { - "slug": "decline-a-repository-invitation", - "subcategory": "invitations", - "verb": "delete", - "requestPath": "/user/repository_invitations/{invitation_id}" - } - ], - "commits": [ - { - "slug": "list-commit-comments-for-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments" - }, - { - "slug": "get-a-commit-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}" - }, - { - "slug": "update-a-commit-comment", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}" - }, - { - "slug": "delete-a-commit-comment", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}" - }, - { - "slug": "list-commits", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits" - }, - { - "slug": "list-branches-for-head-commit", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head" - }, - { - "slug": "list-commit-comments", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments" - }, - { - "slug": "create-a-commit-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments" - }, - { - "slug": "list-pull-requests-associated-with-a-commit", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls" - }, - { - "slug": "get-a-commit", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}" - }, - { - "slug": "get-the-combined-status-for-a-specific-reference", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/status" - }, - { - "slug": "list-commit-statuses-for-a-reference", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/statuses" - }, - { - "slug": "compare-two-commits", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/compare/{basehead}" - }, - { - "slug": "create-a-commit-status", - "subcategory": "statuses", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/statuses/{sha}" - } - ], - "dependabot": [ - { - "slug": "list-dependabot-alerts-for-an-organization", - "subcategory": "alerts", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/alerts" - }, - { - "slug": "list-organization-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets" - }, - { - "slug": "get-an-organization-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets/public-key" - }, - { - "slug": "get-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}" - }, - { - "slug": "create-or-update-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}" - }, - { - "slug": "delete-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}" - }, - { - "slug": "list-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories" - }, - { - "slug": "set-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories" - }, - { - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}" - }, - { - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}" - }, - { - "slug": "list-dependabot-alerts-for-a-repository", - "subcategory": "alerts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/alerts" - }, - { - "slug": "get-a-dependabot-alert", - "subcategory": "alerts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}" - }, - { - "slug": "update-a-dependabot-alert", - "subcategory": "alerts", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}" - }, - { - "slug": "list-repository-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets" - }, - { - "slug": "get-a-repository-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/public-key" - }, - { - "slug": "get-a-repository-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}" - }, - { - "slug": "create-or-update-a-repository-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}" - }, - { - "slug": "delete-a-repository-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}" - } - ], - "dependency-graph": [ - { - "slug": "get-a-diff-of-the-dependencies-between-commits", - "subcategory": "dependency-review", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}" - }, - { - "slug": "export-a-software-bill-of-materials-sbom-for-a-repository", - "subcategory": "sboms", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependency-graph/sbom" - }, - { - "slug": "create-a-snapshot-of-dependencies-for-a-repository", - "subcategory": "dependency-submission", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/dependency-graph/snapshots" - } - ], - "deploy-keys": [ - { - "slug": "list-deploy-keys", - "subcategory": "deploy-keys", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/keys" - }, - { - "slug": "create-a-deploy-key", - "subcategory": "deploy-keys", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/keys" - }, - { - "slug": "get-a-deploy-key", - "subcategory": "deploy-keys", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/keys/{key_id}" - }, - { - "slug": "delete-a-deploy-key", - "subcategory": "deploy-keys", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/keys/{key_id}" - } - ], - "deployments": [ - { - "slug": "list-deployments", - "subcategory": "deployments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments" - }, - { - "slug": "create-a-deployment", - "subcategory": "deployments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/deployments" - }, - { - "slug": "get-a-deployment", - "subcategory": "deployments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}" - }, - { - "slug": "delete-a-deployment", - "subcategory": "deployments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}" - }, - { - "slug": "list-deployment-statuses", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses" - }, - { - "slug": "create-a-deployment-status", - "subcategory": "statuses", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses" - }, - { - "slug": "get-a-deployment-status", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}" - }, - { - "slug": "list-environments", - "subcategory": "environments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments" - }, - { - "slug": "get-an-environment", - "subcategory": "environments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}" - }, - { - "slug": "create-or-update-an-environment", - "subcategory": "environments", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}" - }, - { - "slug": "delete-an-environment", - "subcategory": "environments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}" - }, - { - "slug": "list-deployment-branch-policies", - "subcategory": "branch-policies", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies" - }, - { - "slug": "create-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies" - }, - { - "slug": "get-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}" - }, - { - "slug": "update-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}" - }, - { - "slug": "delete-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}" - }, - { - "slug": "get-all-deployment-protection-rules-for-an-environment", - "subcategory": "protection-rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules" - }, - { - "slug": "create-a-custom-deployment-protection-rule-on-an-environment", - "subcategory": "protection-rules", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules" - }, - { - "slug": "list-custom-deployment-rule-integrations-available-for-an-environment", - "subcategory": "protection-rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps" - }, - { - "slug": "get-a-custom-deployment-protection-rule", - "subcategory": "protection-rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}" - }, - { - "slug": "disable-a-custom-protection-rule-for-an-environment", - "subcategory": "protection-rules", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}" - } - ], - "enterprise-admin": [ - { - "slug": "list-pre-receive-hooks-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks" - }, - { - "slug": "get-a-pre-receive-hook-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}" - }, - { - "slug": "update-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "patch", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}" - }, - { - "slug": "remove-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "delete", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}" - }, - { - "slug": "list-pre-receive-hooks-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks" - }, - { - "slug": "get-a-pre-receive-hook-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}" - }, - { - "slug": "update-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}" - }, - { - "slug": "remove-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}" - } - ], - "gists": [ - { - "slug": "create-a-gist", - "subcategory": "gists", - "verb": "post", - "requestPath": "/gists" - }, - { - "slug": "update-a-gist", - "subcategory": "gists", - "verb": "patch", - "requestPath": "/gists/{gist_id}" - }, - { - "slug": "delete-a-gist", - "subcategory": "gists", - "verb": "delete", - "requestPath": "/gists/{gist_id}" - }, - { - "slug": "create-a-gist-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/gists/{gist_id}/comments" - }, - { - "slug": "update-a-gist-comment", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/gists/{gist_id}/comments/{comment_id}" - }, - { - "slug": "delete-a-gist-comment", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/gists/{gist_id}/comments/{comment_id}" - }, - { - "slug": "fork-a-gist", - "subcategory": "gists", - "verb": "post", - "requestPath": "/gists/{gist_id}/forks" - }, - { - "slug": "star-a-gist", - "subcategory": "gists", - "verb": "put", - "requestPath": "/gists/{gist_id}/star" - }, - { - "slug": "unstar-a-gist", - "subcategory": "gists", - "verb": "delete", - "requestPath": "/gists/{gist_id}/star" - } - ], - "git": [ - { - "slug": "create-a-blob", - "subcategory": "blobs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/blobs" - }, - { - "slug": "get-a-blob", - "subcategory": "blobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/blobs/{file_sha}" - }, - { - "slug": "create-a-commit", - "subcategory": "commits", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/commits" - }, - { - "slug": "get-a-commit-object", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}" - }, - { - "slug": "list-matching-references", - "subcategory": "refs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/matching-refs/{ref}" - }, - { - "slug": "get-a-reference", - "subcategory": "refs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/ref/{ref}" - }, - { - "slug": "create-a-reference", - "subcategory": "refs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/refs" - }, - { - "slug": "update-a-reference", - "subcategory": "refs", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}" - }, - { - "slug": "delete-a-reference", - "subcategory": "refs", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}" - }, - { - "slug": "create-a-tag-object", - "subcategory": "tags", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/tags" - }, - { - "slug": "get-a-tag", - "subcategory": "tags", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/tags/{tag_sha}" - }, - { - "slug": "create-a-tree", - "subcategory": "trees", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/trees" - }, - { - "slug": "get-a-tree", - "subcategory": "trees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/trees/{tree_sha}" - } - ], - "issues": [ - { - "slug": "list-assignees", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/assignees" - }, - { - "slug": "check-if-a-user-can-be-assigned", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/assignees/{assignee}" - }, - { - "slug": "list-repository-issues", - "subcategory": "issues", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues" - }, - { - "slug": "create-an-issue", - "subcategory": "issues", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues" - }, - { - "slug": "list-issue-comments-for-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments" - }, - { - "slug": "get-an-issue-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}" - }, - { - "slug": "update-an-issue-comment", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}" - }, - { - "slug": "delete-an-issue-comment", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}" - }, - { - "slug": "list-issue-events-for-a-repository", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/events" - }, - { - "slug": "get-an-issue-event", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}" - }, - { - "slug": "get-an-issue", - "subcategory": "issues", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}" - }, - { - "slug": "update-an-issue", - "subcategory": "issues", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}" - }, - { - "slug": "add-assignees-to-an-issue", - "subcategory": "assignees", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees" - }, - { - "slug": "remove-assignees-from-an-issue", - "subcategory": "assignees", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees" - }, - { - "slug": "check-if-a-user-can-be-assigned-to-a-issue", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}" - }, - { - "slug": "list-issue-comments", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments" - }, - { - "slug": "create-an-issue-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments" - }, - { - "slug": "list-issue-events", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events" - }, - { - "slug": "list-issue-field-values-for-an-issue", - "subcategory": "issue-field-values", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values" - }, - { - "slug": "list-labels-for-an-issue", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels" - }, - { - "slug": "add-labels-to-an-issue", - "subcategory": "labels", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels" - }, - { - "slug": "set-labels-for-an-issue", - "subcategory": "labels", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels" - }, - { - "slug": "remove-all-labels-from-an-issue", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels" - }, - { - "slug": "remove-a-label-from-an-issue", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}" - }, - { - "slug": "lock-an-issue", - "subcategory": "issues", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock" - }, - { - "slug": "unlock-an-issue", - "subcategory": "issues", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock" - }, - { - "slug": "list-timeline-events-for-an-issue", - "subcategory": "timeline", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline" - }, - { - "slug": "list-labels-for-a-repository", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/labels" - }, - { - "slug": "create-a-label", - "subcategory": "labels", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/labels" - }, - { - "slug": "get-a-label", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/labels/{name}" - }, - { - "slug": "update-a-label", - "subcategory": "labels", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/labels/{name}" - }, - { - "slug": "delete-a-label", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/labels/{name}" - }, - { - "slug": "list-milestones", - "subcategory": "milestones", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones" - }, - { - "slug": "create-a-milestone", - "subcategory": "milestones", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/milestones" - }, - { - "slug": "get-a-milestone", - "subcategory": "milestones", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}" - }, - { - "slug": "update-a-milestone", - "subcategory": "milestones", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}" - }, - { - "slug": "delete-a-milestone", - "subcategory": "milestones", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}" - }, - { - "slug": "list-labels-for-issues-in-a-milestone", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels" - } - ], - "licenses": [ - { - "slug": "get-the-license-for-a-repository", - "subcategory": "licenses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/license" - } - ], - "markdown": [ - { - "slug": "render-a-markdown-document", - "subcategory": "markdown", - "verb": "post", - "requestPath": "/markdown" - } - ], - "metrics": [ - { - "slug": "get-the-weekly-commit-activity", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/code_frequency" - }, - { - "slug": "get-the-last-year-of-commit-activity", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/commit_activity" - }, - { - "slug": "get-all-contributor-commit-activity", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/contributors" - }, - { - "slug": "get-the-weekly-commit-count", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/participation" - }, - { - "slug": "get-the-hourly-commit-count-for-each-day", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/punch_card" - } - ], - "orgs": [ - { - "slug": "closing-down---list-custom-repository-roles-in-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/organizations/{organization_id}/custom_roles" - }, - { - "slug": "update-an-organization", - "subcategory": "orgs", - "verb": "patch", - "requestPath": "/orgs/{org}" - }, - { - "slug": "delete-an-organization", - "subcategory": "orgs", - "verb": "delete", - "requestPath": "/orgs/{org}" - }, - { - "slug": "get-the-audit-log-for-an-organization", - "subcategory": "orgs", - "verb": "get", - "requestPath": "/orgs/{org}/audit-log" - }, - { - "slug": "list-custom-repository-roles-in-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/custom-repository-roles" - }, - { - "slug": "create-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "post", - "requestPath": "/orgs/{org}/custom-repository-roles" - }, - { - "slug": "get-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}" - }, - { - "slug": "update-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "patch", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}" - }, - { - "slug": "delete-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}" - }, - { - "slug": "list-organization-webhooks", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks" - }, - { - "slug": "create-an-organization-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/orgs/{org}/hooks" - }, - { - "slug": "get-an-organization-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}" - }, - { - "slug": "update-an-organization-webhook", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/orgs/{org}/hooks/{hook_id}" - }, - { - "slug": "delete-an-organization-webhook", - "subcategory": "webhooks", - "verb": "delete", - "requestPath": "/orgs/{org}/hooks/{hook_id}" - }, - { - "slug": "get-a-webhook-configuration-for-an-organization", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/config" - }, - { - "slug": "update-a-webhook-configuration-for-an-organization", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/orgs/{org}/hooks/{hook_id}/config" - }, - { - "slug": "list-deliveries-for-an-organization-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries" - }, - { - "slug": "get-a-webhook-delivery-for-an-organization-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}" - }, - { - "slug": "redeliver-a-delivery-for-an-organization-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts" - }, - { - "slug": "ping-an-organization-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/orgs/{org}/hooks/{hook_id}/pings" - }, - { - "slug": "list-app-installations-for-an-organization", - "subcategory": "orgs", - "verb": "get", - "requestPath": "/orgs/{org}/installations" - }, - { - "slug": "list-organization-members", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/members" - }, - { - "slug": "check-organization-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/members/{username}" - }, - { - "slug": "remove-an-organization-member", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/members/{username}" - }, - { - "slug": "get-organization-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/memberships/{username}" - }, - { - "slug": "set-organization-membership-for-a-user", - "subcategory": "members", - "verb": "put", - "requestPath": "/orgs/{org}/memberships/{username}" - }, - { - "slug": "remove-organization-membership-for-a-user", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/memberships/{username}" - }, - { - "slug": "list-organization-fine-grained-permissions-for-an-organization", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-fine-grained-permissions" - }, - { - "slug": "get-all-organization-roles-for-an-organization", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles" - }, - { - "slug": "create-a-custom-organization-role", - "subcategory": "organization-roles", - "verb": "post", - "requestPath": "/orgs/{org}/organization-roles" - }, - { - "slug": "remove-all-organization-roles-for-a-team", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/teams/{team_slug}" - }, - { - "slug": "assign-an-organization-role-to-a-team", - "subcategory": "organization-roles", - "verb": "put", - "requestPath": "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}" - }, - { - "slug": "remove-an-organization-role-from-a-team", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}" - }, - { - "slug": "remove-all-organization-roles-for-a-user", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/users/{username}" - }, - { - "slug": "assign-an-organization-role-to-a-user", - "subcategory": "organization-roles", - "verb": "put", - "requestPath": "/orgs/{org}/organization-roles/users/{username}/{role_id}" - }, - { - "slug": "remove-an-organization-role-from-a-user", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/users/{username}/{role_id}" - }, - { - "slug": "get-an-organization-role", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles/{role_id}" - }, - { - "slug": "update-a-custom-organization-role", - "subcategory": "organization-roles", - "verb": "patch", - "requestPath": "/orgs/{org}/organization-roles/{role_id}" - }, - { - "slug": "delete-a-custom-organization-role", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/{role_id}" - }, - { - "slug": "list-teams-that-are-assigned-to-an-organization-role", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles/{role_id}/teams" - }, - { - "slug": "list-users-that-are-assigned-to-an-organization-role", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles/{role_id}/users" - }, - { - "slug": "list-outside-collaborators-for-an-organization", - "subcategory": "outside-collaborators", - "verb": "get", - "requestPath": "/orgs/{org}/outside_collaborators" - }, - { - "slug": "convert-an-organization-member-to-outside-collaborator", - "subcategory": "outside-collaborators", - "verb": "put", - "requestPath": "/orgs/{org}/outside_collaborators/{username}" - }, - { - "slug": "remove-outside-collaborator-from-an-organization", - "subcategory": "outside-collaborators", - "verb": "delete", - "requestPath": "/orgs/{org}/outside_collaborators/{username}" - }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "list-custom-property-values-for-organization-repositories", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/values" - }, - { - "slug": "create-or-update-custom-property-values-for-organization-repositories", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" - }, - { - "slug": "list-public-organization-members", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/public_members" - }, - { - "slug": "check-public-organization-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/public_members/{username}" - }, - { - "slug": "set-public-organization-membership-for-the-authenticated-user", - "subcategory": "members", - "verb": "put", - "requestPath": "/orgs/{org}/public_members/{username}" - }, - { - "slug": "remove-public-organization-membership-for-the-authenticated-user", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/public_members/{username}" - }, - { - "slug": "list-repository-fine-grained-permissions-for-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/repository-fine-grained-permissions" - }, - { - "slug": "get-all-organization-repository-rulesets", - "subcategory": "rules", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets" - }, - { - "slug": "create-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "post", - "requestPath": "/orgs/{org}/rulesets" - }, - { - "slug": "list-organization-rule-suites", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets/rule-suites" - }, - { - "slug": "get-an-organization-rule-suite", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}" - }, - { - "slug": "get-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets/{ruleset_id}" - }, - { - "slug": "update-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "put", - "requestPath": "/orgs/{org}/rulesets/{ruleset_id}" - }, - { - "slug": "delete-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "delete", - "requestPath": "/orgs/{org}/rulesets/{ruleset_id}" - }, - { - "slug": "list-security-manager-teams", - "subcategory": "security-managers", - "verb": "get", - "requestPath": "/orgs/{org}/security-managers" - }, - { - "slug": "add-a-security-manager-team", - "subcategory": "security-managers", - "verb": "put", - "requestPath": "/orgs/{org}/security-managers/teams/{team_slug}" - }, - { - "slug": "remove-a-security-manager-team", - "subcategory": "security-managers", - "verb": "delete", - "requestPath": "/orgs/{org}/security-managers/teams/{team_slug}" - }, - { - "slug": "enable-or-disable-a-security-feature-for-an-organization", - "subcategory": "orgs", - "verb": "post", - "requestPath": "/orgs/{org}/{security_product}/{enablement}" - }, - { - "slug": "get-an-organization-membership-for-the-authenticated-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/user/memberships/orgs/{org}" - }, - { - "slug": "update-an-organization-membership-for-the-authenticated-user", - "subcategory": "members", - "verb": "patch", - "requestPath": "/user/memberships/orgs/{org}" - } - ], - "pages": [ - { - "slug": "get-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages" - }, - { - "slug": "create-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages" - }, - { - "slug": "update-information-about-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pages" - }, - { - "slug": "delete-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pages" - }, - { - "slug": "list-github-enterprise-server-pages-builds", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/builds" - }, - { - "slug": "request-a-github-enterprise-server-pages-build", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/builds" - }, - { - "slug": "get-latest-pages-build", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/builds/latest" - }, - { - "slug": "get-github-enterprise-server-pages-build", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/builds/{build_id}" - }, - { - "slug": "create-a-github-pages-deployment", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployments" - }, - { - "slug": "get-the-status-of-a-github-pages-deployment", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}" - }, - { - "slug": "cancel-a-github-pages-deployment", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel" - } - ], - "pulls": [ - { - "slug": "list-pull-requests", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls" - }, - { - "slug": "create-a-pull-request", - "subcategory": "pulls", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls" - }, - { - "slug": "list-review-comments-in-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/comments" - }, - { - "slug": "get-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}" - }, - { - "slug": "update-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}" - }, - { - "slug": "delete-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}" - }, - { - "slug": "get-a-pull-request", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}" - }, - { - "slug": "update-a-pull-request", - "subcategory": "pulls", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}" - }, - { - "slug": "list-review-comments-on-a-pull-request", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments" - }, - { - "slug": "create-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments" - }, - { - "slug": "create-a-reply-for-a-review-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies" - }, - { - "slug": "list-commits-on-a-pull-request", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/commits" - }, - { - "slug": "list-pull-requests-files", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/files" - }, - { - "slug": "check-if-a-pull-request-has-been-merged", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge" - }, - { - "slug": "merge-a-pull-request", - "subcategory": "pulls", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge" - }, - { - "slug": "get-all-requested-reviewers-for-a-pull-request", - "subcategory": "review-requests", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers" - }, - { - "slug": "request-reviewers-for-a-pull-request", - "subcategory": "review-requests", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers" - }, - { - "slug": "remove-requested-reviewers-from-a-pull-request", - "subcategory": "review-requests", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers" - }, - { - "slug": "list-reviews-for-a-pull-request", - "subcategory": "reviews", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews" - }, - { - "slug": "create-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews" - }, - { - "slug": "get-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}" - }, - { - "slug": "update-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}" - }, - { - "slug": "delete-a-pending-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}" - }, - { - "slug": "list-comments-for-a-pull-request-review", - "subcategory": "reviews", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments" - }, - { - "slug": "dismiss-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals" - }, - { - "slug": "submit-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events" - }, - { - "slug": "update-a-pull-request-branch", - "subcategory": "pulls", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch" - } - ], - "reactions": [ - { - "slug": "list-reactions-for-a-commit-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions" - }, - { - "slug": "create-reaction-for-a-commit-comment", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions" - }, - { - "slug": "delete-a-commit-comment-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}" - }, - { - "slug": "list-reactions-for-an-issue-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions" - }, - { - "slug": "create-reaction-for-an-issue-comment", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions" - }, - { - "slug": "delete-an-issue-comment-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}" - }, - { - "slug": "list-reactions-for-an-issue", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions" - }, - { - "slug": "create-reaction-for-an-issue", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions" - }, - { - "slug": "delete-an-issue-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}" - }, - { - "slug": "list-reactions-for-a-pull-request-review-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions" - }, - { - "slug": "create-reaction-for-a-pull-request-review-comment", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions" - }, - { - "slug": "delete-a-pull-request-comment-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}" - } - ], - "releases": [ - { - "slug": "list-releases", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases" - }, - { - "slug": "create-a-release", - "subcategory": "releases", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases" - }, - { - "slug": "get-a-release-asset", - "subcategory": "assets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}" - }, - { - "slug": "update-a-release-asset", - "subcategory": "assets", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}" - }, - { - "slug": "delete-a-release-asset", - "subcategory": "assets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}" - }, - { - "slug": "generate-release-notes-content-for-a-release", - "subcategory": "releases", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases/generate-notes" - }, - { - "slug": "get-the-latest-release", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/latest" - }, - { - "slug": "get-a-release-by-tag-name", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}" - }, - { - "slug": "get-a-release", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}" - }, - { - "slug": "update-a-release", - "subcategory": "releases", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}" - }, - { - "slug": "delete-a-release", - "subcategory": "releases", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}" - }, - { - "slug": "list-release-assets", - "subcategory": "assets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets" - } - ], - "repos": [ - { - "slug": "list-organization-repositories", - "subcategory": "repos", - "verb": "get", - "requestPath": "/orgs/{org}/repos" - }, - { - "slug": "create-an-organization-repository", - "subcategory": "repos", - "verb": "post", - "requestPath": "/orgs/{org}/repos" - }, - { - "slug": "get-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}" - }, - { - "slug": "update-a-repository", - "subcategory": "repos", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}" - }, - { - "slug": "delete-a-repository", - "subcategory": "repos", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}" - }, - { - "slug": "list-repository-activities", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/activity" - }, - { - "slug": "get-all-autolinks-of-a-repository", - "subcategory": "autolinks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/autolinks" - }, - { - "slug": "create-an-autolink-reference-for-a-repository", - "subcategory": "autolinks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/autolinks" - }, - { - "slug": "get-an-autolink-reference-of-a-repository", - "subcategory": "autolinks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}" - }, - { - "slug": "delete-an-autolink-reference-from-a-repository", - "subcategory": "autolinks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}" - }, - { - "slug": "check-if-dependabot-security-updates-are-enabled-for-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/automated-security-fixes" - }, - { - "slug": "list-codeowners-errors", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/codeowners/errors" - }, - { - "slug": "get-repository-content", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/contents/{path}" - }, - { - "slug": "create-or-update-file-contents", - "subcategory": "contents", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/contents/{path}" - }, - { - "slug": "delete-a-file", - "subcategory": "contents", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/contents/{path}" - }, - { - "slug": "list-repository-contributors", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/contributors" - }, - { - "slug": "create-a-repository-dispatch-event", - "subcategory": "repos", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/dispatches" - }, - { - "slug": "list-forks", - "subcategory": "forks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/forks" - }, - { - "slug": "create-a-fork", - "subcategory": "forks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/forks" - }, - { - "slug": "list-repository-webhooks", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks" - }, - { - "slug": "create-a-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks" - }, - { - "slug": "get-a-repository-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}" - }, - { - "slug": "update-a-repository-webhook", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}" - }, - { - "slug": "delete-a-repository-webhook", - "subcategory": "webhooks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}" - }, - { - "slug": "get-a-webhook-configuration-for-a-repository", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config" - }, - { - "slug": "update-a-webhook-configuration-for-a-repository", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config" - }, - { - "slug": "list-deliveries-for-a-repository-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries" - }, - { - "slug": "get-a-delivery-for-a-repository-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}" - }, - { - "slug": "redeliver-a-delivery-for-a-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts" - }, - { - "slug": "ping-a-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/pings" - }, - { - "slug": "test-the-push-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/tests" - }, - { - "slug": "list-repository-languages", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/languages" - }, - { - "slug": "get-all-custom-property-values-for-a-repository", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/properties/values" - }, - { - "slug": "create-or-update-custom-property-values-for-a-repository", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/properties/values" - }, - { - "slug": "get-a-repository-readme", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/readme" - }, - { - "slug": "get-a-repository-readme-for-a-directory", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/readme/{dir}" - }, - { - "slug": "list-repository-cache-replication-status", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/replicas/caches" - }, - { - "slug": "get-rules-for-a-branch", - "subcategory": "rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rules/branches/{branch}" - }, - { - "slug": "get-all-repository-rulesets", - "subcategory": "rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets" - }, - { - "slug": "create-a-repository-ruleset", - "subcategory": "rules", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/rulesets" - }, - { - "slug": "list-repository-rule-suites", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets/rule-suites" - }, - { - "slug": "get-a-repository-rule-suite", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}" - }, - { - "slug": "get-a-repository-ruleset", - "subcategory": "rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets/{ruleset_id}" - }, - { - "slug": "update-a-repository-ruleset", - "subcategory": "rules", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/rulesets/{ruleset_id}" - }, - { - "slug": "delete-a-repository-ruleset", - "subcategory": "rules", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/rulesets/{ruleset_id}" - }, - { - "slug": "list-repository-tags", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/tags" - }, - { - "slug": "download-a-repository-archive-tar", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/tarball/{ref}" - }, - { - "slug": "list-repository-teams", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/teams" - }, - { - "slug": "get-all-repository-topics", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/topics" - }, - { - "slug": "replace-all-repository-topics", - "subcategory": "repos", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/topics" - }, - { - "slug": "check-if-vulnerability-alerts-are-enabled-for-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts" - }, - { - "slug": "enable-vulnerability-alerts", - "subcategory": "repos", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts" - }, - { - "slug": "disable-vulnerability-alerts", - "subcategory": "repos", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts" - }, - { - "slug": "download-a-repository-archive-zip", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/zipball/{ref}" - }, - { - "slug": "create-a-repository-using-a-template", - "subcategory": "repos", - "verb": "post", - "requestPath": "/repos/{template_owner}/{template_repo}/generate" - }, - { - "slug": "list-public-repositories", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repositories" - }, - { - "slug": "list-repositories-for-the-authenticated-user", - "subcategory": "repos", - "verb": "get", - "requestPath": "/user/repos" - }, - { - "slug": "create-a-repository-for-the-authenticated-user", - "subcategory": "repos", - "verb": "post", - "requestPath": "/user/repos" - }, - { - "slug": "list-repositories-for-a-user", - "subcategory": "repos", - "verb": "get", - "requestPath": "/users/{username}/repos" - } - ], - "search": [ - { - "slug": "search-labels", - "subcategory": "search", - "verb": "get", - "requestPath": "/search/labels" - } - ], - "secret-scanning": [ - { - "slug": "list-secret-scanning-alerts-for-an-organization", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/orgs/{org}/secret-scanning/alerts" - }, - { - "slug": "list-secret-scanning-alerts-for-a-repository", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts" - }, - { - "slug": "get-a-secret-scanning-alert", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}" - }, - { - "slug": "update-a-secret-scanning-alert", - "subcategory": "secret-scanning", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}" - }, - { - "slug": "list-locations-for-a-secret-scanning-alert", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations" - } - ], - "teams": [ - { - "slug": "get-an-external-group", - "subcategory": "external-groups", - "verb": "get", - "requestPath": "/orgs/{org}/external-group/{group_id}" - }, - { - "slug": "list-external-groups-available-to-an-organization", - "subcategory": "external-groups", - "verb": "get", - "requestPath": "/orgs/{org}/external-groups" - }, - { - "slug": "list-teams", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams" - }, - { - "slug": "create-a-team", - "subcategory": "teams", - "verb": "post", - "requestPath": "/orgs/{org}/teams" - }, - { - "slug": "get-a-team-by-name", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}" - }, - { - "slug": "update-a-team", - "subcategory": "teams", - "verb": "patch", - "requestPath": "/orgs/{org}/teams/{team_slug}" - }, - { - "slug": "delete-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}" - }, - { - "slug": "list-a-connection-between-an-external-group-and-a-team", - "subcategory": "external-groups", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups" - }, - { - "slug": "update-the-connection-between-an-external-group-and-a-team", - "subcategory": "external-groups", - "verb": "patch", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups" - }, - { - "slug": "remove-the-connection-between-an-external-group-and-a-team", - "subcategory": "external-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups" - }, - { - "slug": "list-team-members", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/members" - }, - { - "slug": "get-team-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}" - }, - { - "slug": "add-or-update-team-membership-for-a-user", - "subcategory": "members", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}" - }, - { - "slug": "remove-team-membership-for-a-user", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}" - }, - { - "slug": "list-team-repositories", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos" - }, - { - "slug": "check-team-permissions-for-a-repository", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}" - }, - { - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}" - }, - { - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}" - }, - { - "slug": "list-child-teams", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/teams" - }, - { - "slug": "get-a-team-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}" - }, - { - "slug": "update-a-team-legacy", - "subcategory": "teams", - "verb": "patch", - "requestPath": "/teams/{team_id}" - }, - { - "slug": "delete-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}" - }, - { - "slug": "list-team-members-legacy", - "subcategory": "members", - "verb": "get", - "requestPath": "/teams/{team_id}/members" - }, - { - "slug": "get-team-member-legacy", - "subcategory": "members", - "verb": "get", - "requestPath": "/teams/{team_id}/members/{username}" - }, - { - "slug": "add-team-member-legacy", - "subcategory": "members", - "verb": "put", - "requestPath": "/teams/{team_id}/members/{username}" - }, - { - "slug": "remove-team-member-legacy", - "subcategory": "members", - "verb": "delete", - "requestPath": "/teams/{team_id}/members/{username}" - }, - { - "slug": "get-team-membership-for-a-user-legacy", - "subcategory": "members", - "verb": "get", - "requestPath": "/teams/{team_id}/memberships/{username}" - }, - { - "slug": "add-or-update-team-membership-for-a-user-legacy", - "subcategory": "members", - "verb": "put", - "requestPath": "/teams/{team_id}/memberships/{username}" - }, - { - "slug": "remove-team-membership-for-a-user-legacy", - "subcategory": "members", - "verb": "delete", - "requestPath": "/teams/{team_id}/memberships/{username}" - }, - { - "slug": "list-team-repositories-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos" - }, - { - "slug": "check-team-permissions-for-a-repository-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}" - }, - { - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}" - }, - { - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}" - }, - { - "slug": "list-child-teams-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/teams" - } - ], - "users": [ - { - "slug": "update-the-authenticated-user", - "subcategory": "users", - "verb": "patch", - "requestPath": "/user" - }, - { - "slug": "list-email-addresses-for-the-authenticated-user", - "subcategory": "emails", - "verb": "get", - "requestPath": "/user/emails" - }, - { - "slug": "add-an-email-address-for-the-authenticated-user", - "subcategory": "emails", - "verb": "post", - "requestPath": "/user/emails" - }, - { - "slug": "delete-an-email-address-for-the-authenticated-user", - "subcategory": "emails", - "verb": "delete", - "requestPath": "/user/emails" - }, - { - "slug": "list-followers-of-the-authenticated-user", - "subcategory": "followers", - "verb": "get", - "requestPath": "/user/followers" - }, - { - "slug": "list-the-people-the-authenticated-user-follows", - "subcategory": "followers", - "verb": "get", - "requestPath": "/user/following" - }, - { - "slug": "check-if-a-person-is-followed-by-the-authenticated-user", - "subcategory": "followers", - "verb": "get", - "requestPath": "/user/following/{username}" - }, - { - "slug": "follow-a-user", - "subcategory": "followers", - "verb": "put", - "requestPath": "/user/following/{username}" - }, - { - "slug": "unfollow-a-user", - "subcategory": "followers", - "verb": "delete", - "requestPath": "/user/following/{username}" - }, - { - "slug": "list-gpg-keys-for-the-authenticated-user", - "subcategory": "gpg-keys", - "verb": "get", - "requestPath": "/user/gpg_keys" - }, - { - "slug": "create-a-gpg-key-for-the-authenticated-user", - "subcategory": "gpg-keys", - "verb": "post", - "requestPath": "/user/gpg_keys" - }, - { - "slug": "get-a-gpg-key-for-the-authenticated-user", - "subcategory": "gpg-keys", - "verb": "get", - "requestPath": "/user/gpg_keys/{gpg_key_id}" - }, - { - "slug": "delete-a-gpg-key-for-the-authenticated-user", - "subcategory": "gpg-keys", - "verb": "delete", - "requestPath": "/user/gpg_keys/{gpg_key_id}" - }, - { - "slug": "list-public-ssh-keys-for-the-authenticated-user", - "subcategory": "keys", - "verb": "get", - "requestPath": "/user/keys" - }, - { - "slug": "create-a-public-ssh-key-for-the-authenticated-user", - "subcategory": "keys", - "verb": "post", - "requestPath": "/user/keys" - }, - { - "slug": "get-a-public-ssh-key-for-the-authenticated-user", - "subcategory": "keys", - "verb": "get", - "requestPath": "/user/keys/{key_id}" - }, - { - "slug": "delete-a-public-ssh-key-for-the-authenticated-user", - "subcategory": "keys", - "verb": "delete", - "requestPath": "/user/keys/{key_id}" - }, - { - "slug": "list-public-email-addresses-for-the-authenticated-user", - "subcategory": "emails", - "verb": "get", - "requestPath": "/user/public_emails" - }, - { - "slug": "add-social-accounts-for-the-authenticated-user", - "subcategory": "social-accounts", - "verb": "post", - "requestPath": "/user/social_accounts" - }, - { - "slug": "delete-social-accounts-for-the-authenticated-user", - "subcategory": "social-accounts", - "verb": "delete", - "requestPath": "/user/social_accounts" - }, - { - "slug": "list-ssh-signing-keys-for-the-authenticated-user", - "subcategory": "ssh-signing-keys", - "verb": "get", - "requestPath": "/user/ssh_signing_keys" - }, - { - "slug": "create-a-ssh-signing-key-for-the-authenticated-user", - "subcategory": "ssh-signing-keys", - "verb": "post", - "requestPath": "/user/ssh_signing_keys" - }, - { - "slug": "get-an-ssh-signing-key-for-the-authenticated-user", - "subcategory": "ssh-signing-keys", - "verb": "get", - "requestPath": "/user/ssh_signing_keys/{ssh_signing_key_id}" - }, - { - "slug": "delete-an-ssh-signing-key-for-the-authenticated-user", - "subcategory": "ssh-signing-keys", - "verb": "delete", - "requestPath": "/user/ssh_signing_keys/{ssh_signing_key_id}" - }, - { - "slug": "list-public-keys-for-a-user", - "subcategory": "keys", - "verb": "get", - "requestPath": "/users/{username}/keys" - } - ] -} \ No newline at end of file diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json deleted file mode 100644 index bad9d4ffbaae..000000000000 --- a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json +++ /dev/null @@ -1,7940 +0,0 @@ -{ - "enterprise_scim": { - "title": "Enterprise SCIM", - "displayTitle": "Enterprise permissions for \"Enterprise SCIM\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-provisioned-scim-groups-for-an-enterprise", - "subcategory": "scim", - "verb": "get", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "provision-a-scim-enterprise-group", - "subcategory": "scim", - "verb": "post", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "get-scim-provisioning-information-for-an-enterprise-group", - "subcategory": "scim", - "verb": "get", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "set-scim-information-for-a-provisioned-enterprise-group", - "subcategory": "scim", - "verb": "put", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "update-an-attribute-for-a-scim-enterprise-group", - "subcategory": "scim", - "verb": "patch", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "delete-a-scim-group-from-an-enterprise", - "subcategory": "scim", - "verb": "delete", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "list-scim-provisioned-identities-for-an-enterprise", - "subcategory": "scim", - "verb": "get", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "provision-a-scim-enterprise-user", - "subcategory": "scim", - "verb": "post", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "get-scim-provisioning-information-for-an-enterprise-user", - "subcategory": "scim", - "verb": "get", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "set-scim-information-for-a-provisioned-enterprise-user", - "subcategory": "scim", - "verb": "put", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "update-an-attribute-for-a-scim-enterprise-user", - "subcategory": "scim", - "verb": "patch", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "delete-a-scim-user-from-an-enterprise", - "subcategory": "scim", - "verb": "delete", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "organization_administration": { - "title": "Administration", - "displayTitle": "Organization permissions for \"Administration\"", - "permissions": [ - { - "category": "orgs", - "slug": "closing-down---list-custom-repository-roles-in-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/organizations/{organization_id}/custom_roles", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "orgs", - "slug": "update-an-organization", - "subcategory": "orgs", - "verb": "patch", - "requestPath": "/orgs/{org}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "delete-an-organization", - "subcategory": "orgs", - "verb": "delete", - "requestPath": "/orgs/{org}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-github-actions-cache-usage-for-an-organization", - "subcategory": "cache", - "verb": "get", - "requestPath": "/orgs/{org}/actions/cache/usage", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-repositories-with-github-actions-cache-usage-for-an-organization", - "subcategory": "cache", - "verb": "get", - "requestPath": "/orgs/{org}/actions/cache/usage-by-repository", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-the-customization-template-for-an-oidc-subject-claim-for-an-organization", - "subcategory": "oidc", - "verb": "get", - "requestPath": "/orgs/{org}/actions/oidc/customization/sub", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "set-the-customization-template-for-an-oidc-subject-claim-for-an-organization", - "subcategory": "oidc", - "verb": "put", - "requestPath": "/orgs/{org}/actions/oidc/customization/sub", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-github-actions-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "set-github-actions-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-selected-repositories-enabled-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/repositories", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "set-selected-repositories-enabled-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "actions", - "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "actions", - "slug": "get-allowed-actions-for-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/selected-actions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "set-allowed-actions-for-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/selected-actions", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-default-workflow-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/workflow", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "set-default-workflow-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/workflow", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "get-the-audit-log-for-an-organization", - "subcategory": "orgs", - "verb": "get", - "requestPath": "/orgs/{org}/audit-log", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "list-custom-repository-roles-in-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/custom-repository-roles", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "orgs", - "slug": "get-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "orgs", - "slug": "list-app-installations-for-an-organization", - "subcategory": "orgs", - "verb": "get", - "requestPath": "/orgs/{org}/installations", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "list-repository-fine-grained-permissions-for-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/repository-fine-grained-permissions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "orgs", - "slug": "get-all-organization-repository-rulesets", - "subcategory": "rules", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "create-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "post", - "requestPath": "/orgs/{org}/rulesets", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "list-organization-rule-suites", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets/rule-suites", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "get-an-organization-rule-suite", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "get-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets/{ruleset_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "update-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "put", - "requestPath": "/orgs/{org}/rulesets/{ruleset_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "delete-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "delete", - "requestPath": "/orgs/{org}/rulesets/{ruleset_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "list-security-manager-teams", - "subcategory": "security-managers", - "verb": "get", - "requestPath": "/orgs/{org}/security-managers", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "add-a-security-manager-team", - "subcategory": "security-managers", - "verb": "put", - "requestPath": "/orgs/{org}/security-managers/teams/{team_slug}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "remove-a-security-manager-team", - "subcategory": "security-managers", - "verb": "delete", - "requestPath": "/orgs/{org}/security-managers/teams/{team_slug}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "billing", - "slug": "get-github-advanced-security-active-committers-for-an-organization", - "subcategory": "billing", - "verb": "get", - "requestPath": "/orgs/{org}/settings/billing/advanced-security", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "enable-or-disable-a-security-feature-for-an-organization", - "subcategory": "orgs", - "verb": "post", - "requestPath": "/orgs/{org}/{security_product}/{enablement}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "organization_custom_org_roles": { - "title": "Custom organization roles", - "displayTitle": "Organization permissions for \"Custom organization roles\"", - "permissions": [ - { - "category": "orgs", - "slug": "list-organization-fine-grained-permissions-for-an-organization", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-fine-grained-permissions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "get-all-organization-roles-for-an-organization", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "create-a-custom-organization-role", - "subcategory": "organization-roles", - "verb": "post", - "requestPath": "/orgs/{org}/organization-roles", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "get-an-organization-role", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles/{role_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "update-a-custom-organization-role", - "subcategory": "organization-roles", - "verb": "patch", - "requestPath": "/orgs/{org}/organization-roles/{role_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "delete-a-custom-organization-role", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/{role_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "organization_custom_properties": { - "title": "Custom properties", - "displayTitle": "Organization permissions for \"Custom properties\"", - "permissions": [ - { - "category": "orgs", - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "list-custom-property-values-for-organization-repositories", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/values", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "create-or-update-custom-property-values-for-organization-repositories", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/values", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "organization_custom_roles": { - "title": "Custom repository roles", - "displayTitle": "Organization permissions for \"Custom repository roles\"", - "permissions": [ - { - "category": "orgs", - "slug": "closing-down---list-custom-repository-roles-in-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/organizations/{organization_id}/custom_roles", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "orgs", - "slug": "list-custom-repository-roles-in-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/custom-repository-roles", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "orgs", - "slug": "create-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "post", - "requestPath": "/orgs/{org}/custom-repository-roles", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "get-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "orgs", - "slug": "update-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "patch", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "delete-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "list-repository-fine-grained-permissions-for-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/repository-fine-grained-permissions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - } - ] - }, - "organization_events": { - "title": "Events", - "displayTitle": "Organization permissions for \"Events\"", - "permissions": [ - { - "category": "activity", - "slug": "list-organization-events-for-the-authenticated-user", - "subcategory": "events", - "verb": "get", - "requestPath": "/users/{username}/events/orgs/{org}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - } - ] - }, - "members": { - "title": "Members", - "displayTitle": "Organization permissions for \"Members\"", - "permissions": [ - { - "category": "teams", - "slug": "get-an-external-group", - "subcategory": "external-groups", - "verb": "get", - "requestPath": "/orgs/{org}/external-group/{group_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "list-external-groups-available-to-an-organization", - "subcategory": "external-groups", - "verb": "get", - "requestPath": "/orgs/{org}/external-groups", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "list-organization-members", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/members", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "check-organization-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/members/{username}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "remove-an-organization-member", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/members/{username}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "get-organization-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/memberships/{username}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "set-organization-membership-for-a-user", - "subcategory": "members", - "verb": "put", - "requestPath": "/orgs/{org}/memberships/{username}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "remove-organization-membership-for-a-user", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/memberships/{username}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "remove-all-organization-roles-for-a-team", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/teams/{team_slug}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "assign-an-organization-role-to-a-team", - "subcategory": "organization-roles", - "verb": "put", - "requestPath": "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "remove-an-organization-role-from-a-team", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "remove-all-organization-roles-for-a-user", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/users/{username}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "assign-an-organization-role-to-a-user", - "subcategory": "organization-roles", - "verb": "put", - "requestPath": "/orgs/{org}/organization-roles/users/{username}/{role_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "remove-an-organization-role-from-a-user", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/users/{username}/{role_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "list-teams-that-are-assigned-to-an-organization-role", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles/{role_id}/teams", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "list-users-that-are-assigned-to-an-organization-role", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles/{role_id}/users", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "list-outside-collaborators-for-an-organization", - "subcategory": "outside-collaborators", - "verb": "get", - "requestPath": "/orgs/{org}/outside_collaborators", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "convert-an-organization-member-to-outside-collaborator", - "subcategory": "outside-collaborators", - "verb": "put", - "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "remove-outside-collaborator-from-an-organization", - "subcategory": "outside-collaborators", - "verb": "delete", - "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "list-public-organization-members", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/public_members", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "check-public-organization-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/public_members/{username}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "set-public-organization-membership-for-the-authenticated-user", - "subcategory": "members", - "verb": "put", - "requestPath": "/orgs/{org}/public_members/{username}", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "remove-public-organization-membership-for-the-authenticated-user", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/public_members/{username}", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "list-teams", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "create-a-team", - "subcategory": "teams", - "verb": "post", - "requestPath": "/orgs/{org}/teams", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "get-a-team-by-name", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "update-a-team", - "subcategory": "teams", - "verb": "patch", - "requestPath": "/orgs/{org}/teams/{team_slug}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "delete-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "list-a-connection-between-an-external-group-and-a-team", - "subcategory": "external-groups", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "update-the-connection-between-an-external-group-and-a-team", - "subcategory": "external-groups", - "verb": "patch", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "remove-the-connection-between-an-external-group-and-a-team", - "subcategory": "external-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "list-team-members", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/members", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "get-team-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "add-or-update-team-membership-for-a-user", - "subcategory": "members", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "remove-team-membership-for-a-user", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "list-team-repositories", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "list-child-teams", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/teams", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "get-a-team-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "update-a-team-legacy", - "subcategory": "teams", - "verb": "patch", - "requestPath": "/teams/{team_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "delete-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "list-team-members-legacy", - "subcategory": "members", - "verb": "get", - "requestPath": "/teams/{team_id}/members", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "get-team-member-legacy", - "subcategory": "members", - "verb": "get", - "requestPath": "/teams/{team_id}/members/{username}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "add-team-member-legacy", - "subcategory": "members", - "verb": "put", - "requestPath": "/teams/{team_id}/members/{username}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "remove-team-member-legacy", - "subcategory": "members", - "verb": "delete", - "requestPath": "/teams/{team_id}/members/{username}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "get-team-membership-for-a-user-legacy", - "subcategory": "members", - "verb": "get", - "requestPath": "/teams/{team_id}/memberships/{username}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "add-or-update-team-membership-for-a-user-legacy", - "subcategory": "members", - "verb": "put", - "requestPath": "/teams/{team_id}/memberships/{username}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "remove-team-membership-for-a-user-legacy", - "subcategory": "members", - "verb": "delete", - "requestPath": "/teams/{team_id}/memberships/{username}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "list-team-repositories-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "list-child-teams-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/teams", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "get-an-organization-membership-for-the-authenticated-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/user/memberships/orgs/{org}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "update-an-organization-membership-for-the-authenticated-user", - "subcategory": "members", - "verb": "patch", - "requestPath": "/user/memberships/orgs/{org}", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - } - ] - }, - "organization_announcement_banners": { - "title": "Organization announcement banners", - "displayTitle": "Organization permissions for \"Organization announcement banners\"", - "permissions": [ - { - "category": "announcement-banners", - "slug": "get-announcement-banner-for-organization", - "subcategory": "organizations", - "verb": "get", - "requestPath": "/orgs/{org}/announcement", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "announcement-banners", - "slug": "set-announcement-banner-for-organization", - "subcategory": "organizations", - "verb": "patch", - "requestPath": "/orgs/{org}/announcement", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "announcement-banners", - "slug": "remove-announcement-banner-from-organization", - "subcategory": "organizations", - "verb": "delete", - "requestPath": "/orgs/{org}/announcement", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "organization_dependabot_secrets": { - "title": "Organization dependabot secrets", - "displayTitle": "Organization permissions for \"Organization dependabot secrets\"", - "permissions": [ - { - "category": "dependabot", - "slug": "list-organization-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "dependabot", - "slug": "get-an-organization-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets/public-key", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "dependabot", - "slug": "get-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "dependabot", - "slug": "create-or-update-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "dependabot", - "slug": "delete-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "dependabot", - "slug": "list-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "dependabot", - "slug": "set-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "dependabot", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "dependabot", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - } - ] - }, - "organization_pre_receive_hooks": { - "title": "Organization pre-receive hooks", - "displayTitle": "Organization permissions for \"Organization pre-receive hooks\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-pre-receive-hooks-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "get-a-pre-receive-hook-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "update-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "patch", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "remove-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "delete", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "organization_personal_access_token_requests": { - "title": "Personal access token requests", - "displayTitle": "Organization permissions for \"Personal access token requests\"", - "permissions": [ - { - "category": "orgs", - "slug": "list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens", - "subcategory": "personal-access-tokens", - "verb": "get", - "requestPath": "/orgs/{org}/personal-access-token-requests", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens", - "subcategory": "personal-access-tokens", - "verb": "post", - "requestPath": "/orgs/{org}/personal-access-token-requests", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token", - "subcategory": "personal-access-tokens", - "verb": "post", - "requestPath": "/orgs/{org}/personal-access-token-requests/{pat_request_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token", - "subcategory": "personal-access-tokens", - "verb": "get", - "requestPath": "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "organization_personal_access_tokens": { - "title": "Personal access tokens", - "displayTitle": "Organization permissions for \"Personal access tokens\"", - "permissions": [ - { - "category": "orgs", - "slug": "list-fine-grained-personal-access-tokens-with-access-to-organization-resources", - "subcategory": "personal-access-tokens", - "verb": "get", - "requestPath": "/orgs/{org}/personal-access-tokens", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens", - "subcategory": "personal-access-tokens", - "verb": "post", - "requestPath": "/orgs/{org}/personal-access-tokens", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources", - "subcategory": "personal-access-tokens", - "verb": "post", - "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "list-repositories-a-fine-grained-personal-access-token-has-access-to", - "subcategory": "personal-access-tokens", - "verb": "get", - "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "organization_secrets": { - "title": "Secrets", - "displayTitle": "Organization permissions for \"Secrets\"", - "permissions": [ - { - "category": "actions", - "slug": "list-organization-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-an-organization-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/public-key", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "create-or-update-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "delete-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "set-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - } - ] - }, - "organization_self_hosted_runners": { - "title": "Self-hosted runners", - "displayTitle": "Organization permissions for \"Self-hosted runners\"", - "permissions": [ - { - "category": "actions", - "slug": "list-self-hosted-runner-groups-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "create-a-self-hosted-runner-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runner-groups", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-a-self-hosted-runner-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "update-a-self-hosted-runner-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "patch", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "delete-a-self-hosted-runner-group-from-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "set-repository-access-for-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "actions", - "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "actions", - "slug": "list-self-hosted-runners-in-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "set-self-hosted-runners-in-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "add-a-self-hosted-runner-to-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "remove-a-self-hosted-runner-from-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-self-hosted-runners-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-runner-applications-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/downloads", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "create-configuration-for-a-just-in-time-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/generate-jitconfig", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "create-a-registration-token-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/registration-token", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "create-a-remove-token-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/remove-token", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "delete-a-self-hosted-runner-from-an-organization", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-labels-for-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "add-custom-labels-to-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "set-custom-labels-for-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "remove-a-custom-label-from-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels/{name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "organization_actions_variables": { - "title": "Variables", - "displayTitle": "Organization permissions for \"Variables\"", - "permissions": [ - { - "category": "actions", - "slug": "list-organization-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "create-an-organization-variable", - "subcategory": "variables", - "verb": "post", - "requestPath": "/orgs/{org}/actions/variables", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-an-organization-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables/{name}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "update-an-organization-variable", - "subcategory": "variables", - "verb": "patch", - "requestPath": "/orgs/{org}/actions/variables/{name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "delete-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-selected-repositories-for-an-organization-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "set-selected-repositories-for-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - } - ] - }, - "organization_hooks": { - "title": "Webhooks", - "displayTitle": "Organization permissions for \"Webhooks\"", - "permissions": [ - { - "category": "orgs", - "slug": "list-organization-webhooks", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "create-an-organization-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/orgs/{org}/hooks", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "get-an-organization-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "update-an-organization-webhook", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/orgs/{org}/hooks/{hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "delete-an-organization-webhook", - "subcategory": "webhooks", - "verb": "delete", - "requestPath": "/orgs/{org}/hooks/{hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "get-a-webhook-configuration-for-an-organization", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/config", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "update-a-webhook-configuration-for-an-organization", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/orgs/{org}/hooks/{hook_id}/config", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "list-deliveries-for-an-organization-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "get-a-webhook-delivery-for-an-organization-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "redeliver-a-delivery-for-an-organization-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "ping-an-organization-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/orgs/{org}/hooks/{hook_id}/pings", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "actions": { - "title": "Actions", - "displayTitle": "Repository permissions for \"Actions\"", - "permissions": [ - { - "category": "actions", - "slug": "list-artifacts-for-a-repository", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-an-artifact", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "delete-an-artifact", - "subcategory": "artifacts", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "download-an-artifact", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-github-actions-cache-usage-for-a-repository", - "subcategory": "cache", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/cache/usage", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-github-actions-cache-usage-policy-for-a-repository", - "subcategory": "cache", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/cache/usage-policy", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-github-actions-caches-for-a-repository", - "subcategory": "cache", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/caches", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "delete-github-actions-caches-for-a-repository-using-a-cache-key", - "subcategory": "cache", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/caches", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "delete-a-github-actions-cache-for-a-repository-using-a-cache-id", - "subcategory": "cache", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/caches/{cache_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-a-job-for-a-workflow-run", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "download-job-logs-for-a-workflow-run", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "re-run-a-job-from-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-the-customization-template-for-an-oidc-subject-claim-for-a-repository", - "subcategory": "oidc", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/oidc/customization/sub", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "set-the-customization-template-for-an-oidc-subject-claim-for-a-repository", - "subcategory": "oidc", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/oidc/customization/sub", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-workflow-runs-for-a-repository", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "delete-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-the-review-history-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-workflow-run-artifacts", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-a-workflow-run-attempt", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-jobs-for-a-workflow-run-attempt", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "download-workflow-run-attempt-logs", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "cancel-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "force-cancel-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-jobs-for-a-workflow-run", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "download-workflow-run-logs", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "delete-workflow-run-logs", - "subcategory": "workflow-runs", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "re-run-a-workflow", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "re-run-failed-jobs-from-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-repository-workflows", - "subcategory": "workflows", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/workflows", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-a-workflow", - "subcategory": "workflows", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "disable-a-workflow", - "subcategory": "workflows", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "create-a-workflow-dispatch-event", - "subcategory": "workflows", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "enable-a-workflow", - "subcategory": "workflows", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-workflow-runs-for-a-workflow", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "list-environments", - "subcategory": "environments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "get-an-environment", - "subcategory": "environments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "list-deployment-branch-policies", - "subcategory": "branch-policies", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "get-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "get-all-deployment-protection-rules-for-an-environment", - "subcategory": "protection-rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "get-a-custom-deployment-protection-rule", - "subcategory": "protection-rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "administration": { - "title": "Administration", - "displayTitle": "Repository permissions for \"Administration\"", - "permissions": [ - { - "category": "repos", - "slug": "create-an-organization-repository", - "subcategory": "repos", - "verb": "post", - "requestPath": "/orgs/{org}/repos", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "update-a-repository", - "subcategory": "repos", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "delete-a-repository", - "subcategory": "repos", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "set-github-actions-cache-usage-policy-for-a-repository", - "subcategory": "cache", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/actions/cache/usage-policy", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-github-actions-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "set-github-actions-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-the-level-of-access-for-workflows-outside-of-the-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/access", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "set-the-level-of-access-for-workflows-outside-of-the-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/access", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-allowed-actions-for-a-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "set-allowed-actions-for-a-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-default-workflow-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "set-default-workflow-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-self-hosted-runners-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-runner-applications-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/downloads", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "create-configuration-for-a-just-in-time-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/generate-jitconfig", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "create-a-registration-token-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/registration-token", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "create-a-remove-token-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/remove-token", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "delete-a-self-hosted-runner-from-a-repository", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-labels-for-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "add-custom-labels-to-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "set-custom-labels-for-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "remove-a-custom-label-from-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "get-all-autolinks-of-a-repository", - "subcategory": "autolinks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/autolinks", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "create-an-autolink-reference-for-a-repository", - "subcategory": "autolinks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/autolinks", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "get-an-autolink-reference-of-a-repository", - "subcategory": "autolinks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "delete-an-autolink-reference-from-a-repository", - "subcategory": "autolinks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "check-if-dependabot-security-updates-are-enabled-for-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/automated-security-fixes", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "get-branch-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "update-branch-protection", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "delete-branch-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "get-admin-branch-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "set-admin-branch-protection", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "delete-admin-branch-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "get-pull-request-review-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "update-pull-request-review-protection", - "subcategory": "branch-protection", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "delete-pull-request-review-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "get-commit-signature-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "create-commit-signature-protection", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "delete-commit-signature-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "get-status-checks-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "update-status-check-protection", - "subcategory": "branch-protection", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "remove-status-check-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "get-all-status-check-contexts", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "add-status-check-contexts", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "set-status-check-contexts", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "remove-status-check-contexts", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "get-access-restrictions", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "delete-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "get-apps-with-access-to-the-protected-branch", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "add-app-access-restrictions", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "set-app-access-restrictions", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "remove-app-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "get-teams-with-access-to-the-protected-branch", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "add-team-access-restrictions", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "set-team-access-restrictions", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "remove-team-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "get-users-with-access-to-the-protected-branch", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "add-user-access-restrictions", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "set-user-access-restrictions", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "remove-user-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "code-scanning", - "slug": "get-a-code-scanning-default-setup-configuration", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/default-setup", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "code-scanning", - "slug": "update-a-code-scanning-default-setup-configuration", - "subcategory": "code-scanning", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/code-scanning/default-setup", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "add-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "remove-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "create-or-update-an-environment", - "subcategory": "environments", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "delete-an-environment", - "subcategory": "environments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "create-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "update-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "delete-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "create-a-custom-deployment-protection-rule-on-an-environment", - "subcategory": "protection-rules", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "list-custom-deployment-rule-integrations-available-for-an-environment", - "subcategory": "protection-rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "disable-a-custom-protection-rule-for-an-environment", - "subcategory": "protection-rules", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "create-a-fork", - "subcategory": "forks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/forks", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "collaborators", - "slug": "list-repository-invitations", - "subcategory": "invitations", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/invitations", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "collaborators", - "slug": "update-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "delete-a-repository-invitation", - "subcategory": "invitations", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deploy-keys", - "slug": "list-deploy-keys", - "subcategory": "deploy-keys", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/keys", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deploy-keys", - "slug": "create-a-deploy-key", - "subcategory": "deploy-keys", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/keys", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deploy-keys", - "slug": "get-a-deploy-key", - "subcategory": "deploy-keys", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deploy-keys", - "slug": "delete-a-deploy-key", - "subcategory": "deploy-keys", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pages", - "slug": "create-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "pages", - "slug": "update-information-about-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pages", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "pages", - "slug": "delete-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pages", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "list-repository-cache-replication-status", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/replicas/caches", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "create-a-repository-ruleset", - "subcategory": "rules", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/rulesets", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "list-repository-rule-suites", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets/rule-suites", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "get-a-repository-rule-suite", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "update-a-repository-ruleset", - "subcategory": "rules", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/rulesets/{ruleset_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "delete-a-repository-ruleset", - "subcategory": "rules", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/rulesets/{ruleset_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "list-repository-teams", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/teams", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "replace-all-repository-topics", - "subcategory": "repos", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/topics", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "transfer-a-repository", - "subcategory": "repos", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/transfer", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "check-if-vulnerability-alerts-are-enabled-for-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "enable-vulnerability-alerts", - "subcategory": "repos", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "disable-vulnerability-alerts", - "subcategory": "repos", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "create-a-repository-using-a-template", - "subcategory": "repos", - "verb": "post", - "requestPath": "/repos/{template_owner}/{template_repo}/generate", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "create-a-repository-for-the-authenticated-user", - "subcategory": "repos", - "verb": "post", - "requestPath": "/user/repos", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "list-repository-invitations-for-the-authenticated-user", - "subcategory": "invitations", - "verb": "get", - "requestPath": "/user/repository_invitations", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "accept-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "decline-a-repository-invitation", - "subcategory": "invitations", - "verb": "delete", - "requestPath": "/user/repository_invitations/{invitation_id}", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - } - ] - }, - "checks": { - "title": "Checks", - "displayTitle": "Repository permissions for \"Checks\"", - "permissions": [ - { - "category": "checks", - "slug": "create-a-check-run", - "subcategory": "runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-runs", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "checks", - "slug": "get-a-check-run", - "subcategory": "runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "checks", - "slug": "update-a-check-run", - "subcategory": "runs", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "checks", - "slug": "list-check-run-annotations", - "subcategory": "runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "checks", - "slug": "rerequest-a-check-run", - "subcategory": "runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "checks", - "slug": "create-a-check-suite", - "subcategory": "suites", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-suites", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "checks", - "slug": "update-repository-preferences-for-check-suites", - "subcategory": "suites", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/check-suites/preferences", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "checks", - "slug": "get-a-check-suite", - "subcategory": "suites", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "checks", - "slug": "list-check-runs-in-a-check-suite", - "subcategory": "runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "checks", - "slug": "rerequest-a-check-suite", - "subcategory": "suites", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "checks", - "slug": "list-check-runs-for-a-git-reference", - "subcategory": "runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-runs", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "checks", - "slug": "list-check-suites-for-a-git-reference", - "subcategory": "suites", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-suites", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "security_events": { - "title": "Code scanning alerts", - "displayTitle": "Repository permissions for \"Code scanning alerts\"", - "permissions": [ - { - "category": "code-scanning", - "slug": "list-code-scanning-alerts-for-an-organization", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/orgs/{org}/code-scanning/alerts", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "code-scanning", - "slug": "list-code-scanning-alerts-for-a-repository", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "code-scanning", - "slug": "get-a-code-scanning-alert", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "code-scanning", - "slug": "update-a-code-scanning-alert", - "subcategory": "code-scanning", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "code-scanning", - "slug": "list-instances-of-a-code-scanning-alert", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "code-scanning", - "slug": "list-code-scanning-analyses-for-a-repository", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "code-scanning", - "slug": "get-a-code-scanning-analysis-for-a-repository", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "code-scanning", - "slug": "delete-a-code-scanning-analysis-from-a-repository", - "subcategory": "code-scanning", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "code-scanning", - "slug": "upload-an-analysis-as-sarif-data", - "subcategory": "code-scanning", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "code-scanning", - "slug": "get-information-about-a-sarif-upload", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "statuses": { - "title": "Commit statuses", - "displayTitle": "Repository permissions for \"Commit statuses\"", - "permissions": [ - { - "category": "commits", - "slug": "get-the-combined-status-for-a-specific-reference", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/status", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "list-commit-statuses-for-a-reference", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/statuses", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "create-a-commit-status", - "subcategory": "statuses", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/statuses/{sha}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "contents": { - "title": "Contents", - "displayTitle": "Repository permissions for \"Contents\"", - "permissions": [ - { - "category": "markdown", - "slug": "render-a-markdown-document", - "subcategory": "markdown", - "verb": "post", - "requestPath": "/markdown", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "list-repository-activities", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/activity", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "list-branches", - "subcategory": "branches", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "get-a-branch", - "subcategory": "branches", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "rename-a-branch", - "subcategory": "branches", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "list-codeowners-errors", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/codeowners/errors", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "update-a-commit-comment", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "delete-a-commit-comment", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "reactions", - "slug": "create-reaction-for-a-commit-comment", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "reactions", - "slug": "delete-a-commit-comment-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "list-commits", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "list-branches-for-head-commit", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "create-a-commit-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "get-a-commit", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "compare-two-commits", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "get-repository-content", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "create-or-update-file-contents", - "subcategory": "contents", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "create-or-update-file-contents", - "subcategory": "contents", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "delete-a-file", - "subcategory": "contents", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "delete-a-file", - "subcategory": "contents", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "dependency-graph", - "slug": "get-a-diff-of-the-dependencies-between-commits", - "subcategory": "dependency-review", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "dependency-graph", - "slug": "export-a-software-bill-of-materials-sbom-for-a-repository", - "subcategory": "sboms", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependency-graph/sbom", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "dependency-graph", - "slug": "create-a-snapshot-of-dependencies-for-a-repository", - "subcategory": "dependency-submission", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/dependency-graph/snapshots", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "create-a-repository-dispatch-event", - "subcategory": "repos", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/dispatches", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "create-a-fork", - "subcategory": "forks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/forks", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "git", - "slug": "create-a-blob", - "subcategory": "blobs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/blobs", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "git", - "slug": "get-a-blob", - "subcategory": "blobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/blobs/{file_sha}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "git", - "slug": "create-a-commit", - "subcategory": "commits", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/commits", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "git", - "slug": "get-a-commit-object", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "git", - "slug": "list-matching-references", - "subcategory": "refs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/matching-refs/{ref}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "git", - "slug": "get-a-reference", - "subcategory": "refs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/ref/{ref}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "git", - "slug": "create-a-reference", - "subcategory": "refs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/refs", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "git", - "slug": "create-a-reference", - "subcategory": "refs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/refs", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "git", - "slug": "update-a-reference", - "subcategory": "refs", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "git", - "slug": "update-a-reference", - "subcategory": "refs", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "git", - "slug": "delete-a-reference", - "subcategory": "refs", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "git", - "slug": "create-a-tag-object", - "subcategory": "tags", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/tags", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "git", - "slug": "get-a-tag", - "subcategory": "tags", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/tags/{tag_sha}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "git", - "slug": "create-a-tree", - "subcategory": "trees", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/trees", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "git", - "slug": "get-a-tree", - "subcategory": "trees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/trees/{tree_sha}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "sync-a-fork-branch-with-the-upstream-repository", - "subcategory": "branches", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merge-upstream", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "branches", - "slug": "merge-a-branch", - "subcategory": "branches", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merges", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "get-a-pull-request", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "pulls", - "slug": "merge-a-pull-request", - "subcategory": "pulls", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "get-a-repository-readme", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/readme", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "get-a-repository-readme-for-a-directory", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/readme/{dir}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "releases", - "slug": "list-releases", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "releases", - "slug": "create-a-release", - "subcategory": "releases", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "releases", - "slug": "create-a-release", - "subcategory": "releases", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "releases", - "slug": "get-a-release-asset", - "subcategory": "assets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "releases", - "slug": "update-a-release-asset", - "subcategory": "assets", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "releases", - "slug": "delete-a-release-asset", - "subcategory": "assets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "releases", - "slug": "generate-release-notes-content-for-a-release", - "subcategory": "releases", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases/generate-notes", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "releases", - "slug": "get-the-latest-release", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/latest", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "releases", - "slug": "get-a-release-by-tag-name", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "releases", - "slug": "get-a-release", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "releases", - "slug": "update-a-release", - "subcategory": "releases", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "releases", - "slug": "delete-a-release", - "subcategory": "releases", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "releases", - "slug": "list-release-assets", - "subcategory": "assets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "download-a-repository-archive-tar", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/tarball/{ref}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "download-a-repository-archive-zip", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/zipball/{ref}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "create-a-repository-using-a-template", - "subcategory": "repos", - "verb": "post", - "requestPath": "/repos/{template_owner}/{template_repo}/generate", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - } - ] - }, - "repository_custom_properties": { - "title": "Custom properties", - "displayTitle": "Repository permissions for \"Custom properties\"", - "permissions": [ - { - "category": "repos", - "slug": "create-or-update-custom-property-values-for-a-repository", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/properties/values", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "vulnerability_alerts": { - "title": "Dependabot alerts", - "displayTitle": "Repository permissions for \"Dependabot alerts\"", - "permissions": [ - { - "category": "dependabot", - "slug": "list-dependabot-alerts-for-an-organization", - "subcategory": "alerts", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/alerts", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "dependabot", - "slug": "list-dependabot-alerts-for-a-repository", - "subcategory": "alerts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/alerts", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "dependabot", - "slug": "get-a-dependabot-alert", - "subcategory": "alerts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "dependabot", - "slug": "update-a-dependabot-alert", - "subcategory": "alerts", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "dependabot_secrets": { - "title": "Dependabot secrets", - "displayTitle": "Repository permissions for \"Dependabot secrets\"", - "permissions": [ - { - "category": "dependabot", - "slug": "list-repository-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "dependabot", - "slug": "get-a-repository-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/public-key", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "dependabot", - "slug": "get-a-repository-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "dependabot", - "slug": "create-or-update-a-repository-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "dependabot", - "slug": "delete-a-repository-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "deployments": { - "title": "Deployments", - "displayTitle": "Repository permissions for \"Deployments\"", - "permissions": [ - { - "category": "actions", - "slug": "review-custom-deployment-protection-rules-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule", - "access": "write", - "user-to-server": false, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "list-deployments", - "subcategory": "deployments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "create-a-deployment", - "subcategory": "deployments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/deployments", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "get-a-deployment", - "subcategory": "deployments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "delete-a-deployment", - "subcategory": "deployments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "list-deployment-statuses", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "create-a-deployment-status", - "subcategory": "statuses", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "deployments", - "slug": "get-a-deployment-status", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "environments": { - "title": "Environments", - "displayTitle": "Repository permissions for \"Environments\"", - "permissions": [ - { - "category": "actions", - "slug": "list-environment-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-an-environment-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-an-environment-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "create-or-update-an-environment-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "delete-an-environment-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-environment-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "create-an-environment-variable", - "subcategory": "variables", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-an-environment-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "update-an-environment-variable", - "subcategory": "variables", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "delete-an-environment-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "issues": { - "title": "Issues", - "displayTitle": "Repository permissions for \"Issues\"", - "permissions": [ - { - "category": "issues", - "slug": "list-assignees", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/assignees", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "check-if-a-user-can-be-assigned", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/assignees/{assignee}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "list-repository-issues", - "subcategory": "issues", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "issues", - "slug": "create-an-issue", - "subcategory": "issues", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "issues", - "slug": "list-issue-comments-for-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "get-an-issue-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "update-an-issue-comment", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "delete-an-issue-comment", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "reactions", - "slug": "list-reactions-for-an-issue-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "reactions", - "slug": "create-reaction-for-an-issue-comment", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "reactions", - "slug": "delete-an-issue-comment-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "issues", - "slug": "list-issue-events-for-a-repository", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/events", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "issues", - "slug": "get-an-issue-event", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "get-an-issue", - "subcategory": "issues", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "issues", - "slug": "update-an-issue", - "subcategory": "issues", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "add-assignees-to-an-issue", - "subcategory": "assignees", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "remove-assignees-from-an-issue", - "subcategory": "assignees", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "check-if-a-user-can-be-assigned-to-a-issue", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "list-issue-comments", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "create-an-issue-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "list-issue-events", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "list-issue-field-values-for-an-issue", - "subcategory": "issue-field-values", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "issues", - "slug": "list-labels-for-an-issue", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "add-labels-to-an-issue", - "subcategory": "labels", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "set-labels-for-an-issue", - "subcategory": "labels", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "remove-all-labels-from-an-issue", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "remove-a-label-from-an-issue", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "lock-an-issue", - "subcategory": "issues", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "unlock-an-issue", - "subcategory": "issues", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "reactions", - "slug": "list-reactions-for-an-issue", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "reactions", - "slug": "create-reaction-for-an-issue", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "reactions", - "slug": "delete-an-issue-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "issues", - "slug": "list-timeline-events-for-an-issue", - "subcategory": "timeline", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "list-labels-for-a-repository", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/labels", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "create-a-label", - "subcategory": "labels", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/labels", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "get-a-label", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "update-a-label", - "subcategory": "labels", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "delete-a-label", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "list-milestones", - "subcategory": "milestones", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "create-a-milestone", - "subcategory": "milestones", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/milestones", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "get-a-milestone", - "subcategory": "milestones", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "update-a-milestone", - "subcategory": "milestones", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "delete-a-milestone", - "subcategory": "milestones", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "list-labels-for-issues-in-a-milestone", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - } - ] - }, - "metadata": { - "title": "Metadata", - "displayTitle": "Repository permissions for \"Metadata\"", - "permissions": [ - { - "category": "repos", - "slug": "list-organization-repositories", - "subcategory": "repos", - "verb": "get", - "requestPath": "/orgs/{org}/repos", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "get-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "list-repository-collaborators", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "check-if-a-user-is-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "get-repository-permissions-for-a-user", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "list-commit-comments-for-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "get-a-commit-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "reactions", - "slug": "list-reactions-for-a-commit-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "list-commit-comments", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "list-repository-contributors", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/contributors", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "activity", - "slug": "list-repository-events", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/events", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "list-forks", - "subcategory": "forks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/forks", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "list-repository-languages", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/languages", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "licenses", - "slug": "get-the-license-for-a-repository", - "subcategory": "licenses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/license", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "get-all-custom-property-values-for-a-repository", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/properties/values", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "get-rules-for-a-branch", - "subcategory": "rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rules/branches/{branch}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "get-all-repository-rulesets", - "subcategory": "rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "get-a-repository-ruleset", - "subcategory": "rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets/{ruleset_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "activity", - "slug": "list-stargazers", - "subcategory": "starring", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stargazers", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "metrics", - "slug": "get-the-weekly-commit-activity", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/code_frequency", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "metrics", - "slug": "get-the-last-year-of-commit-activity", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/commit_activity", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "metrics", - "slug": "get-all-contributor-commit-activity", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/contributors", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "metrics", - "slug": "get-the-weekly-commit-count", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/participation", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "metrics", - "slug": "get-the-hourly-commit-count-for-each-day", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/punch_card", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "activity", - "slug": "list-watchers", - "subcategory": "watching", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/subscribers", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "list-repository-tags", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/tags", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "get-all-repository-topics", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/topics", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "list-public-repositories", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repositories", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "search", - "slug": "search-labels", - "subcategory": "search", - "verb": "get", - "requestPath": "/search/labels", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "apps", - "slug": "list-repositories-accessible-to-the-user-access-token", - "subcategory": "installations", - "verb": "get", - "requestPath": "/user/installations/{installation_id}/repositories", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "list-repositories-for-the-authenticated-user", - "subcategory": "repos", - "verb": "get", - "requestPath": "/user/repos", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "list-repositories-for-a-user", - "subcategory": "repos", - "verb": "get", - "requestPath": "/users/{username}/repos", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "pages": { - "title": "Pages", - "displayTitle": "Repository permissions for \"Pages\"", - "permissions": [ - { - "category": "pages", - "slug": "get-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pages", - "slug": "create-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "pages", - "slug": "update-information-about-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pages", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "pages", - "slug": "delete-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pages", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "pages", - "slug": "list-github-enterprise-server-pages-builds", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/builds", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pages", - "slug": "request-a-github-enterprise-server-pages-build", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/builds", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pages", - "slug": "get-latest-pages-build", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/builds/latest", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pages", - "slug": "get-github-enterprise-server-pages-build", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/builds/{build_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pages", - "slug": "create-a-github-pages-deployment", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployments", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pages", - "slug": "get-the-status-of-a-github-pages-deployment", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pages", - "slug": "cancel-a-github-pages-deployment", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "pull_requests": { - "title": "Pull requests", - "displayTitle": "Repository permissions for \"Pull requests\"", - "permissions": [ - { - "category": "issues", - "slug": "list-assignees", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/assignees", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "check-if-a-user-can-be-assigned", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/assignees/{assignee}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "commits", - "slug": "list-pull-requests-associated-with-a-commit", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "issues", - "slug": "list-issue-comments-for-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "get-an-issue-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "update-an-issue-comment", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "delete-an-issue-comment", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "get-an-issue-event", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "update-an-issue", - "subcategory": "issues", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "add-assignees-to-an-issue", - "subcategory": "assignees", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "remove-assignees-from-an-issue", - "subcategory": "assignees", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "check-if-a-user-can-be-assigned-to-a-issue", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "list-issue-comments", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "create-an-issue-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "list-issue-events", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "list-labels-for-an-issue", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "add-labels-to-an-issue", - "subcategory": "labels", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "set-labels-for-an-issue", - "subcategory": "labels", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "remove-all-labels-from-an-issue", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "remove-a-label-from-an-issue", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "lock-an-issue", - "subcategory": "issues", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "unlock-an-issue", - "subcategory": "issues", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "list-timeline-events-for-an-issue", - "subcategory": "timeline", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "list-labels-for-a-repository", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/labels", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "create-a-label", - "subcategory": "labels", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/labels", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "get-a-label", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "update-a-label", - "subcategory": "labels", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "delete-a-label", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "list-milestones", - "subcategory": "milestones", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "create-a-milestone", - "subcategory": "milestones", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/milestones", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "get-a-milestone", - "subcategory": "milestones", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "update-a-milestone", - "subcategory": "milestones", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "delete-a-milestone", - "subcategory": "milestones", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "issues", - "slug": "list-labels-for-issues-in-a-milestone", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "pulls", - "slug": "list-pull-requests", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "create-a-pull-request", - "subcategory": "pulls", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "list-review-comments-in-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/comments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "get-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "update-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "delete-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "reactions", - "slug": "list-reactions-for-a-pull-request-review-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "reactions", - "slug": "create-reaction-for-a-pull-request-review-comment", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "reactions", - "slug": "delete-a-pull-request-comment-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "get-a-pull-request", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "pulls", - "slug": "update-a-pull-request", - "subcategory": "pulls", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "list-review-comments-on-a-pull-request", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "create-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "create-a-reply-for-a-review-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "list-commits-on-a-pull-request", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "list-pull-requests-files", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/files", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "check-if-a-pull-request-has-been-merged", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "get-all-requested-reviewers-for-a-pull-request", - "subcategory": "review-requests", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "request-reviewers-for-a-pull-request", - "subcategory": "review-requests", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "remove-requested-reviewers-from-a-pull-request", - "subcategory": "review-requests", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "list-reviews-for-a-pull-request", - "subcategory": "reviews", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "create-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "get-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "update-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "delete-a-pending-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "list-comments-for-a-pull-request-review", - "subcategory": "reviews", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "dismiss-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "submit-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "pulls", - "slug": "update-a-pull-request-branch", - "subcategory": "pulls", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "repository_pre_receive_hooks": { - "title": "Repository pre-receive hooks", - "displayTitle": "Repository permissions for \"Repository pre-receive hooks\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-pre-receive-hooks-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "get-a-pre-receive-hook-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "update-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "remove-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "secret_scanning_alerts": { - "title": "Secret scanning alerts", - "displayTitle": "Repository permissions for \"Secret scanning alerts\"", - "permissions": [ - { - "category": "secret-scanning", - "slug": "list-secret-scanning-alerts-for-an-organization", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/orgs/{org}/secret-scanning/alerts", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "secret-scanning", - "slug": "list-secret-scanning-alerts-for-a-repository", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "secret-scanning", - "slug": "get-a-secret-scanning-alert", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "secret-scanning", - "slug": "update-a-secret-scanning-alert", - "subcategory": "secret-scanning", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "secret-scanning", - "slug": "list-locations-for-a-secret-scanning-alert", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "secrets": { - "title": "Secrets", - "displayTitle": "Repository permissions for \"Secrets\"", - "permissions": [ - { - "category": "actions", - "slug": "list-repository-organization-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/organization-secrets", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-repository-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-a-repository-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/public-key", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-a-repository-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "create-or-update-a-repository-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "delete-a-repository-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "actions_variables": { - "title": "Variables", - "displayTitle": "Repository permissions for \"Variables\"", - "permissions": [ - { - "category": "actions", - "slug": "list-repository-organization-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/organization-variables", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "list-repository-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/variables", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "create-a-repository-variable", - "subcategory": "variables", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/variables", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "get-a-repository-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "update-a-repository-variable", - "subcategory": "variables", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "actions", - "slug": "delete-a-repository-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "repository_hooks": { - "title": "Webhooks", - "displayTitle": "Repository permissions for \"Webhooks\"", - "permissions": [ - { - "category": "repos", - "slug": "list-repository-webhooks", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "create-a-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "get-a-repository-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "update-a-repository-webhook", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "delete-a-repository-webhook", - "subcategory": "webhooks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "get-a-webhook-configuration-for-a-repository", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "update-a-webhook-configuration-for-a-repository", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "list-deliveries-for-a-repository-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "get-a-delivery-for-a-repository-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "redeliver-a-delivery-for-a-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "ping-a-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "repos", - "slug": "test-the-push-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "workflows": { - "title": "Workflows", - "displayTitle": "Repository permissions for \"Workflows\"", - "permissions": [ - { - "category": "repos", - "slug": "create-or-update-file-contents", - "subcategory": "contents", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "delete-a-file", - "subcategory": "contents", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "git", - "slug": "create-a-reference", - "subcategory": "refs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/refs", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "git", - "slug": "update-a-reference", - "subcategory": "refs", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "releases", - "slug": "create-a-release", - "subcategory": "releases", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - } - ] - }, - "emails": { - "title": "Email addresses", - "displayTitle": "User permissions for \"Email addresses\"", - "permissions": [ - { - "category": "users", - "slug": "list-email-addresses-for-the-authenticated-user", - "subcategory": "emails", - "verb": "get", - "requestPath": "/user/emails", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "add-an-email-address-for-the-authenticated-user", - "subcategory": "emails", - "verb": "post", - "requestPath": "/user/emails", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "delete-an-email-address-for-the-authenticated-user", - "subcategory": "emails", - "verb": "delete", - "requestPath": "/user/emails", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "list-public-email-addresses-for-the-authenticated-user", - "subcategory": "emails", - "verb": "get", - "requestPath": "/user/public_emails", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - } - ] - }, - "followers": { - "title": "Followers", - "displayTitle": "User permissions for \"Followers\"", - "permissions": [ - { - "category": "users", - "slug": "list-followers-of-the-authenticated-user", - "subcategory": "followers", - "verb": "get", - "requestPath": "/user/followers", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "list-the-people-the-authenticated-user-follows", - "subcategory": "followers", - "verb": "get", - "requestPath": "/user/following", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "check-if-a-person-is-followed-by-the-authenticated-user", - "subcategory": "followers", - "verb": "get", - "requestPath": "/user/following/{username}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "follow-a-user", - "subcategory": "followers", - "verb": "put", - "requestPath": "/user/following/{username}", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "unfollow-a-user", - "subcategory": "followers", - "verb": "delete", - "requestPath": "/user/following/{username}", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - } - ] - }, - "gpg_keys": { - "title": "GPG keys", - "displayTitle": "User permissions for \"GPG keys\"", - "permissions": [ - { - "category": "users", - "slug": "list-gpg-keys-for-the-authenticated-user", - "subcategory": "gpg-keys", - "verb": "get", - "requestPath": "/user/gpg_keys", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "create-a-gpg-key-for-the-authenticated-user", - "subcategory": "gpg-keys", - "verb": "post", - "requestPath": "/user/gpg_keys", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "get-a-gpg-key-for-the-authenticated-user", - "subcategory": "gpg-keys", - "verb": "get", - "requestPath": "/user/gpg_keys/{gpg_key_id}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "delete-a-gpg-key-for-the-authenticated-user", - "subcategory": "gpg-keys", - "verb": "delete", - "requestPath": "/user/gpg_keys/{gpg_key_id}", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - } - ] - }, - "gists": { - "title": "Gists", - "displayTitle": "User permissions for \"Gists\"", - "permissions": [ - { - "category": "gists", - "slug": "create-a-gist", - "subcategory": "gists", - "verb": "post", - "requestPath": "/gists", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "gists", - "slug": "update-a-gist", - "subcategory": "gists", - "verb": "patch", - "requestPath": "/gists/{gist_id}", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "gists", - "slug": "delete-a-gist", - "subcategory": "gists", - "verb": "delete", - "requestPath": "/gists/{gist_id}", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "gists", - "slug": "create-a-gist-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/gists/{gist_id}/comments", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "gists", - "slug": "update-a-gist-comment", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "gists", - "slug": "delete-a-gist-comment", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "gists", - "slug": "fork-a-gist", - "subcategory": "gists", - "verb": "post", - "requestPath": "/gists/{gist_id}/forks", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "gists", - "slug": "star-a-gist", - "subcategory": "gists", - "verb": "put", - "requestPath": "/gists/{gist_id}/star", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "gists", - "slug": "unstar-a-gist", - "subcategory": "gists", - "verb": "delete", - "requestPath": "/gists/{gist_id}/star", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - } - ] - }, - "keys": { - "title": "Git SSH keys", - "displayTitle": "User permissions for \"Git SSH keys\"", - "permissions": [ - { - "category": "users", - "slug": "list-public-ssh-keys-for-the-authenticated-user", - "subcategory": "keys", - "verb": "get", - "requestPath": "/user/keys", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "create-a-public-ssh-key-for-the-authenticated-user", - "subcategory": "keys", - "verb": "post", - "requestPath": "/user/keys", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "get-a-public-ssh-key-for-the-authenticated-user", - "subcategory": "keys", - "verb": "get", - "requestPath": "/user/keys/{key_id}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "delete-a-public-ssh-key-for-the-authenticated-user", - "subcategory": "keys", - "verb": "delete", - "requestPath": "/user/keys/{key_id}", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "list-public-keys-for-a-user", - "subcategory": "keys", - "verb": "get", - "requestPath": "/users/{username}/keys", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "private_repository_invitations": { - "title": "Private repository invitations", - "displayTitle": "User permissions for \"Private repository invitations\"", - "permissions": [ - { - "category": "collaborators", - "slug": "list-repository-invitations", - "subcategory": "invitations", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/invitations", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - } - ] - }, - "profile": { - "title": "Profile", - "displayTitle": "User permissions for \"Profile\"", - "permissions": [ - { - "category": "users", - "slug": "update-the-authenticated-user", - "subcategory": "users", - "verb": "patch", - "requestPath": "/user", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "add-social-accounts-for-the-authenticated-user", - "subcategory": "social-accounts", - "verb": "post", - "requestPath": "/user/social_accounts", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "delete-social-accounts-for-the-authenticated-user", - "subcategory": "social-accounts", - "verb": "delete", - "requestPath": "/user/social_accounts", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - } - ] - }, - "git_signing_ssh_public_keys": { - "title": "SSH signing keys", - "displayTitle": "User permissions for \"SSH signing keys\"", - "permissions": [ - { - "category": "users", - "slug": "list-ssh-signing-keys-for-the-authenticated-user", - "subcategory": "ssh-signing-keys", - "verb": "get", - "requestPath": "/user/ssh_signing_keys", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "create-a-ssh-signing-key-for-the-authenticated-user", - "subcategory": "ssh-signing-keys", - "verb": "post", - "requestPath": "/user/ssh_signing_keys", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "get-an-ssh-signing-key-for-the-authenticated-user", - "subcategory": "ssh-signing-keys", - "verb": "get", - "requestPath": "/user/ssh_signing_keys/{ssh_signing_key_id}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "users", - "slug": "delete-an-ssh-signing-key-for-the-authenticated-user", - "subcategory": "ssh-signing-keys", - "verb": "delete", - "requestPath": "/user/ssh_signing_keys/{ssh_signing_key_id}", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - } - ] - }, - "starring": { - "title": "Starring", - "displayTitle": "User permissions for \"Starring\"", - "permissions": [ - { - "category": "activity", - "slug": "list-repositories-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "activity", - "slug": "check-if-a-repository-is-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, - { - "category": "activity", - "slug": "star-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "put", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, - { - "category": "activity", - "slug": "unstar-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "delete", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "write", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, - { - "category": "activity", - "slug": "list-repositories-starred-by-a-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/users/{username}/starred", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, - "watching": { - "title": "Watching", - "displayTitle": "User permissions for \"Watching\"", - "permissions": [ - { - "category": "activity", - "slug": "list-repositories-watched-by-the-authenticated-user", - "subcategory": "watching", - "verb": "get", - "requestPath": "/user/subscriptions", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": false - }, - { - "category": "activity", - "slug": "list-repositories-watched-by-a-user", - "subcategory": "watching", - "verb": "get", - "requestPath": "/users/{username}/subscriptions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - } -} \ No newline at end of file diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json deleted file mode 100644 index c7ff6d213de9..000000000000 --- a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json +++ /dev/null @@ -1,4072 +0,0 @@ -{ - "actions": [ - { - "slug": "get-github-actions-cache-usage-for-an-enterprise", - "subcategory": "cache", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/cache/usage" - }, - { - "slug": "get-github-actions-cache-usage-policy-for-an-enterprise", - "subcategory": "cache", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/cache/usage-policy" - }, - { - "slug": "set-github-actions-cache-usage-policy-for-an-enterprise", - "subcategory": "cache", - "verb": "patch", - "requestPath": "/enterprises/{enterprise}/actions/cache/usage-policy" - }, - { - "slug": "get-github-actions-cache-usage-for-an-organization", - "subcategory": "cache", - "verb": "get", - "requestPath": "/orgs/{org}/actions/cache/usage" - }, - { - "slug": "list-repositories-with-github-actions-cache-usage-for-an-organization", - "subcategory": "cache", - "verb": "get", - "requestPath": "/orgs/{org}/actions/cache/usage-by-repository" - }, - { - "slug": "get-the-customization-template-for-an-oidc-subject-claim-for-an-organization", - "subcategory": "oidc", - "verb": "get", - "requestPath": "/orgs/{org}/actions/oidc/customization/sub" - }, - { - "slug": "set-the-customization-template-for-an-oidc-subject-claim-for-an-organization", - "subcategory": "oidc", - "verb": "put", - "requestPath": "/orgs/{org}/actions/oidc/customization/sub" - }, - { - "slug": "get-github-actions-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions" - }, - { - "slug": "set-github-actions-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions" - }, - { - "slug": "list-selected-repositories-enabled-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/repositories" - }, - { - "slug": "set-selected-repositories-enabled-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories" - }, - { - "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}" - }, - { - "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}" - }, - { - "slug": "get-allowed-actions-for-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/selected-actions" - }, - { - "slug": "set-allowed-actions-for-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/selected-actions" - }, - { - "slug": "get-default-workflow-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/workflow" - }, - { - "slug": "set-default-workflow-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/workflow" - }, - { - "slug": "list-self-hosted-runner-groups-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups" - }, - { - "slug": "create-a-self-hosted-runner-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runner-groups" - }, - { - "slug": "get-a-self-hosted-runner-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}" - }, - { - "slug": "update-a-self-hosted-runner-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "patch", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}" - }, - { - "slug": "delete-a-self-hosted-runner-group-from-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}" - }, - { - "slug": "list-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories" - }, - { - "slug": "set-repository-access-for-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories" - }, - { - "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}" - }, - { - "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}" - }, - { - "slug": "list-self-hosted-runners-in-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners" - }, - { - "slug": "set-self-hosted-runners-in-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners" - }, - { - "slug": "add-a-self-hosted-runner-to-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}" - }, - { - "slug": "remove-a-self-hosted-runner-from-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}" - }, - { - "slug": "list-self-hosted-runners-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners" - }, - { - "slug": "list-runner-applications-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/downloads" - }, - { - "slug": "create-configuration-for-a-just-in-time-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/generate-jitconfig" - }, - { - "slug": "create-a-registration-token-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/registration-token" - }, - { - "slug": "create-a-remove-token-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/remove-token" - }, - { - "slug": "get-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}" - }, - { - "slug": "delete-a-self-hosted-runner-from-an-organization", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}" - }, - { - "slug": "list-labels-for-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels" - }, - { - "slug": "add-custom-labels-to-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels" - }, - { - "slug": "set-custom-labels-for-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels" - }, - { - "slug": "remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels" - }, - { - "slug": "remove-a-custom-label-from-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels/{name}" - }, - { - "slug": "list-organization-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets" - }, - { - "slug": "get-an-organization-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/public-key" - }, - { - "slug": "get-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}" - }, - { - "slug": "create-or-update-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}" - }, - { - "slug": "delete-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}" - }, - { - "slug": "list-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories" - }, - { - "slug": "set-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories" - }, - { - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}" - }, - { - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}" - }, - { - "slug": "list-organization-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables" - }, - { - "slug": "create-an-organization-variable", - "subcategory": "variables", - "verb": "post", - "requestPath": "/orgs/{org}/actions/variables" - }, - { - "slug": "get-an-organization-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables/{name}" - }, - { - "slug": "update-an-organization-variable", - "subcategory": "variables", - "verb": "patch", - "requestPath": "/orgs/{org}/actions/variables/{name}" - }, - { - "slug": "delete-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}" - }, - { - "slug": "list-selected-repositories-for-an-organization-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories" - }, - { - "slug": "set-selected-repositories-for-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories" - }, - { - "slug": "add-selected-repository-to-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}" - }, - { - "slug": "remove-selected-repository-from-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}" - }, - { - "slug": "list-artifacts-for-a-repository", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts" - }, - { - "slug": "get-an-artifact", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}" - }, - { - "slug": "delete-an-artifact", - "subcategory": "artifacts", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}" - }, - { - "slug": "download-an-artifact", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}" - }, - { - "slug": "get-github-actions-cache-usage-for-a-repository", - "subcategory": "cache", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/cache/usage" - }, - { - "slug": "get-github-actions-cache-usage-policy-for-a-repository", - "subcategory": "cache", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/cache/usage-policy" - }, - { - "slug": "set-github-actions-cache-usage-policy-for-a-repository", - "subcategory": "cache", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/actions/cache/usage-policy" - }, - { - "slug": "list-github-actions-caches-for-a-repository", - "subcategory": "cache", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/caches" - }, - { - "slug": "delete-github-actions-caches-for-a-repository-using-a-cache-key", - "subcategory": "cache", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/caches" - }, - { - "slug": "delete-a-github-actions-cache-for-a-repository-using-a-cache-id", - "subcategory": "cache", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/caches/{cache_id}" - }, - { - "slug": "get-a-job-for-a-workflow-run", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}" - }, - { - "slug": "download-job-logs-for-a-workflow-run", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs" - }, - { - "slug": "re-run-a-job-from-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun" - }, - { - "slug": "get-the-customization-template-for-an-oidc-subject-claim-for-a-repository", - "subcategory": "oidc", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/oidc/customization/sub" - }, - { - "slug": "set-the-customization-template-for-an-oidc-subject-claim-for-a-repository", - "subcategory": "oidc", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/oidc/customization/sub" - }, - { - "slug": "list-repository-organization-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/organization-secrets" - }, - { - "slug": "list-repository-organization-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/organization-variables" - }, - { - "slug": "get-github-actions-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions" - }, - { - "slug": "set-github-actions-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions" - }, - { - "slug": "get-the-level-of-access-for-workflows-outside-of-the-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/access" - }, - { - "slug": "set-the-level-of-access-for-workflows-outside-of-the-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/access" - }, - { - "slug": "get-allowed-actions-for-a-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions" - }, - { - "slug": "set-allowed-actions-for-a-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions" - }, - { - "slug": "get-default-workflow-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow" - }, - { - "slug": "set-default-workflow-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow" - }, - { - "slug": "list-self-hosted-runners-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners" - }, - { - "slug": "list-runner-applications-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/downloads" - }, - { - "slug": "create-configuration-for-a-just-in-time-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/generate-jitconfig" - }, - { - "slug": "create-a-registration-token-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/registration-token" - }, - { - "slug": "create-a-remove-token-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/remove-token" - }, - { - "slug": "get-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}" - }, - { - "slug": "delete-a-self-hosted-runner-from-a-repository", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}" - }, - { - "slug": "list-labels-for-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels" - }, - { - "slug": "add-custom-labels-to-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels" - }, - { - "slug": "set-custom-labels-for-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels" - }, - { - "slug": "remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels" - }, - { - "slug": "remove-a-custom-label-from-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}" - }, - { - "slug": "list-workflow-runs-for-a-repository", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs" - }, - { - "slug": "get-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}" - }, - { - "slug": "delete-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}" - }, - { - "slug": "get-the-review-history-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals" - }, - { - "slug": "list-workflow-run-artifacts", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts" - }, - { - "slug": "get-a-workflow-run-attempt", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}" - }, - { - "slug": "list-jobs-for-a-workflow-run-attempt", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs" - }, - { - "slug": "download-workflow-run-attempt-logs", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs" - }, - { - "slug": "cancel-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel" - }, - { - "slug": "review-custom-deployment-protection-rules-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule" - }, - { - "slug": "force-cancel-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel" - }, - { - "slug": "list-jobs-for-a-workflow-run", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs" - }, - { - "slug": "download-workflow-run-logs", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs" - }, - { - "slug": "delete-workflow-run-logs", - "subcategory": "workflow-runs", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs" - }, - { - "slug": "get-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments" - }, - { - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments" - }, - { - "slug": "re-run-a-workflow", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun" - }, - { - "slug": "re-run-failed-jobs-from-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs" - }, - { - "slug": "list-repository-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets" - }, - { - "slug": "get-a-repository-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/public-key" - }, - { - "slug": "get-a-repository-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}" - }, - { - "slug": "create-or-update-a-repository-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}" - }, - { - "slug": "delete-a-repository-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}" - }, - { - "slug": "list-repository-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/variables" - }, - { - "slug": "create-a-repository-variable", - "subcategory": "variables", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/variables" - }, - { - "slug": "get-a-repository-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}" - }, - { - "slug": "update-a-repository-variable", - "subcategory": "variables", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}" - }, - { - "slug": "delete-a-repository-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}" - }, - { - "slug": "list-repository-workflows", - "subcategory": "workflows", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/workflows" - }, - { - "slug": "get-a-workflow", - "subcategory": "workflows", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}" - }, - { - "slug": "disable-a-workflow", - "subcategory": "workflows", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable" - }, - { - "slug": "create-a-workflow-dispatch-event", - "subcategory": "workflows", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches" - }, - { - "slug": "enable-a-workflow", - "subcategory": "workflows", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable" - }, - { - "slug": "list-workflow-runs-for-a-workflow", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs" - }, - { - "slug": "list-environment-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets" - }, - { - "slug": "get-an-environment-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key" - }, - { - "slug": "get-an-environment-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}" - }, - { - "slug": "create-or-update-an-environment-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}" - }, - { - "slug": "delete-an-environment-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}" - }, - { - "slug": "list-environment-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables" - }, - { - "slug": "create-an-environment-variable", - "subcategory": "variables", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables" - }, - { - "slug": "get-an-environment-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}" - }, - { - "slug": "update-an-environment-variable", - "subcategory": "variables", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}" - }, - { - "slug": "delete-an-environment-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}" - } - ], - "activity": [ - { - "slug": "list-public-events", - "subcategory": "events", - "verb": "get", - "requestPath": "/events" - }, - { - "slug": "get-feeds", - "subcategory": "feeds", - "verb": "get", - "requestPath": "/feeds" - }, - { - "slug": "list-public-events-for-a-network-of-repositories", - "subcategory": "events", - "verb": "get", - "requestPath": "/networks/{owner}/{repo}/events" - }, - { - "slug": "list-public-organization-events", - "subcategory": "events", - "verb": "get", - "requestPath": "/orgs/{org}/events" - }, - { - "slug": "list-repository-events", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/events" - }, - { - "slug": "list-stargazers", - "subcategory": "starring", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stargazers" - }, - { - "slug": "list-watchers", - "subcategory": "watching", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/subscribers" - }, - { - "slug": "list-events-for-the-authenticated-user", - "subcategory": "events", - "verb": "get", - "requestPath": "/users/{username}/events" - }, - { - "slug": "list-public-events-for-a-user", - "subcategory": "events", - "verb": "get", - "requestPath": "/users/{username}/events/public" - }, - { - "slug": "list-events-received-by-the-authenticated-user", - "subcategory": "events", - "verb": "get", - "requestPath": "/users/{username}/received_events" - }, - { - "slug": "list-public-events-received-by-a-user", - "subcategory": "events", - "verb": "get", - "requestPath": "/users/{username}/received_events/public" - }, - { - "slug": "list-repositories-starred-by-a-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/users/{username}/starred" - }, - { - "slug": "list-repositories-watched-by-a-user", - "subcategory": "watching", - "verb": "get", - "requestPath": "/users/{username}/subscriptions" - } - ], - "announcement-banners": [ - { - "slug": "get-announcement-banner-for-organization", - "subcategory": "organizations", - "verb": "get", - "requestPath": "/orgs/{org}/announcement" - }, - { - "slug": "set-announcement-banner-for-organization", - "subcategory": "organizations", - "verb": "patch", - "requestPath": "/orgs/{org}/announcement" - }, - { - "slug": "remove-announcement-banner-from-organization", - "subcategory": "organizations", - "verb": "delete", - "requestPath": "/orgs/{org}/announcement" - } - ], - "apps": [ - { - "slug": "get-an-app", - "subcategory": "apps", - "verb": "get", - "requestPath": "/apps/{app_slug}" - }, - { - "slug": "list-repositories-accessible-to-the-app-installation", - "subcategory": "installations", - "verb": "get", - "requestPath": "/installation/repositories" - }, - { - "slug": "revoke-an-installation-access-token", - "subcategory": "installations", - "verb": "delete", - "requestPath": "/installation/token" - } - ], - "billing": [ - { - "slug": "get-github-advanced-security-active-committers-for-an-organization", - "subcategory": "billing", - "verb": "get", - "requestPath": "/orgs/{org}/settings/billing/advanced-security" - } - ], - "branches": [ - { - "slug": "list-branches", - "subcategory": "branches", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches" - }, - { - "slug": "get-a-branch", - "subcategory": "branches", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}" - }, - { - "slug": "get-branch-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection" - }, - { - "slug": "update-branch-protection", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection" - }, - { - "slug": "delete-branch-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection" - }, - { - "slug": "get-admin-branch-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins" - }, - { - "slug": "set-admin-branch-protection", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins" - }, - { - "slug": "delete-admin-branch-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins" - }, - { - "slug": "get-pull-request-review-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews" - }, - { - "slug": "update-pull-request-review-protection", - "subcategory": "branch-protection", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews" - }, - { - "slug": "delete-pull-request-review-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews" - }, - { - "slug": "get-commit-signature-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures" - }, - { - "slug": "create-commit-signature-protection", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures" - }, - { - "slug": "delete-commit-signature-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures" - }, - { - "slug": "get-status-checks-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks" - }, - { - "slug": "update-status-check-protection", - "subcategory": "branch-protection", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks" - }, - { - "slug": "remove-status-check-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks" - }, - { - "slug": "get-all-status-check-contexts", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts" - }, - { - "slug": "add-status-check-contexts", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts" - }, - { - "slug": "set-status-check-contexts", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts" - }, - { - "slug": "remove-status-check-contexts", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts" - }, - { - "slug": "get-access-restrictions", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions" - }, - { - "slug": "delete-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions" - }, - { - "slug": "get-apps-with-access-to-the-protected-branch", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps" - }, - { - "slug": "add-app-access-restrictions", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps" - }, - { - "slug": "set-app-access-restrictions", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps" - }, - { - "slug": "remove-app-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps" - }, - { - "slug": "get-teams-with-access-to-the-protected-branch", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams" - }, - { - "slug": "add-team-access-restrictions", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams" - }, - { - "slug": "set-team-access-restrictions", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams" - }, - { - "slug": "remove-team-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams" - }, - { - "slug": "get-users-with-access-to-the-protected-branch", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users" - }, - { - "slug": "add-user-access-restrictions", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users" - }, - { - "slug": "set-user-access-restrictions", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users" - }, - { - "slug": "remove-user-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users" - }, - { - "slug": "rename-a-branch", - "subcategory": "branches", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename" - }, - { - "slug": "sync-a-fork-branch-with-the-upstream-repository", - "subcategory": "branches", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merge-upstream" - }, - { - "slug": "merge-a-branch", - "subcategory": "branches", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merges" - } - ], - "checks": [ - { - "slug": "create-a-check-run", - "subcategory": "runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-runs" - }, - { - "slug": "get-a-check-run", - "subcategory": "runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}" - }, - { - "slug": "update-a-check-run", - "subcategory": "runs", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}" - }, - { - "slug": "list-check-run-annotations", - "subcategory": "runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations" - }, - { - "slug": "rerequest-a-check-run", - "subcategory": "runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest" - }, - { - "slug": "create-a-check-suite", - "subcategory": "suites", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-suites" - }, - { - "slug": "update-repository-preferences-for-check-suites", - "subcategory": "suites", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/check-suites/preferences" - }, - { - "slug": "get-a-check-suite", - "subcategory": "suites", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}" - }, - { - "slug": "list-check-runs-in-a-check-suite", - "subcategory": "runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs" - }, - { - "slug": "rerequest-a-check-suite", - "subcategory": "suites", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest" - }, - { - "slug": "list-check-runs-for-a-git-reference", - "subcategory": "runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-runs" - }, - { - "slug": "list-check-suites-for-a-git-reference", - "subcategory": "suites", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-suites" - } - ], - "code-scanning": [ - { - "slug": "list-code-scanning-alerts-for-an-organization", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/orgs/{org}/code-scanning/alerts" - }, - { - "slug": "list-code-scanning-alerts-for-a-repository", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts" - }, - { - "slug": "get-a-code-scanning-alert", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}" - }, - { - "slug": "update-a-code-scanning-alert", - "subcategory": "code-scanning", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}" - }, - { - "slug": "list-instances-of-a-code-scanning-alert", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances" - }, - { - "slug": "list-code-scanning-analyses-for-a-repository", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses" - }, - { - "slug": "get-a-code-scanning-analysis-for-a-repository", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}" - }, - { - "slug": "delete-a-code-scanning-analysis-from-a-repository", - "subcategory": "code-scanning", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}" - }, - { - "slug": "get-a-code-scanning-default-setup-configuration", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/default-setup" - }, - { - "slug": "update-a-code-scanning-default-setup-configuration", - "subcategory": "code-scanning", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/code-scanning/default-setup" - }, - { - "slug": "upload-an-analysis-as-sarif-data", - "subcategory": "code-scanning", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs" - }, - { - "slug": "get-information-about-a-sarif-upload", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}" - } - ], - "codes-of-conduct": [ - { - "slug": "get-all-codes-of-conduct", - "subcategory": "codes-of-conduct", - "verb": "get", - "requestPath": "/codes_of_conduct" - }, - { - "slug": "get-a-code-of-conduct", - "subcategory": "codes-of-conduct", - "verb": "get", - "requestPath": "/codes_of_conduct/{key}" - } - ], - "collaborators": [ - { - "slug": "list-repository-collaborators", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators" - }, - { - "slug": "check-if-a-user-is-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}" - }, - { - "slug": "add-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}" - }, - { - "slug": "remove-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}" - }, - { - "slug": "get-repository-permissions-for-a-user", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission" - }, - { - "slug": "list-repository-invitations", - "subcategory": "invitations", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/invitations" - }, - { - "slug": "update-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}" - }, - { - "slug": "delete-a-repository-invitation", - "subcategory": "invitations", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}" - } - ], - "commits": [ - { - "slug": "list-commit-comments-for-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments" - }, - { - "slug": "get-a-commit-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}" - }, - { - "slug": "update-a-commit-comment", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}" - }, - { - "slug": "delete-a-commit-comment", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}" - }, - { - "slug": "list-commits", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits" - }, - { - "slug": "list-branches-for-head-commit", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head" - }, - { - "slug": "list-commit-comments", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments" - }, - { - "slug": "create-a-commit-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments" - }, - { - "slug": "list-pull-requests-associated-with-a-commit", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls" - }, - { - "slug": "get-a-commit", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}" - }, - { - "slug": "get-the-combined-status-for-a-specific-reference", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/status" - }, - { - "slug": "list-commit-statuses-for-a-reference", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/statuses" - }, - { - "slug": "compare-two-commits", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/compare/{basehead}" - }, - { - "slug": "create-a-commit-status", - "subcategory": "statuses", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/statuses/{sha}" - } - ], - "dependabot": [ - { - "slug": "list-dependabot-alerts-for-an-organization", - "subcategory": "alerts", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/alerts" - }, - { - "slug": "list-organization-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets" - }, - { - "slug": "get-an-organization-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets/public-key" - }, - { - "slug": "get-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}" - }, - { - "slug": "create-or-update-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}" - }, - { - "slug": "delete-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}" - }, - { - "slug": "list-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories" - }, - { - "slug": "set-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories" - }, - { - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}" - }, - { - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}" - }, - { - "slug": "list-dependabot-alerts-for-a-repository", - "subcategory": "alerts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/alerts" - }, - { - "slug": "get-a-dependabot-alert", - "subcategory": "alerts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}" - }, - { - "slug": "update-a-dependabot-alert", - "subcategory": "alerts", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}" - }, - { - "slug": "list-repository-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets" - }, - { - "slug": "get-a-repository-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/public-key" - }, - { - "slug": "get-a-repository-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}" - }, - { - "slug": "create-or-update-a-repository-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}" - }, - { - "slug": "delete-a-repository-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}" - } - ], - "dependency-graph": [ - { - "slug": "get-a-diff-of-the-dependencies-between-commits", - "subcategory": "dependency-review", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}" - }, - { - "slug": "export-a-software-bill-of-materials-sbom-for-a-repository", - "subcategory": "sboms", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependency-graph/sbom" - }, - { - "slug": "create-a-snapshot-of-dependencies-for-a-repository", - "subcategory": "dependency-submission", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/dependency-graph/snapshots" - } - ], - "deploy-keys": [ - { - "slug": "list-deploy-keys", - "subcategory": "deploy-keys", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/keys" - }, - { - "slug": "create-a-deploy-key", - "subcategory": "deploy-keys", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/keys" - }, - { - "slug": "get-a-deploy-key", - "subcategory": "deploy-keys", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/keys/{key_id}" - }, - { - "slug": "delete-a-deploy-key", - "subcategory": "deploy-keys", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/keys/{key_id}" - } - ], - "deployments": [ - { - "slug": "list-deployments", - "subcategory": "deployments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments" - }, - { - "slug": "create-a-deployment", - "subcategory": "deployments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/deployments" - }, - { - "slug": "get-a-deployment", - "subcategory": "deployments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}" - }, - { - "slug": "delete-a-deployment", - "subcategory": "deployments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}" - }, - { - "slug": "list-deployment-statuses", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses" - }, - { - "slug": "create-a-deployment-status", - "subcategory": "statuses", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses" - }, - { - "slug": "get-a-deployment-status", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}" - }, - { - "slug": "list-environments", - "subcategory": "environments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments" - }, - { - "slug": "get-an-environment", - "subcategory": "environments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}" - }, - { - "slug": "create-or-update-an-environment", - "subcategory": "environments", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}" - }, - { - "slug": "delete-an-environment", - "subcategory": "environments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}" - }, - { - "slug": "list-deployment-branch-policies", - "subcategory": "branch-policies", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies" - }, - { - "slug": "create-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies" - }, - { - "slug": "get-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}" - }, - { - "slug": "update-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}" - }, - { - "slug": "delete-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}" - }, - { - "slug": "get-all-deployment-protection-rules-for-an-environment", - "subcategory": "protection-rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules" - }, - { - "slug": "create-a-custom-deployment-protection-rule-on-an-environment", - "subcategory": "protection-rules", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules" - }, - { - "slug": "list-custom-deployment-rule-integrations-available-for-an-environment", - "subcategory": "protection-rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps" - }, - { - "slug": "get-a-custom-deployment-protection-rule", - "subcategory": "protection-rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}" - }, - { - "slug": "disable-a-custom-protection-rule-for-an-environment", - "subcategory": "protection-rules", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}" - } - ], - "emojis": [ - { - "slug": "get-emojis", - "subcategory": "emojis", - "verb": "get", - "requestPath": "/emojis" - } - ], - "enterprise-admin": [ - { - "slug": "get-the-audit-log-for-an-enterprise", - "subcategory": "audit-log", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/audit-log" - }, - { - "slug": "get-github-advanced-security-active-committers-for-an-enterprise", - "subcategory": "licensing", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/settings/billing/advanced-security" - }, - { - "slug": "list-pre-receive-hooks-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks" - }, - { - "slug": "get-a-pre-receive-hook-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}" - }, - { - "slug": "update-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "patch", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}" - }, - { - "slug": "remove-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "delete", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}" - }, - { - "slug": "list-pre-receive-hooks-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks" - }, - { - "slug": "get-a-pre-receive-hook-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}" - }, - { - "slug": "update-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}" - }, - { - "slug": "remove-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}" - }, - { - "slug": "list-provisioned-scim-groups-for-an-enterprise", - "subcategory": "scim", - "verb": "get", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups" - }, - { - "slug": "provision-a-scim-enterprise-group", - "subcategory": "scim", - "verb": "post", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups" - }, - { - "slug": "get-scim-provisioning-information-for-an-enterprise-group", - "subcategory": "scim", - "verb": "get", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}" - }, - { - "slug": "set-scim-information-for-a-provisioned-enterprise-group", - "subcategory": "scim", - "verb": "put", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}" - }, - { - "slug": "update-an-attribute-for-a-scim-enterprise-group", - "subcategory": "scim", - "verb": "patch", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}" - }, - { - "slug": "delete-a-scim-group-from-an-enterprise", - "subcategory": "scim", - "verb": "delete", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}" - }, - { - "slug": "list-scim-provisioned-identities-for-an-enterprise", - "subcategory": "scim", - "verb": "get", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users" - }, - { - "slug": "provision-a-scim-enterprise-user", - "subcategory": "scim", - "verb": "post", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users" - }, - { - "slug": "get-scim-provisioning-information-for-an-enterprise-user", - "subcategory": "scim", - "verb": "get", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}" - }, - { - "slug": "set-scim-information-for-a-provisioned-enterprise-user", - "subcategory": "scim", - "verb": "put", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}" - }, - { - "slug": "update-an-attribute-for-a-scim-enterprise-user", - "subcategory": "scim", - "verb": "patch", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}" - }, - { - "slug": "delete-a-scim-user-from-an-enterprise", - "subcategory": "scim", - "verb": "delete", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}" - } - ], - "git": [ - { - "slug": "create-a-blob", - "subcategory": "blobs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/blobs" - }, - { - "slug": "get-a-blob", - "subcategory": "blobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/blobs/{file_sha}" - }, - { - "slug": "create-a-commit", - "subcategory": "commits", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/commits" - }, - { - "slug": "get-a-commit-object", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}" - }, - { - "slug": "list-matching-references", - "subcategory": "refs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/matching-refs/{ref}" - }, - { - "slug": "get-a-reference", - "subcategory": "refs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/ref/{ref}" - }, - { - "slug": "create-a-reference", - "subcategory": "refs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/refs" - }, - { - "slug": "update-a-reference", - "subcategory": "refs", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}" - }, - { - "slug": "delete-a-reference", - "subcategory": "refs", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}" - }, - { - "slug": "create-a-tag-object", - "subcategory": "tags", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/tags" - }, - { - "slug": "get-a-tag", - "subcategory": "tags", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/tags/{tag_sha}" - }, - { - "slug": "create-a-tree", - "subcategory": "trees", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/trees" - }, - { - "slug": "get-a-tree", - "subcategory": "trees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/trees/{tree_sha}" - } - ], - "gitignore": [ - { - "slug": "get-all-gitignore-templates", - "subcategory": "gitignore", - "verb": "get", - "requestPath": "/gitignore/templates" - }, - { - "slug": "get-a-gitignore-template", - "subcategory": "gitignore", - "verb": "get", - "requestPath": "/gitignore/templates/{name}" - } - ], - "issues": [ - { - "slug": "list-assignees", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/assignees" - }, - { - "slug": "check-if-a-user-can-be-assigned", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/assignees/{assignee}" - }, - { - "slug": "list-repository-issues", - "subcategory": "issues", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues" - }, - { - "slug": "create-an-issue", - "subcategory": "issues", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues" - }, - { - "slug": "list-issue-comments-for-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments" - }, - { - "slug": "get-an-issue-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}" - }, - { - "slug": "update-an-issue-comment", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}" - }, - { - "slug": "delete-an-issue-comment", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}" - }, - { - "slug": "list-issue-events-for-a-repository", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/events" - }, - { - "slug": "get-an-issue-event", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}" - }, - { - "slug": "get-an-issue", - "subcategory": "issues", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}" - }, - { - "slug": "update-an-issue", - "subcategory": "issues", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}" - }, - { - "slug": "add-assignees-to-an-issue", - "subcategory": "assignees", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees" - }, - { - "slug": "remove-assignees-from-an-issue", - "subcategory": "assignees", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees" - }, - { - "slug": "check-if-a-user-can-be-assigned-to-a-issue", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}" - }, - { - "slug": "list-issue-comments", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments" - }, - { - "slug": "create-an-issue-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments" - }, - { - "slug": "list-issue-events", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events" - }, - { - "slug": "list-issue-field-values-for-an-issue", - "subcategory": "issue-field-values", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values" - }, - { - "slug": "list-labels-for-an-issue", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels" - }, - { - "slug": "add-labels-to-an-issue", - "subcategory": "labels", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels" - }, - { - "slug": "set-labels-for-an-issue", - "subcategory": "labels", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels" - }, - { - "slug": "remove-all-labels-from-an-issue", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels" - }, - { - "slug": "remove-a-label-from-an-issue", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}" - }, - { - "slug": "lock-an-issue", - "subcategory": "issues", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock" - }, - { - "slug": "unlock-an-issue", - "subcategory": "issues", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock" - }, - { - "slug": "list-timeline-events-for-an-issue", - "subcategory": "timeline", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline" - }, - { - "slug": "list-labels-for-a-repository", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/labels" - }, - { - "slug": "create-a-label", - "subcategory": "labels", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/labels" - }, - { - "slug": "get-a-label", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/labels/{name}" - }, - { - "slug": "update-a-label", - "subcategory": "labels", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/labels/{name}" - }, - { - "slug": "delete-a-label", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/labels/{name}" - }, - { - "slug": "list-milestones", - "subcategory": "milestones", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones" - }, - { - "slug": "create-a-milestone", - "subcategory": "milestones", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/milestones" - }, - { - "slug": "get-a-milestone", - "subcategory": "milestones", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}" - }, - { - "slug": "update-a-milestone", - "subcategory": "milestones", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}" - }, - { - "slug": "delete-a-milestone", - "subcategory": "milestones", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}" - }, - { - "slug": "list-labels-for-issues-in-a-milestone", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels" - } - ], - "licenses": [ - { - "slug": "get-all-commonly-used-licenses", - "subcategory": "licenses", - "verb": "get", - "requestPath": "/licenses" - }, - { - "slug": "get-a-license", - "subcategory": "licenses", - "verb": "get", - "requestPath": "/licenses/{license}" - }, - { - "slug": "get-the-license-for-a-repository", - "subcategory": "licenses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/license" - } - ], - "markdown": [ - { - "slug": "render-a-markdown-document", - "subcategory": "markdown", - "verb": "post", - "requestPath": "/markdown" - }, - { - "slug": "render-a-markdown-document-in-raw-mode", - "subcategory": "markdown", - "verb": "post", - "requestPath": "/markdown/raw" - } - ], - "meta": [ - { - "slug": "github-api-root", - "subcategory": "meta", - "verb": "get", - "requestPath": "/" - }, - { - "slug": "get-github-enterprise-server-meta-information", - "subcategory": "meta", - "verb": "get", - "requestPath": "/meta" - }, - { - "slug": "get-octocat", - "subcategory": "meta", - "verb": "get", - "requestPath": "/octocat" - }, - { - "slug": "get-the-zen-of-github", - "subcategory": "meta", - "verb": "get", - "requestPath": "/zen" - } - ], - "metrics": [ - { - "slug": "get-the-weekly-commit-activity", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/code_frequency" - }, - { - "slug": "get-the-last-year-of-commit-activity", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/commit_activity" - }, - { - "slug": "get-all-contributor-commit-activity", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/contributors" - }, - { - "slug": "get-the-weekly-commit-count", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/participation" - }, - { - "slug": "get-the-hourly-commit-count-for-each-day", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/punch_card" - } - ], - "orgs": [ - { - "slug": "list-organizations", - "subcategory": "orgs", - "verb": "get", - "requestPath": "/organizations" - }, - { - "slug": "closing-down---list-custom-repository-roles-in-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/organizations/{organization_id}/custom_roles" - }, - { - "slug": "get-an-organization", - "subcategory": "orgs", - "verb": "get", - "requestPath": "/orgs/{org}" - }, - { - "slug": "update-an-organization", - "subcategory": "orgs", - "verb": "patch", - "requestPath": "/orgs/{org}" - }, - { - "slug": "delete-an-organization", - "subcategory": "orgs", - "verb": "delete", - "requestPath": "/orgs/{org}" - }, - { - "slug": "get-the-audit-log-for-an-organization", - "subcategory": "orgs", - "verb": "get", - "requestPath": "/orgs/{org}/audit-log" - }, - { - "slug": "list-custom-repository-roles-in-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/custom-repository-roles" - }, - { - "slug": "create-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "post", - "requestPath": "/orgs/{org}/custom-repository-roles" - }, - { - "slug": "get-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}" - }, - { - "slug": "update-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "patch", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}" - }, - { - "slug": "delete-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}" - }, - { - "slug": "list-organization-webhooks", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks" - }, - { - "slug": "create-an-organization-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/orgs/{org}/hooks" - }, - { - "slug": "get-an-organization-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}" - }, - { - "slug": "update-an-organization-webhook", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/orgs/{org}/hooks/{hook_id}" - }, - { - "slug": "delete-an-organization-webhook", - "subcategory": "webhooks", - "verb": "delete", - "requestPath": "/orgs/{org}/hooks/{hook_id}" - }, - { - "slug": "get-a-webhook-configuration-for-an-organization", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/config" - }, - { - "slug": "update-a-webhook-configuration-for-an-organization", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/orgs/{org}/hooks/{hook_id}/config" - }, - { - "slug": "list-deliveries-for-an-organization-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries" - }, - { - "slug": "get-a-webhook-delivery-for-an-organization-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}" - }, - { - "slug": "redeliver-a-delivery-for-an-organization-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts" - }, - { - "slug": "ping-an-organization-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/orgs/{org}/hooks/{hook_id}/pings" - }, - { - "slug": "list-app-installations-for-an-organization", - "subcategory": "orgs", - "verb": "get", - "requestPath": "/orgs/{org}/installations" - }, - { - "slug": "list-organization-members", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/members" - }, - { - "slug": "check-organization-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/members/{username}" - }, - { - "slug": "remove-an-organization-member", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/members/{username}" - }, - { - "slug": "get-organization-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/memberships/{username}" - }, - { - "slug": "set-organization-membership-for-a-user", - "subcategory": "members", - "verb": "put", - "requestPath": "/orgs/{org}/memberships/{username}" - }, - { - "slug": "remove-organization-membership-for-a-user", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/memberships/{username}" - }, - { - "slug": "list-organization-fine-grained-permissions-for-an-organization", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-fine-grained-permissions" - }, - { - "slug": "get-all-organization-roles-for-an-organization", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles" - }, - { - "slug": "create-a-custom-organization-role", - "subcategory": "organization-roles", - "verb": "post", - "requestPath": "/orgs/{org}/organization-roles" - }, - { - "slug": "remove-all-organization-roles-for-a-team", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/teams/{team_slug}" - }, - { - "slug": "assign-an-organization-role-to-a-team", - "subcategory": "organization-roles", - "verb": "put", - "requestPath": "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}" - }, - { - "slug": "remove-an-organization-role-from-a-team", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}" - }, - { - "slug": "remove-all-organization-roles-for-a-user", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/users/{username}" - }, - { - "slug": "assign-an-organization-role-to-a-user", - "subcategory": "organization-roles", - "verb": "put", - "requestPath": "/orgs/{org}/organization-roles/users/{username}/{role_id}" - }, - { - "slug": "remove-an-organization-role-from-a-user", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/users/{username}/{role_id}" - }, - { - "slug": "get-an-organization-role", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles/{role_id}" - }, - { - "slug": "update-a-custom-organization-role", - "subcategory": "organization-roles", - "verb": "patch", - "requestPath": "/orgs/{org}/organization-roles/{role_id}" - }, - { - "slug": "delete-a-custom-organization-role", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/{role_id}" - }, - { - "slug": "list-teams-that-are-assigned-to-an-organization-role", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles/{role_id}/teams" - }, - { - "slug": "list-users-that-are-assigned-to-an-organization-role", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles/{role_id}/users" - }, - { - "slug": "list-outside-collaborators-for-an-organization", - "subcategory": "outside-collaborators", - "verb": "get", - "requestPath": "/orgs/{org}/outside_collaborators" - }, - { - "slug": "convert-an-organization-member-to-outside-collaborator", - "subcategory": "outside-collaborators", - "verb": "put", - "requestPath": "/orgs/{org}/outside_collaborators/{username}" - }, - { - "slug": "remove-outside-collaborator-from-an-organization", - "subcategory": "outside-collaborators", - "verb": "delete", - "requestPath": "/orgs/{org}/outside_collaborators/{username}" - }, - { - "slug": "list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens", - "subcategory": "personal-access-tokens", - "verb": "get", - "requestPath": "/orgs/{org}/personal-access-token-requests" - }, - { - "slug": "review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens", - "subcategory": "personal-access-tokens", - "verb": "post", - "requestPath": "/orgs/{org}/personal-access-token-requests" - }, - { - "slug": "review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token", - "subcategory": "personal-access-tokens", - "verb": "post", - "requestPath": "/orgs/{org}/personal-access-token-requests/{pat_request_id}" - }, - { - "slug": "list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token", - "subcategory": "personal-access-tokens", - "verb": "get", - "requestPath": "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories" - }, - { - "slug": "list-fine-grained-personal-access-tokens-with-access-to-organization-resources", - "subcategory": "personal-access-tokens", - "verb": "get", - "requestPath": "/orgs/{org}/personal-access-tokens" - }, - { - "slug": "update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens", - "subcategory": "personal-access-tokens", - "verb": "post", - "requestPath": "/orgs/{org}/personal-access-tokens" - }, - { - "slug": "update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources", - "subcategory": "personal-access-tokens", - "verb": "post", - "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}" - }, - { - "slug": "list-repositories-a-fine-grained-personal-access-token-has-access-to", - "subcategory": "personal-access-tokens", - "verb": "get", - "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" - }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "list-custom-property-values-for-organization-repositories", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/values" - }, - { - "slug": "create-or-update-custom-property-values-for-organization-repositories", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" - }, - { - "slug": "list-public-organization-members", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/public_members" - }, - { - "slug": "check-public-organization-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/public_members/{username}" - }, - { - "slug": "list-repository-fine-grained-permissions-for-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/repository-fine-grained-permissions" - }, - { - "slug": "get-all-organization-repository-rulesets", - "subcategory": "rules", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets" - }, - { - "slug": "create-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "post", - "requestPath": "/orgs/{org}/rulesets" - }, - { - "slug": "list-organization-rule-suites", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets/rule-suites" - }, - { - "slug": "get-an-organization-rule-suite", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}" - }, - { - "slug": "get-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets/{ruleset_id}" - }, - { - "slug": "update-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "put", - "requestPath": "/orgs/{org}/rulesets/{ruleset_id}" - }, - { - "slug": "delete-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "delete", - "requestPath": "/orgs/{org}/rulesets/{ruleset_id}" - }, - { - "slug": "list-security-manager-teams", - "subcategory": "security-managers", - "verb": "get", - "requestPath": "/orgs/{org}/security-managers" - }, - { - "slug": "add-a-security-manager-team", - "subcategory": "security-managers", - "verb": "put", - "requestPath": "/orgs/{org}/security-managers/teams/{team_slug}" - }, - { - "slug": "remove-a-security-manager-team", - "subcategory": "security-managers", - "verb": "delete", - "requestPath": "/orgs/{org}/security-managers/teams/{team_slug}" - }, - { - "slug": "enable-or-disable-a-security-feature-for-an-organization", - "subcategory": "orgs", - "verb": "post", - "requestPath": "/orgs/{org}/{security_product}/{enablement}" - }, - { - "slug": "list-organizations-for-a-user", - "subcategory": "orgs", - "verb": "get", - "requestPath": "/users/{username}/orgs" - } - ], - "packages": [ - { - "slug": "get-list-of-conflicting-packages-during-docker-migration-for-organization", - "subcategory": "packages", - "verb": "get", - "requestPath": "/orgs/{org}/docker/conflicts" - }, - { - "slug": "list-packages-for-an-organization", - "subcategory": "packages", - "verb": "get", - "requestPath": "/orgs/{org}/packages" - }, - { - "slug": "get-a-package-for-an-organization", - "subcategory": "packages", - "verb": "get", - "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}" - }, - { - "slug": "delete-a-package-for-an-organization", - "subcategory": "packages", - "verb": "delete", - "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}" - }, - { - "slug": "restore-a-package-for-an-organization", - "subcategory": "packages", - "verb": "post", - "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/restore" - }, - { - "slug": "list-package-versions-for-a-package-owned-by-an-organization", - "subcategory": "packages", - "verb": "get", - "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions" - }, - { - "slug": "get-a-package-version-for-an-organization", - "subcategory": "packages", - "verb": "get", - "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}" - }, - { - "slug": "delete-package-version-for-an-organization", - "subcategory": "packages", - "verb": "delete", - "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}" - }, - { - "slug": "restore-package-version-for-an-organization", - "subcategory": "packages", - "verb": "post", - "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore" - }, - { - "slug": "list-packages-for-the-authenticated-users-namespace", - "subcategory": "packages", - "verb": "get", - "requestPath": "/user/packages" - }, - { - "slug": "get-a-package-for-the-authenticated-user", - "subcategory": "packages", - "verb": "get", - "requestPath": "/user/packages/{package_type}/{package_name}" - }, - { - "slug": "delete-a-package-for-the-authenticated-user", - "subcategory": "packages", - "verb": "delete", - "requestPath": "/user/packages/{package_type}/{package_name}" - }, - { - "slug": "restore-a-package-for-the-authenticated-user", - "subcategory": "packages", - "verb": "post", - "requestPath": "/user/packages/{package_type}/{package_name}/restore" - }, - { - "slug": "list-package-versions-for-a-package-owned-by-the-authenticated-user", - "subcategory": "packages", - "verb": "get", - "requestPath": "/user/packages/{package_type}/{package_name}/versions" - }, - { - "slug": "get-a-package-version-for-the-authenticated-user", - "subcategory": "packages", - "verb": "get", - "requestPath": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}" - }, - { - "slug": "delete-a-package-version-for-the-authenticated-user", - "subcategory": "packages", - "verb": "delete", - "requestPath": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}" - }, - { - "slug": "restore-a-package-version-for-the-authenticated-user", - "subcategory": "packages", - "verb": "post", - "requestPath": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore" - }, - { - "slug": "get-list-of-conflicting-packages-during-docker-migration-for-user", - "subcategory": "packages", - "verb": "get", - "requestPath": "/users/{username}/docker/conflicts" - }, - { - "slug": "list-packages-for-a-user", - "subcategory": "packages", - "verb": "get", - "requestPath": "/users/{username}/packages" - }, - { - "slug": "get-a-package-for-a-user", - "subcategory": "packages", - "verb": "get", - "requestPath": "/users/{username}/packages/{package_type}/{package_name}" - }, - { - "slug": "delete-a-package-for-a-user", - "subcategory": "packages", - "verb": "delete", - "requestPath": "/users/{username}/packages/{package_type}/{package_name}" - }, - { - "slug": "restore-a-package-for-a-user", - "subcategory": "packages", - "verb": "post", - "requestPath": "/users/{username}/packages/{package_type}/{package_name}/restore" - }, - { - "slug": "list-package-versions-for-a-package-owned-by-a-user", - "subcategory": "packages", - "verb": "get", - "requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions" - }, - { - "slug": "get-a-package-version-for-a-user", - "subcategory": "packages", - "verb": "get", - "requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}" - }, - { - "slug": "delete-package-version-for-a-user", - "subcategory": "packages", - "verb": "delete", - "requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}" - }, - { - "slug": "restore-package-version-for-a-user", - "subcategory": "packages", - "verb": "post", - "requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore" - } - ], - "pages": [ - { - "slug": "get-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages" - }, - { - "slug": "create-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages" - }, - { - "slug": "update-information-about-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pages" - }, - { - "slug": "delete-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pages" - }, - { - "slug": "list-github-enterprise-server-pages-builds", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/builds" - }, - { - "slug": "request-a-github-enterprise-server-pages-build", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/builds" - }, - { - "slug": "get-latest-pages-build", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/builds/latest" - }, - { - "slug": "get-github-enterprise-server-pages-build", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/builds/{build_id}" - }, - { - "slug": "create-a-github-pages-deployment", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployments" - }, - { - "slug": "get-the-status-of-a-github-pages-deployment", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}" - }, - { - "slug": "cancel-a-github-pages-deployment", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel" - } - ], - "pulls": [ - { - "slug": "list-pull-requests", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls" - }, - { - "slug": "create-a-pull-request", - "subcategory": "pulls", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls" - }, - { - "slug": "list-review-comments-in-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/comments" - }, - { - "slug": "get-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}" - }, - { - "slug": "update-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}" - }, - { - "slug": "delete-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}" - }, - { - "slug": "get-a-pull-request", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}" - }, - { - "slug": "update-a-pull-request", - "subcategory": "pulls", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}" - }, - { - "slug": "list-review-comments-on-a-pull-request", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments" - }, - { - "slug": "create-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments" - }, - { - "slug": "create-a-reply-for-a-review-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies" - }, - { - "slug": "list-commits-on-a-pull-request", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/commits" - }, - { - "slug": "list-pull-requests-files", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/files" - }, - { - "slug": "check-if-a-pull-request-has-been-merged", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge" - }, - { - "slug": "merge-a-pull-request", - "subcategory": "pulls", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge" - }, - { - "slug": "get-all-requested-reviewers-for-a-pull-request", - "subcategory": "review-requests", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers" - }, - { - "slug": "request-reviewers-for-a-pull-request", - "subcategory": "review-requests", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers" - }, - { - "slug": "remove-requested-reviewers-from-a-pull-request", - "subcategory": "review-requests", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers" - }, - { - "slug": "list-reviews-for-a-pull-request", - "subcategory": "reviews", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews" - }, - { - "slug": "create-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews" - }, - { - "slug": "get-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}" - }, - { - "slug": "update-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}" - }, - { - "slug": "delete-a-pending-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}" - }, - { - "slug": "list-comments-for-a-pull-request-review", - "subcategory": "reviews", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments" - }, - { - "slug": "dismiss-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals" - }, - { - "slug": "submit-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events" - }, - { - "slug": "update-a-pull-request-branch", - "subcategory": "pulls", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch" - } - ], - "rate-limit": [ - { - "slug": "get-rate-limit-status-for-the-authenticated-user", - "subcategory": "rate-limit", - "verb": "get", - "requestPath": "/rate_limit" - } - ], - "reactions": [ - { - "slug": "list-reactions-for-a-commit-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions" - }, - { - "slug": "create-reaction-for-a-commit-comment", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions" - }, - { - "slug": "delete-a-commit-comment-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}" - }, - { - "slug": "list-reactions-for-an-issue-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions" - }, - { - "slug": "create-reaction-for-an-issue-comment", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions" - }, - { - "slug": "delete-an-issue-comment-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}" - }, - { - "slug": "list-reactions-for-an-issue", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions" - }, - { - "slug": "create-reaction-for-an-issue", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions" - }, - { - "slug": "delete-an-issue-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}" - }, - { - "slug": "list-reactions-for-a-pull-request-review-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions" - }, - { - "slug": "create-reaction-for-a-pull-request-review-comment", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions" - }, - { - "slug": "delete-a-pull-request-comment-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}" - }, - { - "slug": "list-reactions-for-a-release", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions" - }, - { - "slug": "create-reaction-for-a-release", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions" - }, - { - "slug": "delete-a-release-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}" - } - ], - "releases": [ - { - "slug": "list-releases", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases" - }, - { - "slug": "create-a-release", - "subcategory": "releases", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases" - }, - { - "slug": "get-a-release-asset", - "subcategory": "assets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}" - }, - { - "slug": "update-a-release-asset", - "subcategory": "assets", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}" - }, - { - "slug": "delete-a-release-asset", - "subcategory": "assets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}" - }, - { - "slug": "generate-release-notes-content-for-a-release", - "subcategory": "releases", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases/generate-notes" - }, - { - "slug": "get-the-latest-release", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/latest" - }, - { - "slug": "get-a-release-by-tag-name", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}" - }, - { - "slug": "get-a-release", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}" - }, - { - "slug": "update-a-release", - "subcategory": "releases", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}" - }, - { - "slug": "delete-a-release", - "subcategory": "releases", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}" - }, - { - "slug": "list-release-assets", - "subcategory": "assets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets" - } - ], - "repos": [ - { - "slug": "list-organization-repositories", - "subcategory": "repos", - "verb": "get", - "requestPath": "/orgs/{org}/repos" - }, - { - "slug": "create-an-organization-repository", - "subcategory": "repos", - "verb": "post", - "requestPath": "/orgs/{org}/repos" - }, - { - "slug": "get-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}" - }, - { - "slug": "update-a-repository", - "subcategory": "repos", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}" - }, - { - "slug": "delete-a-repository", - "subcategory": "repos", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}" - }, - { - "slug": "list-repository-activities", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/activity" - }, - { - "slug": "get-all-autolinks-of-a-repository", - "subcategory": "autolinks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/autolinks" - }, - { - "slug": "create-an-autolink-reference-for-a-repository", - "subcategory": "autolinks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/autolinks" - }, - { - "slug": "get-an-autolink-reference-of-a-repository", - "subcategory": "autolinks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}" - }, - { - "slug": "delete-an-autolink-reference-from-a-repository", - "subcategory": "autolinks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}" - }, - { - "slug": "check-if-dependabot-security-updates-are-enabled-for-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/automated-security-fixes" - }, - { - "slug": "list-codeowners-errors", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/codeowners/errors" - }, - { - "slug": "get-repository-content", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/contents/{path}" - }, - { - "slug": "create-or-update-file-contents", - "subcategory": "contents", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/contents/{path}" - }, - { - "slug": "delete-a-file", - "subcategory": "contents", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/contents/{path}" - }, - { - "slug": "list-repository-contributors", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/contributors" - }, - { - "slug": "create-a-repository-dispatch-event", - "subcategory": "repos", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/dispatches" - }, - { - "slug": "list-forks", - "subcategory": "forks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/forks" - }, - { - "slug": "create-a-fork", - "subcategory": "forks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/forks" - }, - { - "slug": "list-repository-webhooks", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks" - }, - { - "slug": "create-a-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks" - }, - { - "slug": "get-a-repository-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}" - }, - { - "slug": "update-a-repository-webhook", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}" - }, - { - "slug": "delete-a-repository-webhook", - "subcategory": "webhooks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}" - }, - { - "slug": "get-a-webhook-configuration-for-a-repository", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config" - }, - { - "slug": "update-a-webhook-configuration-for-a-repository", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config" - }, - { - "slug": "list-deliveries-for-a-repository-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries" - }, - { - "slug": "get-a-delivery-for-a-repository-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}" - }, - { - "slug": "redeliver-a-delivery-for-a-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts" - }, - { - "slug": "ping-a-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/pings" - }, - { - "slug": "test-the-push-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/tests" - }, - { - "slug": "list-repository-languages", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/languages" - }, - { - "slug": "get-all-custom-property-values-for-a-repository", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/properties/values" - }, - { - "slug": "create-or-update-custom-property-values-for-a-repository", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/properties/values" - }, - { - "slug": "get-a-repository-readme", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/readme" - }, - { - "slug": "get-a-repository-readme-for-a-directory", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/readme/{dir}" - }, - { - "slug": "list-repository-cache-replication-status", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/replicas/caches" - }, - { - "slug": "get-rules-for-a-branch", - "subcategory": "rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rules/branches/{branch}" - }, - { - "slug": "get-all-repository-rulesets", - "subcategory": "rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets" - }, - { - "slug": "create-a-repository-ruleset", - "subcategory": "rules", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/rulesets" - }, - { - "slug": "list-repository-rule-suites", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets/rule-suites" - }, - { - "slug": "get-a-repository-rule-suite", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}" - }, - { - "slug": "get-a-repository-ruleset", - "subcategory": "rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets/{ruleset_id}" - }, - { - "slug": "update-a-repository-ruleset", - "subcategory": "rules", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/rulesets/{ruleset_id}" - }, - { - "slug": "delete-a-repository-ruleset", - "subcategory": "rules", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/rulesets/{ruleset_id}" - }, - { - "slug": "list-repository-tags", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/tags" - }, - { - "slug": "download-a-repository-archive-tar", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/tarball/{ref}" - }, - { - "slug": "list-repository-teams", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/teams" - }, - { - "slug": "get-all-repository-topics", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/topics" - }, - { - "slug": "replace-all-repository-topics", - "subcategory": "repos", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/topics" - }, - { - "slug": "check-if-vulnerability-alerts-are-enabled-for-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts" - }, - { - "slug": "enable-vulnerability-alerts", - "subcategory": "repos", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts" - }, - { - "slug": "disable-vulnerability-alerts", - "subcategory": "repos", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts" - }, - { - "slug": "download-a-repository-archive-zip", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/zipball/{ref}" - }, - { - "slug": "create-a-repository-using-a-template", - "subcategory": "repos", - "verb": "post", - "requestPath": "/repos/{template_owner}/{template_repo}/generate" - }, - { - "slug": "list-public-repositories", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repositories" - }, - { - "slug": "list-repositories-for-a-user", - "subcategory": "repos", - "verb": "get", - "requestPath": "/users/{username}/repos" - } - ], - "search": [ - { - "slug": "search-code", - "subcategory": "search", - "verb": "get", - "requestPath": "/search/code" - }, - { - "slug": "search-commits", - "subcategory": "search", - "verb": "get", - "requestPath": "/search/commits" - }, - { - "slug": "search-issues-and-pull-requests", - "subcategory": "search", - "verb": "get", - "requestPath": "/search/issues" - }, - { - "slug": "search-labels", - "subcategory": "search", - "verb": "get", - "requestPath": "/search/labels" - }, - { - "slug": "search-repositories", - "subcategory": "search", - "verb": "get", - "requestPath": "/search/repositories" - }, - { - "slug": "search-topics", - "subcategory": "search", - "verb": "get", - "requestPath": "/search/topics" - }, - { - "slug": "search-users", - "subcategory": "search", - "verb": "get", - "requestPath": "/search/users" - } - ], - "secret-scanning": [ - { - "slug": "list-secret-scanning-alerts-for-an-organization", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/orgs/{org}/secret-scanning/alerts" - }, - { - "slug": "list-secret-scanning-alerts-for-a-repository", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts" - }, - { - "slug": "get-a-secret-scanning-alert", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}" - }, - { - "slug": "update-a-secret-scanning-alert", - "subcategory": "secret-scanning", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}" - }, - { - "slug": "list-locations-for-a-secret-scanning-alert", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations" - } - ], - "security-advisories": [ - { - "slug": "list-global-security-advisories", - "subcategory": "global-advisories", - "verb": "get", - "requestPath": "/advisories" - }, - { - "slug": "get-a-global-security-advisory", - "subcategory": "global-advisories", - "verb": "get", - "requestPath": "/advisories/{ghsa_id}" - } - ], - "teams": [ - { - "slug": "get-an-external-group", - "subcategory": "external-groups", - "verb": "get", - "requestPath": "/orgs/{org}/external-group/{group_id}" - }, - { - "slug": "list-external-groups-available-to-an-organization", - "subcategory": "external-groups", - "verb": "get", - "requestPath": "/orgs/{org}/external-groups" - }, - { - "slug": "list-teams", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams" - }, - { - "slug": "create-a-team", - "subcategory": "teams", - "verb": "post", - "requestPath": "/orgs/{org}/teams" - }, - { - "slug": "get-a-team-by-name", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}" - }, - { - "slug": "update-a-team", - "subcategory": "teams", - "verb": "patch", - "requestPath": "/orgs/{org}/teams/{team_slug}" - }, - { - "slug": "delete-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}" - }, - { - "slug": "list-a-connection-between-an-external-group-and-a-team", - "subcategory": "external-groups", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups" - }, - { - "slug": "update-the-connection-between-an-external-group-and-a-team", - "subcategory": "external-groups", - "verb": "patch", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups" - }, - { - "slug": "remove-the-connection-between-an-external-group-and-a-team", - "subcategory": "external-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups" - }, - { - "slug": "list-team-members", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/members" - }, - { - "slug": "get-team-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}" - }, - { - "slug": "add-or-update-team-membership-for-a-user", - "subcategory": "members", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}" - }, - { - "slug": "remove-team-membership-for-a-user", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}" - }, - { - "slug": "list-team-repositories", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos" - }, - { - "slug": "check-team-permissions-for-a-repository", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}" - }, - { - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}" - }, - { - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}" - }, - { - "slug": "list-child-teams", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/teams" - }, - { - "slug": "get-a-team-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}" - }, - { - "slug": "update-a-team-legacy", - "subcategory": "teams", - "verb": "patch", - "requestPath": "/teams/{team_id}" - }, - { - "slug": "delete-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}" - }, - { - "slug": "list-team-members-legacy", - "subcategory": "members", - "verb": "get", - "requestPath": "/teams/{team_id}/members" - }, - { - "slug": "get-team-member-legacy", - "subcategory": "members", - "verb": "get", - "requestPath": "/teams/{team_id}/members/{username}" - }, - { - "slug": "add-team-member-legacy", - "subcategory": "members", - "verb": "put", - "requestPath": "/teams/{team_id}/members/{username}" - }, - { - "slug": "remove-team-member-legacy", - "subcategory": "members", - "verb": "delete", - "requestPath": "/teams/{team_id}/members/{username}" - }, - { - "slug": "get-team-membership-for-a-user-legacy", - "subcategory": "members", - "verb": "get", - "requestPath": "/teams/{team_id}/memberships/{username}" - }, - { - "slug": "add-or-update-team-membership-for-a-user-legacy", - "subcategory": "members", - "verb": "put", - "requestPath": "/teams/{team_id}/memberships/{username}" - }, - { - "slug": "remove-team-membership-for-a-user-legacy", - "subcategory": "members", - "verb": "delete", - "requestPath": "/teams/{team_id}/memberships/{username}" - }, - { - "slug": "list-team-repositories-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos" - }, - { - "slug": "check-team-permissions-for-a-repository-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}" - }, - { - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}" - }, - { - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}" - }, - { - "slug": "list-child-teams-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/teams" - } - ], - "users": [ - { - "slug": "get-a-user-using-their-id", - "subcategory": "users", - "verb": "get", - "requestPath": "/user/{account_id}" - }, - { - "slug": "list-users", - "subcategory": "users", - "verb": "get", - "requestPath": "/users" - }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, - { - "slug": "list-followers-of-a-user", - "subcategory": "followers", - "verb": "get", - "requestPath": "/users/{username}/followers" - }, - { - "slug": "list-the-people-a-user-follows", - "subcategory": "followers", - "verb": "get", - "requestPath": "/users/{username}/following" - }, - { - "slug": "check-if-a-user-follows-another-user", - "subcategory": "followers", - "verb": "get", - "requestPath": "/users/{username}/following/{target_user}" - }, - { - "slug": "list-gpg-keys-for-a-user", - "subcategory": "gpg-keys", - "verb": "get", - "requestPath": "/users/{username}/gpg_keys" - }, - { - "slug": "list-public-keys-for-a-user", - "subcategory": "keys", - "verb": "get", - "requestPath": "/users/{username}/keys" - }, - { - "slug": "list-social-accounts-for-a-user", - "subcategory": "social-accounts", - "verb": "get", - "requestPath": "/users/{username}/social_accounts" - }, - { - "slug": "list-ssh-signing-keys-for-a-user", - "subcategory": "ssh-signing-keys", - "verb": "get", - "requestPath": "/users/{username}/ssh_signing_keys" - } - ] -} \ No newline at end of file diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json deleted file mode 100644 index 1491f20fbb65..000000000000 --- a/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json +++ /dev/null @@ -1,4428 +0,0 @@ -{ - "actions": [ - { - "slug": "get-github-actions-cache-usage-for-an-enterprise", - "subcategory": "cache", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/cache/usage" - }, - { - "slug": "get-github-actions-cache-usage-policy-for-an-enterprise", - "subcategory": "cache", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/cache/usage-policy" - }, - { - "slug": "set-github-actions-cache-usage-policy-for-an-enterprise", - "subcategory": "cache", - "verb": "patch", - "requestPath": "/enterprises/{enterprise}/actions/cache/usage-policy" - }, - { - "slug": "get-github-actions-cache-usage-for-an-organization", - "subcategory": "cache", - "verb": "get", - "requestPath": "/orgs/{org}/actions/cache/usage" - }, - { - "slug": "list-repositories-with-github-actions-cache-usage-for-an-organization", - "subcategory": "cache", - "verb": "get", - "requestPath": "/orgs/{org}/actions/cache/usage-by-repository" - }, - { - "slug": "get-the-customization-template-for-an-oidc-subject-claim-for-an-organization", - "subcategory": "oidc", - "verb": "get", - "requestPath": "/orgs/{org}/actions/oidc/customization/sub" - }, - { - "slug": "set-the-customization-template-for-an-oidc-subject-claim-for-an-organization", - "subcategory": "oidc", - "verb": "put", - "requestPath": "/orgs/{org}/actions/oidc/customization/sub" - }, - { - "slug": "get-github-actions-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions" - }, - { - "slug": "set-github-actions-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions" - }, - { - "slug": "list-selected-repositories-enabled-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/repositories" - }, - { - "slug": "set-selected-repositories-enabled-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories" - }, - { - "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}" - }, - { - "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}" - }, - { - "slug": "get-allowed-actions-for-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/selected-actions" - }, - { - "slug": "set-allowed-actions-for-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/selected-actions" - }, - { - "slug": "get-default-workflow-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/workflow" - }, - { - "slug": "set-default-workflow-permissions-for-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/workflow" - }, - { - "slug": "list-self-hosted-runner-groups-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups" - }, - { - "slug": "create-a-self-hosted-runner-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runner-groups" - }, - { - "slug": "get-a-self-hosted-runner-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}" - }, - { - "slug": "update-a-self-hosted-runner-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "patch", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}" - }, - { - "slug": "delete-a-self-hosted-runner-group-from-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}" - }, - { - "slug": "list-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories" - }, - { - "slug": "set-repository-access-for-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories" - }, - { - "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}" - }, - { - "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}" - }, - { - "slug": "list-self-hosted-runners-in-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners" - }, - { - "slug": "set-self-hosted-runners-in-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners" - }, - { - "slug": "add-a-self-hosted-runner-to-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}" - }, - { - "slug": "remove-a-self-hosted-runner-from-a-group-for-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}" - }, - { - "slug": "list-self-hosted-runners-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners" - }, - { - "slug": "list-runner-applications-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/downloads" - }, - { - "slug": "create-configuration-for-a-just-in-time-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/generate-jitconfig" - }, - { - "slug": "create-a-registration-token-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/registration-token" - }, - { - "slug": "create-a-remove-token-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/remove-token" - }, - { - "slug": "get-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}" - }, - { - "slug": "delete-a-self-hosted-runner-from-an-organization", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}" - }, - { - "slug": "list-labels-for-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels" - }, - { - "slug": "add-custom-labels-to-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels" - }, - { - "slug": "set-custom-labels-for-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels" - }, - { - "slug": "remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels" - }, - { - "slug": "remove-a-custom-label-from-a-self-hosted-runner-for-an-organization", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels/{name}" - }, - { - "slug": "list-organization-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets" - }, - { - "slug": "get-an-organization-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/public-key" - }, - { - "slug": "get-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}" - }, - { - "slug": "create-or-update-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}" - }, - { - "slug": "delete-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}" - }, - { - "slug": "list-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories" - }, - { - "slug": "set-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories" - }, - { - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}" - }, - { - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}" - }, - { - "slug": "list-organization-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables" - }, - { - "slug": "create-an-organization-variable", - "subcategory": "variables", - "verb": "post", - "requestPath": "/orgs/{org}/actions/variables" - }, - { - "slug": "get-an-organization-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables/{name}" - }, - { - "slug": "update-an-organization-variable", - "subcategory": "variables", - "verb": "patch", - "requestPath": "/orgs/{org}/actions/variables/{name}" - }, - { - "slug": "delete-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}" - }, - { - "slug": "list-selected-repositories-for-an-organization-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories" - }, - { - "slug": "set-selected-repositories-for-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories" - }, - { - "slug": "add-selected-repository-to-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}" - }, - { - "slug": "remove-selected-repository-from-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}" - }, - { - "slug": "list-artifacts-for-a-repository", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts" - }, - { - "slug": "get-an-artifact", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}" - }, - { - "slug": "delete-an-artifact", - "subcategory": "artifacts", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}" - }, - { - "slug": "download-an-artifact", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}" - }, - { - "slug": "get-github-actions-cache-usage-for-a-repository", - "subcategory": "cache", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/cache/usage" - }, - { - "slug": "get-github-actions-cache-usage-policy-for-a-repository", - "subcategory": "cache", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/cache/usage-policy" - }, - { - "slug": "set-github-actions-cache-usage-policy-for-a-repository", - "subcategory": "cache", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/actions/cache/usage-policy" - }, - { - "slug": "list-github-actions-caches-for-a-repository", - "subcategory": "cache", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/caches" - }, - { - "slug": "delete-github-actions-caches-for-a-repository-using-a-cache-key", - "subcategory": "cache", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/caches" - }, - { - "slug": "delete-a-github-actions-cache-for-a-repository-using-a-cache-id", - "subcategory": "cache", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/caches/{cache_id}" - }, - { - "slug": "get-a-job-for-a-workflow-run", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}" - }, - { - "slug": "download-job-logs-for-a-workflow-run", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs" - }, - { - "slug": "re-run-a-job-from-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun" - }, - { - "slug": "get-the-customization-template-for-an-oidc-subject-claim-for-a-repository", - "subcategory": "oidc", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/oidc/customization/sub" - }, - { - "slug": "set-the-customization-template-for-an-oidc-subject-claim-for-a-repository", - "subcategory": "oidc", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/oidc/customization/sub" - }, - { - "slug": "list-repository-organization-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/organization-secrets" - }, - { - "slug": "list-repository-organization-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/organization-variables" - }, - { - "slug": "get-github-actions-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions" - }, - { - "slug": "set-github-actions-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions" - }, - { - "slug": "get-the-level-of-access-for-workflows-outside-of-the-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/access" - }, - { - "slug": "set-the-level-of-access-for-workflows-outside-of-the-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/access" - }, - { - "slug": "get-allowed-actions-for-a-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions" - }, - { - "slug": "set-allowed-actions-for-a-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions" - }, - { - "slug": "get-default-workflow-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow" - }, - { - "slug": "set-default-workflow-permissions-for-a-repository", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow" - }, - { - "slug": "list-self-hosted-runners-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners" - }, - { - "slug": "list-runner-applications-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/downloads" - }, - { - "slug": "create-configuration-for-a-just-in-time-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/generate-jitconfig" - }, - { - "slug": "create-a-registration-token-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/registration-token" - }, - { - "slug": "create-a-remove-token-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/remove-token" - }, - { - "slug": "get-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}" - }, - { - "slug": "delete-a-self-hosted-runner-from-a-repository", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}" - }, - { - "slug": "list-labels-for-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels" - }, - { - "slug": "add-custom-labels-to-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels" - }, - { - "slug": "set-custom-labels-for-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels" - }, - { - "slug": "remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels" - }, - { - "slug": "remove-a-custom-label-from-a-self-hosted-runner-for-a-repository", - "subcategory": "self-hosted-runners", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}" - }, - { - "slug": "list-workflow-runs-for-a-repository", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs" - }, - { - "slug": "get-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}" - }, - { - "slug": "delete-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}" - }, - { - "slug": "get-the-review-history-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals" - }, - { - "slug": "list-workflow-run-artifacts", - "subcategory": "artifacts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts" - }, - { - "slug": "get-a-workflow-run-attempt", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}" - }, - { - "slug": "list-jobs-for-a-workflow-run-attempt", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs" - }, - { - "slug": "download-workflow-run-attempt-logs", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs" - }, - { - "slug": "cancel-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel" - }, - { - "slug": "force-cancel-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel" - }, - { - "slug": "list-jobs-for-a-workflow-run", - "subcategory": "workflow-jobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs" - }, - { - "slug": "download-workflow-run-logs", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs" - }, - { - "slug": "delete-workflow-run-logs", - "subcategory": "workflow-runs", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs" - }, - { - "slug": "get-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments" - }, - { - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments" - }, - { - "slug": "re-run-a-workflow", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun" - }, - { - "slug": "re-run-failed-jobs-from-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs" - }, - { - "slug": "list-repository-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets" - }, - { - "slug": "get-a-repository-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/public-key" - }, - { - "slug": "get-a-repository-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}" - }, - { - "slug": "create-or-update-a-repository-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}" - }, - { - "slug": "delete-a-repository-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}" - }, - { - "slug": "list-repository-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/variables" - }, - { - "slug": "create-a-repository-variable", - "subcategory": "variables", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/variables" - }, - { - "slug": "get-a-repository-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}" - }, - { - "slug": "update-a-repository-variable", - "subcategory": "variables", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}" - }, - { - "slug": "delete-a-repository-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}" - }, - { - "slug": "list-repository-workflows", - "subcategory": "workflows", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/workflows" - }, - { - "slug": "get-a-workflow", - "subcategory": "workflows", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}" - }, - { - "slug": "disable-a-workflow", - "subcategory": "workflows", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable" - }, - { - "slug": "create-a-workflow-dispatch-event", - "subcategory": "workflows", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches" - }, - { - "slug": "enable-a-workflow", - "subcategory": "workflows", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable" - }, - { - "slug": "list-workflow-runs-for-a-workflow", - "subcategory": "workflow-runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs" - }, - { - "slug": "list-environment-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets" - }, - { - "slug": "get-an-environment-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key" - }, - { - "slug": "get-an-environment-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}" - }, - { - "slug": "create-or-update-an-environment-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}" - }, - { - "slug": "delete-an-environment-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}" - }, - { - "slug": "list-environment-variables", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables" - }, - { - "slug": "create-an-environment-variable", - "subcategory": "variables", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables" - }, - { - "slug": "get-an-environment-variable", - "subcategory": "variables", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}" - }, - { - "slug": "update-an-environment-variable", - "subcategory": "variables", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}" - }, - { - "slug": "delete-an-environment-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}" - } - ], - "activity": [ - { - "slug": "list-public-events", - "subcategory": "events", - "verb": "get", - "requestPath": "/events" - }, - { - "slug": "get-feeds", - "subcategory": "feeds", - "verb": "get", - "requestPath": "/feeds" - }, - { - "slug": "list-public-events-for-a-network-of-repositories", - "subcategory": "events", - "verb": "get", - "requestPath": "/networks/{owner}/{repo}/events" - }, - { - "slug": "list-public-organization-events", - "subcategory": "events", - "verb": "get", - "requestPath": "/orgs/{org}/events" - }, - { - "slug": "list-repository-events", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/events" - }, - { - "slug": "list-stargazers", - "subcategory": "starring", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stargazers" - }, - { - "slug": "list-watchers", - "subcategory": "watching", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/subscribers" - }, - { - "slug": "list-repositories-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred" - }, - { - "slug": "check-if-a-repository-is-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred/{owner}/{repo}" - }, - { - "slug": "star-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "put", - "requestPath": "/user/starred/{owner}/{repo}" - }, - { - "slug": "unstar-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "delete", - "requestPath": "/user/starred/{owner}/{repo}" - }, - { - "slug": "list-repositories-watched-by-the-authenticated-user", - "subcategory": "watching", - "verb": "get", - "requestPath": "/user/subscriptions" - }, - { - "slug": "list-events-for-the-authenticated-user", - "subcategory": "events", - "verb": "get", - "requestPath": "/users/{username}/events" - }, - { - "slug": "list-organization-events-for-the-authenticated-user", - "subcategory": "events", - "verb": "get", - "requestPath": "/users/{username}/events/orgs/{org}" - }, - { - "slug": "list-public-events-for-a-user", - "subcategory": "events", - "verb": "get", - "requestPath": "/users/{username}/events/public" - }, - { - "slug": "list-events-received-by-the-authenticated-user", - "subcategory": "events", - "verb": "get", - "requestPath": "/users/{username}/received_events" - }, - { - "slug": "list-public-events-received-by-a-user", - "subcategory": "events", - "verb": "get", - "requestPath": "/users/{username}/received_events/public" - }, - { - "slug": "list-repositories-starred-by-a-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/users/{username}/starred" - }, - { - "slug": "list-repositories-watched-by-a-user", - "subcategory": "watching", - "verb": "get", - "requestPath": "/users/{username}/subscriptions" - } - ], - "announcement-banners": [ - { - "slug": "get-announcement-banner-for-organization", - "subcategory": "organizations", - "verb": "get", - "requestPath": "/orgs/{org}/announcement" - }, - { - "slug": "set-announcement-banner-for-organization", - "subcategory": "organizations", - "verb": "patch", - "requestPath": "/orgs/{org}/announcement" - }, - { - "slug": "remove-announcement-banner-from-organization", - "subcategory": "organizations", - "verb": "delete", - "requestPath": "/orgs/{org}/announcement" - } - ], - "apps": [ - { - "slug": "get-an-app", - "subcategory": "apps", - "verb": "get", - "requestPath": "/apps/{app_slug}" - }, - { - "slug": "list-app-installations-accessible-to-the-user-access-token", - "subcategory": "installations", - "verb": "get", - "requestPath": "/user/installations" - }, - { - "slug": "list-repositories-accessible-to-the-user-access-token", - "subcategory": "installations", - "verb": "get", - "requestPath": "/user/installations/{installation_id}/repositories" - } - ], - "billing": [ - { - "slug": "get-github-advanced-security-active-committers-for-an-organization", - "subcategory": "billing", - "verb": "get", - "requestPath": "/orgs/{org}/settings/billing/advanced-security" - } - ], - "branches": [ - { - "slug": "list-branches", - "subcategory": "branches", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches" - }, - { - "slug": "get-a-branch", - "subcategory": "branches", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}" - }, - { - "slug": "get-branch-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection" - }, - { - "slug": "update-branch-protection", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection" - }, - { - "slug": "delete-branch-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection" - }, - { - "slug": "get-admin-branch-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins" - }, - { - "slug": "set-admin-branch-protection", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins" - }, - { - "slug": "delete-admin-branch-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins" - }, - { - "slug": "get-pull-request-review-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews" - }, - { - "slug": "update-pull-request-review-protection", - "subcategory": "branch-protection", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews" - }, - { - "slug": "delete-pull-request-review-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews" - }, - { - "slug": "get-commit-signature-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures" - }, - { - "slug": "create-commit-signature-protection", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures" - }, - { - "slug": "delete-commit-signature-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures" - }, - { - "slug": "get-status-checks-protection", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks" - }, - { - "slug": "update-status-check-protection", - "subcategory": "branch-protection", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks" - }, - { - "slug": "remove-status-check-protection", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks" - }, - { - "slug": "get-all-status-check-contexts", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts" - }, - { - "slug": "add-status-check-contexts", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts" - }, - { - "slug": "set-status-check-contexts", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts" - }, - { - "slug": "remove-status-check-contexts", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts" - }, - { - "slug": "get-access-restrictions", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions" - }, - { - "slug": "delete-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions" - }, - { - "slug": "get-apps-with-access-to-the-protected-branch", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps" - }, - { - "slug": "add-app-access-restrictions", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps" - }, - { - "slug": "set-app-access-restrictions", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps" - }, - { - "slug": "remove-app-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps" - }, - { - "slug": "get-teams-with-access-to-the-protected-branch", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams" - }, - { - "slug": "add-team-access-restrictions", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams" - }, - { - "slug": "set-team-access-restrictions", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams" - }, - { - "slug": "remove-team-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams" - }, - { - "slug": "get-users-with-access-to-the-protected-branch", - "subcategory": "branch-protection", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users" - }, - { - "slug": "add-user-access-restrictions", - "subcategory": "branch-protection", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users" - }, - { - "slug": "set-user-access-restrictions", - "subcategory": "branch-protection", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users" - }, - { - "slug": "remove-user-access-restrictions", - "subcategory": "branch-protection", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users" - }, - { - "slug": "rename-a-branch", - "subcategory": "branches", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename" - }, - { - "slug": "sync-a-fork-branch-with-the-upstream-repository", - "subcategory": "branches", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merge-upstream" - }, - { - "slug": "merge-a-branch", - "subcategory": "branches", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merges" - } - ], - "checks": [ - { - "slug": "create-a-check-run", - "subcategory": "runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-runs" - }, - { - "slug": "get-a-check-run", - "subcategory": "runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}" - }, - { - "slug": "update-a-check-run", - "subcategory": "runs", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}" - }, - { - "slug": "list-check-run-annotations", - "subcategory": "runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations" - }, - { - "slug": "rerequest-a-check-run", - "subcategory": "runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest" - }, - { - "slug": "create-a-check-suite", - "subcategory": "suites", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-suites" - }, - { - "slug": "update-repository-preferences-for-check-suites", - "subcategory": "suites", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/check-suites/preferences" - }, - { - "slug": "get-a-check-suite", - "subcategory": "suites", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}" - }, - { - "slug": "list-check-runs-in-a-check-suite", - "subcategory": "runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs" - }, - { - "slug": "rerequest-a-check-suite", - "subcategory": "suites", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest" - }, - { - "slug": "list-check-runs-for-a-git-reference", - "subcategory": "runs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-runs" - }, - { - "slug": "list-check-suites-for-a-git-reference", - "subcategory": "suites", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-suites" - } - ], - "code-scanning": [ - { - "slug": "list-code-scanning-alerts-for-an-organization", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/orgs/{org}/code-scanning/alerts" - }, - { - "slug": "list-code-scanning-alerts-for-a-repository", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts" - }, - { - "slug": "get-a-code-scanning-alert", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}" - }, - { - "slug": "update-a-code-scanning-alert", - "subcategory": "code-scanning", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}" - }, - { - "slug": "list-instances-of-a-code-scanning-alert", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances" - }, - { - "slug": "list-code-scanning-analyses-for-a-repository", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses" - }, - { - "slug": "get-a-code-scanning-analysis-for-a-repository", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}" - }, - { - "slug": "delete-a-code-scanning-analysis-from-a-repository", - "subcategory": "code-scanning", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}" - }, - { - "slug": "get-a-code-scanning-default-setup-configuration", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/default-setup" - }, - { - "slug": "update-a-code-scanning-default-setup-configuration", - "subcategory": "code-scanning", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/code-scanning/default-setup" - }, - { - "slug": "upload-an-analysis-as-sarif-data", - "subcategory": "code-scanning", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs" - }, - { - "slug": "get-information-about-a-sarif-upload", - "subcategory": "code-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}" - } - ], - "codes-of-conduct": [ - { - "slug": "get-all-codes-of-conduct", - "subcategory": "codes-of-conduct", - "verb": "get", - "requestPath": "/codes_of_conduct" - }, - { - "slug": "get-a-code-of-conduct", - "subcategory": "codes-of-conduct", - "verb": "get", - "requestPath": "/codes_of_conduct/{key}" - } - ], - "collaborators": [ - { - "slug": "list-repository-collaborators", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators" - }, - { - "slug": "check-if-a-user-is-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}" - }, - { - "slug": "add-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}" - }, - { - "slug": "remove-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}" - }, - { - "slug": "get-repository-permissions-for-a-user", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission" - }, - { - "slug": "list-repository-invitations", - "subcategory": "invitations", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/invitations" - }, - { - "slug": "update-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}" - }, - { - "slug": "delete-a-repository-invitation", - "subcategory": "invitations", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}" - }, - { - "slug": "list-repository-invitations-for-the-authenticated-user", - "subcategory": "invitations", - "verb": "get", - "requestPath": "/user/repository_invitations" - }, - { - "slug": "accept-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}" - }, - { - "slug": "decline-a-repository-invitation", - "subcategory": "invitations", - "verb": "delete", - "requestPath": "/user/repository_invitations/{invitation_id}" - } - ], - "commits": [ - { - "slug": "list-commit-comments-for-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments" - }, - { - "slug": "get-a-commit-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}" - }, - { - "slug": "update-a-commit-comment", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}" - }, - { - "slug": "delete-a-commit-comment", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}" - }, - { - "slug": "list-commits", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits" - }, - { - "slug": "list-branches-for-head-commit", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head" - }, - { - "slug": "list-commit-comments", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments" - }, - { - "slug": "create-a-commit-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments" - }, - { - "slug": "list-pull-requests-associated-with-a-commit", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls" - }, - { - "slug": "get-a-commit", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}" - }, - { - "slug": "get-the-combined-status-for-a-specific-reference", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/status" - }, - { - "slug": "list-commit-statuses-for-a-reference", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/statuses" - }, - { - "slug": "compare-two-commits", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/compare/{basehead}" - }, - { - "slug": "create-a-commit-status", - "subcategory": "statuses", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/statuses/{sha}" - } - ], - "dependabot": [ - { - "slug": "list-dependabot-alerts-for-an-organization", - "subcategory": "alerts", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/alerts" - }, - { - "slug": "list-organization-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets" - }, - { - "slug": "get-an-organization-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets/public-key" - }, - { - "slug": "get-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}" - }, - { - "slug": "create-or-update-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}" - }, - { - "slug": "delete-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}" - }, - { - "slug": "list-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories" - }, - { - "slug": "set-selected-repositories-for-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories" - }, - { - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}" - }, - { - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}" - }, - { - "slug": "list-dependabot-alerts-for-a-repository", - "subcategory": "alerts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/alerts" - }, - { - "slug": "get-a-dependabot-alert", - "subcategory": "alerts", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}" - }, - { - "slug": "update-a-dependabot-alert", - "subcategory": "alerts", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}" - }, - { - "slug": "list-repository-secrets", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets" - }, - { - "slug": "get-a-repository-public-key", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/public-key" - }, - { - "slug": "get-a-repository-secret", - "subcategory": "secrets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}" - }, - { - "slug": "create-or-update-a-repository-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}" - }, - { - "slug": "delete-a-repository-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}" - } - ], - "dependency-graph": [ - { - "slug": "get-a-diff-of-the-dependencies-between-commits", - "subcategory": "dependency-review", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}" - }, - { - "slug": "export-a-software-bill-of-materials-sbom-for-a-repository", - "subcategory": "sboms", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependency-graph/sbom" - }, - { - "slug": "create-a-snapshot-of-dependencies-for-a-repository", - "subcategory": "dependency-submission", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/dependency-graph/snapshots" - } - ], - "deploy-keys": [ - { - "slug": "list-deploy-keys", - "subcategory": "deploy-keys", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/keys" - }, - { - "slug": "create-a-deploy-key", - "subcategory": "deploy-keys", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/keys" - }, - { - "slug": "get-a-deploy-key", - "subcategory": "deploy-keys", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/keys/{key_id}" - }, - { - "slug": "delete-a-deploy-key", - "subcategory": "deploy-keys", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/keys/{key_id}" - } - ], - "deployments": [ - { - "slug": "list-deployments", - "subcategory": "deployments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments" - }, - { - "slug": "create-a-deployment", - "subcategory": "deployments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/deployments" - }, - { - "slug": "get-a-deployment", - "subcategory": "deployments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}" - }, - { - "slug": "delete-a-deployment", - "subcategory": "deployments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}" - }, - { - "slug": "list-deployment-statuses", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses" - }, - { - "slug": "create-a-deployment-status", - "subcategory": "statuses", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses" - }, - { - "slug": "get-a-deployment-status", - "subcategory": "statuses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}" - }, - { - "slug": "list-environments", - "subcategory": "environments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments" - }, - { - "slug": "get-an-environment", - "subcategory": "environments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}" - }, - { - "slug": "create-or-update-an-environment", - "subcategory": "environments", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}" - }, - { - "slug": "delete-an-environment", - "subcategory": "environments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}" - }, - { - "slug": "list-deployment-branch-policies", - "subcategory": "branch-policies", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies" - }, - { - "slug": "create-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies" - }, - { - "slug": "get-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}" - }, - { - "slug": "update-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}" - }, - { - "slug": "delete-a-deployment-branch-policy", - "subcategory": "branch-policies", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}" - }, - { - "slug": "get-all-deployment-protection-rules-for-an-environment", - "subcategory": "protection-rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules" - }, - { - "slug": "create-a-custom-deployment-protection-rule-on-an-environment", - "subcategory": "protection-rules", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules" - }, - { - "slug": "list-custom-deployment-rule-integrations-available-for-an-environment", - "subcategory": "protection-rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps" - }, - { - "slug": "get-a-custom-deployment-protection-rule", - "subcategory": "protection-rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}" - }, - { - "slug": "disable-a-custom-protection-rule-for-an-environment", - "subcategory": "protection-rules", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}" - } - ], - "emojis": [ - { - "slug": "get-emojis", - "subcategory": "emojis", - "verb": "get", - "requestPath": "/emojis" - } - ], - "enterprise-admin": [ - { - "slug": "get-the-audit-log-for-an-enterprise", - "subcategory": "audit-log", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/audit-log" - }, - { - "slug": "get-github-advanced-security-active-committers-for-an-enterprise", - "subcategory": "licensing", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/settings/billing/advanced-security" - }, - { - "slug": "list-pre-receive-hooks-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks" - }, - { - "slug": "get-a-pre-receive-hook-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}" - }, - { - "slug": "update-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "patch", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}" - }, - { - "slug": "remove-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "delete", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}" - }, - { - "slug": "list-pre-receive-hooks-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks" - }, - { - "slug": "get-a-pre-receive-hook-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}" - }, - { - "slug": "update-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}" - }, - { - "slug": "remove-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}" - }, - { - "slug": "list-provisioned-scim-groups-for-an-enterprise", - "subcategory": "scim", - "verb": "get", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups" - }, - { - "slug": "provision-a-scim-enterprise-group", - "subcategory": "scim", - "verb": "post", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups" - }, - { - "slug": "get-scim-provisioning-information-for-an-enterprise-group", - "subcategory": "scim", - "verb": "get", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}" - }, - { - "slug": "set-scim-information-for-a-provisioned-enterprise-group", - "subcategory": "scim", - "verb": "put", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}" - }, - { - "slug": "update-an-attribute-for-a-scim-enterprise-group", - "subcategory": "scim", - "verb": "patch", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}" - }, - { - "slug": "delete-a-scim-group-from-an-enterprise", - "subcategory": "scim", - "verb": "delete", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}" - }, - { - "slug": "list-scim-provisioned-identities-for-an-enterprise", - "subcategory": "scim", - "verb": "get", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users" - }, - { - "slug": "provision-a-scim-enterprise-user", - "subcategory": "scim", - "verb": "post", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users" - }, - { - "slug": "get-scim-provisioning-information-for-an-enterprise-user", - "subcategory": "scim", - "verb": "get", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}" - }, - { - "slug": "set-scim-information-for-a-provisioned-enterprise-user", - "subcategory": "scim", - "verb": "put", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}" - }, - { - "slug": "update-an-attribute-for-a-scim-enterprise-user", - "subcategory": "scim", - "verb": "patch", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}" - }, - { - "slug": "delete-a-scim-user-from-an-enterprise", - "subcategory": "scim", - "verb": "delete", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}" - } - ], - "gists": [ - { - "slug": "list-gists-for-the-authenticated-user", - "subcategory": "gists", - "verb": "get", - "requestPath": "/gists" - }, - { - "slug": "create-a-gist", - "subcategory": "gists", - "verb": "post", - "requestPath": "/gists" - }, - { - "slug": "list-public-gists", - "subcategory": "gists", - "verb": "get", - "requestPath": "/gists/public" - }, - { - "slug": "list-starred-gists", - "subcategory": "gists", - "verb": "get", - "requestPath": "/gists/starred" - }, - { - "slug": "get-a-gist", - "subcategory": "gists", - "verb": "get", - "requestPath": "/gists/{gist_id}" - }, - { - "slug": "update-a-gist", - "subcategory": "gists", - "verb": "patch", - "requestPath": "/gists/{gist_id}" - }, - { - "slug": "delete-a-gist", - "subcategory": "gists", - "verb": "delete", - "requestPath": "/gists/{gist_id}" - }, - { - "slug": "list-gist-comments", - "subcategory": "comments", - "verb": "get", - "requestPath": "/gists/{gist_id}/comments" - }, - { - "slug": "create-a-gist-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/gists/{gist_id}/comments" - }, - { - "slug": "get-a-gist-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/gists/{gist_id}/comments/{comment_id}" - }, - { - "slug": "update-a-gist-comment", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/gists/{gist_id}/comments/{comment_id}" - }, - { - "slug": "delete-a-gist-comment", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/gists/{gist_id}/comments/{comment_id}" - }, - { - "slug": "list-gist-commits", - "subcategory": "gists", - "verb": "get", - "requestPath": "/gists/{gist_id}/commits" - }, - { - "slug": "list-gist-forks", - "subcategory": "gists", - "verb": "get", - "requestPath": "/gists/{gist_id}/forks" - }, - { - "slug": "fork-a-gist", - "subcategory": "gists", - "verb": "post", - "requestPath": "/gists/{gist_id}/forks" - }, - { - "slug": "check-if-a-gist-is-starred", - "subcategory": "gists", - "verb": "get", - "requestPath": "/gists/{gist_id}/star" - }, - { - "slug": "star-a-gist", - "subcategory": "gists", - "verb": "put", - "requestPath": "/gists/{gist_id}/star" - }, - { - "slug": "unstar-a-gist", - "subcategory": "gists", - "verb": "delete", - "requestPath": "/gists/{gist_id}/star" - }, - { - "slug": "get-a-gist-revision", - "subcategory": "gists", - "verb": "get", - "requestPath": "/gists/{gist_id}/{sha}" - }, - { - "slug": "list-gists-for-a-user", - "subcategory": "gists", - "verb": "get", - "requestPath": "/users/{username}/gists" - } - ], - "git": [ - { - "slug": "create-a-blob", - "subcategory": "blobs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/blobs" - }, - { - "slug": "get-a-blob", - "subcategory": "blobs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/blobs/{file_sha}" - }, - { - "slug": "create-a-commit", - "subcategory": "commits", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/commits" - }, - { - "slug": "get-a-commit-object", - "subcategory": "commits", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}" - }, - { - "slug": "list-matching-references", - "subcategory": "refs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/matching-refs/{ref}" - }, - { - "slug": "get-a-reference", - "subcategory": "refs", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/ref/{ref}" - }, - { - "slug": "create-a-reference", - "subcategory": "refs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/refs" - }, - { - "slug": "update-a-reference", - "subcategory": "refs", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}" - }, - { - "slug": "delete-a-reference", - "subcategory": "refs", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}" - }, - { - "slug": "create-a-tag-object", - "subcategory": "tags", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/tags" - }, - { - "slug": "get-a-tag", - "subcategory": "tags", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/tags/{tag_sha}" - }, - { - "slug": "create-a-tree", - "subcategory": "trees", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/trees" - }, - { - "slug": "get-a-tree", - "subcategory": "trees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/trees/{tree_sha}" - } - ], - "gitignore": [ - { - "slug": "get-all-gitignore-templates", - "subcategory": "gitignore", - "verb": "get", - "requestPath": "/gitignore/templates" - }, - { - "slug": "get-a-gitignore-template", - "subcategory": "gitignore", - "verb": "get", - "requestPath": "/gitignore/templates/{name}" - } - ], - "issues": [ - { - "slug": "list-issues-assigned-to-the-authenticated-user", - "subcategory": "issues", - "verb": "get", - "requestPath": "/issues" - }, - { - "slug": "list-organization-issues-assigned-to-the-authenticated-user", - "subcategory": "issues", - "verb": "get", - "requestPath": "/orgs/{org}/issues" - }, - { - "slug": "list-assignees", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/assignees" - }, - { - "slug": "check-if-a-user-can-be-assigned", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/assignees/{assignee}" - }, - { - "slug": "list-repository-issues", - "subcategory": "issues", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues" - }, - { - "slug": "create-an-issue", - "subcategory": "issues", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues" - }, - { - "slug": "list-issue-comments-for-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments" - }, - { - "slug": "get-an-issue-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}" - }, - { - "slug": "update-an-issue-comment", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}" - }, - { - "slug": "delete-an-issue-comment", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}" - }, - { - "slug": "list-issue-events-for-a-repository", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/events" - }, - { - "slug": "get-an-issue-event", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}" - }, - { - "slug": "get-an-issue", - "subcategory": "issues", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}" - }, - { - "slug": "update-an-issue", - "subcategory": "issues", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}" - }, - { - "slug": "add-assignees-to-an-issue", - "subcategory": "assignees", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees" - }, - { - "slug": "remove-assignees-from-an-issue", - "subcategory": "assignees", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees" - }, - { - "slug": "check-if-a-user-can-be-assigned-to-a-issue", - "subcategory": "assignees", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}" - }, - { - "slug": "list-issue-comments", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments" - }, - { - "slug": "create-an-issue-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments" - }, - { - "slug": "list-issue-events", - "subcategory": "events", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events" - }, - { - "slug": "list-issue-field-values-for-an-issue", - "subcategory": "issue-field-values", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values" - }, - { - "slug": "list-labels-for-an-issue", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels" - }, - { - "slug": "add-labels-to-an-issue", - "subcategory": "labels", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels" - }, - { - "slug": "set-labels-for-an-issue", - "subcategory": "labels", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels" - }, - { - "slug": "remove-all-labels-from-an-issue", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels" - }, - { - "slug": "remove-a-label-from-an-issue", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}" - }, - { - "slug": "lock-an-issue", - "subcategory": "issues", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock" - }, - { - "slug": "unlock-an-issue", - "subcategory": "issues", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock" - }, - { - "slug": "list-timeline-events-for-an-issue", - "subcategory": "timeline", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline" - }, - { - "slug": "list-labels-for-a-repository", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/labels" - }, - { - "slug": "create-a-label", - "subcategory": "labels", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/labels" - }, - { - "slug": "get-a-label", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/labels/{name}" - }, - { - "slug": "update-a-label", - "subcategory": "labels", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/labels/{name}" - }, - { - "slug": "delete-a-label", - "subcategory": "labels", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/labels/{name}" - }, - { - "slug": "list-milestones", - "subcategory": "milestones", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones" - }, - { - "slug": "create-a-milestone", - "subcategory": "milestones", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/milestones" - }, - { - "slug": "get-a-milestone", - "subcategory": "milestones", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}" - }, - { - "slug": "update-a-milestone", - "subcategory": "milestones", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}" - }, - { - "slug": "delete-a-milestone", - "subcategory": "milestones", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}" - }, - { - "slug": "list-labels-for-issues-in-a-milestone", - "subcategory": "labels", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels" - }, - { - "slug": "list-user-account-issues-assigned-to-the-authenticated-user", - "subcategory": "issues", - "verb": "get", - "requestPath": "/user/issues" - } - ], - "licenses": [ - { - "slug": "get-all-commonly-used-licenses", - "subcategory": "licenses", - "verb": "get", - "requestPath": "/licenses" - }, - { - "slug": "get-a-license", - "subcategory": "licenses", - "verb": "get", - "requestPath": "/licenses/{license}" - }, - { - "slug": "get-the-license-for-a-repository", - "subcategory": "licenses", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/license" - } - ], - "markdown": [ - { - "slug": "render-a-markdown-document", - "subcategory": "markdown", - "verb": "post", - "requestPath": "/markdown" - }, - { - "slug": "render-a-markdown-document-in-raw-mode", - "subcategory": "markdown", - "verb": "post", - "requestPath": "/markdown/raw" - } - ], - "meta": [ - { - "slug": "github-api-root", - "subcategory": "meta", - "verb": "get", - "requestPath": "/" - }, - { - "slug": "get-github-enterprise-server-meta-information", - "subcategory": "meta", - "verb": "get", - "requestPath": "/meta" - }, - { - "slug": "get-octocat", - "subcategory": "meta", - "verb": "get", - "requestPath": "/octocat" - }, - { - "slug": "get-the-zen-of-github", - "subcategory": "meta", - "verb": "get", - "requestPath": "/zen" - } - ], - "metrics": [ - { - "slug": "get-the-weekly-commit-activity", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/code_frequency" - }, - { - "slug": "get-the-last-year-of-commit-activity", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/commit_activity" - }, - { - "slug": "get-all-contributor-commit-activity", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/contributors" - }, - { - "slug": "get-the-weekly-commit-count", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/participation" - }, - { - "slug": "get-the-hourly-commit-count-for-each-day", - "subcategory": "statistics", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/punch_card" - } - ], - "orgs": [ - { - "slug": "list-organizations", - "subcategory": "orgs", - "verb": "get", - "requestPath": "/organizations" - }, - { - "slug": "closing-down---list-custom-repository-roles-in-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/organizations/{organization_id}/custom_roles" - }, - { - "slug": "get-an-organization", - "subcategory": "orgs", - "verb": "get", - "requestPath": "/orgs/{org}" - }, - { - "slug": "update-an-organization", - "subcategory": "orgs", - "verb": "patch", - "requestPath": "/orgs/{org}" - }, - { - "slug": "delete-an-organization", - "subcategory": "orgs", - "verb": "delete", - "requestPath": "/orgs/{org}" - }, - { - "slug": "get-the-audit-log-for-an-organization", - "subcategory": "orgs", - "verb": "get", - "requestPath": "/orgs/{org}/audit-log" - }, - { - "slug": "list-custom-repository-roles-in-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/custom-repository-roles" - }, - { - "slug": "create-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "post", - "requestPath": "/orgs/{org}/custom-repository-roles" - }, - { - "slug": "get-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}" - }, - { - "slug": "update-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "patch", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}" - }, - { - "slug": "delete-a-custom-repository-role", - "subcategory": "custom-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}" - }, - { - "slug": "list-organization-webhooks", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks" - }, - { - "slug": "create-an-organization-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/orgs/{org}/hooks" - }, - { - "slug": "get-an-organization-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}" - }, - { - "slug": "update-an-organization-webhook", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/orgs/{org}/hooks/{hook_id}" - }, - { - "slug": "delete-an-organization-webhook", - "subcategory": "webhooks", - "verb": "delete", - "requestPath": "/orgs/{org}/hooks/{hook_id}" - }, - { - "slug": "get-a-webhook-configuration-for-an-organization", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/config" - }, - { - "slug": "update-a-webhook-configuration-for-an-organization", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/orgs/{org}/hooks/{hook_id}/config" - }, - { - "slug": "list-deliveries-for-an-organization-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries" - }, - { - "slug": "get-a-webhook-delivery-for-an-organization-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}" - }, - { - "slug": "redeliver-a-delivery-for-an-organization-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts" - }, - { - "slug": "ping-an-organization-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/orgs/{org}/hooks/{hook_id}/pings" - }, - { - "slug": "list-app-installations-for-an-organization", - "subcategory": "orgs", - "verb": "get", - "requestPath": "/orgs/{org}/installations" - }, - { - "slug": "list-organization-members", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/members" - }, - { - "slug": "check-organization-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/members/{username}" - }, - { - "slug": "remove-an-organization-member", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/members/{username}" - }, - { - "slug": "get-organization-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/memberships/{username}" - }, - { - "slug": "set-organization-membership-for-a-user", - "subcategory": "members", - "verb": "put", - "requestPath": "/orgs/{org}/memberships/{username}" - }, - { - "slug": "remove-organization-membership-for-a-user", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/memberships/{username}" - }, - { - "slug": "list-organization-fine-grained-permissions-for-an-organization", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-fine-grained-permissions" - }, - { - "slug": "get-all-organization-roles-for-an-organization", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles" - }, - { - "slug": "create-a-custom-organization-role", - "subcategory": "organization-roles", - "verb": "post", - "requestPath": "/orgs/{org}/organization-roles" - }, - { - "slug": "remove-all-organization-roles-for-a-team", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/teams/{team_slug}" - }, - { - "slug": "assign-an-organization-role-to-a-team", - "subcategory": "organization-roles", - "verb": "put", - "requestPath": "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}" - }, - { - "slug": "remove-an-organization-role-from-a-team", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}" - }, - { - "slug": "remove-all-organization-roles-for-a-user", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/users/{username}" - }, - { - "slug": "assign-an-organization-role-to-a-user", - "subcategory": "organization-roles", - "verb": "put", - "requestPath": "/orgs/{org}/organization-roles/users/{username}/{role_id}" - }, - { - "slug": "remove-an-organization-role-from-a-user", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/users/{username}/{role_id}" - }, - { - "slug": "get-an-organization-role", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles/{role_id}" - }, - { - "slug": "update-a-custom-organization-role", - "subcategory": "organization-roles", - "verb": "patch", - "requestPath": "/orgs/{org}/organization-roles/{role_id}" - }, - { - "slug": "delete-a-custom-organization-role", - "subcategory": "organization-roles", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/{role_id}" - }, - { - "slug": "list-teams-that-are-assigned-to-an-organization-role", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles/{role_id}/teams" - }, - { - "slug": "list-users-that-are-assigned-to-an-organization-role", - "subcategory": "organization-roles", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles/{role_id}/users" - }, - { - "slug": "list-outside-collaborators-for-an-organization", - "subcategory": "outside-collaborators", - "verb": "get", - "requestPath": "/orgs/{org}/outside_collaborators" - }, - { - "slug": "convert-an-organization-member-to-outside-collaborator", - "subcategory": "outside-collaborators", - "verb": "put", - "requestPath": "/orgs/{org}/outside_collaborators/{username}" - }, - { - "slug": "remove-outside-collaborator-from-an-organization", - "subcategory": "outside-collaborators", - "verb": "delete", - "requestPath": "/orgs/{org}/outside_collaborators/{username}" - }, - { - "slug": "list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens", - "subcategory": "personal-access-tokens", - "verb": "get", - "requestPath": "/orgs/{org}/personal-access-token-requests" - }, - { - "slug": "review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens", - "subcategory": "personal-access-tokens", - "verb": "post", - "requestPath": "/orgs/{org}/personal-access-token-requests" - }, - { - "slug": "review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token", - "subcategory": "personal-access-tokens", - "verb": "post", - "requestPath": "/orgs/{org}/personal-access-token-requests/{pat_request_id}" - }, - { - "slug": "list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token", - "subcategory": "personal-access-tokens", - "verb": "get", - "requestPath": "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories" - }, - { - "slug": "list-fine-grained-personal-access-tokens-with-access-to-organization-resources", - "subcategory": "personal-access-tokens", - "verb": "get", - "requestPath": "/orgs/{org}/personal-access-tokens" - }, - { - "slug": "update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens", - "subcategory": "personal-access-tokens", - "verb": "post", - "requestPath": "/orgs/{org}/personal-access-tokens" - }, - { - "slug": "update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources", - "subcategory": "personal-access-tokens", - "verb": "post", - "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}" - }, - { - "slug": "list-repositories-a-fine-grained-personal-access-token-has-access-to", - "subcategory": "personal-access-tokens", - "verb": "get", - "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" - }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "list-custom-property-values-for-organization-repositories", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/values" - }, - { - "slug": "create-or-update-custom-property-values-for-organization-repositories", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" - }, - { - "slug": "list-public-organization-members", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/public_members" - }, - { - "slug": "check-public-organization-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/public_members/{username}" - }, - { - "slug": "set-public-organization-membership-for-the-authenticated-user", - "subcategory": "members", - "verb": "put", - "requestPath": "/orgs/{org}/public_members/{username}" - }, - { - "slug": "remove-public-organization-membership-for-the-authenticated-user", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/public_members/{username}" - }, - { - "slug": "list-repository-fine-grained-permissions-for-an-organization", - "subcategory": "custom-roles", - "verb": "get", - "requestPath": "/orgs/{org}/repository-fine-grained-permissions" - }, - { - "slug": "get-all-organization-repository-rulesets", - "subcategory": "rules", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets" - }, - { - "slug": "create-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "post", - "requestPath": "/orgs/{org}/rulesets" - }, - { - "slug": "list-organization-rule-suites", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets/rule-suites" - }, - { - "slug": "get-an-organization-rule-suite", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}" - }, - { - "slug": "get-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets/{ruleset_id}" - }, - { - "slug": "update-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "put", - "requestPath": "/orgs/{org}/rulesets/{ruleset_id}" - }, - { - "slug": "delete-an-organization-repository-ruleset", - "subcategory": "rules", - "verb": "delete", - "requestPath": "/orgs/{org}/rulesets/{ruleset_id}" - }, - { - "slug": "list-security-manager-teams", - "subcategory": "security-managers", - "verb": "get", - "requestPath": "/orgs/{org}/security-managers" - }, - { - "slug": "add-a-security-manager-team", - "subcategory": "security-managers", - "verb": "put", - "requestPath": "/orgs/{org}/security-managers/teams/{team_slug}" - }, - { - "slug": "remove-a-security-manager-team", - "subcategory": "security-managers", - "verb": "delete", - "requestPath": "/orgs/{org}/security-managers/teams/{team_slug}" - }, - { - "slug": "enable-or-disable-a-security-feature-for-an-organization", - "subcategory": "orgs", - "verb": "post", - "requestPath": "/orgs/{org}/{security_product}/{enablement}" - }, - { - "slug": "list-organization-memberships-for-the-authenticated-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/user/memberships/orgs" - }, - { - "slug": "get-an-organization-membership-for-the-authenticated-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/user/memberships/orgs/{org}" - }, - { - "slug": "update-an-organization-membership-for-the-authenticated-user", - "subcategory": "members", - "verb": "patch", - "requestPath": "/user/memberships/orgs/{org}" - }, - { - "slug": "list-organizations-for-the-authenticated-user", - "subcategory": "orgs", - "verb": "get", - "requestPath": "/user/orgs" - }, - { - "slug": "list-organizations-for-a-user", - "subcategory": "orgs", - "verb": "get", - "requestPath": "/users/{username}/orgs" - } - ], - "packages": [ - { - "slug": "get-list-of-conflicting-packages-during-docker-migration-for-organization", - "subcategory": "packages", - "verb": "get", - "requestPath": "/orgs/{org}/docker/conflicts" - }, - { - "slug": "list-packages-for-an-organization", - "subcategory": "packages", - "verb": "get", - "requestPath": "/orgs/{org}/packages" - }, - { - "slug": "get-a-package-for-an-organization", - "subcategory": "packages", - "verb": "get", - "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}" - }, - { - "slug": "delete-a-package-for-an-organization", - "subcategory": "packages", - "verb": "delete", - "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}" - }, - { - "slug": "list-package-versions-for-a-package-owned-by-an-organization", - "subcategory": "packages", - "verb": "get", - "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions" - }, - { - "slug": "get-a-package-version-for-an-organization", - "subcategory": "packages", - "verb": "get", - "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}" - }, - { - "slug": "get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user", - "subcategory": "packages", - "verb": "get", - "requestPath": "/user/docker/conflicts" - }, - { - "slug": "list-packages-for-the-authenticated-users-namespace", - "subcategory": "packages", - "verb": "get", - "requestPath": "/user/packages" - }, - { - "slug": "get-a-package-for-the-authenticated-user", - "subcategory": "packages", - "verb": "get", - "requestPath": "/user/packages/{package_type}/{package_name}" - }, - { - "slug": "delete-a-package-for-the-authenticated-user", - "subcategory": "packages", - "verb": "delete", - "requestPath": "/user/packages/{package_type}/{package_name}" - }, - { - "slug": "list-package-versions-for-a-package-owned-by-the-authenticated-user", - "subcategory": "packages", - "verb": "get", - "requestPath": "/user/packages/{package_type}/{package_name}/versions" - }, - { - "slug": "get-a-package-version-for-the-authenticated-user", - "subcategory": "packages", - "verb": "get", - "requestPath": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}" - }, - { - "slug": "get-list-of-conflicting-packages-during-docker-migration-for-user", - "subcategory": "packages", - "verb": "get", - "requestPath": "/users/{username}/docker/conflicts" - }, - { - "slug": "list-packages-for-a-user", - "subcategory": "packages", - "verb": "get", - "requestPath": "/users/{username}/packages" - }, - { - "slug": "get-a-package-for-a-user", - "subcategory": "packages", - "verb": "get", - "requestPath": "/users/{username}/packages/{package_type}/{package_name}" - }, - { - "slug": "delete-a-package-for-a-user", - "subcategory": "packages", - "verb": "delete", - "requestPath": "/users/{username}/packages/{package_type}/{package_name}" - }, - { - "slug": "list-package-versions-for-a-package-owned-by-a-user", - "subcategory": "packages", - "verb": "get", - "requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions" - }, - { - "slug": "get-a-package-version-for-a-user", - "subcategory": "packages", - "verb": "get", - "requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}" - } - ], - "pages": [ - { - "slug": "get-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages" - }, - { - "slug": "create-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages" - }, - { - "slug": "update-information-about-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pages" - }, - { - "slug": "delete-a-github-enterprise-server-pages-site", - "subcategory": "pages", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pages" - }, - { - "slug": "list-github-enterprise-server-pages-builds", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/builds" - }, - { - "slug": "request-a-github-enterprise-server-pages-build", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/builds" - }, - { - "slug": "get-latest-pages-build", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/builds/latest" - }, - { - "slug": "get-github-enterprise-server-pages-build", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/builds/{build_id}" - }, - { - "slug": "create-a-github-pages-deployment", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployments" - }, - { - "slug": "get-the-status-of-a-github-pages-deployment", - "subcategory": "pages", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}" - }, - { - "slug": "cancel-a-github-pages-deployment", - "subcategory": "pages", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel" - } - ], - "pulls": [ - { - "slug": "list-pull-requests", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls" - }, - { - "slug": "create-a-pull-request", - "subcategory": "pulls", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls" - }, - { - "slug": "list-review-comments-in-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/comments" - }, - { - "slug": "get-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}" - }, - { - "slug": "update-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}" - }, - { - "slug": "delete-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}" - }, - { - "slug": "get-a-pull-request", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}" - }, - { - "slug": "update-a-pull-request", - "subcategory": "pulls", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}" - }, - { - "slug": "list-review-comments-on-a-pull-request", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments" - }, - { - "slug": "create-a-review-comment-for-a-pull-request", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments" - }, - { - "slug": "create-a-reply-for-a-review-comment", - "subcategory": "comments", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies" - }, - { - "slug": "list-commits-on-a-pull-request", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/commits" - }, - { - "slug": "list-pull-requests-files", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/files" - }, - { - "slug": "check-if-a-pull-request-has-been-merged", - "subcategory": "pulls", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge" - }, - { - "slug": "merge-a-pull-request", - "subcategory": "pulls", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge" - }, - { - "slug": "get-all-requested-reviewers-for-a-pull-request", - "subcategory": "review-requests", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers" - }, - { - "slug": "request-reviewers-for-a-pull-request", - "subcategory": "review-requests", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers" - }, - { - "slug": "remove-requested-reviewers-from-a-pull-request", - "subcategory": "review-requests", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers" - }, - { - "slug": "list-reviews-for-a-pull-request", - "subcategory": "reviews", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews" - }, - { - "slug": "create-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews" - }, - { - "slug": "get-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}" - }, - { - "slug": "update-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}" - }, - { - "slug": "delete-a-pending-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}" - }, - { - "slug": "list-comments-for-a-pull-request-review", - "subcategory": "reviews", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments" - }, - { - "slug": "dismiss-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals" - }, - { - "slug": "submit-a-review-for-a-pull-request", - "subcategory": "reviews", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events" - }, - { - "slug": "update-a-pull-request-branch", - "subcategory": "pulls", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch" - } - ], - "rate-limit": [ - { - "slug": "get-rate-limit-status-for-the-authenticated-user", - "subcategory": "rate-limit", - "verb": "get", - "requestPath": "/rate_limit" - } - ], - "reactions": [ - { - "slug": "list-reactions-for-a-commit-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions" - }, - { - "slug": "create-reaction-for-a-commit-comment", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions" - }, - { - "slug": "delete-a-commit-comment-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}" - }, - { - "slug": "list-reactions-for-an-issue-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions" - }, - { - "slug": "create-reaction-for-an-issue-comment", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions" - }, - { - "slug": "delete-an-issue-comment-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}" - }, - { - "slug": "list-reactions-for-an-issue", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions" - }, - { - "slug": "create-reaction-for-an-issue", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions" - }, - { - "slug": "delete-an-issue-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}" - }, - { - "slug": "list-reactions-for-a-pull-request-review-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions" - }, - { - "slug": "create-reaction-for-a-pull-request-review-comment", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions" - }, - { - "slug": "delete-a-pull-request-comment-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}" - }, - { - "slug": "list-reactions-for-a-release", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions" - }, - { - "slug": "create-reaction-for-a-release", - "subcategory": "reactions", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions" - }, - { - "slug": "delete-a-release-reaction", - "subcategory": "reactions", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}" - } - ], - "releases": [ - { - "slug": "list-releases", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases" - }, - { - "slug": "create-a-release", - "subcategory": "releases", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases" - }, - { - "slug": "get-a-release-asset", - "subcategory": "assets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}" - }, - { - "slug": "update-a-release-asset", - "subcategory": "assets", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}" - }, - { - "slug": "delete-a-release-asset", - "subcategory": "assets", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}" - }, - { - "slug": "generate-release-notes-content-for-a-release", - "subcategory": "releases", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases/generate-notes" - }, - { - "slug": "get-the-latest-release", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/latest" - }, - { - "slug": "get-a-release-by-tag-name", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}" - }, - { - "slug": "get-a-release", - "subcategory": "releases", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}" - }, - { - "slug": "update-a-release", - "subcategory": "releases", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}" - }, - { - "slug": "delete-a-release", - "subcategory": "releases", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}" - }, - { - "slug": "list-release-assets", - "subcategory": "assets", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets" - } - ], - "repos": [ - { - "slug": "list-organization-repositories", - "subcategory": "repos", - "verb": "get", - "requestPath": "/orgs/{org}/repos" - }, - { - "slug": "create-an-organization-repository", - "subcategory": "repos", - "verb": "post", - "requestPath": "/orgs/{org}/repos" - }, - { - "slug": "get-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}" - }, - { - "slug": "update-a-repository", - "subcategory": "repos", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}" - }, - { - "slug": "delete-a-repository", - "subcategory": "repos", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}" - }, - { - "slug": "list-repository-activities", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/activity" - }, - { - "slug": "get-all-autolinks-of-a-repository", - "subcategory": "autolinks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/autolinks" - }, - { - "slug": "create-an-autolink-reference-for-a-repository", - "subcategory": "autolinks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/autolinks" - }, - { - "slug": "get-an-autolink-reference-of-a-repository", - "subcategory": "autolinks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}" - }, - { - "slug": "delete-an-autolink-reference-from-a-repository", - "subcategory": "autolinks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}" - }, - { - "slug": "check-if-dependabot-security-updates-are-enabled-for-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/automated-security-fixes" - }, - { - "slug": "list-codeowners-errors", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/codeowners/errors" - }, - { - "slug": "get-repository-content", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/contents/{path}" - }, - { - "slug": "create-or-update-file-contents", - "subcategory": "contents", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/contents/{path}" - }, - { - "slug": "delete-a-file", - "subcategory": "contents", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/contents/{path}" - }, - { - "slug": "list-repository-contributors", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/contributors" - }, - { - "slug": "create-a-repository-dispatch-event", - "subcategory": "repos", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/dispatches" - }, - { - "slug": "list-forks", - "subcategory": "forks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/forks" - }, - { - "slug": "create-a-fork", - "subcategory": "forks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/forks" - }, - { - "slug": "list-repository-webhooks", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks" - }, - { - "slug": "create-a-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks" - }, - { - "slug": "get-a-repository-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}" - }, - { - "slug": "update-a-repository-webhook", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}" - }, - { - "slug": "delete-a-repository-webhook", - "subcategory": "webhooks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}" - }, - { - "slug": "get-a-webhook-configuration-for-a-repository", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config" - }, - { - "slug": "update-a-webhook-configuration-for-a-repository", - "subcategory": "webhooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config" - }, - { - "slug": "list-deliveries-for-a-repository-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries" - }, - { - "slug": "get-a-delivery-for-a-repository-webhook", - "subcategory": "webhooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}" - }, - { - "slug": "redeliver-a-delivery-for-a-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts" - }, - { - "slug": "ping-a-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/pings" - }, - { - "slug": "test-the-push-repository-webhook", - "subcategory": "webhooks", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/tests" - }, - { - "slug": "list-repository-languages", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/languages" - }, - { - "slug": "get-all-custom-property-values-for-a-repository", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/properties/values" - }, - { - "slug": "create-or-update-custom-property-values-for-a-repository", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/properties/values" - }, - { - "slug": "get-a-repository-readme", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/readme" - }, - { - "slug": "get-a-repository-readme-for-a-directory", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/readme/{dir}" - }, - { - "slug": "list-repository-cache-replication-status", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/replicas/caches" - }, - { - "slug": "get-rules-for-a-branch", - "subcategory": "rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rules/branches/{branch}" - }, - { - "slug": "get-all-repository-rulesets", - "subcategory": "rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets" - }, - { - "slug": "create-a-repository-ruleset", - "subcategory": "rules", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/rulesets" - }, - { - "slug": "list-repository-rule-suites", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets/rule-suites" - }, - { - "slug": "get-a-repository-rule-suite", - "subcategory": "rule-suites", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}" - }, - { - "slug": "get-a-repository-ruleset", - "subcategory": "rules", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets/{ruleset_id}" - }, - { - "slug": "update-a-repository-ruleset", - "subcategory": "rules", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/rulesets/{ruleset_id}" - }, - { - "slug": "delete-a-repository-ruleset", - "subcategory": "rules", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/rulesets/{ruleset_id}" - }, - { - "slug": "list-repository-tags", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/tags" - }, - { - "slug": "download-a-repository-archive-tar", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/tarball/{ref}" - }, - { - "slug": "list-repository-teams", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/teams" - }, - { - "slug": "get-all-repository-topics", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/topics" - }, - { - "slug": "replace-all-repository-topics", - "subcategory": "repos", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/topics" - }, - { - "slug": "transfer-a-repository", - "subcategory": "repos", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/transfer" - }, - { - "slug": "check-if-vulnerability-alerts-are-enabled-for-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts" - }, - { - "slug": "enable-vulnerability-alerts", - "subcategory": "repos", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts" - }, - { - "slug": "disable-vulnerability-alerts", - "subcategory": "repos", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts" - }, - { - "slug": "download-a-repository-archive-zip", - "subcategory": "contents", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/zipball/{ref}" - }, - { - "slug": "create-a-repository-using-a-template", - "subcategory": "repos", - "verb": "post", - "requestPath": "/repos/{template_owner}/{template_repo}/generate" - }, - { - "slug": "list-public-repositories", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repositories" - }, - { - "slug": "list-repositories-for-the-authenticated-user", - "subcategory": "repos", - "verb": "get", - "requestPath": "/user/repos" - }, - { - "slug": "create-a-repository-for-the-authenticated-user", - "subcategory": "repos", - "verb": "post", - "requestPath": "/user/repos" - }, - { - "slug": "list-repositories-for-a-user", - "subcategory": "repos", - "verb": "get", - "requestPath": "/users/{username}/repos" - } - ], - "search": [ - { - "slug": "search-code", - "subcategory": "search", - "verb": "get", - "requestPath": "/search/code" - }, - { - "slug": "search-commits", - "subcategory": "search", - "verb": "get", - "requestPath": "/search/commits" - }, - { - "slug": "search-issues-and-pull-requests", - "subcategory": "search", - "verb": "get", - "requestPath": "/search/issues" - }, - { - "slug": "search-labels", - "subcategory": "search", - "verb": "get", - "requestPath": "/search/labels" - }, - { - "slug": "search-repositories", - "subcategory": "search", - "verb": "get", - "requestPath": "/search/repositories" - }, - { - "slug": "search-topics", - "subcategory": "search", - "verb": "get", - "requestPath": "/search/topics" - }, - { - "slug": "search-users", - "subcategory": "search", - "verb": "get", - "requestPath": "/search/users" - } - ], - "secret-scanning": [ - { - "slug": "list-secret-scanning-alerts-for-an-organization", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/orgs/{org}/secret-scanning/alerts" - }, - { - "slug": "list-secret-scanning-alerts-for-a-repository", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts" - }, - { - "slug": "get-a-secret-scanning-alert", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}" - }, - { - "slug": "update-a-secret-scanning-alert", - "subcategory": "secret-scanning", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}" - }, - { - "slug": "list-locations-for-a-secret-scanning-alert", - "subcategory": "secret-scanning", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations" - } - ], - "security-advisories": [ - { - "slug": "list-global-security-advisories", - "subcategory": "global-advisories", - "verb": "get", - "requestPath": "/advisories" - }, - { - "slug": "get-a-global-security-advisory", - "subcategory": "global-advisories", - "verb": "get", - "requestPath": "/advisories/{ghsa_id}" - } - ], - "teams": [ - { - "slug": "get-an-external-group", - "subcategory": "external-groups", - "verb": "get", - "requestPath": "/orgs/{org}/external-group/{group_id}" - }, - { - "slug": "list-external-groups-available-to-an-organization", - "subcategory": "external-groups", - "verb": "get", - "requestPath": "/orgs/{org}/external-groups" - }, - { - "slug": "list-teams", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams" - }, - { - "slug": "create-a-team", - "subcategory": "teams", - "verb": "post", - "requestPath": "/orgs/{org}/teams" - }, - { - "slug": "get-a-team-by-name", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}" - }, - { - "slug": "update-a-team", - "subcategory": "teams", - "verb": "patch", - "requestPath": "/orgs/{org}/teams/{team_slug}" - }, - { - "slug": "delete-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}" - }, - { - "slug": "list-a-connection-between-an-external-group-and-a-team", - "subcategory": "external-groups", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups" - }, - { - "slug": "update-the-connection-between-an-external-group-and-a-team", - "subcategory": "external-groups", - "verb": "patch", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups" - }, - { - "slug": "remove-the-connection-between-an-external-group-and-a-team", - "subcategory": "external-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups" - }, - { - "slug": "list-team-members", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/members" - }, - { - "slug": "get-team-membership-for-a-user", - "subcategory": "members", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}" - }, - { - "slug": "add-or-update-team-membership-for-a-user", - "subcategory": "members", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}" - }, - { - "slug": "remove-team-membership-for-a-user", - "subcategory": "members", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}" - }, - { - "slug": "list-team-repositories", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos" - }, - { - "slug": "check-team-permissions-for-a-repository", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}" - }, - { - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}" - }, - { - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}" - }, - { - "slug": "list-child-teams", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/teams" - }, - { - "slug": "get-a-team-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}" - }, - { - "slug": "update-a-team-legacy", - "subcategory": "teams", - "verb": "patch", - "requestPath": "/teams/{team_id}" - }, - { - "slug": "delete-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}" - }, - { - "slug": "list-team-members-legacy", - "subcategory": "members", - "verb": "get", - "requestPath": "/teams/{team_id}/members" - }, - { - "slug": "get-team-member-legacy", - "subcategory": "members", - "verb": "get", - "requestPath": "/teams/{team_id}/members/{username}" - }, - { - "slug": "add-team-member-legacy", - "subcategory": "members", - "verb": "put", - "requestPath": "/teams/{team_id}/members/{username}" - }, - { - "slug": "remove-team-member-legacy", - "subcategory": "members", - "verb": "delete", - "requestPath": "/teams/{team_id}/members/{username}" - }, - { - "slug": "get-team-membership-for-a-user-legacy", - "subcategory": "members", - "verb": "get", - "requestPath": "/teams/{team_id}/memberships/{username}" - }, - { - "slug": "add-or-update-team-membership-for-a-user-legacy", - "subcategory": "members", - "verb": "put", - "requestPath": "/teams/{team_id}/memberships/{username}" - }, - { - "slug": "remove-team-membership-for-a-user-legacy", - "subcategory": "members", - "verb": "delete", - "requestPath": "/teams/{team_id}/memberships/{username}" - }, - { - "slug": "list-team-repositories-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos" - }, - { - "slug": "check-team-permissions-for-a-repository-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}" - }, - { - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}" - }, - { - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}" - }, - { - "slug": "list-child-teams-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/teams" - }, - { - "slug": "list-teams-for-the-authenticated-user", - "subcategory": "teams", - "verb": "get", - "requestPath": "/user/teams" - } - ], - "users": [ - { - "slug": "get-the-authenticated-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/user" - }, - { - "slug": "update-the-authenticated-user", - "subcategory": "users", - "verb": "patch", - "requestPath": "/user" - }, - { - "slug": "list-email-addresses-for-the-authenticated-user", - "subcategory": "emails", - "verb": "get", - "requestPath": "/user/emails" - }, - { - "slug": "add-an-email-address-for-the-authenticated-user", - "subcategory": "emails", - "verb": "post", - "requestPath": "/user/emails" - }, - { - "slug": "delete-an-email-address-for-the-authenticated-user", - "subcategory": "emails", - "verb": "delete", - "requestPath": "/user/emails" - }, - { - "slug": "list-followers-of-the-authenticated-user", - "subcategory": "followers", - "verb": "get", - "requestPath": "/user/followers" - }, - { - "slug": "list-the-people-the-authenticated-user-follows", - "subcategory": "followers", - "verb": "get", - "requestPath": "/user/following" - }, - { - "slug": "check-if-a-person-is-followed-by-the-authenticated-user", - "subcategory": "followers", - "verb": "get", - "requestPath": "/user/following/{username}" - }, - { - "slug": "follow-a-user", - "subcategory": "followers", - "verb": "put", - "requestPath": "/user/following/{username}" - }, - { - "slug": "unfollow-a-user", - "subcategory": "followers", - "verb": "delete", - "requestPath": "/user/following/{username}" - }, - { - "slug": "list-gpg-keys-for-the-authenticated-user", - "subcategory": "gpg-keys", - "verb": "get", - "requestPath": "/user/gpg_keys" - }, - { - "slug": "create-a-gpg-key-for-the-authenticated-user", - "subcategory": "gpg-keys", - "verb": "post", - "requestPath": "/user/gpg_keys" - }, - { - "slug": "get-a-gpg-key-for-the-authenticated-user", - "subcategory": "gpg-keys", - "verb": "get", - "requestPath": "/user/gpg_keys/{gpg_key_id}" - }, - { - "slug": "delete-a-gpg-key-for-the-authenticated-user", - "subcategory": "gpg-keys", - "verb": "delete", - "requestPath": "/user/gpg_keys/{gpg_key_id}" - }, - { - "slug": "list-public-ssh-keys-for-the-authenticated-user", - "subcategory": "keys", - "verb": "get", - "requestPath": "/user/keys" - }, - { - "slug": "create-a-public-ssh-key-for-the-authenticated-user", - "subcategory": "keys", - "verb": "post", - "requestPath": "/user/keys" - }, - { - "slug": "get-a-public-ssh-key-for-the-authenticated-user", - "subcategory": "keys", - "verb": "get", - "requestPath": "/user/keys/{key_id}" - }, - { - "slug": "delete-a-public-ssh-key-for-the-authenticated-user", - "subcategory": "keys", - "verb": "delete", - "requestPath": "/user/keys/{key_id}" - }, - { - "slug": "list-public-email-addresses-for-the-authenticated-user", - "subcategory": "emails", - "verb": "get", - "requestPath": "/user/public_emails" - }, - { - "slug": "list-social-accounts-for-the-authenticated-user", - "subcategory": "social-accounts", - "verb": "get", - "requestPath": "/user/social_accounts" - }, - { - "slug": "add-social-accounts-for-the-authenticated-user", - "subcategory": "social-accounts", - "verb": "post", - "requestPath": "/user/social_accounts" - }, - { - "slug": "delete-social-accounts-for-the-authenticated-user", - "subcategory": "social-accounts", - "verb": "delete", - "requestPath": "/user/social_accounts" - }, - { - "slug": "list-ssh-signing-keys-for-the-authenticated-user", - "subcategory": "ssh-signing-keys", - "verb": "get", - "requestPath": "/user/ssh_signing_keys" - }, - { - "slug": "create-a-ssh-signing-key-for-the-authenticated-user", - "subcategory": "ssh-signing-keys", - "verb": "post", - "requestPath": "/user/ssh_signing_keys" - }, - { - "slug": "get-an-ssh-signing-key-for-the-authenticated-user", - "subcategory": "ssh-signing-keys", - "verb": "get", - "requestPath": "/user/ssh_signing_keys/{ssh_signing_key_id}" - }, - { - "slug": "delete-an-ssh-signing-key-for-the-authenticated-user", - "subcategory": "ssh-signing-keys", - "verb": "delete", - "requestPath": "/user/ssh_signing_keys/{ssh_signing_key_id}" - }, - { - "slug": "get-a-user-using-their-id", - "subcategory": "users", - "verb": "get", - "requestPath": "/user/{account_id}" - }, - { - "slug": "list-users", - "subcategory": "users", - "verb": "get", - "requestPath": "/users" - }, - { - "slug": "get-a-user", - "subcategory": "users", - "verb": "get", - "requestPath": "/users/{username}" - }, - { - "slug": "list-followers-of-a-user", - "subcategory": "followers", - "verb": "get", - "requestPath": "/users/{username}/followers" - }, - { - "slug": "list-the-people-a-user-follows", - "subcategory": "followers", - "verb": "get", - "requestPath": "/users/{username}/following" - }, - { - "slug": "check-if-a-user-follows-another-user", - "subcategory": "followers", - "verb": "get", - "requestPath": "/users/{username}/following/{target_user}" - }, - { - "slug": "list-gpg-keys-for-a-user", - "subcategory": "gpg-keys", - "verb": "get", - "requestPath": "/users/{username}/gpg_keys" - }, - { - "slug": "list-public-keys-for-a-user", - "subcategory": "keys", - "verb": "get", - "requestPath": "/users/{username}/keys" - }, - { - "slug": "list-social-accounts-for-a-user", - "subcategory": "social-accounts", - "verb": "get", - "requestPath": "/users/{username}/social_accounts" - }, - { - "slug": "list-ssh-signing-keys-for-a-user", - "subcategory": "ssh-signing-keys", - "verb": "get", - "requestPath": "/users/{username}/ssh_signing_keys" - } - ] -} \ No newline at end of file diff --git a/src/graphql/data/ghes-3.14/graphql_upcoming_changes.public-enterprise.yml b/src/graphql/data/ghes-3.14/graphql_upcoming_changes.public-enterprise.yml deleted file mode 100644 index 9b77dce856c4..000000000000 --- a/src/graphql/data/ghes-3.14/graphql_upcoming_changes.public-enterprise.yml +++ /dev/null @@ -1,528 +0,0 @@ ---- -upcoming_changes: - - location: LegacyMigration.uploadUrlTemplate - description: '`uploadUrlTemplate` will be removed. Use `uploadUrl` instead.' - reason: - '`uploadUrlTemplate` is being removed because it is not a standard URL and - adds an extra user step.' - date: '2019-04-01T00:00:00+00:00' - criticality: breaking - owner: tambling - - location: AssignedEvent.user - description: '`user` will be removed. Use the `assignee` field instead.' - reason: Assignees can now be mannequins. - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: tambling - - location: UnassignedEvent.user - description: '`user` will be removed. Use the `assignee` field instead.' - reason: Assignees can now be mannequins. - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: tambling - - location: Issue.timeline - description: '`timeline` will be removed. Use Issue.timelineItems instead.' - reason: '`timeline` will be removed' - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: mikesea - - location: PullRequest.timeline - description: '`timeline` will be removed. Use PullRequest.timelineItems instead.' - reason: '`timeline` will be removed' - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: mikesea - - location: MergeStateStatus.DRAFT - description: '`DRAFT` will be removed. Use PullRequest.isDraft instead.' - reason: - DRAFT state will be removed from this enum and `isDraft` should be used - instead - date: '2021-01-01T00:00:00+00:00' - criticality: breaking - owner: nplasterer - - location: PackageType.DOCKER - description: '`DOCKER` will be removed.' - reason: - DOCKER will be removed from this enum as this type will be migrated to only - be used by the Packages REST API. - date: '2021-06-21' - criticality: breaking - owner: reybard - - location: ReactionGroup.users - description: '`users` will be removed. Use the `reactors` field instead.' - reason: Reactors can now be mannequins, bots, and organizations. - date: '2021-10-01T00:00:00+00:00' - criticality: breaking - owner: synthead - - location: AddPullRequestToMergeQueueInput.branch - description: '`branch` will be removed.' - reason: - PRs are added to the merge queue for the base branch, the `branch` argument - is now a no-op - date: '2022-07-01T00:00:00+00:00' - criticality: breaking - owner: jhunschejones - - location: DependencyGraphDependency.packageLabel - description: - '`packageLabel` will be removed. Use normalized `packageName` field - instead.' - reason: '`packageLabel` will be removed.' - date: '2022-10-01T00:00:00+00:00' - criticality: breaking - owner: github/dependency_graph - - location: RemovePullRequestFromMergeQueueInput.branch - description: '`branch` will be removed.' - reason: - PRs are removed from the merge queue for the base branch, the `branch` argument - is now a no-op - date: '2022-10-01T00:00:00+00:00' - criticality: breaking - owner: jhunschejones - - location: PackageType.NPM - description: '`NPM` will be removed.' - reason: - NPM will be removed from this enum as this type will be migrated to only - be used by the Packages REST API. - date: '2022-11-21' - criticality: breaking - owner: s-anupam - - location: PackageType.NUGET - description: '`NUGET` will be removed.' - reason: - NUGET will be removed from this enum as this type will be migrated to only - be used by the Packages REST API. - date: '2022-11-21' - criticality: breaking - owner: s-anupam - - location: PackageType.RUBYGEMS - description: '`RUBYGEMS` will be removed.' - reason: - RUBYGEMS will be removed from this enum as this type will be migrated to - only be used by the Packages REST API. - date: '2022-12-28' - criticality: breaking - owner: ankitkaushal01 - - location: Commit.changedFiles - description: '`changedFiles` will be removed. Use `changedFilesIfAvailable` instead.' - reason: '`changedFiles` will be removed.' - date: '2023-01-01T00:00:00+00:00' - criticality: breaking - owner: adamshwert - - location: ProjectV2View.visibleFields - description: - '`visibleFields` will be removed. Check out the `ProjectV2View#fields` - API as an example for the more capable alternative.' - reason: - The `ProjectV2View#visibleFields` API is deprecated in favour of the more - capable `ProjectV2View#fields` API. - date: '2023-01-01T00:00:00+00:00' - criticality: breaking - owner: mattruggio - - location: PackageType.MAVEN - description: '`MAVEN` will be removed.' - reason: - MAVEN will be removed from this enum as this type will be migrated to only - be used by the Packages REST API. - date: '2023-02-10' - criticality: breaking - owner: ankitkaushal01 - - location: ProjectV2View.groupBy - description: - '`groupBy` will be removed. Check out the `ProjectV2View#group_by_fields` - API as an example for the more capable alternative.' - reason: - The `ProjectV2View#order_by` API is deprecated in favour of the more capable - `ProjectV2View#group_by_field` API. - date: '2023-04-01T00:00:00+00:00' - criticality: breaking - owner: alcere - - location: ProjectV2View.sortBy - description: - '`sortBy` will be removed. Check out the `ProjectV2View#sort_by_fields` - API as an example for the more capable alternative.' - reason: - The `ProjectV2View#sort_by` API is deprecated in favour of the more capable - `ProjectV2View#sort_by_fields` API. - date: '2023-04-01T00:00:00+00:00' - criticality: breaking - owner: traumverloren - - location: ProjectV2View.verticalGroupBy - description: - '`verticalGroupBy` will be removed. Check out the `ProjectV2View#vertical_group_by_fields` - API as an example for the more capable alternative.' - reason: - The `ProjectV2View#vertical_group_by` API is deprecated in favour of the - more capable `ProjectV2View#vertical_group_by_fields` API. - date: '2023-04-01T00:00:00+00:00' - criticality: breaking - owner: traumverloren - - location: Repository.squashPrTitleUsedAsDefault - description: - '`squashPrTitleUsedAsDefault` will be removed. Use `Repository.squashMergeCommitTitle` - instead.' - reason: '`squashPrTitleUsedAsDefault` will be removed.' - date: '2023-04-01T00:00:00+00:00' - criticality: breaking - owner: github/pull_requests - - location: Commit.pushedDate - description: '`pushedDate` will be removed.' - reason: '`pushedDate` is no longer supported.' - date: '2023-07-01T00:00:00+00:00' - criticality: breaking - owner: darthwillis - - location: ProjectV2ItemFieldGroup.field - description: - '`field` will be removed. Check out the `ProjectV2ItemFieldGroup#groupByField` - API as an example for the more capable alternative.' - reason: - The `ProjectV2ItemFieldGroup#field` API is deprecated in favour of the more - capable `ProjectV2ItemFieldGroup#groupByField` API. - date: '2023-07-01T00:00:00+00:00' - criticality: breaking - owner: stevepopovich - - location: AddPullRequestReviewCommentInput.body - description: - '`body` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply - instead' - reason: We are deprecating the addPullRequestReviewComment mutation - date: '2023-10-01T00:00:00+00:00' - criticality: breaking - owner: aharpole - - location: AddPullRequestReviewCommentInput.commitOID - description: - '`commitOID` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply - instead' - reason: We are deprecating the addPullRequestReviewComment mutation - date: '2023-10-01T00:00:00+00:00' - criticality: breaking - owner: aharpole - - location: AddPullRequestReviewCommentInput.inReplyTo - description: - '`inReplyTo` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply - instead' - reason: We are deprecating the addPullRequestReviewComment mutation - date: '2023-10-01T00:00:00+00:00' - criticality: breaking - owner: aharpole - - location: AddPullRequestReviewCommentInput.path - description: - '`path` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply - instead' - reason: We are deprecating the addPullRequestReviewComment mutation - date: '2023-10-01T00:00:00+00:00' - criticality: breaking - owner: aharpole - - location: AddPullRequestReviewCommentInput.position - description: - '`position` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply - instead' - reason: We are deprecating the addPullRequestReviewComment mutation - date: '2023-10-01T00:00:00+00:00' - criticality: breaking - owner: aharpole - - location: AddPullRequestReviewCommentInput.pullRequestId - description: - '`pullRequestId` will be removed. use addPullRequestReviewThread or - addPullRequestReviewThreadReply instead' - reason: We are deprecating the addPullRequestReviewComment mutation - date: '2023-10-01T00:00:00+00:00' - criticality: breaking - owner: aharpole - - location: AddPullRequestReviewCommentInput.pullRequestReviewId - description: - '`pullRequestReviewId` will be removed. use addPullRequestReviewThread - or addPullRequestReviewThreadReply instead' - reason: We are deprecating the addPullRequestReviewComment mutation - date: '2023-10-01T00:00:00+00:00' - criticality: breaking - owner: aharpole - - location: AddPullRequestReviewInput.comments - description: '`comments` will be removed. use the `threads` argument instead' - reason: We are deprecating comment fields that use diff-relative positioning - date: '2023-10-01T00:00:00+00:00' - criticality: breaking - owner: aharpole - - location: PullRequestReviewComment.originalPosition - description: '`originalPosition` will be removed.' - reason: We are phasing out diff-relative positioning for PR comments - date: '2023-10-01T00:00:00+00:00' - criticality: breaking - owner: aharpole - - location: PullRequestReviewComment.position - description: - '`position` will be removed. Use the `line` and `startLine` fields - instead, which are file line numbers instead of diff line numbers' - reason: We are phasing out diff-relative positioning for PR comments - date: '2023-10-01T00:00:00+00:00' - criticality: breaking - owner: aharpole - - location: TopicSuggestionDeclineReason.NOT_RELEVANT - description: '`NOT_RELEVANT` will be removed.' - reason: Suggested topics are no longer supported - date: '2024-04-01T00:00:00+00:00' - criticality: breaking - owner: calvinchilds - - location: TopicSuggestionDeclineReason.PERSONAL_PREFERENCE - description: '`PERSONAL_PREFERENCE` will be removed.' - reason: Suggested topics are no longer supported - date: '2024-04-01T00:00:00+00:00' - criticality: breaking - owner: calvinchilds - - location: TopicSuggestionDeclineReason.TOO_GENERAL - description: '`TOO_GENERAL` will be removed.' - reason: Suggested topics are no longer supported - date: '2024-04-01T00:00:00+00:00' - criticality: breaking - owner: calvinchilds - - location: TopicSuggestionDeclineReason.TOO_SPECIFIC - description: '`TOO_SPECIFIC` will be removed.' - reason: Suggested topics are no longer supported - date: '2024-04-01T00:00:00+00:00' - criticality: breaking - owner: calvinchilds - - location: CreateTeamDiscussionCommentInput.body - description: - '`body` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: CreateTeamDiscussionCommentInput.discussionId - description: - '`discussionId` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: CreateTeamDiscussionCommentPayload.teamDiscussionComment - description: - '`teamDiscussionComment` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: CreateTeamDiscussionInput.body - description: - '`body` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: CreateTeamDiscussionInput.private - description: - '`private` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: CreateTeamDiscussionInput.teamId - description: - '`teamId` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: CreateTeamDiscussionInput.title - description: - '`title` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: CreateTeamDiscussionPayload.teamDiscussion - description: - '`teamDiscussion` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: OrganizationInvitation.inviter - description: '`inviter` will be removed. `inviter` will be replaced by `inviterActor`.' - reason: '`inviter` will be removed.' - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: jdennes - - location: PullRequest.databaseId - description: '`databaseId` will be removed. Use `fullDatabaseId` instead.' - reason: - '`databaseId` will be removed because it does not support 64-bit signed - integer identifiers.' - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: JanKoszewski - - location: PullRequestReview.databaseId - description: '`databaseId` will be removed. Use `fullDatabaseId` instead.' - reason: - '`databaseId` will be removed because it does not support 64-bit signed - integer identifiers.' - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: JanKoszewski - - location: PullRequestReviewComment.databaseId - description: '`databaseId` will be removed. Use `fullDatabaseId` instead.' - reason: - '`databaseId` will be removed because it does not support 64-bit signed - integer identifiers.' - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: JanKoszewski - - location: TeamDiscussion.authorAssociation - description: - '`authorAssociation` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: TeamDiscussion.bodyVersion - description: - '`bodyVersion` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: TeamDiscussion.comments - description: - '`comments` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: TeamDiscussion.commentsResourcePath - description: - '`commentsResourcePath` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: TeamDiscussion.commentsUrl - description: - '`commentsUrl` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: TeamDiscussion.isPinned - description: - '`isPinned` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: TeamDiscussion.isPrivate - description: - '`isPrivate` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: TeamDiscussion.number - description: - '`number` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: TeamDiscussion.resourcePath - description: - '`resourcePath` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: TeamDiscussion.team - description: - '`team` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: TeamDiscussion.title - description: - '`title` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: TeamDiscussion.url - description: - '`url` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: TeamDiscussion.viewerCanPin - description: - '`viewerCanPin` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: TeamDiscussionComment.authorAssociation - description: - '`authorAssociation` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: TeamDiscussionComment.bodyVersion - description: - '`bodyVersion` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: TeamDiscussionComment.discussion - description: - '`discussion` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: TeamDiscussionComment.number - description: - '`number` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: TeamDiscussionComment.resourcePath - description: - '`resourcePath` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges - - location: TeamDiscussionComment.url - description: - '`url` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ - to find a suitable replacement.' - reason: The Team Discussions feature is deprecated in favor of Organization Discussions. - date: '2024-07-01T00:00:00+00:00' - criticality: breaking - owner: deborah-digges diff --git a/src/graphql/data/ghes-3.14/previews.json b/src/graphql/data/ghes-3.14/previews.json deleted file mode 100644 index 0637a088a01e..000000000000 --- a/src/graphql/data/ghes-3.14/previews.json +++ /dev/null @@ -1 +0,0 @@ -[] \ No newline at end of file diff --git a/src/graphql/data/ghes-3.14/schema.docs-enterprise.graphql b/src/graphql/data/ghes-3.14/schema.docs-enterprise.graphql deleted file mode 100644 index 0092e3c5bbd7..000000000000 --- a/src/graphql/data/ghes-3.14/schema.docs-enterprise.graphql +++ /dev/null @@ -1,56354 +0,0 @@ -directive @requiredCapabilities( - requiredCapabilities: [String!] -) on ARGUMENT_DEFINITION | ENUM | ENUM_VALUE | FIELD_DEFINITION | INPUT_FIELD_DEFINITION | INPUT_OBJECT | INTERFACE | OBJECT | SCALAR | UNION - -""" -Marks an element of a GraphQL schema as only available via a preview header -""" -directive @preview( - """ - The identifier of the API preview that toggles this field. - """ - toggledBy: String! -) on ARGUMENT_DEFINITION | ENUM | ENUM_VALUE | FIELD_DEFINITION | INPUT_FIELD_DEFINITION | INPUT_OBJECT | INTERFACE | OBJECT | SCALAR | UNION - -""" -Defines what type of global IDs are accepted for a mutation argument of type ID. -""" -directive @possibleTypes( - """ - Abstract type of accepted global ID - """ - abstractType: String - - """ - Accepted types of global IDs. - """ - concreteTypes: [String!]! -) on INPUT_FIELD_DEFINITION - -""" -Autogenerated input type of AbortQueuedMigrations -""" -input AbortQueuedMigrationsInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the organization that is running the migrations. - """ - ownerId: ID! @possibleTypes(concreteTypes: ["Organization"]) -} - -""" -Autogenerated return type of AbortQueuedMigrations -""" -type AbortQueuedMigrationsPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Did the operation succeed? - """ - success: Boolean -} - -""" -Autogenerated input type of AbortRepositoryMigration -""" -input AbortRepositoryMigrationInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the migration to be aborted. - """ - migrationId: ID! @possibleTypes(concreteTypes: ["RepositoryMigration"]) -} - -""" -Autogenerated return type of AbortRepositoryMigration -""" -type AbortRepositoryMigrationPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Did the operation succeed? - """ - success: Boolean -} - -""" -Represents an object which can take actions on GitHub. Typically a User or Bot. -""" -interface Actor { - """ - A URL pointing to the actor's public avatar. - """ - avatarUrl( - """ - The size of the resulting square image. - """ - size: Int - ): URI! - - """ - The username of the actor. - """ - login: String! - - """ - The HTTP path for this actor. - """ - resourcePath: URI! - - """ - The HTTP URL for this actor. - """ - url: URI! -} - -""" -Location information for an actor -""" -type ActorLocation { - """ - City - """ - city: String - - """ - Country name - """ - country: String - - """ - Country code - """ - countryCode: String - - """ - Region name - """ - region: String - - """ - Region or state code - """ - regionCode: String -} - -""" -The actor's type. -""" -enum ActorType { - """ - Indicates a team actor. - """ - TEAM - - """ - Indicates a user actor. - """ - USER -} - -""" -Autogenerated input type of AddAssigneesToAssignable -""" -input AddAssigneesToAssignableInput { - """ - The id of the assignable object to add assignees to. - """ - assignableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Assignable") - - """ - The id of users to add as assignees. - """ - assigneeIds: [ID!]! @possibleTypes(concreteTypes: ["User"]) - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated return type of AddAssigneesToAssignable -""" -type AddAssigneesToAssignablePayload { - """ - The item that was assigned. - """ - assignable: Assignable - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of AddComment -""" -input AddCommentInput { - """ - The contents of the comment. - """ - body: String! - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the subject to modify. - """ - subjectId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "IssueOrPullRequest") -} - -""" -Autogenerated return type of AddComment -""" -type AddCommentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The edge from the subject's comment connection. - """ - commentEdge: IssueCommentEdge - - """ - The subject - """ - subject: Node - - """ - The edge from the subject's timeline connection. - """ - timelineEdge: IssueTimelineItemEdge -} - -""" -Autogenerated input type of AddDiscussionComment -""" -input AddDiscussionCommentInput { - """ - The contents of the comment. - """ - body: String! - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the discussion to comment on. - """ - discussionId: ID! @possibleTypes(concreteTypes: ["Discussion"]) - - """ - The Node ID of the discussion comment within this discussion to reply to. - """ - replyToId: ID @possibleTypes(concreteTypes: ["DiscussionComment"]) -} - -""" -Autogenerated return type of AddDiscussionComment -""" -type AddDiscussionCommentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The newly created discussion comment. - """ - comment: DiscussionComment -} - -""" -Autogenerated input type of AddDiscussionPollVote -""" -input AddDiscussionPollVoteInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the discussion poll option to vote for. - """ - pollOptionId: ID! @possibleTypes(concreteTypes: ["DiscussionPollOption"]) -} - -""" -Autogenerated return type of AddDiscussionPollVote -""" -type AddDiscussionPollVotePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The poll option that a vote was added to. - """ - pollOption: DiscussionPollOption -} - -""" -Autogenerated input type of AddEnterpriseAdmin -""" -input AddEnterpriseAdminInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the enterprise account to which the administrator should be added. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The login of the user to add as an administrator. - """ - login: String! -} - -""" -Autogenerated return type of AddEnterpriseAdmin -""" -type AddEnterpriseAdminPayload { - """ - The user who was added as an administrator. - """ - admin: User - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated enterprise. - """ - enterprise: Enterprise - - """ - The role of the administrator. - """ - role: EnterpriseAdministratorRole - - """ - The viewer performing the mutation. - """ - viewer: User -} - -""" -Autogenerated input type of AddEnterpriseOrganizationMember -""" -input AddEnterpriseOrganizationMemberInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the enterprise which owns the organization. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The ID of the organization the users will be added to. - """ - organizationId: ID! @possibleTypes(concreteTypes: ["Organization"]) - - """ - The role to assign the users in the organization - """ - role: OrganizationMemberRole - - """ - The IDs of the enterprise members to add. - """ - userIds: [ID!]! -} - -""" -Autogenerated return type of AddEnterpriseOrganizationMember -""" -type AddEnterpriseOrganizationMemberPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The users who were added to the organization. - """ - users: [User!] -} - -""" -Autogenerated input type of AddLabelsToLabelable -""" -input AddLabelsToLabelableInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ids of the labels to add. - """ - labelIds: [ID!]! @possibleTypes(concreteTypes: ["Label"]) - - """ - The id of the labelable object to add labels to. - """ - labelableId: ID! @possibleTypes(concreteTypes: ["Discussion", "Issue", "PullRequest"], abstractType: "Labelable") -} - -""" -Autogenerated return type of AddLabelsToLabelable -""" -type AddLabelsToLabelablePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The item that was labeled. - """ - labelable: Labelable -} - -""" -Autogenerated input type of AddProjectCard -""" -input AddProjectCardInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The content of the card. Must be a member of the ProjectCardItem union - """ - contentId: ID @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "ProjectCardItem") - - """ - The note on the card. - """ - note: String - - """ - The Node ID of the ProjectColumn. - """ - projectColumnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"]) -} - -""" -Autogenerated return type of AddProjectCard -""" -type AddProjectCardPayload { - """ - The edge from the ProjectColumn's card connection. - """ - cardEdge: ProjectCardEdge - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ProjectColumn - """ - projectColumn: ProjectColumn -} - -""" -Autogenerated input type of AddProjectColumn -""" -input AddProjectColumnInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The name of the column. - """ - name: String! - - """ - The Node ID of the project. - """ - projectId: ID! @possibleTypes(concreteTypes: ["Project"]) -} - -""" -Autogenerated return type of AddProjectColumn -""" -type AddProjectColumnPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The edge from the project's column connection. - """ - columnEdge: ProjectColumnEdge - - """ - The project - """ - project: Project -} - -""" -Autogenerated input type of AddProjectV2DraftIssue -""" -input AddProjectV2DraftIssueInput { - """ - The IDs of the assignees of the draft issue. - """ - assigneeIds: [ID!] @possibleTypes(concreteTypes: ["User"]) - - """ - The body of the draft issue. - """ - body: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the Project to add the draft issue to. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) - - """ - The title of the draft issue. A project item can also be created by providing - the URL of an Issue or Pull Request if you have access. - """ - title: String! -} - -""" -Autogenerated return type of AddProjectV2DraftIssue -""" -type AddProjectV2DraftIssuePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The draft issue added to the project. - """ - projectItem: ProjectV2Item -} - -""" -Autogenerated input type of AddProjectV2ItemById -""" -input AddProjectV2ItemByIdInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The id of the Issue or Pull Request to add. - """ - contentId: ID! - @possibleTypes(concreteTypes: ["DraftIssue", "Issue", "PullRequest"], abstractType: "ProjectV2ItemContent") - - """ - The ID of the Project to add the item to. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) -} - -""" -Autogenerated return type of AddProjectV2ItemById -""" -type AddProjectV2ItemByIdPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The item added to the project. - """ - item: ProjectV2Item -} - -""" -Autogenerated input type of AddPullRequestReviewComment -""" -input AddPullRequestReviewCommentInput { - """ - The text of the comment. This field is required - - **Upcoming Change on 2023-10-01 UTC** - **Description:** `body` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead - **Reason:** We are deprecating the addPullRequestReviewComment mutation - """ - body: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The SHA of the commit to comment on. - - **Upcoming Change on 2023-10-01 UTC** - **Description:** `commitOID` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead - **Reason:** We are deprecating the addPullRequestReviewComment mutation - """ - commitOID: GitObjectID - - """ - The comment id to reply to. - - **Upcoming Change on 2023-10-01 UTC** - **Description:** `inReplyTo` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead - **Reason:** We are deprecating the addPullRequestReviewComment mutation - """ - inReplyTo: ID @possibleTypes(concreteTypes: ["PullRequestReviewComment"]) - - """ - The relative path of the file to comment on. - - **Upcoming Change on 2023-10-01 UTC** - **Description:** `path` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead - **Reason:** We are deprecating the addPullRequestReviewComment mutation - """ - path: String - - """ - The line index in the diff to comment on. - - **Upcoming Change on 2023-10-01 UTC** - **Description:** `position` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead - **Reason:** We are deprecating the addPullRequestReviewComment mutation - """ - position: Int - - """ - The node ID of the pull request reviewing - - **Upcoming Change on 2023-10-01 UTC** - **Description:** `pullRequestId` will be removed. use - addPullRequestReviewThread or addPullRequestReviewThreadReply instead - **Reason:** We are deprecating the addPullRequestReviewComment mutation - """ - pullRequestId: ID @possibleTypes(concreteTypes: ["PullRequest"]) - - """ - The Node ID of the review to modify. - - **Upcoming Change on 2023-10-01 UTC** - **Description:** `pullRequestReviewId` will be removed. use - addPullRequestReviewThread or addPullRequestReviewThreadReply instead - **Reason:** We are deprecating the addPullRequestReviewComment mutation - """ - pullRequestReviewId: ID @possibleTypes(concreteTypes: ["PullRequestReview"]) -} - -""" -Autogenerated return type of AddPullRequestReviewComment -""" -type AddPullRequestReviewCommentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The newly created comment. - """ - comment: PullRequestReviewComment - - """ - The edge from the review's comment connection. - """ - commentEdge: PullRequestReviewCommentEdge -} - -""" -Autogenerated input type of AddPullRequestReview -""" -input AddPullRequestReviewInput { - """ - The contents of the review body comment. - """ - body: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The review line comments. - - **Upcoming Change on 2023-10-01 UTC** - **Description:** `comments` will be removed. use the `threads` argument instead - **Reason:** We are deprecating comment fields that use diff-relative positioning - """ - comments: [DraftPullRequestReviewComment] - - """ - The commit OID the review pertains to. - """ - commitOID: GitObjectID - - """ - The event to perform on the pull request review. - """ - event: PullRequestReviewEvent - - """ - The Node ID of the pull request to modify. - """ - pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"]) - - """ - The review line comment threads. - """ - threads: [DraftPullRequestReviewThread] -} - -""" -Autogenerated return type of AddPullRequestReview -""" -type AddPullRequestReviewPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The newly created pull request review. - """ - pullRequestReview: PullRequestReview - - """ - The edge from the pull request's review connection. - """ - reviewEdge: PullRequestReviewEdge -} - -""" -Autogenerated input type of AddPullRequestReviewThread -""" -input AddPullRequestReviewThreadInput { - """ - Body of the thread's first comment. - """ - body: String! - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The line of the blob to which the thread refers, required for line-level - threads. The end of the line range for multi-line comments. - """ - line: Int - - """ - Path to the file being commented on. - """ - path: String! - - """ - The node ID of the pull request reviewing - """ - pullRequestId: ID @possibleTypes(concreteTypes: ["PullRequest"]) - - """ - The Node ID of the review to modify. - """ - pullRequestReviewId: ID @possibleTypes(concreteTypes: ["PullRequestReview"]) - - """ - The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range. - """ - side: DiffSide = RIGHT - - """ - The first line of the range to which the comment refers. - """ - startLine: Int - - """ - The side of the diff on which the start line resides. - """ - startSide: DiffSide = RIGHT - - """ - The level at which the comments in the corresponding thread are targeted, can be a diff line or a file - """ - subjectType: PullRequestReviewThreadSubjectType = LINE -} - -""" -Autogenerated return type of AddPullRequestReviewThread -""" -type AddPullRequestReviewThreadPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The newly created thread. - """ - thread: PullRequestReviewThread -} - -""" -Autogenerated input type of AddPullRequestReviewThreadReply -""" -input AddPullRequestReviewThreadReplyInput { - """ - The text of the reply. - """ - body: String! - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the pending review to which the reply will belong. - """ - pullRequestReviewId: ID @possibleTypes(concreteTypes: ["PullRequestReview"]) - - """ - The Node ID of the thread to which this reply is being written. - """ - pullRequestReviewThreadId: ID! @possibleTypes(concreteTypes: ["PullRequestReviewThread"]) -} - -""" -Autogenerated return type of AddPullRequestReviewThreadReply -""" -type AddPullRequestReviewThreadReplyPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The newly created reply. - """ - comment: PullRequestReviewComment -} - -""" -Autogenerated input type of AddReaction -""" -input AddReactionInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The name of the emoji to react with. - """ - content: ReactionContent! - - """ - The Node ID of the subject to modify. - """ - subjectId: ID! - @possibleTypes( - concreteTypes: [ - "CommitComment" - "Discussion" - "DiscussionComment" - "Issue" - "IssueComment" - "PullRequest" - "PullRequestReview" - "PullRequestReviewComment" - "Release" - "TeamDiscussion" - "TeamDiscussionComment" - ] - abstractType: "Reactable" - ) -} - -""" -Autogenerated return type of AddReaction -""" -type AddReactionPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The reaction object. - """ - reaction: Reaction - - """ - The reaction groups for the subject. - """ - reactionGroups: [ReactionGroup!] - - """ - The reactable subject. - """ - subject: Reactable -} - -""" -Autogenerated input type of AddStar -""" -input AddStarInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Starrable ID to star. - """ - starrableId: ID! @possibleTypes(concreteTypes: ["Gist", "Repository", "Topic"], abstractType: "Starrable") -} - -""" -Autogenerated return type of AddStar -""" -type AddStarPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The starrable. - """ - starrable: Starrable -} - -""" -Autogenerated input type of AddUpvote -""" -input AddUpvoteInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the discussion or comment to upvote. - """ - subjectId: ID! @possibleTypes(concreteTypes: ["Discussion", "DiscussionComment"], abstractType: "Votable") -} - -""" -Autogenerated return type of AddUpvote -""" -type AddUpvotePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The votable subject. - """ - subject: Votable -} - -""" -Autogenerated input type of AddVerifiableDomain -""" -input AddVerifiableDomainInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The URL of the domain - """ - domain: URI! - - """ - The ID of the owner to add the domain to - """ - ownerId: ID! @possibleTypes(concreteTypes: ["Enterprise", "Organization"], abstractType: "VerifiableDomainOwner") -} - -""" -Autogenerated return type of AddVerifiableDomain -""" -type AddVerifiableDomainPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The verifiable domain that was added. - """ - domain: VerifiableDomain -} - -""" -Represents an 'added_to_merge_queue' event on a given pull request. -""" -type AddedToMergeQueueEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The user who added this Pull Request to the merge queue - """ - enqueuer: User - - """ - The Node ID of the AddedToMergeQueueEvent object - """ - id: ID! - - """ - The merge queue where this pull request was added to. - """ - mergeQueue: MergeQueue - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest -} - -""" -Represents a 'added_to_project' event on a given issue or pull request. -""" -type AddedToProjectEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the AddedToProjectEvent object - """ - id: ID! - - """ - Project referenced by event. - """ - project: Project - - """ - Project card referenced by this project event. - """ - projectCard: ProjectCard - - """ - Column name referenced by this project event. - """ - projectColumnName: String! -} - -""" -Represents an announcement banner. -""" -interface AnnouncementBanner { - """ - The text of the announcement - """ - announcement: String - - """ - The date the announcement was created - """ - announcementCreatedAt: DateTime - - """ - The expiration date of the announcement, if any - """ - announcementExpiresAt: DateTime - - """ - Whether the announcement can be dismissed by the user - """ - announcementUserDismissible: Boolean -} - -""" -A GitHub App. -""" -type App implements Node { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The description of the app. - """ - description: String - - """ - The Node ID of the App object - """ - id: ID! - - """ - The IP addresses of the app. - """ - ipAllowListEntries( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for IP allow list entries returned. - """ - orderBy: IpAllowListEntryOrder = {field: ALLOW_LIST_VALUE, direction: ASC} - ): IpAllowListEntryConnection! - - """ - The hex color code, without the leading '#', for the logo background. - """ - logoBackgroundColor: String! - - """ - A URL pointing to the app's logo. - """ - logoUrl( - """ - The size of the resulting image. - """ - size: Int - ): URI! - - """ - The name of the app. - """ - name: String! - - """ - A slug based on the name of the app for use in URLs. - """ - slug: String! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The URL to the app's homepage. - """ - url: URI! -} - -""" -Autogenerated input type of ApproveDeployments -""" -input ApproveDeploymentsInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Optional comment for approving deployments - """ - comment: String = "" - - """ - The ids of environments to reject deployments - """ - environmentIds: [ID!]! - - """ - The node ID of the workflow run containing the pending deployments. - """ - workflowRunId: ID! @possibleTypes(concreteTypes: ["WorkflowRun"]) -} - -""" -Autogenerated return type of ApproveDeployments -""" -type ApproveDeploymentsPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The affected deployments. - """ - deployments: [Deployment!] -} - -""" -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 ArchiveProjectV2Item -""" -input ArchiveProjectV2ItemInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the ProjectV2Item to archive. - """ - itemId: ID! @possibleTypes(concreteTypes: ["ProjectV2Item"]) - - """ - The ID of the Project to archive the item from. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) -} - -""" -Autogenerated return type of ArchiveProjectV2Item -""" -type ArchiveProjectV2ItemPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The item archived from the project. - """ - item: ProjectV2Item -} - -""" -Autogenerated input type of ArchiveRepository -""" -input ArchiveRepositoryInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the repository to mark as archived. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) -} - -""" -Autogenerated return type of ArchiveRepository -""" -type ArchiveRepositoryPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The repository that was marked as archived. - """ - repository: Repository -} - -""" -An object that can have users assigned to it. -""" -interface Assignable { - """ - A list of Users assigned to this object. - """ - assignees( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserConnection! -} - -""" -Represents an 'assigned' event on any assignable object. -""" -type AssignedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the assignable associated with the event. - """ - assignable: Assignable! - - """ - Identifies the user or mannequin that was assigned. - """ - assignee: Assignee - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the AssignedEvent object - """ - id: ID! - - """ - Identifies the user who was assigned. - """ - user: User - @deprecated(reason: "Assignees can now be mannequins. Use the `assignee` field instead. Removal on 2020-01-01 UTC.") -} - -""" -Types that can be assigned to issues. -""" -union Assignee = Bot | Mannequin | Organization | User - -""" -An entry in the audit log. -""" -interface AuditEntry { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Types that can initiate an audit log event. -""" -union AuditEntryActor = Bot | Organization | User - -""" -Ordering options for Audit Log connections. -""" -input AuditLogOrder { - """ - The ordering direction. - """ - direction: OrderDirection - - """ - The field to order Audit Logs by. - """ - field: AuditLogOrderField -} - -""" -Properties by which Audit Log connections can be ordered. -""" -enum AuditLogOrderField { - """ - Order audit log entries by timestamp - """ - CREATED_AT -} - -""" -Represents a 'auto_merge_disabled' event on a given pull request. -""" -type AutoMergeDisabledEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The user who disabled auto-merge for this Pull Request - """ - disabler: User - - """ - The Node ID of the AutoMergeDisabledEvent object - """ - id: ID! - - """ - PullRequest referenced by event - """ - pullRequest: PullRequest - - """ - The reason auto-merge was disabled - """ - reason: String - - """ - The reason_code relating to why auto-merge was disabled - """ - reasonCode: String -} - -""" -Represents a 'auto_merge_enabled' event on a given pull request. -""" -type AutoMergeEnabledEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The user who enabled auto-merge for this Pull Request - """ - enabler: User - - """ - The Node ID of the AutoMergeEnabledEvent object - """ - id: ID! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest -} - -""" -Represents an auto-merge request for a pull request -""" -type AutoMergeRequest { - """ - The email address of the author of this auto-merge request. - """ - authorEmail: String - - """ - The commit message of the auto-merge request. If a merge queue is required by - the base branch, this value will be set by the merge queue when merging. - """ - commitBody: String - - """ - The commit title of the auto-merge request. If a merge queue is required by - the base branch, this value will be set by the merge queue when merging - """ - commitHeadline: String - - """ - When was this auto-merge request was enabled. - """ - enabledAt: DateTime - - """ - The actor who created the auto-merge request. - """ - enabledBy: Actor - - """ - The merge method of the auto-merge request. If a merge queue is required by - the base branch, this value will be set by the merge queue when merging. - """ - mergeMethod: PullRequestMergeMethod! - - """ - The pull request that this auto-merge request is set against. - """ - pullRequest: PullRequest! -} - -""" -Represents a 'auto_rebase_enabled' event on a given pull request. -""" -type AutoRebaseEnabledEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The user who enabled auto-merge (rebase) for this Pull Request - """ - enabler: User - - """ - The Node ID of the AutoRebaseEnabledEvent object - """ - id: ID! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest -} - -""" -Represents a 'auto_squash_enabled' event on a given pull request. -""" -type AutoSquashEnabledEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The user who enabled auto-merge (squash) for this Pull Request - """ - enabler: User - - """ - The Node ID of the AutoSquashEnabledEvent object - """ - id: ID! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest -} - -""" -Represents a 'automatic_base_change_failed' event on a given pull request. -""" -type AutomaticBaseChangeFailedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the AutomaticBaseChangeFailedEvent object - """ - id: ID! - - """ - The new base for this PR - """ - newBase: String! - - """ - The old base for this PR - """ - oldBase: String! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest! -} - -""" -Represents a 'automatic_base_change_succeeded' event on a given pull request. -""" -type AutomaticBaseChangeSucceededEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the AutomaticBaseChangeSucceededEvent object - """ - id: ID! - - """ - The new base for this PR - """ - newBase: String! - - """ - The old base for this PR - """ - oldBase: String! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest! -} - -""" -A (potentially binary) string encoded using base64. -""" -scalar Base64String - -""" -Represents a 'base_ref_changed' event on a given issue or pull request. -""" -type BaseRefChangedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the name of the base ref for the pull request after it was changed. - """ - currentRefName: String! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the BaseRefChangedEvent object - """ - id: ID! - - """ - Identifies the name of the base ref for the pull request before it was changed. - """ - previousRefName: String! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest! -} - -""" -Represents a 'base_ref_deleted' event on a given pull request. -""" -type BaseRefDeletedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the name of the Ref associated with the `base_ref_deleted` event. - """ - baseRefName: String - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the BaseRefDeletedEvent object - """ - id: ID! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest -} - -""" -Represents a 'base_ref_force_pushed' event on a given pull request. -""" -type BaseRefForcePushedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the after commit SHA for the 'base_ref_force_pushed' event. - """ - afterCommit: Commit - - """ - Identifies the before commit SHA for the 'base_ref_force_pushed' event. - """ - beforeCommit: Commit - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the BaseRefForcePushedEvent object - """ - id: ID! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest! - - """ - Identifies the fully qualified ref name for the 'base_ref_force_pushed' event. - """ - ref: Ref -} - -""" -Represents non-fractional signed whole numeric values. Since the value may -exceed the size of a 32-bit integer, it's encoded as a string. -""" -scalar BigInt - -""" -Represents a Git blame. -""" -type Blame { - """ - The list of ranges from a Git blame. - """ - ranges: [BlameRange!]! -} - -""" -Represents a range of information from a Git blame. -""" -type BlameRange { - """ - Identifies the recency of the change, from 1 (new) to 10 (old). This is - calculated as a 2-quantile and determines the length of distance between the - median age of all the changes in the file and the recency of the current - range's change. - """ - age: Int! - - """ - Identifies the line author - """ - commit: Commit! - - """ - The ending line for the range - """ - endingLine: Int! - - """ - The starting line for the range - """ - startingLine: Int! -} - -""" -Represents a Git blob. -""" -type Blob implements GitObject & Node { - """ - An abbreviated version of the Git object ID - """ - abbreviatedOid: String! - - """ - Byte size of Blob object - """ - byteSize: Int! - - """ - The HTTP path for this Git object - """ - commitResourcePath: URI! - - """ - The HTTP URL for this Git object - """ - commitUrl: URI! - - """ - The Node ID of the Blob object - """ - id: ID! - - """ - Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding. - """ - isBinary: Boolean - - """ - Indicates whether the contents is truncated - """ - isTruncated: Boolean! - - """ - The Git object ID - """ - oid: GitObjectID! - - """ - The Repository the Git object belongs to - """ - repository: Repository! - - """ - UTF8 text data or null if the Blob is binary - """ - text: String -} - -""" -A special type of user which takes actions on behalf of GitHub Apps. -""" -type Bot implements Actor & Node & UniformResourceLocatable { - """ - A URL pointing to the GitHub App's public avatar. - """ - avatarUrl( - """ - The size of the resulting square image. - """ - size: Int - ): URI! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the Bot object - """ - id: ID! - - """ - The username of the actor. - """ - login: String! - - """ - The HTTP path for this bot - """ - resourcePath: URI! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this bot - """ - url: URI! -} - -""" -Types which can be actors for `BranchActorAllowance` objects. -""" -union BranchActorAllowanceActor = App | Team | User - -""" -Parameters to be used for the branch_name_pattern rule -""" -type BranchNamePatternParameters { - """ - How this rule will appear to users. - """ - name: String - - """ - If true, the rule will fail if the pattern matches. - """ - negate: Boolean! - - """ - The operator to use for matching. - """ - operator: String! - - """ - The pattern to match with. - """ - pattern: String! -} - -""" -Parameters to be used for the branch_name_pattern rule -""" -input BranchNamePatternParametersInput { - """ - How this rule will appear to users. - """ - name: String - - """ - If true, the rule will fail if the pattern matches. - """ - negate: Boolean - - """ - The operator to use for matching. - """ - operator: String! - - """ - The pattern to match with. - """ - pattern: String! -} - -""" -A branch protection rule. -""" -type BranchProtectionRule implements Node { - """ - Can this branch be deleted. - """ - allowsDeletions: Boolean! - - """ - Are force pushes allowed on this branch. - """ - allowsForcePushes: Boolean! - - """ - Is branch creation a protected operation. - """ - blocksCreations: Boolean! - - """ - A list of conflicts matching branches protection rule and other branch protection rules - """ - branchProtectionRuleConflicts( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): BranchProtectionRuleConflictConnection! - - """ - A list of actors able to force push for this branch protection rule. - """ - bypassForcePushAllowances( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): BypassForcePushAllowanceConnection! - - """ - A list of actors able to bypass PRs for this branch protection rule. - """ - bypassPullRequestAllowances( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): BypassPullRequestAllowanceConnection! - - """ - The actor who created this branch protection rule. - """ - creator: Actor - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - Will new commits pushed to matching branches dismiss pull request review approvals. - """ - dismissesStaleReviews: Boolean! - - """ - The Node ID of the BranchProtectionRule object - """ - id: ID! - - """ - Can admins override branch protection. - """ - isAdminEnforced: Boolean! - - """ - Whether users can pull changes from upstream when the branch is locked. Set to - `true` to allow fork syncing. Set to `false` to prevent fork syncing. - """ - lockAllowsFetchAndMerge: Boolean! - - """ - Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. - """ - lockBranch: Boolean! - - """ - Repository refs that are protected by this rule - """ - matchingRefs( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filters refs with query on name - """ - query: String - ): RefConnection! - - """ - Identifies the protection rule pattern. - """ - pattern: String! - - """ - A list push allowances for this branch protection rule. - """ - pushAllowances( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): PushAllowanceConnection! - - """ - The repository associated with this branch protection rule. - """ - repository: Repository - - """ - Whether the most recent push must be approved by someone other than the person who pushed it - """ - requireLastPushApproval: Boolean! - - """ - Number of approving reviews required to update matching branches. - """ - requiredApprovingReviewCount: Int - - """ - List of required deployment environments that must be deployed successfully to update matching branches - """ - requiredDeploymentEnvironments: [String] - - """ - List of required status check contexts that must pass for commits to be accepted to matching branches. - """ - requiredStatusCheckContexts: [String] - - """ - List of required status checks that must pass for commits to be accepted to matching branches. - """ - requiredStatusChecks: [RequiredStatusCheckDescription!] - - """ - Are approving reviews required to update matching branches. - """ - requiresApprovingReviews: Boolean! - - """ - Are reviews from code owners required to update matching branches. - """ - requiresCodeOwnerReviews: Boolean! - - """ - Are commits required to be signed. - """ - requiresCommitSignatures: Boolean! - - """ - Are conversations required to be resolved before merging. - """ - requiresConversationResolution: Boolean! - - """ - Does this branch require deployment to specific environments before merging - """ - requiresDeployments: Boolean! - - """ - Are merge commits prohibited from being pushed to this branch. - """ - requiresLinearHistory: Boolean! - - """ - Are status checks required to update matching branches. - """ - requiresStatusChecks: Boolean! - - """ - Are branches required to be up to date before merging. - """ - requiresStrictStatusChecks: Boolean! - - """ - Is pushing to matching branches restricted. - """ - restrictsPushes: Boolean! - - """ - Is dismissal of pull request reviews restricted. - """ - restrictsReviewDismissals: Boolean! - - """ - A list review dismissal allowances for this branch protection rule. - """ - reviewDismissalAllowances( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ReviewDismissalAllowanceConnection! -} - -""" -A conflict between two branch protection rules. -""" -type BranchProtectionRuleConflict { - """ - Identifies the branch protection rule. - """ - branchProtectionRule: BranchProtectionRule - - """ - Identifies the conflicting branch protection rule. - """ - conflictingBranchProtectionRule: BranchProtectionRule - - """ - Identifies the branch ref that has conflicting rules - """ - ref: Ref -} - -""" -The connection type for BranchProtectionRuleConflict. -""" -type BranchProtectionRuleConflictConnection { - """ - A list of edges. - """ - edges: [BranchProtectionRuleConflictEdge] - - """ - A list of nodes. - """ - nodes: [BranchProtectionRuleConflict] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type BranchProtectionRuleConflictEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: BranchProtectionRuleConflict -} - -""" -The connection type for BranchProtectionRule. -""" -type BranchProtectionRuleConnection { - """ - A list of edges. - """ - edges: [BranchProtectionRuleEdge] - - """ - A list of nodes. - """ - nodes: [BranchProtectionRule] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type BranchProtectionRuleEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: BranchProtectionRule -} - -""" -Types that can represent a repository ruleset bypass actor. -""" -union BypassActor = App | Team - -""" -A user, team, or app who has the ability to bypass a force push requirement on a protected branch. -""" -type BypassForcePushAllowance implements Node { - """ - The actor that can force push. - """ - actor: BranchActorAllowanceActor - - """ - Identifies the branch protection rule associated with the allowed user, team, or app. - """ - branchProtectionRule: BranchProtectionRule - - """ - The Node ID of the BypassForcePushAllowance object - """ - id: ID! -} - -""" -The connection type for BypassForcePushAllowance. -""" -type BypassForcePushAllowanceConnection { - """ - A list of edges. - """ - edges: [BypassForcePushAllowanceEdge] - - """ - A list of nodes. - """ - nodes: [BypassForcePushAllowance] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type BypassForcePushAllowanceEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: BypassForcePushAllowance -} - -""" -A user, team, or app who has the ability to bypass a pull request requirement on a protected branch. -""" -type BypassPullRequestAllowance implements Node { - """ - The actor that can bypass. - """ - actor: BranchActorAllowanceActor - - """ - Identifies the branch protection rule associated with the allowed user, team, or app. - """ - branchProtectionRule: BranchProtectionRule - - """ - The Node ID of the BypassPullRequestAllowance object - """ - id: ID! -} - -""" -The connection type for BypassPullRequestAllowance. -""" -type BypassPullRequestAllowanceConnection { - """ - A list of edges. - """ - edges: [BypassPullRequestAllowanceEdge] - - """ - A list of nodes. - """ - nodes: [BypassPullRequestAllowance] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type BypassPullRequestAllowanceEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: BypassPullRequestAllowance -} - -""" -The Common Vulnerability Scoring System -""" -type CVSS { - """ - The CVSS score associated with this advisory - """ - score: Float! - - """ - The CVSS vector string associated with this advisory - """ - vectorString: String -} - -""" -A common weakness enumeration -""" -type CWE implements Node { - """ - The id of the CWE - """ - cweId: String! - - """ - A detailed description of this CWE - """ - description: String! - - """ - The Node ID of the CWE object - """ - id: ID! - - """ - The name of this CWE - """ - name: String! -} - -""" -The connection type for CWE. -""" -type CWEConnection { - """ - A list of edges. - """ - edges: [CWEEdge] - - """ - A list of nodes. - """ - nodes: [CWE] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type CWEEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: CWE -} - -""" -Autogenerated input type of ChangeUserStatus -""" -input ChangeUserStatusInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., :grinning:. - """ - emoji: String - - """ - If set, the user status will not be shown after this date. - """ - expiresAt: DateTime - - """ - Whether this status should indicate you are not fully available on GitHub, e.g., you are away. - """ - limitedAvailability: Boolean = false - - """ - A short description of your current status. - """ - message: String - - """ - The ID of the organization whose members will be allowed to see the status. If - omitted, the status will be publicly visible. - """ - organizationId: ID @possibleTypes(concreteTypes: ["Organization"]) -} - -""" -Autogenerated return type of ChangeUserStatus -""" -type ChangeUserStatusPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Your updated status. - """ - status: UserStatus -} - -""" -A single check annotation. -""" -type CheckAnnotation { - """ - The annotation's severity level. - """ - annotationLevel: CheckAnnotationLevel - - """ - The path to the file that this annotation was made on. - """ - blobUrl: URI! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The position of this annotation. - """ - location: CheckAnnotationSpan! - - """ - The annotation's message. - """ - message: String! - - """ - The path that this annotation was made on. - """ - path: String! - - """ - Additional information about the annotation. - """ - rawDetails: String - - """ - The annotation's title - """ - title: String -} - -""" -The connection type for CheckAnnotation. -""" -type CheckAnnotationConnection { - """ - A list of edges. - """ - edges: [CheckAnnotationEdge] - - """ - A list of nodes. - """ - nodes: [CheckAnnotation] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -Information from a check run analysis to specific lines of code. -""" -input CheckAnnotationData { - """ - Represents an annotation's information level - """ - annotationLevel: CheckAnnotationLevel! - - """ - The location of the annotation - """ - location: CheckAnnotationRange! - - """ - A short description of the feedback for these lines of code. - """ - message: String! - - """ - The path of the file to add an annotation to. - """ - path: String! - - """ - Details about this annotation. - """ - rawDetails: String - - """ - The title that represents the annotation. - """ - title: String -} - -""" -An edge in a connection. -""" -type CheckAnnotationEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: CheckAnnotation -} - -""" -Represents an annotation's information level. -""" -enum CheckAnnotationLevel { - """ - An annotation indicating an inescapable error. - """ - FAILURE - - """ - An annotation indicating some information. - """ - NOTICE - - """ - An annotation indicating an ignorable error. - """ - WARNING -} - -""" -A character position in a check annotation. -""" -type CheckAnnotationPosition { - """ - Column number (1 indexed). - """ - column: Int - - """ - Line number (1 indexed). - """ - line: Int! -} - -""" -Information from a check run analysis to specific lines of code. -""" -input CheckAnnotationRange { - """ - The ending column of the range. - """ - endColumn: Int - - """ - The ending line of the range. - """ - endLine: Int! - - """ - The starting column of the range. - """ - startColumn: Int - - """ - The starting line of the range. - """ - startLine: Int! -} - -""" -An inclusive pair of positions for a check annotation. -""" -type CheckAnnotationSpan { - """ - End position (inclusive). - """ - end: CheckAnnotationPosition! - - """ - Start position (inclusive). - """ - start: CheckAnnotationPosition! -} - -""" -The possible states for a check suite or run conclusion. -""" -enum CheckConclusionState { - """ - The check suite or run requires action. - """ - ACTION_REQUIRED - - """ - The check suite or run has been cancelled. - """ - CANCELLED - - """ - The check suite or run has failed. - """ - FAILURE - - """ - The check suite or run was neutral. - """ - NEUTRAL - - """ - The check suite or run was skipped. - """ - SKIPPED - - """ - The check suite or run was marked stale by GitHub. Only GitHub can use this conclusion. - """ - STALE - - """ - The check suite or run has failed at startup. - """ - STARTUP_FAILURE - - """ - The check suite or run has succeeded. - """ - SUCCESS - - """ - The check suite or run has timed out. - """ - TIMED_OUT -} - -""" -A check run. -""" -type CheckRun implements Node & RequirableByPullRequest & UniformResourceLocatable { - """ - The check run's annotations - """ - annotations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): CheckAnnotationConnection - - """ - The check suite that this run is a part of. - """ - checkSuite: CheckSuite! - - """ - Identifies the date and time when the check run was completed. - """ - completedAt: DateTime - - """ - The conclusion of the check run. - """ - conclusion: CheckConclusionState - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The corresponding deployment for this job, if any - """ - deployment: Deployment - - """ - The URL from which to find full details of the check run on the integrator's site. - """ - detailsUrl: URI - - """ - A reference for the check run on the integrator's system. - """ - externalId: String - - """ - The Node ID of the CheckRun object - """ - id: ID! - - """ - Whether this is required to pass before merging for a specific pull request. - """ - isRequired( - """ - The id of the pull request this is required for - """ - pullRequestId: ID - - """ - The number of the pull request this is required for - """ - pullRequestNumber: Int - ): Boolean! - - """ - The name of the check for this check run. - """ - name: String! - - """ - Information about a pending deployment, if any, in this check run - """ - pendingDeploymentRequest: DeploymentRequest - - """ - The permalink to the check run summary. - """ - permalink: URI! - - """ - The repository associated with this check run. - """ - repository: Repository! - - """ - The HTTP path for this check run. - """ - resourcePath: URI! - - """ - Identifies the date and time when the check run was started. - """ - startedAt: DateTime - - """ - The current status of the check run. - """ - status: CheckStatusState! - - """ - The check run's steps - """ - steps( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Step number - """ - number: Int - ): CheckStepConnection - - """ - A string representing the check run's summary - """ - summary: String - - """ - A string representing the check run's text - """ - text: String - - """ - A string representing the check run - """ - title: String - - """ - The HTTP URL for this check run. - """ - url: URI! -} - -""" -Possible further actions the integrator can perform. -""" -input CheckRunAction { - """ - A short explanation of what this action would do. - """ - description: String! - - """ - A reference for the action on the integrator's system. - """ - identifier: String! - - """ - The text to be displayed on a button in the web UI. - """ - label: String! -} - -""" -The connection type for CheckRun. -""" -type CheckRunConnection { - """ - A list of edges. - """ - edges: [CheckRunEdge] - - """ - A list of nodes. - """ - nodes: [CheckRun] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type CheckRunEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: CheckRun -} - -""" -The filters that are available when fetching check runs. -""" -input CheckRunFilter { - """ - Filters the check runs created by this application ID. - """ - appId: Int - - """ - Filters the check runs by this name. - """ - checkName: String - - """ - Filters the check runs by this type. - """ - checkType: CheckRunType - - """ - Filters the check runs by these conclusions. - """ - conclusions: [CheckConclusionState!] - - """ - Filters the check runs by this status. Superceded by statuses. - """ - status: CheckStatusState - - """ - Filters the check runs by this status. Overrides status. - """ - statuses: [CheckStatusState!] -} - -""" -Descriptive details about the check run. -""" -input CheckRunOutput { - """ - The annotations that are made as part of the check run. - """ - annotations: [CheckAnnotationData!] - - """ - Images attached to the check run output displayed in the GitHub pull request UI. - """ - images: [CheckRunOutputImage!] - - """ - The summary of the check run (supports Commonmark). - """ - summary: String! - - """ - The details of the check run (supports Commonmark). - """ - text: String - - """ - A title to provide for this check run. - """ - title: String! -} - -""" -Images attached to the check run output displayed in the GitHub pull request UI. -""" -input CheckRunOutputImage { - """ - The alternative text for the image. - """ - alt: String! - - """ - A short image description. - """ - caption: String - - """ - The full URL of the image. - """ - imageUrl: URI! -} - -""" -The possible states of a check run in a status rollup. -""" -enum CheckRunState { - """ - The check run requires action. - """ - ACTION_REQUIRED - - """ - The check run has been cancelled. - """ - CANCELLED - - """ - The check run has been completed. - """ - COMPLETED - - """ - The check run has failed. - """ - FAILURE - - """ - The check run is in progress. - """ - IN_PROGRESS - - """ - The check run was neutral. - """ - NEUTRAL - - """ - The check run is in pending state. - """ - PENDING - - """ - The check run has been queued. - """ - QUEUED - - """ - The check run was skipped. - """ - SKIPPED - - """ - The check run was marked stale by GitHub. Only GitHub can use this conclusion. - """ - STALE - - """ - The check run has failed at startup. - """ - STARTUP_FAILURE - - """ - The check run has succeeded. - """ - SUCCESS - - """ - The check run has timed out. - """ - TIMED_OUT - - """ - The check run is in waiting state. - """ - WAITING -} - -""" -Represents a count of the state of a check run. -""" -type CheckRunStateCount { - """ - The number of check runs with this state. - """ - count: Int! - - """ - The state of a check run. - """ - state: CheckRunState! -} - -""" -The possible types of check runs. -""" -enum CheckRunType { - """ - Every check run available. - """ - ALL - - """ - The latest check run. - """ - LATEST -} - -""" -The possible states for a check suite or run status. -""" -enum CheckStatusState { - """ - The check suite or run has been completed. - """ - COMPLETED - - """ - The check suite or run is in progress. - """ - IN_PROGRESS - - """ - The check suite or run is in pending state. - """ - PENDING - - """ - The check suite or run has been queued. - """ - QUEUED - - """ - The check suite or run has been requested. - """ - REQUESTED - - """ - The check suite or run is in waiting state. - """ - WAITING -} - -""" -A single check step. -""" -type CheckStep { - """ - Identifies the date and time when the check step was completed. - """ - completedAt: DateTime - - """ - The conclusion of the check step. - """ - conclusion: CheckConclusionState - - """ - A reference for the check step on the integrator's system. - """ - externalId: String - - """ - The step's name. - """ - name: String! - - """ - The index of the step in the list of steps of the parent check run. - """ - number: Int! - - """ - Number of seconds to completion. - """ - secondsToCompletion: Int - - """ - Identifies the date and time when the check step was started. - """ - startedAt: DateTime - - """ - The current status of the check step. - """ - status: CheckStatusState! -} - -""" -The connection type for CheckStep. -""" -type CheckStepConnection { - """ - A list of edges. - """ - edges: [CheckStepEdge] - - """ - A list of nodes. - """ - nodes: [CheckStep] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type CheckStepEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: CheckStep -} - -""" -A check suite. -""" -type CheckSuite implements Node { - """ - The GitHub App which created this check suite. - """ - app: App - - """ - The name of the branch for this check suite. - """ - branch: Ref - - """ - The check runs associated with a check suite. - """ - checkRuns( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Filters the check runs by this type. - """ - filterBy: CheckRunFilter - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): CheckRunConnection - - """ - The commit for this check suite - """ - commit: Commit! - - """ - The conclusion of this check suite. - """ - conclusion: CheckConclusionState - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The user who triggered the check suite. - """ - creator: User - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the CheckSuite object - """ - id: ID! - - """ - A list of open pull requests matching the check suite. - """ - matchingPullRequests( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - The base ref name to filter the pull requests by. - """ - baseRefName: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - The head ref name to filter the pull requests by. - """ - headRefName: String - - """ - A list of label names to filter the pull requests by. - """ - labels: [String!] - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for pull requests returned from the connection. - """ - orderBy: IssueOrder - - """ - A list of states to filter the pull requests by. - """ - states: [PullRequestState!] - ): PullRequestConnection - - """ - The push that triggered this check suite. - """ - push: Push - - """ - The repository associated with this check suite. - """ - repository: Repository! - - """ - The HTTP path for this check suite - """ - resourcePath: URI! - - """ - The status of this check suite. - """ - status: CheckStatusState! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this check suite - """ - url: URI! - - """ - The workflow run associated with this check suite. - """ - workflowRun: WorkflowRun -} - -""" -The auto-trigger preferences that are available for check suites. -""" -input CheckSuiteAutoTriggerPreference { - """ - The node ID of the application that owns the check suite. - """ - appId: ID! - - """ - Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository. - """ - setting: Boolean! -} - -""" -The connection type for CheckSuite. -""" -type CheckSuiteConnection { - """ - A list of edges. - """ - edges: [CheckSuiteEdge] - - """ - A list of nodes. - """ - nodes: [CheckSuite] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type CheckSuiteEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: CheckSuite -} - -""" -The filters that are available when fetching check suites. -""" -input CheckSuiteFilter { - """ - Filters the check suites created by this application ID. - """ - appId: Int - - """ - Filters the check suites by this name. - """ - checkName: String -} - -""" -An object which can have its data claimed or claim data from another. -""" -union Claimable = Mannequin | User - -""" -Autogenerated input type of ClearLabelsFromLabelable -""" -input ClearLabelsFromLabelableInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The id of the labelable object to clear the labels from. - """ - labelableId: ID! @possibleTypes(concreteTypes: ["Discussion", "Issue", "PullRequest"], abstractType: "Labelable") -} - -""" -Autogenerated return type of ClearLabelsFromLabelable -""" -type ClearLabelsFromLabelablePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The item that was unlabeled. - """ - labelable: Labelable -} - -""" -Autogenerated input type of ClearProjectV2ItemFieldValue -""" -input ClearProjectV2ItemFieldValueInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the field to be cleared. - """ - fieldId: ID! - @possibleTypes( - concreteTypes: ["ProjectV2Field", "ProjectV2IterationField", "ProjectV2SingleSelectField"] - abstractType: "ProjectV2FieldConfiguration" - ) - - """ - The ID of the item to be cleared. - """ - itemId: ID! @possibleTypes(concreteTypes: ["ProjectV2Item"]) - - """ - The ID of the Project. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) -} - -""" -Autogenerated return type of ClearProjectV2ItemFieldValue -""" -type ClearProjectV2ItemFieldValuePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated item. - """ - projectV2Item: ProjectV2Item -} - -""" -Autogenerated input type of CloneProject -""" -input CloneProjectInput { - """ - The description of the project. - """ - body: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Whether or not to clone the source project's workflows. - """ - includeWorkflows: Boolean! - - """ - The name of the project. - """ - name: String! - - """ - The visibility of the project, defaults to false (private). - """ - public: Boolean - - """ - The source project to clone. - """ - sourceId: ID! @possibleTypes(concreteTypes: ["Project"]) - - """ - The owner ID to create the project under. - """ - targetOwnerId: ID! @possibleTypes(concreteTypes: ["Organization", "Repository", "User"], abstractType: "ProjectOwner") -} - -""" -Autogenerated return type of CloneProject -""" -type CloneProjectPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The id of the JobStatus for populating cloned fields. - """ - jobStatusId: String - - """ - The new cloned project. - """ - project: Project -} - -""" -Autogenerated input type of CloneTemplateRepository -""" -input CloneTemplateRepositoryInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - A short description of the new repository. - """ - description: String - - """ - Whether to copy all branches from the template to the new repository. Defaults - to copying only the default branch of the template. - """ - includeAllBranches: Boolean = false - - """ - The name of the new repository. - """ - name: String! - - """ - The ID of the owner for the new repository. - """ - ownerId: ID! @possibleTypes(concreteTypes: ["Organization", "User"], abstractType: "RepositoryOwner") - - """ - The Node ID of the template repository. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) - - """ - Indicates the repository's visibility level. - """ - visibility: RepositoryVisibility! -} - -""" -Autogenerated return type of CloneTemplateRepository -""" -type CloneTemplateRepositoryPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new repository. - """ - repository: Repository -} - -""" -An object that can be closed -""" -interface Closable { - """ - Indicates if the object is closed (definition of closed may depend on type) - """ - closed: Boolean! - - """ - Identifies the date and time when the object was closed. - """ - closedAt: DateTime - - """ - Indicates if the object can be closed by the viewer. - """ - viewerCanClose: Boolean! - - """ - Indicates if the object can be reopened by the viewer. - """ - viewerCanReopen: Boolean! -} - -""" -Autogenerated input type of CloseDiscussion -""" -input CloseDiscussionInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - ID of the discussion to be closed. - """ - discussionId: ID! @possibleTypes(concreteTypes: ["Discussion"]) - - """ - The reason why the discussion is being closed. - """ - reason: DiscussionCloseReason = RESOLVED -} - -""" -Autogenerated return type of CloseDiscussion -""" -type CloseDiscussionPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The discussion that was closed. - """ - discussion: Discussion -} - -""" -Autogenerated input type of CloseIssue -""" -input CloseIssueInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - ID of the issue to be closed. - """ - issueId: ID! @possibleTypes(concreteTypes: ["Issue"]) - - """ - The reason the issue is to be closed. - """ - stateReason: IssueClosedStateReason -} - -""" -Autogenerated return type of CloseIssue -""" -type CloseIssuePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The issue that was closed. - """ - issue: Issue -} - -""" -Autogenerated input type of ClosePullRequest -""" -input ClosePullRequestInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - ID of the pull request to be closed. - """ - pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"]) -} - -""" -Autogenerated return type of ClosePullRequest -""" -type ClosePullRequestPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The pull request that was closed. - """ - pullRequest: PullRequest -} - -""" -Represents a 'closed' event on any `Closable`. -""" -type ClosedEvent implements Node & UniformResourceLocatable { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Object that was closed. - """ - closable: Closable! - - """ - Object which triggered the creation of this event. - """ - closer: Closer - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the ClosedEvent object - """ - id: ID! - - """ - The HTTP path for this closed event. - """ - resourcePath: URI! - - """ - The reason the issue state was changed to closed. - """ - stateReason: IssueStateReason - - """ - The HTTP URL for this closed event. - """ - url: URI! -} - -""" -The object which triggered a `ClosedEvent`. -""" -union Closer = Commit | ProjectV2 | PullRequest - -""" -The Code of Conduct for a repository -""" -type CodeOfConduct implements Node { - """ - The body of the Code of Conduct - """ - body: String - - """ - The Node ID of the CodeOfConduct object - """ - id: ID! - - """ - The key for the Code of Conduct - """ - key: String! - - """ - The formal name of the Code of Conduct - """ - name: String! - - """ - The HTTP path for this Code of Conduct - """ - resourcePath: URI - - """ - The HTTP URL for this Code of Conduct - """ - url: URI -} - -""" -Choose which tools must provide code scanning results before the reference is -updated. When configured, code scanning must be enabled and have results for -both the commit and the reference being updated. -""" -type CodeScanningParameters { - """ - Tools that must provide code scanning results for this rule to pass. - """ - codeScanningTools: [CodeScanningTool!]! -} - -""" -Choose which tools must provide code scanning results before the reference is -updated. When configured, code scanning must be enabled and have results for -both the commit and the reference being updated. -""" -input CodeScanningParametersInput { - """ - Tools that must provide code scanning results for this rule to pass. - """ - codeScanningTools: [CodeScanningToolInput!]! -} - -""" -A tool that must provide code scanning results for this rule to pass. -""" -type CodeScanningTool { - """ - The severity level at which code scanning results that raise alerts block a - reference update. For more information on alert severity levels, see "[About code scanning alerts](${externalDocsUrl}/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." - """ - alertsThreshold: String! - - """ - The severity level at which code scanning results that raise security alerts - block a reference update. For more information on security severity levels, - see "[About code scanning alerts](${externalDocsUrl}/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." - """ - securityAlertsThreshold: String! - - """ - The name of a code scanning tool - """ - tool: String! -} - -""" -A tool that must provide code scanning results for this rule to pass. -""" -input CodeScanningToolInput { - """ - The severity level at which code scanning results that raise alerts block a - reference update. For more information on alert severity levels, see "[About code scanning alerts](${externalDocsUrl}/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." - """ - alertsThreshold: String! - - """ - The severity level at which code scanning results that raise security alerts - block a reference update. For more information on security severity levels, - see "[About code scanning alerts](${externalDocsUrl}/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." - """ - securityAlertsThreshold: String! - - """ - The name of a code scanning tool - """ - tool: String! -} - -""" -Collaborators affiliation level with a subject. -""" -enum CollaboratorAffiliation { - """ - All collaborators the authenticated user can see. - """ - ALL - - """ - All collaborators with permissions to an organization-owned subject, regardless of organization membership status. - """ - DIRECT - - """ - All outside collaborators of an organization-owned subject. - """ - OUTSIDE -} - -""" -Represents a comment. -""" -interface Comment { - """ - The actor who authored the comment. - """ - author: Actor - - """ - Author's association with the subject of the comment. - """ - authorAssociation: CommentAuthorAssociation! - - """ - The body as Markdown. - """ - body: String! - - """ - The body rendered to HTML. - """ - bodyHTML: HTML! - - """ - The body rendered to text. - """ - bodyText: String! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Check if this comment was created via an email reply. - """ - createdViaEmail: Boolean! - - """ - The actor who edited the comment. - """ - editor: Actor - - """ - The Node ID of the Comment object - """ - id: ID! - - """ - Check if this comment was edited and includes an edit with the creation data - """ - includesCreatedEdit: Boolean! - - """ - The moment the editor made the last edit - """ - lastEditedAt: DateTime - - """ - Identifies when the comment was published at. - """ - publishedAt: DateTime - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - A list of edits to this content. - """ - userContentEdits( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserContentEditConnection - - """ - Did the viewer author this comment. - """ - viewerDidAuthor: Boolean! -} - -""" -A comment author association with repository. -""" -enum CommentAuthorAssociation { - """ - Author has been invited to collaborate on the repository. - """ - COLLABORATOR - - """ - Author has previously committed to the repository. - """ - CONTRIBUTOR - - """ - Author has not previously committed to GitHub. - """ - FIRST_TIMER - - """ - Author has not previously committed to the repository. - """ - FIRST_TIME_CONTRIBUTOR - - """ - Author is a placeholder for an unclaimed user. - """ - MANNEQUIN - - """ - Author is a member of the organization that owns the repository. - """ - MEMBER - - """ - Author has no association with the repository. - """ - NONE - - """ - Author is the owner of the repository. - """ - OWNER -} - -""" -The possible errors that will prevent a user from updating a comment. -""" -enum CommentCannotUpdateReason { - """ - Unable to create comment because repository is archived. - """ - ARCHIVED - - """ - You cannot update this comment - """ - DENIED - - """ - You must be the author or have write access to this repository to update this comment. - """ - INSUFFICIENT_ACCESS - - """ - Unable to create comment because issue is locked. - """ - LOCKED - - """ - You must be logged in to update this comment. - """ - LOGIN_REQUIRED - - """ - Repository is under maintenance. - """ - MAINTENANCE - - """ - At least one email address must be verified to update this comment. - """ - VERIFIED_EMAIL_REQUIRED -} - -""" -Represents a 'comment_deleted' event on a given issue or pull request. -""" -type CommentDeletedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The user who authored the deleted comment. - """ - deletedCommentAuthor: Actor - - """ - The Node ID of the CommentDeletedEvent object - """ - id: ID! -} - -""" -Represents a Git commit. -""" -type Commit implements GitObject & Node & Subscribable & UniformResourceLocatable { - """ - An abbreviated version of the Git object ID - """ - abbreviatedOid: String! - - """ - The number of additions in this commit. - """ - additions: Int! - - """ - The merged Pull Request that introduced the commit to the repository. If the - commit is not present in the default branch, additionally returns open Pull - Requests associated with the commit - """ - associatedPullRequests( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for pull requests. - """ - orderBy: PullRequestOrder = {field: CREATED_AT, direction: ASC} - ): PullRequestConnection - - """ - Authorship details of the commit. - """ - author: GitActor - - """ - Check if the committer and the author match. - """ - authoredByCommitter: Boolean! - - """ - The datetime when this commit was authored. - """ - authoredDate: DateTime! - - """ - The list of authors for this commit based on the git author and the Co-authored-by - message trailer. The git author will always be first. - """ - authors( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): GitActorConnection! - - """ - Fetches `git blame` information. - """ - blame( - """ - The file whose Git blame information you want. - """ - path: String! - ): Blame! - - """ - We recommend using the `changedFilesIfAvailable` field instead of - `changedFiles`, as `changedFiles` will cause your request to return an error - if GitHub is unable to calculate the number of changed files. - """ - changedFiles: Int! - @deprecated( - reason: "`changedFiles` will be removed. Use `changedFilesIfAvailable` instead. Removal on 2023-01-01 UTC." - ) - - """ - The number of changed files in this commit. If GitHub is unable to calculate - the number of changed files (for example due to a timeout), this will return - `null`. We recommend using this field instead of `changedFiles`. - """ - changedFilesIfAvailable: Int - - """ - The check suites associated with a commit. - """ - checkSuites( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Filters the check suites by this type. - """ - filterBy: CheckSuiteFilter - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): CheckSuiteConnection - - """ - Comments made on the commit. - """ - comments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): CommitCommentConnection! - - """ - The HTTP path for this Git object - """ - commitResourcePath: URI! - - """ - The HTTP URL for this Git object - """ - commitUrl: URI! - - """ - The datetime when this commit was committed. - """ - committedDate: DateTime! - - """ - Check if committed via GitHub web UI. - """ - committedViaWeb: Boolean! - - """ - Committer details of the commit. - """ - committer: GitActor - - """ - The number of deletions in this commit. - """ - deletions: Int! - - """ - The deployments associated with a commit. - """ - deployments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Environments to list deployments for - """ - environments: [String!] - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for deployments returned from the connection. - """ - orderBy: DeploymentOrder = {field: CREATED_AT, direction: ASC} - ): DeploymentConnection - - """ - The tree entry representing the file located at the given path. - """ - file( - """ - The path for the file - """ - path: String! - ): TreeEntry - - """ - The linear commit history starting from (and including) this commit, in the same order as `git log`. - """ - history( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - If non-null, filters history to only show commits with matching authorship. - """ - author: CommitAuthor - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - If non-null, filters history to only show commits touching files under this path. - """ - path: String - - """ - Allows specifying a beginning time or date for fetching commits. - """ - since: GitTimestamp - - """ - Allows specifying an ending time or date for fetching commits. - """ - until: GitTimestamp - ): CommitHistoryConnection! - - """ - The Node ID of the Commit object - """ - id: ID! - - """ - The Git commit message - """ - message: String! - - """ - The Git commit message body - """ - messageBody: String! - - """ - The commit message body rendered to HTML. - """ - messageBodyHTML: HTML! - - """ - The Git commit message headline - """ - messageHeadline: String! - - """ - The commit message headline rendered to HTML. - """ - messageHeadlineHTML: HTML! - - """ - The Git object ID - """ - oid: GitObjectID! - - """ - The organization this commit was made on behalf of. - """ - onBehalfOf: Organization - - """ - The parents of a commit. - """ - parents( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): CommitConnection! - - """ - The datetime when this commit was pushed. - """ - pushedDate: DateTime @deprecated(reason: "`pushedDate` is no longer supported. Removal on 2023-07-01 UTC.") - - """ - The Repository this commit belongs to - """ - repository: Repository! - - """ - The HTTP path for this commit - """ - resourcePath: URI! - - """ - Commit signing information, if present. - """ - signature: GitSignature - - """ - Status information for this commit - """ - status: Status - - """ - Check and Status rollup information for this commit. - """ - statusCheckRollup: StatusCheckRollup - - """ - Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file. - """ - submodules( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): SubmoduleConnection! - - """ - Returns a URL to download a tarball archive for a repository. - Note: For private repositories, these links are temporary and expire after five minutes. - """ - tarballUrl: URI! - - """ - Commit's root Tree - """ - tree: Tree! - - """ - The HTTP path for the tree of this commit - """ - treeResourcePath: URI! - - """ - The HTTP URL for the tree of this commit - """ - treeUrl: URI! - - """ - The HTTP URL for this commit - """ - url: URI! - - """ - Check if the viewer is able to change their subscription status for the repository. - """ - viewerCanSubscribe: Boolean! - - """ - Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. - """ - viewerSubscription: SubscriptionState - - """ - Returns a URL to download a zipball archive for a repository. - Note: For private repositories, these links are temporary and expire after five minutes. - """ - zipballUrl: URI! -} - -""" -Specifies an author for filtering Git commits. -""" -input CommitAuthor { - """ - Email addresses to filter by. Commits authored by any of the specified email addresses will be returned. - """ - emails: [String!] - - """ - ID of a User to filter by. If non-null, only commits authored by this user - will be returned. This field takes precedence over emails. - """ - id: ID -} - -""" -Parameters to be used for the commit_author_email_pattern rule -""" -type CommitAuthorEmailPatternParameters { - """ - How this rule will appear to users. - """ - name: String - - """ - If true, the rule will fail if the pattern matches. - """ - negate: Boolean! - - """ - The operator to use for matching. - """ - operator: String! - - """ - The pattern to match with. - """ - pattern: String! -} - -""" -Parameters to be used for the commit_author_email_pattern rule -""" -input CommitAuthorEmailPatternParametersInput { - """ - How this rule will appear to users. - """ - name: String - - """ - If true, the rule will fail if the pattern matches. - """ - negate: Boolean - - """ - The operator to use for matching. - """ - operator: String! - - """ - The pattern to match with. - """ - pattern: String! -} - -""" -Represents a comment on a given Commit. -""" -type CommitComment implements Comment & Deletable & Minimizable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment { - """ - The actor who authored the comment. - """ - author: Actor - - """ - Author's association with the subject of the comment. - """ - authorAssociation: CommentAuthorAssociation! - - """ - Identifies the comment body. - """ - body: String! - - """ - The body rendered to HTML. - """ - bodyHTML: HTML! - - """ - The body rendered to text. - """ - bodyText: String! - - """ - Identifies the commit associated with the comment, if the commit exists. - """ - commit: Commit - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Check if this comment was created via an email reply. - """ - createdViaEmail: Boolean! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The actor who edited the comment. - """ - editor: Actor - - """ - The Node ID of the CommitComment object - """ - id: ID! - - """ - Check if this comment was edited and includes an edit with the creation data - """ - includesCreatedEdit: Boolean! - - """ - Returns whether or not a comment has been minimized. - """ - isMinimized: Boolean! - - """ - The moment the editor made the last edit - """ - lastEditedAt: DateTime - - """ - Returns why the comment was minimized. One of `abuse`, `off-topic`, - `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and - formatting of these values differs from the inputs to the `MinimizeComment` mutation. - """ - minimizedReason: String - - """ - Identifies the file path associated with the comment. - """ - path: String - - """ - Identifies the line position associated with the comment. - """ - position: Int - - """ - Identifies when the comment was published at. - """ - publishedAt: DateTime - - """ - A list of reactions grouped by content left on the subject. - """ - reactionGroups: [ReactionGroup!] - - """ - A list of Reactions left on the Issue. - """ - reactions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Allows filtering Reactions by emoji. - """ - content: ReactionContent - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Allows specifying the order in which reactions are returned. - """ - orderBy: ReactionOrder - ): ReactionConnection! - - """ - The repository associated with this node. - """ - repository: Repository! - - """ - The HTTP path permalink for this commit comment. - """ - resourcePath: URI! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL permalink for this commit comment. - """ - url: URI! - - """ - A list of edits to this content. - """ - userContentEdits( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserContentEditConnection - - """ - Check if the current viewer can delete this object. - """ - viewerCanDelete: Boolean! - - """ - Check if the current viewer can minimize this object. - """ - viewerCanMinimize: Boolean! - - """ - Can user react to this subject - """ - viewerCanReact: Boolean! - - """ - Check if the current viewer can update this object. - """ - viewerCanUpdate: Boolean! - - """ - Reasons why the current viewer can not update this comment. - """ - viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - - """ - Did the viewer author this comment. - """ - viewerDidAuthor: Boolean! -} - -""" -The connection type for CommitComment. -""" -type CommitCommentConnection { - """ - A list of edges. - """ - edges: [CommitCommentEdge] - - """ - A list of nodes. - """ - nodes: [CommitComment] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type CommitCommentEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: CommitComment -} - -""" -A thread of comments on a commit. -""" -type CommitCommentThread implements Node & RepositoryNode { - """ - The comments that exist in this thread. - """ - comments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): CommitCommentConnection! - - """ - The commit the comments were made on. - """ - commit: Commit - - """ - The Node ID of the CommitCommentThread object - """ - id: ID! - - """ - The file the comments were made on. - """ - path: String - - """ - The position in the diff for the commit that the comment was made on. - """ - position: Int - - """ - The repository associated with this node. - """ - repository: Repository! -} - -""" -The connection type for Commit. -""" -type CommitConnection { - """ - A list of edges. - """ - edges: [CommitEdge] - - """ - A list of nodes. - """ - nodes: [Commit] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -Ordering options for commit contribution connections. -""" -input CommitContributionOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field by which to order commit contributions. - """ - field: CommitContributionOrderField! -} - -""" -Properties by which commit contribution connections can be ordered. -""" -enum CommitContributionOrderField { - """ - Order commit contributions by how many commits they represent. - """ - COMMIT_COUNT - - """ - Order commit contributions by when they were made. - """ - OCCURRED_AT -} - -""" -This aggregates commits made by a user within one repository. -""" -type CommitContributionsByRepository { - """ - The commit contributions, each representing a day. - """ - contributions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for commit contributions returned from the connection. - """ - orderBy: CommitContributionOrder = {field: OCCURRED_AT, direction: DESC} - ): CreatedCommitContributionConnection! - - """ - The repository in which the commits were made. - """ - repository: Repository! - - """ - The HTTP path for the user's commits to the repository in this time range. - """ - resourcePath: URI! - - """ - The HTTP URL for the user's commits to the repository in this time range. - """ - url: URI! -} - -""" -An edge in a connection. -""" -type CommitEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Commit -} - -""" -The connection type for Commit. -""" -type CommitHistoryConnection { - """ - A list of edges. - """ - edges: [CommitEdge] - - """ - A list of nodes. - """ - nodes: [Commit] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -A message to include with a new commit -""" -input CommitMessage { - """ - The body of the message. - """ - body: String - - """ - The headline of the message. - """ - headline: String! -} - -""" -Parameters to be used for the commit_message_pattern rule -""" -type CommitMessagePatternParameters { - """ - How this rule will appear to users. - """ - name: String - - """ - If true, the rule will fail if the pattern matches. - """ - negate: Boolean! - - """ - The operator to use for matching. - """ - operator: String! - - """ - The pattern to match with. - """ - pattern: String! -} - -""" -Parameters to be used for the commit_message_pattern rule -""" -input CommitMessagePatternParametersInput { - """ - How this rule will appear to users. - """ - name: String - - """ - If true, the rule will fail if the pattern matches. - """ - negate: Boolean - - """ - The operator to use for matching. - """ - operator: String! - - """ - The pattern to match with. - """ - pattern: String! -} - -""" -A git ref for a commit to be appended to. - -The ref must be a branch, i.e. its fully qualified name must start -with `refs/heads/` (although the input is not required to be fully -qualified). - -The Ref may be specified by its global node ID or by the -`repositoryNameWithOwner` and `branchName`. - -### Examples - -Specify a branch using a global node ID: - - { "id": "MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=" } - -Specify a branch using `repositoryNameWithOwner` and `branchName`: - - { - "repositoryNameWithOwner": "github/graphql-client", - "branchName": "main" - } -""" -input CommittableBranch { - """ - The unqualified name of the branch to append the commit to. - """ - branchName: String - - """ - The Node ID of the Ref to be updated. - """ - id: ID - - """ - The nameWithOwner of the repository to commit to. - """ - repositoryNameWithOwner: String -} - -""" -Parameters to be used for the committer_email_pattern rule -""" -type CommitterEmailPatternParameters { - """ - How this rule will appear to users. - """ - name: String - - """ - If true, the rule will fail if the pattern matches. - """ - negate: Boolean! - - """ - The operator to use for matching. - """ - operator: String! - - """ - The pattern to match with. - """ - pattern: String! -} - -""" -Parameters to be used for the committer_email_pattern rule -""" -input CommitterEmailPatternParametersInput { - """ - How this rule will appear to users. - """ - name: String - - """ - If true, the rule will fail if the pattern matches. - """ - negate: Boolean - - """ - The operator to use for matching. - """ - operator: String! - - """ - The pattern to match with. - """ - pattern: String! -} - -""" -Represents a comparison between two commit revisions. -""" -type Comparison implements Node { - """ - The number of commits ahead of the base branch. - """ - aheadBy: Int! - - """ - The base revision of this comparison. - """ - baseTarget: GitObject! - - """ - The number of commits behind the base branch. - """ - behindBy: Int! - - """ - The commits which compose this comparison. - """ - commits( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ComparisonCommitConnection! - - """ - The head revision of this comparison. - """ - headTarget: GitObject! - - """ - The Node ID of the Comparison object - """ - id: ID! - - """ - The status of this comparison. - """ - status: ComparisonStatus! -} - -""" -The connection type for Commit. -""" -type ComparisonCommitConnection { - """ - The total count of authors and co-authors across all commits. - """ - authorCount: Int! - - """ - A list of edges. - """ - edges: [CommitEdge] - - """ - A list of nodes. - """ - nodes: [Commit] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -The status of a git comparison between two refs. -""" -enum ComparisonStatus { - """ - The head ref is ahead of the base ref. - """ - AHEAD - - """ - The head ref is behind the base ref. - """ - BEHIND - - """ - The head ref is both ahead and behind of the base ref, indicating git history has diverged. - """ - DIVERGED - - """ - The head ref and base ref are identical. - """ - IDENTICAL -} - -""" -Represents a 'connected' event on a given issue or pull request. -""" -type ConnectedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the ConnectedEvent object - """ - id: ID! - - """ - Reference originated in a different repository. - """ - isCrossRepository: Boolean! - - """ - Issue or pull request that made the reference. - """ - source: ReferencedSubject! - - """ - Issue or pull request which was connected. - """ - subject: ReferencedSubject! -} - -""" -The Contributing Guidelines for a repository. -""" -type ContributingGuidelines { - """ - The body of the Contributing Guidelines. - """ - body: String - - """ - The HTTP path for the Contributing Guidelines. - """ - resourcePath: URI - - """ - The HTTP URL for the Contributing Guidelines. - """ - url: URI -} - -""" -Represents a contribution a user made on GitHub, such as opening an issue. -""" -interface Contribution { - """ - Whether this contribution is associated with a record you do not have access to. For - example, your own 'first issue' contribution may have been made on a repository you can no - longer access. - """ - isRestricted: Boolean! - - """ - When this contribution was made. - """ - occurredAt: DateTime! - - """ - The HTTP path for this contribution. - """ - resourcePath: URI! - - """ - The HTTP URL for this contribution. - """ - url: URI! - - """ - The user who made this contribution. - """ - user: User! -} - -""" -A calendar of contributions made on GitHub by a user. -""" -type ContributionCalendar { - """ - A list of hex color codes used in this calendar. The darker the color, the more contributions it represents. - """ - colors: [String!]! - - """ - Determine if the color set was chosen because it's currently Halloween. - """ - isHalloween: Boolean! - - """ - A list of the months of contributions in this calendar. - """ - months: [ContributionCalendarMonth!]! - - """ - The count of total contributions in the calendar. - """ - totalContributions: Int! - - """ - A list of the weeks of contributions in this calendar. - """ - weeks: [ContributionCalendarWeek!]! -} - -""" -Represents a single day of contributions on GitHub by a user. -""" -type ContributionCalendarDay { - """ - The hex color code that represents how many contributions were made on this day compared to others in the calendar. - """ - color: String! - - """ - How many contributions were made by the user on this day. - """ - contributionCount: Int! - - """ - Indication of contributions, relative to other days. Can be used to indicate - which color to represent this day on a calendar. - """ - contributionLevel: ContributionLevel! - - """ - The day this square represents. - """ - date: Date! - - """ - A number representing which day of the week this square represents, e.g., 1 is Monday. - """ - weekday: Int! -} - -""" -A month of contributions in a user's contribution graph. -""" -type ContributionCalendarMonth { - """ - The date of the first day of this month. - """ - firstDay: Date! - - """ - The name of the month. - """ - name: String! - - """ - How many weeks started in this month. - """ - totalWeeks: Int! - - """ - The year the month occurred in. - """ - year: Int! -} - -""" -A week of contributions in a user's contribution graph. -""" -type ContributionCalendarWeek { - """ - The days of contributions in this week. - """ - contributionDays: [ContributionCalendarDay!]! - - """ - The date of the earliest square in this week. - """ - firstDay: Date! -} - -""" -Varying levels of contributions from none to many. -""" -enum ContributionLevel { - """ - Lowest 25% of days of contributions. - """ - FIRST_QUARTILE - - """ - Highest 25% of days of contributions. More contributions than the third quartile. - """ - FOURTH_QUARTILE - - """ - No contributions occurred. - """ - NONE - - """ - Second lowest 25% of days of contributions. More contributions than the first quartile. - """ - SECOND_QUARTILE - - """ - Second highest 25% of days of contributions. More contributions than second quartile, less than the fourth quartile. - """ - THIRD_QUARTILE -} - -""" -Ordering options for contribution connections. -""" -input ContributionOrder { - """ - The ordering direction. - """ - direction: OrderDirection! -} - -""" -A contributions collection aggregates contributions such as opened issues and commits created by a user. -""" -type ContributionsCollection { - """ - Commit contributions made by the user, grouped by repository. - """ - commitContributionsByRepository( - """ - How many repositories should be included. - """ - maxRepositories: Int = 25 - ): [CommitContributionsByRepository!]! - - """ - A calendar of this user's contributions on GitHub. - """ - contributionCalendar: ContributionCalendar! - - """ - The years the user has been making contributions with the most recent year first. - """ - contributionYears: [Int!]! - - """ - Determine if this collection's time span ends in the current month. - """ - doesEndInCurrentMonth: Boolean! - - """ - The date of the first restricted contribution the user made in this time - period. Can only be non-null when the user has enabled private contribution counts. - """ - earliestRestrictedContributionDate: Date - - """ - The ending date and time of this collection. - """ - endedAt: DateTime! - - """ - The first issue the user opened on GitHub. This will be null if that issue was - opened outside the collection's time range and ignoreTimeRange is false. If - the issue is not visible but the user has opted to show private contributions, - a RestrictedContribution will be returned. - """ - firstIssueContribution: CreatedIssueOrRestrictedContribution - - """ - The first pull request the user opened on GitHub. This will be null if that - pull request was opened outside the collection's time range and - ignoreTimeRange is not true. If the pull request is not visible but the user - has opted to show private contributions, a RestrictedContribution will be returned. - """ - firstPullRequestContribution: CreatedPullRequestOrRestrictedContribution - - """ - The first repository the user created on GitHub. This will be null if that - first repository was created outside the collection's time range and - ignoreTimeRange is false. If the repository is not visible, then a - RestrictedContribution is returned. - """ - firstRepositoryContribution: CreatedRepositoryOrRestrictedContribution - - """ - Does the user have any more activity in the timeline that occurred prior to the collection's time range? - """ - hasActivityInThePast: Boolean! - - """ - Determine if there are any contributions in this collection. - """ - hasAnyContributions: Boolean! - - """ - Determine if the user made any contributions in this time frame whose details - are not visible because they were made in a private repository. Can only be - true if the user enabled private contribution counts. - """ - hasAnyRestrictedContributions: Boolean! - - """ - Whether or not the collector's time span is all within the same day. - """ - isSingleDay: Boolean! - - """ - A list of issues the user opened. - """ - issueContributions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Should the user's first issue ever be excluded from the result. - """ - excludeFirst: Boolean = false - - """ - Should the user's most commented issue be excluded from the result. - """ - excludePopular: Boolean = false - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for contributions returned from the connection. - """ - orderBy: ContributionOrder = {direction: DESC} - ): CreatedIssueContributionConnection! - - """ - Issue contributions made by the user, grouped by repository. - """ - issueContributionsByRepository( - """ - Should the user's first issue ever be excluded from the result. - """ - excludeFirst: Boolean = false - - """ - Should the user's most commented issue be excluded from the result. - """ - excludePopular: Boolean = false - - """ - How many repositories should be included. - """ - maxRepositories: Int = 25 - ): [IssueContributionsByRepository!]! - - """ - When the user signed up for GitHub. This will be null if that sign up date - falls outside the collection's time range and ignoreTimeRange is false. - """ - joinedGitHubContribution: JoinedGitHubContribution - - """ - The date of the most recent restricted contribution the user made in this time - period. Can only be non-null when the user has enabled private contribution counts. - """ - latestRestrictedContributionDate: Date - - """ - When this collection's time range does not include any activity from the user, use this - to get a different collection from an earlier time range that does have activity. - """ - mostRecentCollectionWithActivity: ContributionsCollection - - """ - Returns a different contributions collection from an earlier time range than this one - that does not have any contributions. - """ - mostRecentCollectionWithoutActivity: ContributionsCollection - - """ - The issue the user opened on GitHub that received the most comments in the specified - time frame. - """ - popularIssueContribution: CreatedIssueContribution - - """ - The pull request the user opened on GitHub that received the most comments in the - specified time frame. - """ - popularPullRequestContribution: CreatedPullRequestContribution - - """ - Pull request contributions made by the user. - """ - pullRequestContributions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Should the user's first pull request ever be excluded from the result. - """ - excludeFirst: Boolean = false - - """ - Should the user's most commented pull request be excluded from the result. - """ - excludePopular: Boolean = false - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for contributions returned from the connection. - """ - orderBy: ContributionOrder = {direction: DESC} - ): CreatedPullRequestContributionConnection! - - """ - Pull request contributions made by the user, grouped by repository. - """ - pullRequestContributionsByRepository( - """ - Should the user's first pull request ever be excluded from the result. - """ - excludeFirst: Boolean = false - - """ - Should the user's most commented pull request be excluded from the result. - """ - excludePopular: Boolean = false - - """ - How many repositories should be included. - """ - maxRepositories: Int = 25 - ): [PullRequestContributionsByRepository!]! - - """ - Pull request review contributions made by the user. Returns the most recently - submitted review for each PR reviewed by the user. - """ - pullRequestReviewContributions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for contributions returned from the connection. - """ - orderBy: ContributionOrder = {direction: DESC} - ): CreatedPullRequestReviewContributionConnection! - - """ - Pull request review contributions made by the user, grouped by repository. - """ - pullRequestReviewContributionsByRepository( - """ - How many repositories should be included. - """ - maxRepositories: Int = 25 - ): [PullRequestReviewContributionsByRepository!]! - - """ - A list of repositories owned by the user that the user created in this time range. - """ - repositoryContributions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Should the user's first repository ever be excluded from the result. - """ - excludeFirst: Boolean = false - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for contributions returned from the connection. - """ - orderBy: ContributionOrder = {direction: DESC} - ): CreatedRepositoryContributionConnection! - - """ - A count of contributions made by the user that the viewer cannot access. Only - non-zero when the user has chosen to share their private contribution counts. - """ - restrictedContributionsCount: Int! - - """ - The beginning date and time of this collection. - """ - startedAt: DateTime! - - """ - How many commits were made by the user in this time span. - """ - totalCommitContributions: Int! - - """ - How many issues the user opened. - """ - totalIssueContributions( - """ - Should the user's first issue ever be excluded from this count. - """ - excludeFirst: Boolean = false - - """ - Should the user's most commented issue be excluded from this count. - """ - excludePopular: Boolean = false - ): Int! - - """ - How many pull requests the user opened. - """ - totalPullRequestContributions( - """ - Should the user's first pull request ever be excluded from this count. - """ - excludeFirst: Boolean = false - - """ - Should the user's most commented pull request be excluded from this count. - """ - excludePopular: Boolean = false - ): Int! - - """ - How many pull request reviews the user left. - """ - totalPullRequestReviewContributions: Int! - - """ - How many different repositories the user committed to. - """ - totalRepositoriesWithContributedCommits: Int! - - """ - How many different repositories the user opened issues in. - """ - totalRepositoriesWithContributedIssues( - """ - Should the user's first issue ever be excluded from this count. - """ - excludeFirst: Boolean = false - - """ - Should the user's most commented issue be excluded from this count. - """ - excludePopular: Boolean = false - ): Int! - - """ - How many different repositories the user left pull request reviews in. - """ - totalRepositoriesWithContributedPullRequestReviews: Int! - - """ - How many different repositories the user opened pull requests in. - """ - totalRepositoriesWithContributedPullRequests( - """ - Should the user's first pull request ever be excluded from this count. - """ - excludeFirst: Boolean = false - - """ - Should the user's most commented pull request be excluded from this count. - """ - excludePopular: Boolean = false - ): Int! - - """ - How many repositories the user created. - """ - totalRepositoryContributions( - """ - Should the user's first repository ever be excluded from this count. - """ - excludeFirst: Boolean = false - ): Int! - - """ - The user who made the contributions in this collection. - """ - user: User! -} - -""" -Autogenerated input type of ConvertProjectCardNoteToIssue -""" -input ConvertProjectCardNoteToIssueInput { - """ - The body of the newly created issue. - """ - body: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ProjectCard ID to convert. - """ - projectCardId: ID! @possibleTypes(concreteTypes: ["ProjectCard"]) - - """ - The ID of the repository to create the issue in. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) - - """ - The title of the newly created issue. Defaults to the card's note text. - """ - title: String -} - -""" -Autogenerated return type of ConvertProjectCardNoteToIssue -""" -type ConvertProjectCardNoteToIssuePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated ProjectCard. - """ - projectCard: ProjectCard -} - -""" -Autogenerated input type of ConvertPullRequestToDraft -""" -input ConvertPullRequestToDraftInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - ID of the pull request to convert to draft - """ - pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"]) -} - -""" -Autogenerated return type of ConvertPullRequestToDraft -""" -type ConvertPullRequestToDraftPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The pull request that is now a draft. - """ - pullRequest: PullRequest -} - -""" -Represents a 'convert_to_draft' event on a given pull request. -""" -type ConvertToDraftEvent implements Node & UniformResourceLocatable { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the ConvertToDraftEvent object - """ - id: ID! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest! - - """ - The HTTP path for this convert to draft event. - """ - resourcePath: URI! - - """ - The HTTP URL for this convert to draft event. - """ - url: URI! -} - -""" -Represents a 'converted_note_to_issue' event on a given issue or pull request. -""" -type ConvertedNoteToIssueEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the ConvertedNoteToIssueEvent object - """ - id: ID! - - """ - Project referenced by event. - """ - project: Project - - """ - Project card referenced by this project event. - """ - projectCard: ProjectCard - - """ - Column name referenced by this project event. - """ - projectColumnName: String! -} - -""" -Represents a 'converted_to_discussion' event on a given issue. -""" -type ConvertedToDiscussionEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The discussion that the issue was converted into. - """ - discussion: Discussion - - """ - The Node ID of the ConvertedToDiscussionEvent object - """ - id: ID! -} - -""" -Copilot endpoint information -""" -type CopilotEndpoints { - """ - Copilot API endpoint - """ - api: String! - - """ - Copilot origin tracker endpoint - """ - originTracker: String! - - """ - Copilot proxy endpoint - """ - proxy: String! - - """ - Copilot telemetry endpoint - """ - telemetry: String! -} - -""" -Autogenerated input type of CopyProjectV2 -""" -input CopyProjectV2Input { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Include draft issues in the new project - """ - includeDraftIssues: Boolean = false - - """ - The owner ID of the new project. - """ - ownerId: ID! @possibleTypes(concreteTypes: ["Organization", "User"], abstractType: "OrganizationOrUser") - - """ - The ID of the source Project to copy. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) - - """ - The title of the project. - """ - title: String! -} - -""" -Autogenerated return type of CopyProjectV2 -""" -type CopyProjectV2Payload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The copied project. - """ - projectV2: ProjectV2 -} - -""" -Autogenerated input type of CreateAttributionInvitation -""" -input CreateAttributionInvitationInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the owner scoping the reattributable data. - """ - ownerId: ID! - @possibleTypes(concreteTypes: ["Bot", "Enterprise", "Mannequin", "Organization", "User"], abstractType: "Account") - - """ - The Node ID of the account owning the data to reattribute. - """ - sourceId: ID! - @possibleTypes(concreteTypes: ["Bot", "Enterprise", "Mannequin", "Organization", "User"], abstractType: "Account") - - """ - The Node ID of the account which may claim the data. - """ - targetId: ID! - @possibleTypes(concreteTypes: ["Bot", "Enterprise", "Mannequin", "Organization", "User"], abstractType: "Account") -} - -""" -Autogenerated return type of CreateAttributionInvitation -""" -type CreateAttributionInvitationPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The owner scoping the reattributable data. - """ - owner: Organization - - """ - The account owning the data to reattribute. - """ - source: Claimable - - """ - The account which may claim the data. - """ - target: Claimable -} - -""" -Autogenerated input type of CreateBranchProtectionRule -""" -input CreateBranchProtectionRuleInput { - """ - Can this branch be deleted. - """ - allowsDeletions: Boolean - - """ - Are force pushes allowed on this branch. - """ - allowsForcePushes: Boolean - - """ - Is branch creation a protected operation. - """ - blocksCreations: Boolean - - """ - A list of User, Team, or App IDs allowed to bypass force push targeting matching branches. - """ - bypassForcePushActorIds: [ID!] - - """ - A list of User, Team, or App IDs allowed to bypass pull requests targeting matching branches. - """ - bypassPullRequestActorIds: [ID!] - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Will new commits pushed to matching branches dismiss pull request review approvals. - """ - dismissesStaleReviews: Boolean - - """ - Can admins override branch protection. - """ - isAdminEnforced: Boolean - - """ - Whether users can pull changes from upstream when the branch is locked. Set to - `true` to allow fork syncing. Set to `false` to prevent fork syncing. - """ - lockAllowsFetchAndMerge: Boolean - - """ - Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. - """ - lockBranch: Boolean - - """ - The glob-like pattern used to determine matching branches. - """ - pattern: String! - - """ - A list of User, Team, or App IDs allowed to push to matching branches. - """ - pushActorIds: [ID!] - - """ - The global relay id of the repository in which a new branch protection rule should be created in. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) - - """ - Whether the most recent push must be approved by someone other than the person who pushed it - """ - requireLastPushApproval: Boolean - - """ - Number of approving reviews required to update matching branches. - """ - requiredApprovingReviewCount: Int - - """ - The list of required deployment environments - """ - requiredDeploymentEnvironments: [String!] - - """ - List of required status check contexts that must pass for commits to be accepted to matching branches. - """ - requiredStatusCheckContexts: [String!] - - """ - The list of required status checks - """ - requiredStatusChecks: [RequiredStatusCheckInput!] - - """ - Are approving reviews required to update matching branches. - """ - requiresApprovingReviews: Boolean - - """ - Are reviews from code owners required to update matching branches. - """ - requiresCodeOwnerReviews: Boolean - - """ - Are commits required to be signed. - """ - requiresCommitSignatures: Boolean - - """ - Are conversations required to be resolved before merging. - """ - requiresConversationResolution: Boolean - - """ - Are successful deployments required before merging. - """ - requiresDeployments: Boolean - - """ - Are merge commits prohibited from being pushed to this branch. - """ - requiresLinearHistory: Boolean - - """ - Are status checks required to update matching branches. - """ - requiresStatusChecks: Boolean - - """ - Are branches required to be up to date before merging. - """ - requiresStrictStatusChecks: Boolean - - """ - Is pushing to matching branches restricted. - """ - restrictsPushes: Boolean - - """ - Is dismissal of pull request reviews restricted. - """ - restrictsReviewDismissals: Boolean - - """ - A list of User, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches. - """ - reviewDismissalActorIds: [ID!] -} - -""" -Autogenerated return type of CreateBranchProtectionRule -""" -type CreateBranchProtectionRulePayload { - """ - The newly created BranchProtectionRule. - """ - branchProtectionRule: BranchProtectionRule - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of CreateCheckRun -""" -input CreateCheckRunInput { - """ - Possible further actions the integrator can perform, which a user may trigger. - """ - actions: [CheckRunAction!] - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The time that the check run finished. - """ - completedAt: DateTime - - """ - The final conclusion of the check. - """ - conclusion: CheckConclusionState - - """ - The URL of the integrator's site that has the full details of the check. - """ - detailsUrl: URI - - """ - A reference for the run on the integrator's system. - """ - externalId: String - - """ - The SHA of the head commit. - """ - headSha: GitObjectID! - - """ - The name of the check. - """ - name: String! - - """ - Descriptive details about the run. - """ - output: CheckRunOutput - - """ - The node ID of the repository. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) - - """ - The time that the check run began. - """ - startedAt: DateTime - - """ - The current status. - """ - status: RequestableCheckStatusState -} - -""" -Autogenerated return type of CreateCheckRun -""" -type CreateCheckRunPayload { - """ - The newly created check run. - """ - checkRun: CheckRun - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of CreateCheckSuite -""" -input CreateCheckSuiteInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The SHA of the head commit. - """ - headSha: GitObjectID! - - """ - The Node ID of the repository. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) -} - -""" -Autogenerated return type of CreateCheckSuite -""" -type CreateCheckSuitePayload { - """ - The newly created check suite. - """ - checkSuite: CheckSuite - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of CreateCommitOnBranch -""" -input CreateCommitOnBranchInput { - """ - The Ref to be updated. Must be a branch. - """ - branch: CommittableBranch! - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The git commit oid expected at the head of the branch prior to the commit - """ - expectedHeadOid: GitObjectID! - - """ - A description of changes to files in this commit. - """ - fileChanges: FileChanges - - """ - The commit message the be included with the commit. - """ - message: CommitMessage! -} - -""" -Autogenerated return type of CreateCommitOnBranch -""" -type CreateCommitOnBranchPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new commit. - """ - commit: Commit - - """ - The ref which has been updated to point to the new commit. - """ - ref: Ref -} - -""" -Autogenerated input type of CreateDeployment -""" -input CreateDeploymentInput { - """ - Attempt to automatically merge the default branch into the requested ref, defaults to true. - """ - autoMerge: Boolean = true - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Short description of the deployment. - """ - description: String = "" - - """ - Name for the target deployment environment. - """ - environment: String = "production" - - """ - JSON payload with extra information about the deployment. - """ - payload: String = "{}" - - """ - The node ID of the ref to be deployed. - """ - refId: ID! @possibleTypes(concreteTypes: ["Ref"]) - - """ - The node ID of the repository. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) - - """ - The status contexts to verify against commit status checks. To bypass required - contexts, pass an empty array. Defaults to all unique contexts. - """ - requiredContexts: [String!] - - """ - Specifies a task to execute. - """ - task: String = "deploy" -} - -""" -Autogenerated return type of CreateDeployment -""" -type CreateDeploymentPayload { - """ - True if the default branch has been auto-merged into the deployment ref. - """ - autoMerged: Boolean - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new deployment. - """ - deployment: Deployment -} - -""" -Autogenerated input type of CreateDeploymentStatus -""" -input CreateDeploymentStatusInput { - """ - Adds a new inactive status to all non-transient, non-production environment - deployments with the same repository and environment name as the created - status's deployment. - """ - autoInactive: Boolean = true - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The node ID of the deployment. - """ - deploymentId: ID! @possibleTypes(concreteTypes: ["Deployment"]) - - """ - A short description of the status. Maximum length of 140 characters. - """ - description: String = "" - - """ - If provided, updates the environment of the deploy. Otherwise, does not modify the environment. - """ - environment: String - - """ - Sets the URL for accessing your environment. - """ - environmentUrl: String = "" - - """ - The log URL to associate with this status. This URL should contain - output to keep the user updated while the task is running or serve as - historical information for what happened in the deployment. - """ - logUrl: String = "" - - """ - The state of the deployment. - """ - state: DeploymentStatusState! -} - -""" -Autogenerated return type of CreateDeploymentStatus -""" -type CreateDeploymentStatusPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new deployment status. - """ - deploymentStatus: DeploymentStatus -} - -""" -Autogenerated input type of CreateDiscussion -""" -input CreateDiscussionInput { - """ - The body of the discussion. - """ - body: String! - - """ - The id of the discussion category to associate with this discussion. - """ - categoryId: ID! @possibleTypes(concreteTypes: ["DiscussionCategory"]) - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The id of the repository on which to create the discussion. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) - - """ - The title of the discussion. - """ - title: String! -} - -""" -Autogenerated return type of CreateDiscussion -""" -type CreateDiscussionPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The discussion that was just created. - """ - discussion: Discussion -} - -""" -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 CreateEnvironment -""" -input CreateEnvironmentInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The name of the environment. - """ - name: String! - - """ - The node ID of the repository. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) -} - -""" -Autogenerated return type of CreateEnvironment -""" -type CreateEnvironmentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new or existing environment. - """ - environment: Environment -} - -""" -Autogenerated input type of CreateIpAllowListEntry -""" -input CreateIpAllowListEntryInput { - """ - An IP address or range of addresses in CIDR notation. - """ - allowListValue: String! - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Whether the IP allow list entry is active when an IP allow list is enabled. - """ - isActive: Boolean! - - """ - An optional name for the IP allow list entry. - """ - name: String - - """ - The ID of the owner for which to create the new IP allow list entry. - """ - ownerId: ID! @possibleTypes(concreteTypes: ["App", "Enterprise", "Organization"], abstractType: "IpAllowListOwner") -} - -""" -Autogenerated return type of CreateIpAllowListEntry -""" -type CreateIpAllowListEntryPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The IP allow list entry that was created. - """ - ipAllowListEntry: IpAllowListEntry -} - -""" -Autogenerated input type of CreateIssue -""" -input CreateIssueInput { - """ - The Node ID for the user assignee for this issue. - """ - assigneeIds: [ID!] @possibleTypes(concreteTypes: ["User"]) - - """ - The body for the issue description. - """ - body: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The name of an issue template in the repository, assigns labels and assignees from the template to the issue - """ - issueTemplate: String - - """ - An array of Node IDs of labels for this issue. - """ - labelIds: [ID!] @possibleTypes(concreteTypes: ["Label"]) - - """ - The Node ID of the milestone for this issue. - """ - milestoneId: ID @possibleTypes(concreteTypes: ["Milestone"]) - - """ - An array of Node IDs for projects associated with this issue. - """ - projectIds: [ID!] @possibleTypes(concreteTypes: ["Project"]) - - """ - The Node ID of the repository. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) - - """ - The title for the issue. - """ - title: String! -} - -""" -Autogenerated return type of CreateIssue -""" -type CreateIssuePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new issue. - """ - issue: Issue -} - -""" -Autogenerated input type of CreateLabel -""" -input CreateLabelInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - A 6 character hex code, without the leading #, identifying the color of the label. - """ - color: String! - - """ - A brief description of the label, such as its purpose. - """ - description: String - - """ - The name of the label. - """ - name: String! - - """ - The Node ID of the repository. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) -} - -""" -Autogenerated return type of CreateLabel -""" -type CreateLabelPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new label. - """ - label: Label -} - -""" -Autogenerated input type of CreateLinkedBranch -""" -input CreateLinkedBranchInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - ID of the issue to link to. - """ - issueId: ID! @possibleTypes(concreteTypes: ["Issue"]) - - """ - The name of the new branch. Defaults to issue number and title. - """ - name: String - - """ - The commit SHA to base the new branch on. - """ - oid: GitObjectID! - - """ - ID of the repository to create the branch in. Defaults to the issue repository. - """ - repositoryId: ID @possibleTypes(concreteTypes: ["Repository"]) -} - -""" -Autogenerated return type of CreateLinkedBranch -""" -type CreateLinkedBranchPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The issue that was linked to. - """ - issue: Issue - - """ - The new branch issue reference. - """ - linkedBranch: LinkedBranch -} - -""" -Autogenerated input type of CreateMigrationSource -""" -input CreateMigrationSourceInput { - """ - The migration source access token. - """ - accessToken: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The GitHub personal access token of the user importing to the target repository. - """ - githubPat: String - - """ - The migration source name. - """ - name: String! - - """ - The ID of the organization that will own the migration source. - """ - ownerId: ID! @possibleTypes(concreteTypes: ["Organization"]) - - """ - The migration source type. - """ - type: MigrationSourceType! - - """ - The migration source URL, for example `https://github.com` or `https://monalisa.ghe.com`. - """ - url: String -} - -""" -Autogenerated return type of CreateMigrationSource -""" -type CreateMigrationSourcePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The created migration source. - """ - migrationSource: MigrationSource -} - -""" -Autogenerated input type of CreateProject -""" -input CreateProjectInput { - """ - The description of project. - """ - body: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The name of project. - """ - name: String! - - """ - The owner ID to create the project under. - """ - ownerId: ID! @possibleTypes(concreteTypes: ["Organization", "Repository", "User"], abstractType: "ProjectOwner") - - """ - A list of repository IDs to create as linked repositories for the project - """ - repositoryIds: [ID!] @possibleTypes(concreteTypes: ["Repository"]) - - """ - The name of the GitHub-provided template. - """ - template: ProjectTemplate -} - -""" -Autogenerated return type of CreateProject -""" -type CreateProjectPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new project. - """ - project: Project -} - -""" -Autogenerated input type of CreateProjectV2Field -""" -input CreateProjectV2FieldInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The data type of the field. - """ - dataType: ProjectV2CustomFieldType! - - """ - The name of the field. - """ - name: String! - - """ - The ID of the Project to create the field in. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) - - """ - Options for a single select field. At least one value is required if data_type is SINGLE_SELECT - """ - singleSelectOptions: [ProjectV2SingleSelectFieldOptionInput!] -} - -""" -Autogenerated return type of CreateProjectV2Field -""" -type CreateProjectV2FieldPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new field. - """ - projectV2Field: ProjectV2FieldConfiguration -} - -""" -Autogenerated input type of CreateProjectV2 -""" -input CreateProjectV2Input { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The owner ID to create the project under. - """ - ownerId: ID! @possibleTypes(concreteTypes: ["Organization", "User"], abstractType: "OrganizationOrUser") - - """ - The repository to link the project to. - """ - repositoryId: ID @possibleTypes(concreteTypes: ["Repository"]) - - """ - The team to link the project to. The team will be granted read permissions. - """ - teamId: ID @possibleTypes(concreteTypes: ["Team"]) - - """ - The title of the project. - """ - title: String! -} - -""" -Autogenerated return type of CreateProjectV2 -""" -type CreateProjectV2Payload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new project. - """ - projectV2: ProjectV2 -} - -""" -Autogenerated input type of CreatePullRequest -""" -input CreatePullRequestInput { - """ - The name of the branch you want your changes pulled into. This should be an existing branch - on the current repository. You cannot update the base branch on a pull request to point - to another repository. - """ - baseRefName: String! - - """ - The contents of the pull request. - """ - body: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Indicates whether this pull request should be a draft. - """ - draft: Boolean = false - - """ - The name of the branch where your changes are implemented. For cross-repository pull requests - in the same network, namespace `head_ref_name` with a user like this: `username:branch`. - """ - headRefName: String! - - """ - The Node ID of the head repository. - """ - headRepositoryId: ID @possibleTypes(concreteTypes: ["Repository"]) - - """ - Indicates whether maintainers can modify the pull request. - """ - maintainerCanModify: Boolean = true - - """ - The Node ID of the repository. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) - - """ - The title of the pull request. - """ - title: String! -} - -""" -Autogenerated return type of CreatePullRequest -""" -type CreatePullRequestPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new pull request. - """ - pullRequest: PullRequest -} - -""" -Autogenerated input type of CreateRef -""" -input CreateRefInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The fully qualified name of the new Ref (ie: `refs/heads/my_new_branch`). - """ - name: String! - - """ - The GitObjectID that the new Ref shall target. Must point to a commit. - """ - oid: GitObjectID! - - """ - The Node ID of the Repository to create the Ref in. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) -} - -""" -Autogenerated return type of CreateRef -""" -type CreateRefPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The newly created ref. - """ - ref: Ref -} - -""" -Autogenerated input type of CreateRepository -""" -input CreateRepositoryInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - A short description of the new repository. - """ - description: String - - """ - Indicates if the repository should have the issues feature enabled. - """ - hasIssuesEnabled: Boolean = true - - """ - Indicates if the repository should have the wiki feature enabled. - """ - hasWikiEnabled: Boolean = false - - """ - The URL for a web page about this repository. - """ - homepageUrl: URI - - """ - The name of the new repository. - """ - name: String! - - """ - The ID of the owner for the new repository. - """ - ownerId: ID @possibleTypes(concreteTypes: ["Organization", "User"], abstractType: "RepositoryOwner") - - """ - When an organization is specified as the owner, this ID identifies the team - that should be granted access to the new repository. - """ - teamId: ID @possibleTypes(concreteTypes: ["Team"]) - - """ - Whether this repository should be marked as a template such that anyone who - can access it can create new repositories with the same files and directory structure. - """ - template: Boolean = false - - """ - Indicates the repository's visibility level. - """ - visibility: RepositoryVisibility! -} - -""" -Autogenerated return type of CreateRepository -""" -type CreateRepositoryPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new repository. - """ - repository: Repository -} - -""" -Autogenerated input type of CreateRepositoryRuleset -""" -input CreateRepositoryRulesetInput { - """ - A list of actors that are allowed to bypass rules in this ruleset. - """ - bypassActors: [RepositoryRulesetBypassActorInput!] - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The set of conditions for this ruleset - """ - conditions: RepositoryRuleConditionsInput! - - """ - The enforcement level for this ruleset - """ - enforcement: RuleEnforcement! - - """ - The name of the ruleset. - """ - name: String! - - """ - The list of rules for this ruleset - """ - rules: [RepositoryRuleInput!] - - """ - The global relay id of the source in which a new ruleset should be created in. - """ - sourceId: ID! @possibleTypes(concreteTypes: ["Organization", "Repository"], abstractType: "RuleSource") - - """ - The target of the ruleset. - """ - target: RepositoryRulesetTarget -} - -""" -Autogenerated return type of CreateRepositoryRuleset -""" -type CreateRepositoryRulesetPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The newly created Ruleset. - """ - ruleset: RepositoryRuleset -} - -""" -Autogenerated input type of CreateTeamDiscussionComment -""" -input CreateTeamDiscussionCommentInput { - """ - The content of the comment. This field is required. - - **Upcoming Change on 2024-07-01 UTC** - **Description:** `body` will be removed. Follow the guide at - https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to - find a suitable replacement. - **Reason:** The Team Discussions feature is deprecated in favor of Organization Discussions. - """ - body: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the discussion to which the comment belongs. This field is required. - - **Upcoming Change on 2024-07-01 UTC** - **Description:** `discussionId` will be removed. Follow the guide at - https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to - find a suitable replacement. - **Reason:** The Team Discussions feature is deprecated in favor of Organization Discussions. - """ - discussionId: ID @possibleTypes(concreteTypes: ["TeamDiscussion"]) -} - -""" -Autogenerated return type of CreateTeamDiscussionComment -""" -type CreateTeamDiscussionCommentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new comment. - """ - teamDiscussionComment: TeamDiscussionComment - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) -} - -""" -Autogenerated input type of CreateTeamDiscussion -""" -input CreateTeamDiscussionInput { - """ - The content of the discussion. This field is required. - - **Upcoming Change on 2024-07-01 UTC** - **Description:** `body` will be removed. Follow the guide at - https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to - find a suitable replacement. - **Reason:** The Team Discussions feature is deprecated in favor of Organization Discussions. - """ - body: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - If true, restricts the visibility of this discussion to team members and - organization owners. If false or not specified, allows any organization member - to view this discussion. - - **Upcoming Change on 2024-07-01 UTC** - **Description:** `private` will be removed. Follow the guide at - https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to - find a suitable replacement. - **Reason:** The Team Discussions feature is deprecated in favor of Organization Discussions. - """ - private: Boolean - - """ - The ID of the team to which the discussion belongs. This field is required. - - **Upcoming Change on 2024-07-01 UTC** - **Description:** `teamId` will be removed. Follow the guide at - https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to - find a suitable replacement. - **Reason:** The Team Discussions feature is deprecated in favor of Organization Discussions. - """ - teamId: ID @possibleTypes(concreteTypes: ["Team"]) - - """ - The title of the discussion. This field is required. - - **Upcoming Change on 2024-07-01 UTC** - **Description:** `title` will be removed. Follow the guide at - https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to - find a suitable replacement. - **Reason:** The Team Discussions feature is deprecated in favor of Organization Discussions. - """ - title: String -} - -""" -Autogenerated return type of CreateTeamDiscussion -""" -type CreateTeamDiscussionPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new discussion. - """ - teamDiscussion: TeamDiscussion - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) -} - -""" -Autogenerated input type of CreateUserList -""" -input CreateUserListInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - A description of the list - """ - description: String - - """ - Whether or not the list is private - """ - isPrivate: Boolean = false - - """ - The name of the new list - """ - name: String! -} - -""" -Autogenerated return type of CreateUserList -""" -type CreateUserListPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The list that was just created - """ - list: UserList - - """ - The user who created the list - """ - viewer: User -} - -""" -Represents the contribution a user made by committing to a repository. -""" -type CreatedCommitContribution implements Contribution { - """ - How many commits were made on this day to this repository by the user. - """ - commitCount: Int! - - """ - Whether this contribution is associated with a record you do not have access to. For - example, your own 'first issue' contribution may have been made on a repository you can no - longer access. - """ - isRestricted: Boolean! - - """ - When this contribution was made. - """ - occurredAt: DateTime! - - """ - The repository the user made a commit in. - """ - repository: Repository! - - """ - The HTTP path for this contribution. - """ - resourcePath: URI! - - """ - The HTTP URL for this contribution. - """ - url: URI! - - """ - The user who made this contribution. - """ - user: User! -} - -""" -The connection type for CreatedCommitContribution. -""" -type CreatedCommitContributionConnection { - """ - A list of edges. - """ - edges: [CreatedCommitContributionEdge] - - """ - A list of nodes. - """ - nodes: [CreatedCommitContribution] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of commits across days and repositories in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type CreatedCommitContributionEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: CreatedCommitContribution -} - -""" -Represents the contribution a user made on GitHub by opening an issue. -""" -type CreatedIssueContribution implements Contribution { - """ - Whether this contribution is associated with a record you do not have access to. For - example, your own 'first issue' contribution may have been made on a repository you can no - longer access. - """ - isRestricted: Boolean! - - """ - The issue that was opened. - """ - issue: Issue! - - """ - When this contribution was made. - """ - occurredAt: DateTime! - - """ - The HTTP path for this contribution. - """ - resourcePath: URI! - - """ - The HTTP URL for this contribution. - """ - url: URI! - - """ - The user who made this contribution. - """ - user: User! -} - -""" -The connection type for CreatedIssueContribution. -""" -type CreatedIssueContributionConnection { - """ - A list of edges. - """ - edges: [CreatedIssueContributionEdge] - - """ - A list of nodes. - """ - nodes: [CreatedIssueContribution] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type CreatedIssueContributionEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: CreatedIssueContribution -} - -""" -Represents either a issue the viewer can access or a restricted contribution. -""" -union CreatedIssueOrRestrictedContribution = CreatedIssueContribution | RestrictedContribution - -""" -Represents the contribution a user made on GitHub by opening a pull request. -""" -type CreatedPullRequestContribution implements Contribution { - """ - Whether this contribution is associated with a record you do not have access to. For - example, your own 'first issue' contribution may have been made on a repository you can no - longer access. - """ - isRestricted: Boolean! - - """ - When this contribution was made. - """ - occurredAt: DateTime! - - """ - The pull request that was opened. - """ - pullRequest: PullRequest! - - """ - The HTTP path for this contribution. - """ - resourcePath: URI! - - """ - The HTTP URL for this contribution. - """ - url: URI! - - """ - The user who made this contribution. - """ - user: User! -} - -""" -The connection type for CreatedPullRequestContribution. -""" -type CreatedPullRequestContributionConnection { - """ - A list of edges. - """ - edges: [CreatedPullRequestContributionEdge] - - """ - A list of nodes. - """ - nodes: [CreatedPullRequestContribution] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type CreatedPullRequestContributionEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: CreatedPullRequestContribution -} - -""" -Represents either a pull request the viewer can access or a restricted contribution. -""" -union CreatedPullRequestOrRestrictedContribution = CreatedPullRequestContribution | RestrictedContribution - -""" -Represents the contribution a user made by leaving a review on a pull request. -""" -type CreatedPullRequestReviewContribution implements Contribution { - """ - Whether this contribution is associated with a record you do not have access to. For - example, your own 'first issue' contribution may have been made on a repository you can no - longer access. - """ - isRestricted: Boolean! - - """ - When this contribution was made. - """ - occurredAt: DateTime! - - """ - The pull request the user reviewed. - """ - pullRequest: PullRequest! - - """ - The review the user left on the pull request. - """ - pullRequestReview: PullRequestReview! - - """ - The repository containing the pull request that the user reviewed. - """ - repository: Repository! - - """ - The HTTP path for this contribution. - """ - resourcePath: URI! - - """ - The HTTP URL for this contribution. - """ - url: URI! - - """ - The user who made this contribution. - """ - user: User! -} - -""" -The connection type for CreatedPullRequestReviewContribution. -""" -type CreatedPullRequestReviewContributionConnection { - """ - A list of edges. - """ - edges: [CreatedPullRequestReviewContributionEdge] - - """ - A list of nodes. - """ - nodes: [CreatedPullRequestReviewContribution] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type CreatedPullRequestReviewContributionEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: CreatedPullRequestReviewContribution -} - -""" -Represents the contribution a user made on GitHub by creating a repository. -""" -type CreatedRepositoryContribution implements Contribution { - """ - Whether this contribution is associated with a record you do not have access to. For - example, your own 'first issue' contribution may have been made on a repository you can no - longer access. - """ - isRestricted: Boolean! - - """ - When this contribution was made. - """ - occurredAt: DateTime! - - """ - The repository that was created. - """ - repository: Repository! - - """ - The HTTP path for this contribution. - """ - resourcePath: URI! - - """ - The HTTP URL for this contribution. - """ - url: URI! - - """ - The user who made this contribution. - """ - user: User! -} - -""" -The connection type for CreatedRepositoryContribution. -""" -type CreatedRepositoryContributionConnection { - """ - A list of edges. - """ - edges: [CreatedRepositoryContributionEdge] - - """ - A list of nodes. - """ - nodes: [CreatedRepositoryContribution] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type CreatedRepositoryContributionEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: CreatedRepositoryContribution -} - -""" -Represents either a repository the viewer can access or a restricted contribution. -""" -union CreatedRepositoryOrRestrictedContribution = CreatedRepositoryContribution | RestrictedContribution - -""" -Represents a mention made by one issue or pull request to another. -""" -type CrossReferencedEvent implements Node & UniformResourceLocatable { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the CrossReferencedEvent object - """ - id: ID! - - """ - Reference originated in a different repository. - """ - isCrossRepository: Boolean! - - """ - Identifies when the reference was made. - """ - referencedAt: DateTime! - - """ - The HTTP path for this pull request. - """ - resourcePath: URI! - - """ - Issue or pull request that made the reference. - """ - source: ReferencedSubject! - - """ - Issue or pull request to which the reference was made. - """ - target: ReferencedSubject! - - """ - The HTTP URL for this pull request. - """ - url: URI! - - """ - Checks if the target will be closed when the source is merged. - """ - willCloseTarget: Boolean! -} - -""" -An ISO-8601 encoded date string. -""" -scalar Date - -""" -An ISO-8601 encoded UTC date string. -""" -scalar DateTime - -""" -The possible base permissions for repositories. -""" -enum DefaultRepositoryPermissionField { - """ - Can read, write, and administrate repos by default - """ - ADMIN - - """ - No access - """ - NONE - - """ - Can read repos by default - """ - READ - - """ - Can read and write repos by default - """ - WRITE -} - -""" -Entities that can be deleted. -""" -interface Deletable { - """ - Check if the current viewer can delete this object. - """ - viewerCanDelete: Boolean! -} - -""" -Autogenerated input type of DeleteBranchProtectionRule -""" -input DeleteBranchProtectionRuleInput { - """ - The global relay id of the branch protection rule to be deleted. - """ - branchProtectionRuleId: ID! @possibleTypes(concreteTypes: ["BranchProtectionRule"]) - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated return type of DeleteBranchProtectionRule -""" -type DeleteBranchProtectionRulePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of DeleteDeployment -""" -input DeleteDeploymentInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the deployment to be deleted. - """ - id: ID! @possibleTypes(concreteTypes: ["Deployment"]) -} - -""" -Autogenerated return type of DeleteDeployment -""" -type DeleteDeploymentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of DeleteDiscussionComment -""" -input DeleteDiscussionCommentInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node id of the discussion comment to delete. - """ - id: ID! @possibleTypes(concreteTypes: ["DiscussionComment"]) -} - -""" -Autogenerated return type of DeleteDiscussionComment -""" -type DeleteDiscussionCommentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The discussion comment that was just deleted. - """ - comment: DiscussionComment -} - -""" -Autogenerated input type of DeleteDiscussion -""" -input DeleteDiscussionInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The id of the discussion to delete. - """ - id: ID! @possibleTypes(concreteTypes: ["Discussion"]) -} - -""" -Autogenerated return type of DeleteDiscussion -""" -type DeleteDiscussionPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The discussion that was just deleted. - """ - discussion: Discussion -} - -""" -Autogenerated input type of DeleteEnvironment -""" -input DeleteEnvironmentInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the environment to be deleted. - """ - id: ID! @possibleTypes(concreteTypes: ["Environment"]) -} - -""" -Autogenerated return type of DeleteEnvironment -""" -type DeleteEnvironmentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of DeleteIpAllowListEntry -""" -input DeleteIpAllowListEntryInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the IP allow list entry to delete. - """ - ipAllowListEntryId: ID! @possibleTypes(concreteTypes: ["IpAllowListEntry"]) -} - -""" -Autogenerated return type of DeleteIpAllowListEntry -""" -type DeleteIpAllowListEntryPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The IP allow list entry that was deleted. - """ - ipAllowListEntry: IpAllowListEntry -} - -""" -Autogenerated input type of DeleteIssueComment -""" -input DeleteIssueCommentInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the comment to delete. - """ - id: ID! @possibleTypes(concreteTypes: ["IssueComment"]) -} - -""" -Autogenerated return type of DeleteIssueComment -""" -type DeleteIssueCommentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of DeleteIssue -""" -input DeleteIssueInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the issue to delete. - """ - issueId: ID! @possibleTypes(concreteTypes: ["Issue"]) -} - -""" -Autogenerated return type of DeleteIssue -""" -type DeleteIssuePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The repository the issue belonged to - """ - repository: Repository -} - -""" -Autogenerated input type of DeleteLabel -""" -input DeleteLabelInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the label to be deleted. - """ - id: ID! @possibleTypes(concreteTypes: ["Label"]) -} - -""" -Autogenerated return type of DeleteLabel -""" -type DeleteLabelPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of DeleteLinkedBranch -""" -input DeleteLinkedBranchInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the linked branch - """ - linkedBranchId: ID! @possibleTypes(concreteTypes: ["LinkedBranch"]) -} - -""" -Autogenerated return type of DeleteLinkedBranch -""" -type DeleteLinkedBranchPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The issue the linked branch was unlinked from. - """ - issue: Issue -} - -""" -Autogenerated input type of DeletePackageVersion -""" -input DeletePackageVersionInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the package version to be deleted. - """ - packageVersionId: ID! @possibleTypes(concreteTypes: ["PackageVersion"]) -} - -""" -Autogenerated return type of DeletePackageVersion -""" -type DeletePackageVersionPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Whether or not the operation succeeded. - """ - success: Boolean -} - -""" -Autogenerated input type of DeleteProjectCard -""" -input DeleteProjectCardInput { - """ - The id of the card to delete. - """ - cardId: ID! @possibleTypes(concreteTypes: ["ProjectCard"]) - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated return type of DeleteProjectCard -""" -type DeleteProjectCardPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The column the deleted card was in. - """ - column: ProjectColumn - - """ - The deleted card ID. - """ - deletedCardId: ID -} - -""" -Autogenerated input type of DeleteProjectColumn -""" -input DeleteProjectColumnInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The id of the column to delete. - """ - columnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"]) -} - -""" -Autogenerated return type of DeleteProjectColumn -""" -type DeleteProjectColumnPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The deleted column ID. - """ - deletedColumnId: ID - - """ - The project the deleted column was in. - """ - project: Project -} - -""" -Autogenerated input type of DeleteProject -""" -input DeleteProjectInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Project ID to update. - """ - projectId: ID! @possibleTypes(concreteTypes: ["Project"]) -} - -""" -Autogenerated return type of DeleteProject -""" -type DeleteProjectPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The repository or organization the project was removed from. - """ - owner: ProjectOwner -} - -""" -Autogenerated input type of DeleteProjectV2Field -""" -input DeleteProjectV2FieldInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the field to delete. - """ - fieldId: ID! - @possibleTypes( - concreteTypes: ["ProjectV2Field", "ProjectV2IterationField", "ProjectV2SingleSelectField"] - abstractType: "ProjectV2FieldConfiguration" - ) -} - -""" -Autogenerated return type of DeleteProjectV2Field -""" -type DeleteProjectV2FieldPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The deleted field. - """ - projectV2Field: ProjectV2FieldConfiguration -} - -""" -Autogenerated input type of DeleteProjectV2 -""" -input DeleteProjectV2Input { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the Project to delete. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) -} - -""" -Autogenerated input type of DeleteProjectV2Item -""" -input DeleteProjectV2ItemInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the item to be removed. - """ - itemId: ID! @possibleTypes(concreteTypes: ["ProjectV2Item"]) - - """ - The ID of the Project from which the item should be removed. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) -} - -""" -Autogenerated return type of DeleteProjectV2Item -""" -type DeleteProjectV2ItemPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the deleted item. - """ - deletedItemId: ID -} - -""" -Autogenerated return type of DeleteProjectV2 -""" -type DeleteProjectV2Payload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The deleted Project. - """ - projectV2: ProjectV2 -} - -""" -Autogenerated input type of DeleteProjectV2Workflow -""" -input DeleteProjectV2WorkflowInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the workflow to be removed. - """ - workflowId: ID! @possibleTypes(concreteTypes: ["ProjectV2Workflow"]) -} - -""" -Autogenerated return type of DeleteProjectV2Workflow -""" -type DeleteProjectV2WorkflowPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the deleted workflow. - """ - deletedWorkflowId: ID - - """ - The project the deleted workflow was in. - """ - projectV2: ProjectV2 -} - -""" -Autogenerated input type of DeletePullRequestReviewComment -""" -input DeletePullRequestReviewCommentInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the comment to delete. - """ - id: ID! @possibleTypes(concreteTypes: ["PullRequestReviewComment"]) -} - -""" -Autogenerated return type of DeletePullRequestReviewComment -""" -type DeletePullRequestReviewCommentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The pull request review the deleted comment belonged to. - """ - pullRequestReview: PullRequestReview - - """ - The deleted pull request review comment. - """ - pullRequestReviewComment: PullRequestReviewComment -} - -""" -Autogenerated input type of DeletePullRequestReview -""" -input DeletePullRequestReviewInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the pull request review to delete. - """ - pullRequestReviewId: ID! @possibleTypes(concreteTypes: ["PullRequestReview"]) -} - -""" -Autogenerated return type of DeletePullRequestReview -""" -type DeletePullRequestReviewPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The deleted pull request review. - """ - pullRequestReview: PullRequestReview -} - -""" -Autogenerated input type of DeleteRef -""" -input DeleteRefInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the Ref to be deleted. - """ - refId: ID! @possibleTypes(concreteTypes: ["Ref"]) -} - -""" -Autogenerated return type of DeleteRef -""" -type DeleteRefPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of DeleteRepositoryRuleset -""" -input DeleteRepositoryRulesetInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The global relay id of the repository ruleset to be deleted. - """ - repositoryRulesetId: ID! @possibleTypes(concreteTypes: ["RepositoryRuleset"]) -} - -""" -Autogenerated return type of DeleteRepositoryRuleset -""" -type DeleteRepositoryRulesetPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of DeleteTeamDiscussionComment -""" -input DeleteTeamDiscussionCommentInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the comment to delete. - """ - id: ID! @possibleTypes(concreteTypes: ["TeamDiscussionComment"]) -} - -""" -Autogenerated return type of DeleteTeamDiscussionComment -""" -type DeleteTeamDiscussionCommentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of DeleteTeamDiscussion -""" -input DeleteTeamDiscussionInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The discussion ID to delete. - """ - id: ID! @possibleTypes(concreteTypes: ["TeamDiscussion"]) -} - -""" -Autogenerated return type of DeleteTeamDiscussion -""" -type DeleteTeamDiscussionPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of DeleteUserList -""" -input DeleteUserListInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the list to delete. - """ - listId: ID! @possibleTypes(concreteTypes: ["UserList"]) -} - -""" -Autogenerated return type of DeleteUserList -""" -type DeleteUserListPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The owner of the list that will be deleted - """ - user: User -} - -""" -Autogenerated input type of DeleteVerifiableDomain -""" -input DeleteVerifiableDomainInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the verifiable domain to delete. - """ - id: ID! @possibleTypes(concreteTypes: ["VerifiableDomain"]) -} - -""" -Autogenerated return type of DeleteVerifiableDomain -""" -type DeleteVerifiableDomainPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The owning account from which the domain was deleted. - """ - owner: VerifiableDomainOwner -} - -""" -Represents a 'demilestoned' event on a given issue or pull request. -""" -type DemilestonedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the DemilestonedEvent object - """ - id: ID! - - """ - Identifies the milestone title associated with the 'demilestoned' event. - """ - milestoneTitle: String! - - """ - Object referenced by event. - """ - subject: MilestoneItem! -} - -""" -A Dependabot Update for a dependency in a repository -""" -type DependabotUpdate implements RepositoryNode { - """ - The error from a dependency update - """ - error: DependabotUpdateError - - """ - The associated pull request - """ - pullRequest: PullRequest - - """ - The repository associated with this node. - """ - repository: Repository! -} - -""" -An error produced from a Dependabot Update -""" -type DependabotUpdateError { - """ - The body of the error - """ - body: String! - - """ - The error code - """ - errorType: String! - - """ - The title of the error - """ - title: String! -} - -""" -A dependency manifest entry -""" -type DependencyGraphDependency { - """ - Does the dependency itself have dependencies? - """ - hasDependencies: Boolean! - - """ - The original name of the package, as it appears in the manifest. - """ - packageLabel: String! - @deprecated( - reason: "`packageLabel` will be removed. Use normalized `packageName` field instead. Removal on 2022-10-01 UTC." - ) - - """ - The dependency package manager - """ - packageManager: String - - """ - The name of the package in the canonical form used by the package manager. - """ - packageName: String! - - """ - The repository containing the package - """ - repository: Repository - - """ - The dependency version requirements - """ - requirements: String! -} - -""" -The connection type for DependencyGraphDependency. -""" -type DependencyGraphDependencyConnection { - """ - A list of edges. - """ - edges: [DependencyGraphDependencyEdge] - - """ - A list of nodes. - """ - nodes: [DependencyGraphDependency] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type DependencyGraphDependencyEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: DependencyGraphDependency -} - -""" -Dependency manifest for a repository -""" -type DependencyGraphManifest implements Node { - """ - Path to view the manifest file blob - """ - blobPath: String! - - """ - A list of manifest dependencies - """ - dependencies( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): DependencyGraphDependencyConnection - - """ - The number of dependencies listed in the manifest - """ - dependenciesCount: Int - - """ - Is the manifest too big to parse? - """ - exceedsMaxSize: Boolean! - - """ - Fully qualified manifest filename - """ - filename: String! - - """ - The Node ID of the DependencyGraphManifest object - """ - id: ID! - - """ - Were we able to parse the manifest? - """ - parseable: Boolean! - - """ - The repository containing the manifest - """ - repository: Repository! -} - -""" -The connection type for DependencyGraphManifest. -""" -type DependencyGraphManifestConnection { - """ - A list of edges. - """ - edges: [DependencyGraphManifestEdge] - - """ - A list of nodes. - """ - nodes: [DependencyGraphManifest] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type DependencyGraphManifestEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: DependencyGraphManifest -} - -""" -A repository deploy key. -""" -type DeployKey implements Node { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the DeployKey object - """ - id: ID! - - """ - The deploy key. - """ - key: String! - - """ - Whether or not the deploy key is read only. - """ - readOnly: Boolean! - - """ - The deploy key title. - """ - title: String! - - """ - Whether or not the deploy key has been verified. - """ - verified: Boolean! -} - -""" -The connection type for DeployKey. -""" -type DeployKeyConnection { - """ - A list of edges. - """ - edges: [DeployKeyEdge] - - """ - A list of nodes. - """ - nodes: [DeployKey] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type DeployKeyEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: DeployKey -} - -""" -Represents a 'deployed' event on a given pull request. -""" -type DeployedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The deployment associated with the 'deployed' event. - """ - deployment: Deployment! - - """ - The Node ID of the DeployedEvent object - """ - id: ID! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest! - - """ - The ref associated with the 'deployed' event. - """ - ref: Ref -} - -""" -Represents triggered deployment instance. -""" -type Deployment implements Node { - """ - Identifies the commit sha of the deployment. - """ - commit: Commit - - """ - Identifies the oid of the deployment commit, even if the commit has been deleted. - """ - commitOid: String! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the actor who triggered the deployment. - """ - creator: Actor! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The deployment description. - """ - description: String - - """ - The latest environment to which this deployment was made. - """ - environment: String - - """ - The Node ID of the Deployment object - """ - id: ID! - - """ - The latest environment to which this deployment was made. - """ - latestEnvironment: String - - """ - The latest status of this deployment. - """ - latestStatus: DeploymentStatus - - """ - The original environment to which this deployment was made. - """ - originalEnvironment: String - - """ - Extra information that a deployment system might need. - """ - payload: String - - """ - Identifies the Ref of the deployment, if the deployment was created by ref. - """ - ref: Ref - - """ - Identifies the repository associated with the deployment. - """ - repository: Repository! - - """ - The current state of the deployment. - """ - state: DeploymentState - - """ - A list of statuses associated with the deployment. - """ - statuses( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): DeploymentStatusConnection - - """ - The deployment task. - """ - task: String - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -The connection type for Deployment. -""" -type DeploymentConnection { - """ - A list of edges. - """ - edges: [DeploymentEdge] - - """ - A list of nodes. - """ - nodes: [Deployment] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type DeploymentEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Deployment -} - -""" -Represents a 'deployment_environment_changed' event on a given pull request. -""" -type DeploymentEnvironmentChangedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The deployment status that updated the deployment environment. - """ - deploymentStatus: DeploymentStatus! - - """ - The Node ID of the DeploymentEnvironmentChangedEvent object - """ - id: ID! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest! -} - -""" -Ordering options for deployment connections -""" -input DeploymentOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order deployments by. - """ - field: DeploymentOrderField! -} - -""" -Properties by which deployment connections can be ordered. -""" -enum DeploymentOrderField { - """ - Order collection by creation time - """ - CREATED_AT -} - -""" -A protection rule. -""" -type DeploymentProtectionRule { - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - Whether deployments to this environment can be approved by the user who created the deployment. - """ - preventSelfReview: Boolean - - """ - The teams or users that can review the deployment - """ - reviewers( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): DeploymentReviewerConnection! - - """ - The timeout in minutes for this protection rule. - """ - timeout: Int! - - """ - The type of protection rule. - """ - type: DeploymentProtectionRuleType! -} - -""" -The connection type for DeploymentProtectionRule. -""" -type DeploymentProtectionRuleConnection { - """ - A list of edges. - """ - edges: [DeploymentProtectionRuleEdge] - - """ - A list of nodes. - """ - nodes: [DeploymentProtectionRule] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type DeploymentProtectionRuleEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: DeploymentProtectionRule -} - -""" -The possible protection rule types. -""" -enum DeploymentProtectionRuleType { - """ - Branch policy - """ - BRANCH_POLICY - - """ - Required reviewers - """ - REQUIRED_REVIEWERS - - """ - Wait timer - """ - WAIT_TIMER -} - -""" -A request to deploy a workflow run to an environment. -""" -type DeploymentRequest { - """ - Whether or not the current user can approve the deployment - """ - currentUserCanApprove: Boolean! - - """ - The target environment of the deployment - """ - environment: Environment! - - """ - The teams or users that can review the deployment - """ - reviewers( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): DeploymentReviewerConnection! - - """ - The wait timer in minutes configured in the environment - """ - waitTimer: Int! - - """ - The wait timer in minutes configured in the environment - """ - waitTimerStartedAt: DateTime -} - -""" -The connection type for DeploymentRequest. -""" -type DeploymentRequestConnection { - """ - A list of edges. - """ - edges: [DeploymentRequestEdge] - - """ - A list of nodes. - """ - nodes: [DeploymentRequest] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type DeploymentRequestEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: DeploymentRequest -} - -""" -A deployment review. -""" -type DeploymentReview implements Node { - """ - The comment the user left. - """ - comment: String! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The environments approved or rejected - """ - environments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): EnvironmentConnection! - - """ - The Node ID of the DeploymentReview object - """ - id: ID! - - """ - The decision of the user. - """ - state: DeploymentReviewState! - - """ - The user that reviewed the deployment. - """ - user: User! -} - -""" -The connection type for DeploymentReview. -""" -type DeploymentReviewConnection { - """ - A list of edges. - """ - edges: [DeploymentReviewEdge] - - """ - A list of nodes. - """ - nodes: [DeploymentReview] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type DeploymentReviewEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: DeploymentReview -} - -""" -The possible states for a deployment review. -""" -enum DeploymentReviewState { - """ - The deployment was approved. - """ - APPROVED - - """ - The deployment was rejected. - """ - REJECTED -} - -""" -Users and teams. -""" -union DeploymentReviewer = Team | User - -""" -The connection type for DeploymentReviewer. -""" -type DeploymentReviewerConnection { - """ - A list of edges. - """ - edges: [DeploymentReviewerEdge] - - """ - A list of nodes. - """ - nodes: [DeploymentReviewer] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type DeploymentReviewerEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: DeploymentReviewer -} - -""" -The possible states in which a deployment can be. -""" -enum DeploymentState { - """ - The pending deployment was not updated after 30 minutes. - """ - ABANDONED - - """ - The deployment is currently active. - """ - ACTIVE - - """ - An inactive transient deployment. - """ - DESTROYED - - """ - The deployment experienced an error. - """ - ERROR - - """ - The deployment has failed. - """ - FAILURE - - """ - The deployment is inactive. - """ - INACTIVE - - """ - The deployment is in progress. - """ - IN_PROGRESS - - """ - The deployment is pending. - """ - PENDING - - """ - The deployment has queued - """ - QUEUED - - """ - The deployment was successful. - """ - SUCCESS - - """ - The deployment is waiting. - """ - WAITING -} - -""" -Describes the status of a given deployment attempt. -""" -type DeploymentStatus implements Node { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the actor who triggered the deployment. - """ - creator: Actor! - - """ - Identifies the deployment associated with status. - """ - deployment: Deployment! - - """ - Identifies the description of the deployment. - """ - description: String - - """ - Identifies the environment of the deployment at the time of this deployment status - """ - environment: String - - """ - Identifies the environment URL of the deployment. - """ - environmentUrl: URI - - """ - The Node ID of the DeploymentStatus object - """ - id: ID! - - """ - Identifies the log URL of the deployment. - """ - logUrl: URI - - """ - Identifies the current state of the deployment. - """ - state: DeploymentStatusState! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -The connection type for DeploymentStatus. -""" -type DeploymentStatusConnection { - """ - A list of edges. - """ - edges: [DeploymentStatusEdge] - - """ - A list of nodes. - """ - nodes: [DeploymentStatus] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type DeploymentStatusEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: DeploymentStatus -} - -""" -The possible states for a deployment status. -""" -enum DeploymentStatusState { - """ - The deployment experienced an error. - """ - ERROR - - """ - The deployment has failed. - """ - FAILURE - - """ - The deployment is inactive. - """ - INACTIVE - - """ - The deployment is in progress. - """ - IN_PROGRESS - - """ - The deployment is pending. - """ - PENDING - - """ - The deployment is queued - """ - QUEUED - - """ - The deployment was successful. - """ - SUCCESS - - """ - The deployment is waiting. - """ - WAITING -} - -""" -Autogenerated input type of DequeuePullRequest -""" -input DequeuePullRequestInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the pull request to be dequeued. - """ - id: ID! @possibleTypes(concreteTypes: ["PullRequest"]) -} - -""" -Autogenerated return type of DequeuePullRequest -""" -type DequeuePullRequestPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The merge queue entry of the dequeued pull request. - """ - mergeQueueEntry: MergeQueueEntry -} - -""" -The possible sides of a diff. -""" -enum DiffSide { - """ - The left side of the diff. - """ - LEFT - - """ - The right side of the diff. - """ - RIGHT -} - -""" -Autogenerated input type of DisablePullRequestAutoMerge -""" -input DisablePullRequestAutoMergeInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - ID of the pull request to disable auto merge on. - """ - pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"]) -} - -""" -Autogenerated return type of DisablePullRequestAutoMerge -""" -type DisablePullRequestAutoMergePayload { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The pull request auto merge was disabled on. - """ - pullRequest: PullRequest -} - -""" -Represents a 'disconnected' event on a given issue or pull request. -""" -type DisconnectedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the DisconnectedEvent object - """ - id: ID! - - """ - Reference originated in a different repository. - """ - isCrossRepository: Boolean! - - """ - Issue or pull request from which the issue was disconnected. - """ - source: ReferencedSubject! - - """ - Issue or pull request which was disconnected. - """ - subject: ReferencedSubject! -} - -""" -A discussion in a repository. -""" -type Discussion implements Closable & Comment & Deletable & Labelable & Lockable & Node & Reactable & RepositoryNode & Subscribable & Updatable & Votable { - """ - Reason that the conversation was locked. - """ - activeLockReason: LockReason - - """ - The comment chosen as this discussion's answer, if any. - """ - answer: DiscussionComment - - """ - The time when a user chose this discussion's answer, if answered. - """ - answerChosenAt: DateTime - - """ - The user who chose this discussion's answer, if answered. - """ - answerChosenBy: Actor - - """ - The actor who authored the comment. - """ - author: Actor - - """ - Author's association with the subject of the comment. - """ - authorAssociation: CommentAuthorAssociation! - - """ - The main text of the discussion post. - """ - body: String! - - """ - The body rendered to HTML. - """ - bodyHTML: HTML! - - """ - The body rendered to text. - """ - bodyText: String! - - """ - The category for this discussion. - """ - category: DiscussionCategory! - - """ - Indicates if the object is closed (definition of closed may depend on type) - """ - closed: Boolean! - - """ - Identifies the date and time when the object was closed. - """ - closedAt: DateTime - - """ - The replies to the discussion. - """ - comments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): DiscussionCommentConnection! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Check if this comment was created via an email reply. - """ - createdViaEmail: Boolean! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The actor who edited the comment. - """ - editor: Actor - - """ - The Node ID of the Discussion object - """ - id: ID! - - """ - Check if this comment was edited and includes an edit with the creation data - """ - includesCreatedEdit: Boolean! - - """ - Only return answered/unanswered discussions - """ - isAnswered: Boolean - - """ - A list of labels associated with the object. - """ - labels( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for labels returned from the connection. - """ - orderBy: LabelOrder = {field: CREATED_AT, direction: ASC} - ): LabelConnection - - """ - The moment the editor made the last edit - """ - lastEditedAt: DateTime - - """ - `true` if the object is locked - """ - locked: Boolean! - - """ - The number identifying this discussion within the repository. - """ - number: Int! - - """ - The poll associated with this discussion, if one exists. - """ - poll: DiscussionPoll - - """ - Identifies when the comment was published at. - """ - publishedAt: DateTime - - """ - A list of reactions grouped by content left on the subject. - """ - reactionGroups: [ReactionGroup!] - - """ - A list of Reactions left on the Issue. - """ - reactions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Allows filtering Reactions by emoji. - """ - content: ReactionContent - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Allows specifying the order in which reactions are returned. - """ - orderBy: ReactionOrder - ): ReactionConnection! - - """ - The repository associated with this node. - """ - repository: Repository! - - """ - The path for this discussion. - """ - resourcePath: URI! - - """ - Identifies the reason for the discussion's state. - """ - stateReason: DiscussionStateReason - - """ - The title of this discussion. - """ - title: String! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - Number of upvotes that this subject has received. - """ - upvoteCount: Int! - - """ - The URL for this discussion. - """ - url: URI! - - """ - A list of edits to this content. - """ - userContentEdits( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserContentEditConnection - - """ - Indicates if the object can be closed by the viewer. - """ - viewerCanClose: Boolean! - - """ - Check if the current viewer can delete this object. - """ - viewerCanDelete: Boolean! - - """ - Can user react to this subject - """ - viewerCanReact: Boolean! - - """ - Indicates if the object can be reopened by the viewer. - """ - viewerCanReopen: Boolean! - - """ - Check if the viewer is able to change their subscription status for the repository. - """ - viewerCanSubscribe: Boolean! - - """ - Check if the current viewer can update this object. - """ - viewerCanUpdate: Boolean! - - """ - Whether or not the current user can add or remove an upvote on this subject. - """ - viewerCanUpvote: Boolean! - - """ - Did the viewer author this comment. - """ - viewerDidAuthor: Boolean! - - """ - Whether or not the current user has already upvoted this subject. - """ - viewerHasUpvoted: Boolean! - - """ - Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. - """ - viewerSubscription: SubscriptionState -} - -""" -A category for discussions in a repository. -""" -type DiscussionCategory implements Node & RepositoryNode { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - A description of this category. - """ - description: String - - """ - An emoji representing this category. - """ - emoji: String! - - """ - This category's emoji rendered as HTML. - """ - emojiHTML: HTML! - - """ - The Node ID of the DiscussionCategory object - """ - id: ID! - - """ - Whether or not discussions in this category support choosing an answer with the markDiscussionCommentAsAnswer mutation. - """ - isAnswerable: Boolean! - - """ - The name of this category. - """ - name: String! - - """ - The repository associated with this node. - """ - repository: Repository! - - """ - The slug of this category. - """ - slug: String! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -The connection type for DiscussionCategory. -""" -type DiscussionCategoryConnection { - """ - A list of edges. - """ - edges: [DiscussionCategoryEdge] - - """ - A list of nodes. - """ - nodes: [DiscussionCategory] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type DiscussionCategoryEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: DiscussionCategory -} - -""" -The possible reasons for closing a discussion. -""" -enum DiscussionCloseReason { - """ - The discussion is a duplicate of another - """ - DUPLICATE - - """ - The discussion is no longer relevant - """ - OUTDATED - - """ - The discussion has been resolved - """ - RESOLVED -} - -""" -A comment on a discussion. -""" -type DiscussionComment implements Comment & Deletable & Minimizable & Node & Reactable & Updatable & UpdatableComment & Votable { - """ - The actor who authored the comment. - """ - author: Actor - - """ - Author's association with the subject of the comment. - """ - authorAssociation: CommentAuthorAssociation! - - """ - The body as Markdown. - """ - body: String! - - """ - The body rendered to HTML. - """ - bodyHTML: HTML! - - """ - The body rendered to text. - """ - bodyText: String! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Check if this comment was created via an email reply. - """ - createdViaEmail: Boolean! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The time when this replied-to comment was deleted - """ - deletedAt: DateTime - - """ - The discussion this comment was created in - """ - discussion: Discussion - - """ - The actor who edited the comment. - """ - editor: Actor - - """ - The Node ID of the DiscussionComment object - """ - id: ID! - - """ - Check if this comment was edited and includes an edit with the creation data - """ - includesCreatedEdit: Boolean! - - """ - Has this comment been chosen as the answer of its discussion? - """ - isAnswer: Boolean! - - """ - Returns whether or not a comment has been minimized. - """ - isMinimized: Boolean! - - """ - The moment the editor made the last edit - """ - lastEditedAt: DateTime - - """ - Returns why the comment was minimized. One of `abuse`, `off-topic`, - `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and - formatting of these values differs from the inputs to the `MinimizeComment` mutation. - """ - minimizedReason: String - - """ - Identifies when the comment was published at. - """ - publishedAt: DateTime - - """ - A list of reactions grouped by content left on the subject. - """ - reactionGroups: [ReactionGroup!] - - """ - A list of Reactions left on the Issue. - """ - reactions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Allows filtering Reactions by emoji. - """ - content: ReactionContent - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Allows specifying the order in which reactions are returned. - """ - orderBy: ReactionOrder - ): ReactionConnection! - - """ - The threaded replies to this comment. - """ - replies( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): DiscussionCommentConnection! - - """ - The discussion comment this comment is a reply to - """ - replyTo: DiscussionComment - - """ - The path for this discussion comment. - """ - resourcePath: URI! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - Number of upvotes that this subject has received. - """ - upvoteCount: Int! - - """ - The URL for this discussion comment. - """ - url: URI! - - """ - A list of edits to this content. - """ - userContentEdits( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserContentEditConnection - - """ - Check if the current viewer can delete this object. - """ - viewerCanDelete: Boolean! - - """ - Can the current user mark this comment as an answer? - """ - viewerCanMarkAsAnswer: Boolean! - - """ - Check if the current viewer can minimize this object. - """ - viewerCanMinimize: Boolean! - - """ - Can user react to this subject - """ - viewerCanReact: Boolean! - - """ - Can the current user unmark this comment as an answer? - """ - viewerCanUnmarkAsAnswer: Boolean! - - """ - Check if the current viewer can update this object. - """ - viewerCanUpdate: Boolean! - - """ - Whether or not the current user can add or remove an upvote on this subject. - """ - viewerCanUpvote: Boolean! - - """ - Reasons why the current viewer can not update this comment. - """ - viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - - """ - Did the viewer author this comment. - """ - viewerDidAuthor: Boolean! - - """ - Whether or not the current user has already upvoted this subject. - """ - viewerHasUpvoted: Boolean! -} - -""" -The connection type for DiscussionComment. -""" -type DiscussionCommentConnection { - """ - A list of edges. - """ - edges: [DiscussionCommentEdge] - - """ - A list of nodes. - """ - nodes: [DiscussionComment] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type DiscussionCommentEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: DiscussionComment -} - -""" -The connection type for Discussion. -""" -type DiscussionConnection { - """ - A list of edges. - """ - edges: [DiscussionEdge] - - """ - A list of nodes. - """ - nodes: [Discussion] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type DiscussionEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Discussion -} - -""" -Ways in which lists of discussions can be ordered upon return. -""" -input DiscussionOrder { - """ - The direction in which to order discussions by the specified field. - """ - direction: OrderDirection! - - """ - The field by which to order discussions. - """ - field: DiscussionOrderField! -} - -""" -Properties by which discussion connections can be ordered. -""" -enum DiscussionOrderField { - """ - Order discussions by creation time. - """ - CREATED_AT - - """ - Order discussions by most recent modification time. - """ - UPDATED_AT -} - -""" -A poll for a discussion. -""" -type DiscussionPoll implements Node { - """ - The discussion that this poll belongs to. - """ - discussion: Discussion - - """ - The Node ID of the DiscussionPoll object - """ - id: ID! - - """ - The options for this poll. - """ - options( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - How to order the options for the discussion poll. - """ - orderBy: DiscussionPollOptionOrder = {field: AUTHORED_ORDER, direction: ASC} - ): DiscussionPollOptionConnection - - """ - The question that is being asked by this poll. - """ - question: String! - - """ - The total number of votes that have been cast for this poll. - """ - totalVoteCount: Int! - - """ - Indicates if the viewer has permission to vote in this poll. - """ - viewerCanVote: Boolean! - - """ - Indicates if the viewer has voted for any option in this poll. - """ - viewerHasVoted: Boolean! -} - -""" -An option for a discussion poll. -""" -type DiscussionPollOption implements Node { - """ - The Node ID of the DiscussionPollOption object - """ - id: ID! - - """ - The text for this option. - """ - option: String! - - """ - The discussion poll that this option belongs to. - """ - poll: DiscussionPoll - - """ - The total number of votes that have been cast for this option. - """ - totalVoteCount: Int! - - """ - Indicates if the viewer has voted for this option in the poll. - """ - viewerHasVoted: Boolean! -} - -""" -The connection type for DiscussionPollOption. -""" -type DiscussionPollOptionConnection { - """ - A list of edges. - """ - edges: [DiscussionPollOptionEdge] - - """ - A list of nodes. - """ - nodes: [DiscussionPollOption] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type DiscussionPollOptionEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: DiscussionPollOption -} - -""" -Ordering options for discussion poll option connections. -""" -input DiscussionPollOptionOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order poll options by. - """ - field: DiscussionPollOptionOrderField! -} - -""" -Properties by which discussion poll option connections can be ordered. -""" -enum DiscussionPollOptionOrderField { - """ - Order poll options by the order that the poll author specified when creating the poll. - """ - AUTHORED_ORDER - - """ - Order poll options by the number of votes it has. - """ - VOTE_COUNT -} - -""" -The possible states of a discussion. -""" -enum DiscussionState { - """ - A discussion that has been closed - """ - CLOSED - - """ - A discussion that is open - """ - OPEN -} - -""" -The possible state reasons of a discussion. -""" -enum DiscussionStateReason { - """ - The discussion is a duplicate of another - """ - DUPLICATE - - """ - The discussion is no longer relevant - """ - OUTDATED - - """ - The discussion was reopened - """ - REOPENED - - """ - The discussion has been resolved - """ - RESOLVED -} - -""" -Autogenerated input type of DismissPullRequestReview -""" -input DismissPullRequestReviewInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The contents of the pull request review dismissal message. - """ - message: String! - - """ - The Node ID of the pull request review to modify. - """ - pullRequestReviewId: ID! @possibleTypes(concreteTypes: ["PullRequestReview"]) -} - -""" -Autogenerated return type of DismissPullRequestReview -""" -type DismissPullRequestReviewPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The dismissed pull request review. - """ - pullRequestReview: PullRequestReview -} - -""" -The possible reasons that a Dependabot alert was dismissed. -""" -enum DismissReason { - """ - A fix has already been started - """ - FIX_STARTED - - """ - This alert is inaccurate or incorrect - """ - INACCURATE - - """ - Vulnerable code is not actually used - """ - NOT_USED - - """ - No bandwidth to fix this - """ - NO_BANDWIDTH - - """ - Risk is tolerable to this project - """ - TOLERABLE_RISK -} - -""" -Autogenerated input type of DismissRepositoryVulnerabilityAlert -""" -input DismissRepositoryVulnerabilityAlertInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The reason the Dependabot alert is being dismissed. - """ - dismissReason: DismissReason! - - """ - The Dependabot alert ID to dismiss. - """ - repositoryVulnerabilityAlertId: ID! @possibleTypes(concreteTypes: ["RepositoryVulnerabilityAlert"]) -} - -""" -Autogenerated return type of DismissRepositoryVulnerabilityAlert -""" -type DismissRepositoryVulnerabilityAlertPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Dependabot alert that was dismissed - """ - repositoryVulnerabilityAlert: RepositoryVulnerabilityAlert -} - -""" -A draft issue within a project. -""" -type DraftIssue implements Node { - """ - A list of users to assigned to this draft issue. - """ - assignees( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserConnection! - - """ - The body of the draft issue. - """ - body: String! - - """ - The body of the draft issue rendered to HTML. - """ - bodyHTML: HTML! - - """ - The body of the draft issue rendered to text. - """ - bodyText: String! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The actor who created this draft issue. - """ - creator: Actor - - """ - The Node ID of the DraftIssue object - """ - id: ID! - - """ - List of items linked with the draft issue (currently draft issue can be linked to only one item). - """ - projectV2Items( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ProjectV2ItemConnection! - - """ - Projects that link to this draft issue (currently draft issue can be linked to only one project). - """ - projectsV2( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ProjectV2Connection! - - """ - The title of the draft issue - """ - title: String! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -Specifies a review comment to be left with a Pull Request Review. -""" -input DraftPullRequestReviewComment { - """ - Body of the comment to leave. - """ - body: String! - - """ - Path to the file being commented on. - """ - path: String! - - """ - Position in the file to leave a comment on. - """ - position: Int! -} - -""" -Specifies a review comment thread to be left with a Pull Request Review. -""" -input DraftPullRequestReviewThread { - """ - Body of the comment to leave. - """ - body: String! - - """ - The line of the blob to which the thread refers. The end of the line range for multi-line comments. - """ - line: Int! - - """ - Path to the file being commented on. - """ - path: String! - - """ - The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range. - """ - side: DiffSide = RIGHT - - """ - The first line of the range to which the comment refers. - """ - startLine: Int - - """ - The side of the diff on which the start line resides. - """ - startSide: DiffSide = RIGHT -} - -""" -Autogenerated input type of EnablePullRequestAutoMerge -""" -input EnablePullRequestAutoMergeInput { - """ - The email address to associate with this merge. - """ - authorEmail: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Commit body to use for the commit when the PR is mergable; if omitted, a - default message will be used. NOTE: when merging with a merge queue any input - value for commit message is ignored. - """ - commitBody: String - - """ - Commit headline to use for the commit when the PR is mergable; if omitted, a - default message will be used. NOTE: when merging with a merge queue any input - value for commit headline is ignored. - """ - commitHeadline: String - - """ - The expected head OID of the pull request. - """ - expectedHeadOid: GitObjectID - - """ - The merge method to use. If omitted, defaults to `MERGE`. NOTE: when merging - with a merge queue any input value for merge method is ignored. - """ - mergeMethod: PullRequestMergeMethod = MERGE - - """ - ID of the pull request to enable auto-merge on. - """ - pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"]) -} - -""" -Autogenerated return type of EnablePullRequestAutoMerge -""" -type EnablePullRequestAutoMergePayload { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The pull request auto-merge was enabled on. - """ - pullRequest: PullRequest -} - -""" -Autogenerated input type of EnqueuePullRequest -""" -input EnqueuePullRequestInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The expected head OID of the pull request. - """ - expectedHeadOid: GitObjectID - - """ - Add the pull request to the front of the queue. - """ - jump: Boolean - - """ - The ID of the pull request to enqueue. - """ - pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"]) -} - -""" -Autogenerated return type of EnqueuePullRequest -""" -type EnqueuePullRequestPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The merge queue entry for the enqueued pull request. - """ - mergeQueueEntry: MergeQueueEntry -} - -""" -An account to manage multiple organizations with consolidated policy and billing. -""" -type Enterprise implements AnnouncementBanner & Node { - """ - The text of the announcement - """ - announcement: String - - """ - The date the announcement was created - """ - announcementCreatedAt: DateTime - - """ - The expiration date of the announcement, if any - """ - announcementExpiresAt: DateTime - - """ - Whether the announcement can be dismissed by the user - """ - announcementUserDismissible: Boolean - - """ - A URL pointing to the enterprise's public avatar. - """ - avatarUrl( - """ - The size of the resulting square image. - """ - size: Int - ): URI! - - """ - The enterprise's billing email. - """ - billingEmail: String - - """ - Enterprise billing information visible to enterprise billing managers. - """ - billingInfo: EnterpriseBillingInfo - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The description of the enterprise. - """ - description: String - - """ - The description of the enterprise as HTML. - """ - descriptionHTML: HTML! - - """ - The Node ID of the Enterprise object - """ - id: ID! - - """ - The location of the enterprise. - """ - location: String - - """ - A list of users who are members of this enterprise. - """ - members( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Only return members within the selected GitHub Enterprise deployment - """ - deployment: EnterpriseUserDeployment - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Only return members with this two-factor authentication status. Does not - include members who only have an account on a GitHub Enterprise Server instance. - """ - hasTwoFactorEnabled: Boolean = null - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for members returned from the connection. - """ - orderBy: EnterpriseMemberOrder = {field: LOGIN, direction: ASC} - - """ - Only return members within the organizations with these logins - """ - organizationLogins: [String!] - - """ - The search string to look for. - """ - query: String - - """ - The role of the user in the enterprise organization or server. - """ - role: EnterpriseUserAccountMembershipRole - ): EnterpriseMemberConnection! - - """ - The name of the enterprise. - """ - name: String! - - """ - A list of organizations that belong to this enterprise. - """ - organizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for organizations returned from the connection. - """ - orderBy: OrganizationOrder = {field: LOGIN, direction: ASC} - - """ - The search string to look for. - """ - query: String - - """ - The viewer's role in an organization. - """ - viewerOrganizationRole: RoleInOrganization - ): OrganizationConnection! - - """ - Enterprise information visible to enterprise owners or enterprise owners' - personal access tokens (classic) with read:enterprise or admin:enterprise scope. - """ - ownerInfo: EnterpriseOwnerInfo - - """ - The HTTP path for this enterprise. - """ - resourcePath: URI! - - """ - The URL-friendly identifier for the enterprise. - """ - slug: String! - - """ - The HTTP URL for this enterprise. - """ - url: URI! - - """ - Is the current viewer an admin of this enterprise? - """ - viewerIsAdmin: Boolean! - - """ - The URL of the enterprise website. - """ - websiteUrl: URI -} - -""" -The connection type for User. -""" -type EnterpriseAdministratorConnection { - """ - A list of edges. - """ - edges: [EnterpriseAdministratorEdge] - - """ - A list of nodes. - """ - nodes: [User] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -A User who is an administrator of an enterprise. -""" -type EnterpriseAdministratorEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: User - - """ - The role of the administrator. - """ - role: EnterpriseAdministratorRole! -} - -""" -An invitation for a user to become an owner or billing manager of an enterprise. -""" -type EnterpriseAdministratorInvitation implements Node { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The email of the person who was invited to the enterprise. - """ - email: String - - """ - The enterprise the invitation is for. - """ - enterprise: Enterprise! - - """ - The Node ID of the EnterpriseAdministratorInvitation object - """ - id: ID! - - """ - The user who was invited to the enterprise. - """ - invitee: User - - """ - The user who created the invitation. - """ - inviter: User - - """ - The invitee's pending role in the enterprise (owner or billing_manager). - """ - role: EnterpriseAdministratorRole! -} - -""" -The connection type for EnterpriseAdministratorInvitation. -""" -type EnterpriseAdministratorInvitationConnection { - """ - A list of edges. - """ - edges: [EnterpriseAdministratorInvitationEdge] - - """ - A list of nodes. - """ - nodes: [EnterpriseAdministratorInvitation] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type EnterpriseAdministratorInvitationEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: EnterpriseAdministratorInvitation -} - -""" -Ordering options for enterprise administrator invitation connections -""" -input EnterpriseAdministratorInvitationOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order enterprise administrator invitations by. - """ - field: EnterpriseAdministratorInvitationOrderField! -} - -""" -Properties by which enterprise administrator invitation connections can be ordered. -""" -enum EnterpriseAdministratorInvitationOrderField { - """ - Order enterprise administrator member invitations by creation time - """ - CREATED_AT -} - -""" -The possible administrator roles in an enterprise account. -""" -enum EnterpriseAdministratorRole { - """ - Represents a billing manager of the enterprise account. - """ - BILLING_MANAGER - - """ - Represents an owner of the enterprise account. - """ - OWNER -} - -""" -The possible values for the enterprise allow private repository forking policy value. -""" -enum EnterpriseAllowPrivateRepositoryForkingPolicyValue { - """ - Members can fork a repository to an organization within this enterprise. - """ - ENTERPRISE_ORGANIZATIONS - - """ - Members can fork a repository to their enterprise-managed user account or an organization inside this enterprise. - """ - ENTERPRISE_ORGANIZATIONS_USER_ACCOUNTS - - """ - Members can fork a repository to their user account or an organization, either inside or outside of this enterprise. - """ - EVERYWHERE - - """ - Members can fork a repository only within the same organization (intra-org). - """ - SAME_ORGANIZATION - - """ - Members can fork a repository to their user account or within the same organization. - """ - SAME_ORGANIZATION_USER_ACCOUNTS - - """ - Members can fork a repository to their user account. - """ - USER_ACCOUNTS -} - -""" -Metadata for an audit entry containing enterprise account information. -""" -interface EnterpriseAuditEntryData { - """ - The HTTP path for this enterprise. - """ - enterpriseResourcePath: URI - - """ - The slug of the enterprise. - """ - enterpriseSlug: String - - """ - The HTTP URL for this enterprise. - """ - enterpriseUrl: URI -} - -""" -Enterprise billing information visible to enterprise billing managers and owners. -""" -type EnterpriseBillingInfo { - """ - The number of licenseable users/emails across the enterprise. - """ - allLicensableUsersCount: Int! - - """ - The number of data packs used by all organizations owned by the enterprise. - """ - assetPacks: Int! - - """ - The bandwidth quota in GB for all organizations owned by the enterprise. - """ - bandwidthQuota: Float! - - """ - The bandwidth usage in GB for all organizations owned by the enterprise. - """ - bandwidthUsage: Float! - - """ - The bandwidth usage as a percentage of the bandwidth quota. - """ - bandwidthUsagePercentage: Int! - - """ - The storage quota in GB for all organizations owned by the enterprise. - """ - storageQuota: Float! - - """ - The storage usage in GB for all organizations owned by the enterprise. - """ - storageUsage: Float! - - """ - The storage usage as a percentage of the storage quota. - """ - storageUsagePercentage: Int! - - """ - The number of available licenses across all owned organizations based on the unique number of billable users. - """ - totalAvailableLicenses: Int! - - """ - The total number of licenses allocated. - """ - totalLicenses: Int! -} - -""" -The connection type for Enterprise. -""" -type EnterpriseConnection { - """ - A list of edges. - """ - edges: [EnterpriseEdge] - - """ - A list of nodes. - """ - nodes: [Enterprise] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -The possible values for the enterprise base repository permission setting. -""" -enum EnterpriseDefaultRepositoryPermissionSettingValue { - """ - Organization members will be able to clone, pull, push, and add new collaborators to all organization repositories. - """ - ADMIN - - """ - Organization members will only be able to clone and pull public repositories. - """ - NONE - - """ - Organizations in the enterprise choose base repository permissions for their members. - """ - NO_POLICY - - """ - Organization members will be able to clone and pull all organization repositories. - """ - READ - - """ - Organization members will be able to clone, pull, and push all organization repositories. - """ - WRITE -} - -""" -An edge in a connection. -""" -type EnterpriseEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Enterprise -} - -""" -The possible values for an enabled/disabled enterprise setting. -""" -enum EnterpriseEnabledDisabledSettingValue { - """ - The setting is disabled for organizations in the enterprise. - """ - DISABLED - - """ - The setting is enabled for organizations in the enterprise. - """ - ENABLED - - """ - There is no policy set for organizations in the enterprise. - """ - NO_POLICY -} - -""" -The possible values for an enabled/no policy enterprise setting. -""" -enum EnterpriseEnabledSettingValue { - """ - The setting is enabled for organizations in the enterprise. - """ - ENABLED - - """ - There is no policy set for organizations in the enterprise. - """ - NO_POLICY -} - -""" -The connection type for OrganizationInvitation. -""" -type EnterpriseFailedInvitationConnection { - """ - A list of edges. - """ - edges: [EnterpriseFailedInvitationEdge] - - """ - A list of nodes. - """ - nodes: [OrganizationInvitation] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! - - """ - Identifies the total count of unique users in the connection. - """ - totalUniqueUserCount: Int! -} - -""" -A failed invitation to be a member in an enterprise organization. -""" -type EnterpriseFailedInvitationEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: OrganizationInvitation -} - -""" -An identity provider configured to provision identities for an enterprise. -Visible to enterprise owners or enterprise owners' personal access tokens -(classic) with read:enterprise or admin:enterprise scope. -""" -type EnterpriseIdentityProvider implements Node { - """ - The digest algorithm used to sign SAML requests for the identity provider. - """ - digestMethod: SamlDigestAlgorithm - - """ - The enterprise this identity provider belongs to. - """ - enterprise: Enterprise - - """ - ExternalIdentities provisioned by this identity provider. - """ - externalIdentities( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filter to external identities with the users login - """ - login: String - - """ - Filter to external identities with valid org membership only - """ - membersOnly: Boolean - - """ - Filter to external identities with the users userName/NameID attribute - """ - userName: String - ): ExternalIdentityConnection! - - """ - The Node ID of the EnterpriseIdentityProvider object - """ - id: ID! - - """ - The x509 certificate used by the identity provider to sign assertions and responses. - """ - idpCertificate: X509Certificate - - """ - The Issuer Entity ID for the SAML identity provider. - """ - issuer: String - - """ - Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable. - """ - recoveryCodes: [String!] - - """ - The signature algorithm used to sign SAML requests for the identity provider. - """ - signatureMethod: SamlSignatureAlgorithm - - """ - The URL endpoint for the identity provider's SAML SSO. - """ - ssoUrl: URI -} - -""" -An object that is a member of an enterprise. -""" -union EnterpriseMember = EnterpriseUserAccount | User - -""" -The connection type for EnterpriseMember. -""" -type EnterpriseMemberConnection { - """ - A list of edges. - """ - edges: [EnterpriseMemberEdge] - - """ - A list of nodes. - """ - nodes: [EnterpriseMember] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -A User who is a member of an enterprise through one or more organizations. -""" -type EnterpriseMemberEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: EnterpriseMember -} - -""" -Ordering options for enterprise member connections. -""" -input EnterpriseMemberOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order enterprise members by. - """ - field: EnterpriseMemberOrderField! -} - -""" -Properties by which enterprise member connections can be ordered. -""" -enum EnterpriseMemberOrderField { - """ - Order enterprise members by creation time - """ - CREATED_AT - - """ - Order enterprise members by login - """ - LOGIN -} - -""" -The possible values for the enterprise members can create repositories setting. -""" -enum EnterpriseMembersCanCreateRepositoriesSettingValue { - """ - Members will be able to create public and private repositories. - """ - ALL - - """ - Members will not be able to create public or private repositories. - """ - DISABLED - - """ - Organization owners choose whether to allow members to create repositories. - """ - NO_POLICY - - """ - Members will be able to create only private repositories. - """ - PRIVATE - - """ - Members will be able to create only public repositories. - """ - PUBLIC -} - -""" -The possible values for the members can make purchases setting. -""" -enum EnterpriseMembersCanMakePurchasesSettingValue { - """ - The setting is disabled for organizations in the enterprise. - """ - DISABLED - - """ - The setting is enabled for organizations in the enterprise. - """ - ENABLED -} - -""" -The possible values we have for filtering Platform::Objects::User#enterprises. -""" -enum EnterpriseMembershipType { - """ - Returns all enterprises in which the user is an admin. - """ - ADMIN - - """ - Returns all enterprises in which the user is a member, admin, or billing manager. - """ - ALL - - """ - Returns all enterprises in which the user is a billing manager. - """ - BILLING_MANAGER - - """ - Returns all enterprises in which the user is a member of an org that is owned by the enterprise. - """ - ORG_MEMBERSHIP -} - -""" -Ordering options for enterprises. -""" -input EnterpriseOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order enterprises by. - """ - field: EnterpriseOrderField! -} - -""" -Properties by which enterprise connections can be ordered. -""" -enum EnterpriseOrderField { - """ - Order enterprises by name - """ - NAME -} - -""" -The connection type for Organization. -""" -type EnterpriseOrganizationMembershipConnection { - """ - A list of edges. - """ - edges: [EnterpriseOrganizationMembershipEdge] - - """ - A list of nodes. - """ - nodes: [Organization] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An enterprise organization that a user is a member of. -""" -type EnterpriseOrganizationMembershipEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Organization - - """ - The role of the user in the enterprise membership. - """ - role: EnterpriseUserAccountMembershipRole! -} - -""" -The connection type for User. -""" -type EnterpriseOutsideCollaboratorConnection { - """ - A list of edges. - """ - edges: [EnterpriseOutsideCollaboratorEdge] - - """ - A list of nodes. - """ - nodes: [User] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -A User who is an outside collaborator of an enterprise through one or more organizations. -""" -type EnterpriseOutsideCollaboratorEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: User - - """ - The enterprise organization repositories this user is a member of. - """ - repositories( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for repositories. - """ - orderBy: RepositoryOrder = {field: NAME, direction: ASC} - ): EnterpriseRepositoryInfoConnection! -} - -""" -Enterprise information visible to enterprise owners or enterprise owners' -personal access tokens (classic) with read:enterprise or admin:enterprise scope. -""" -type EnterpriseOwnerInfo { - """ - A list of all of the administrators for this enterprise. - """ - admins( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Only return administrators with this two-factor authentication status. - """ - hasTwoFactorEnabled: Boolean = null - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for administrators returned from the connection. - """ - orderBy: EnterpriseMemberOrder = {field: LOGIN, direction: ASC} - - """ - Only return members within the organizations with these logins - """ - organizationLogins: [String!] - - """ - The search string to look for. - """ - query: String - - """ - The role to filter by. - """ - role: EnterpriseAdministratorRole - ): EnterpriseAdministratorConnection! - - """ - A list of users in the enterprise who currently have two-factor authentication disabled. - """ - affiliatedUsersWithTwoFactorDisabled( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserConnection! - - """ - Whether or not affiliated users with two-factor authentication disabled exist in the enterprise. - """ - affiliatedUsersWithTwoFactorDisabledExist: Boolean! - - """ - The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise. - """ - allowPrivateRepositoryForkingSetting: EnterpriseEnabledDisabledSettingValue! - - """ - A list of enterprise organizations configured with the provided private repository forking setting value. - """ - allowPrivateRepositoryForkingSettingOrganizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for organizations with this setting. - """ - orderBy: OrganizationOrder = {field: LOGIN, direction: ASC} - - """ - The setting value to find organizations for. - """ - value: Boolean! - ): OrganizationConnection! - - """ - The value for the allow private repository forking policy on the enterprise. - """ - allowPrivateRepositoryForkingSettingPolicyValue: EnterpriseAllowPrivateRepositoryForkingPolicyValue - - """ - The setting value for base repository permissions for organizations in this enterprise. - """ - defaultRepositoryPermissionSetting: EnterpriseDefaultRepositoryPermissionSettingValue! - - """ - A list of enterprise organizations configured with the provided base repository permission. - """ - defaultRepositoryPermissionSettingOrganizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for organizations with this setting. - """ - orderBy: OrganizationOrder = {field: LOGIN, direction: ASC} - - """ - The permission to find organizations for. - """ - value: DefaultRepositoryPermissionField! - ): OrganizationConnection! - - """ - A list of domains owned by the enterprise. Visible to enterprise owners or - enterprise owners' personal access tokens (classic) with admin:enterprise scope. - """ - domains( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Filter whether or not the domain is approved. - """ - isApproved: Boolean = null - - """ - Filter whether or not the domain is verified. - """ - isVerified: Boolean = null - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for verifiable domains returned. - """ - orderBy: VerifiableDomainOrder = {field: DOMAIN, direction: ASC} - ): VerifiableDomainConnection! - - """ - A list of failed invitations in the enterprise. - """ - failedInvitations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - The search string to look for. - """ - query: String - ): EnterpriseFailedInvitationConnection! - - """ - The setting value for whether the enterprise has an IP allow list enabled. - """ - ipAllowListEnabledSetting: IpAllowListEnabledSettingValue! - - """ - The IP addresses that are allowed to access resources owned by the enterprise. - Visible to enterprise owners or enterprise owners' personal access tokens - (classic) with admin:enterprise scope. - """ - ipAllowListEntries( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for IP allow list entries returned. - """ - orderBy: IpAllowListEntryOrder = {field: ALLOW_LIST_VALUE, direction: ASC} - ): IpAllowListEntryConnection! - - """ - The setting value for whether the enterprise has IP allow list configuration for installed GitHub Apps enabled. - """ - ipAllowListForInstalledAppsEnabledSetting: IpAllowListForInstalledAppsEnabledSettingValue! - - """ - Whether or not the base repository permission is currently being updated. - """ - isUpdatingDefaultRepositoryPermission: Boolean! - - """ - Whether the two-factor authentication requirement is currently being enforced. - """ - isUpdatingTwoFactorRequirement: Boolean! - - """ - The setting value for whether organization members with admin permissions on a - repository can change repository visibility. - """ - membersCanChangeRepositoryVisibilitySetting: EnterpriseEnabledDisabledSettingValue! - - """ - A list of enterprise organizations configured with the provided can change repository visibility setting value. - """ - membersCanChangeRepositoryVisibilitySettingOrganizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for organizations with this setting. - """ - orderBy: OrganizationOrder = {field: LOGIN, direction: ASC} - - """ - The setting value to find organizations for. - """ - value: Boolean! - ): OrganizationConnection! - - """ - The setting value for whether members of organizations in the enterprise can create internal repositories. - """ - membersCanCreateInternalRepositoriesSetting: Boolean - - """ - The setting value for whether members of organizations in the enterprise can create private repositories. - """ - membersCanCreatePrivateRepositoriesSetting: Boolean - - """ - The setting value for whether members of organizations in the enterprise can create public repositories. - """ - membersCanCreatePublicRepositoriesSetting: Boolean - - """ - The setting value for whether members of organizations in the enterprise can create repositories. - """ - membersCanCreateRepositoriesSetting: EnterpriseMembersCanCreateRepositoriesSettingValue - - """ - A list of enterprise organizations configured with the provided repository creation setting value. - """ - membersCanCreateRepositoriesSettingOrganizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for organizations with this setting. - """ - orderBy: OrganizationOrder = {field: LOGIN, direction: ASC} - - """ - The setting to find organizations for. - """ - value: OrganizationMembersCanCreateRepositoriesSettingValue! - ): OrganizationConnection! - - """ - The setting value for whether members with admin permissions for repositories can delete issues. - """ - membersCanDeleteIssuesSetting: EnterpriseEnabledDisabledSettingValue! - - """ - A list of enterprise organizations configured with the provided members can delete issues setting value. - """ - membersCanDeleteIssuesSettingOrganizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for organizations with this setting. - """ - orderBy: OrganizationOrder = {field: LOGIN, direction: ASC} - - """ - The setting value to find organizations for. - """ - value: Boolean! - ): OrganizationConnection! - - """ - The setting value for whether members with admin permissions for repositories can delete or transfer repositories. - """ - membersCanDeleteRepositoriesSetting: EnterpriseEnabledDisabledSettingValue! - - """ - A list of enterprise organizations configured with the provided members can delete repositories setting value. - """ - membersCanDeleteRepositoriesSettingOrganizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for organizations with this setting. - """ - orderBy: OrganizationOrder = {field: LOGIN, direction: ASC} - - """ - The setting value to find organizations for. - """ - value: Boolean! - ): OrganizationConnection! - - """ - The setting value for whether members of organizations in the enterprise can invite outside collaborators. - """ - membersCanInviteCollaboratorsSetting: EnterpriseEnabledDisabledSettingValue! - - """ - A list of enterprise organizations configured with the provided members can invite collaborators setting value. - """ - membersCanInviteCollaboratorsSettingOrganizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for organizations with this setting. - """ - orderBy: OrganizationOrder = {field: LOGIN, direction: ASC} - - """ - The setting value to find organizations for. - """ - value: Boolean! - ): OrganizationConnection! - - """ - Indicates whether members of this enterprise's organizations can purchase additional services for those organizations. - """ - membersCanMakePurchasesSetting: EnterpriseMembersCanMakePurchasesSettingValue! - - """ - The setting value for whether members with admin permissions for repositories can update protected branches. - """ - membersCanUpdateProtectedBranchesSetting: EnterpriseEnabledDisabledSettingValue! - - """ - A list of enterprise organizations configured with the provided members can update protected branches setting value. - """ - membersCanUpdateProtectedBranchesSettingOrganizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for organizations with this setting. - """ - orderBy: OrganizationOrder = {field: LOGIN, direction: ASC} - - """ - The setting value to find organizations for. - """ - value: Boolean! - ): OrganizationConnection! - - """ - The setting value for whether members can view dependency insights. - """ - membersCanViewDependencyInsightsSetting: EnterpriseEnabledDisabledSettingValue! - - """ - A list of enterprise organizations configured with the provided members can view dependency insights setting value. - """ - membersCanViewDependencyInsightsSettingOrganizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for organizations with this setting. - """ - orderBy: OrganizationOrder = {field: LOGIN, direction: ASC} - - """ - The setting value to find organizations for. - """ - value: Boolean! - ): OrganizationConnection! - - """ - Indicates if email notification delivery for this enterprise is restricted to verified or approved domains. - """ - notificationDeliveryRestrictionEnabledSetting: NotificationRestrictionSettingValue! - - """ - The setting value for whether organization projects are enabled for organizations in this enterprise. - """ - organizationProjectsSetting: EnterpriseEnabledDisabledSettingValue! - - """ - A list of enterprise organizations configured with the provided organization projects setting value. - """ - organizationProjectsSettingOrganizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for organizations with this setting. - """ - orderBy: OrganizationOrder = {field: LOGIN, direction: ASC} - - """ - The setting value to find organizations for. - """ - value: Boolean! - ): OrganizationConnection! - - """ - A list of outside collaborators across the repositories in the enterprise. - """ - outsideCollaborators( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Only return outside collaborators with this two-factor authentication status. - """ - hasTwoFactorEnabled: Boolean = null - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - The login of one specific outside collaborator. - """ - login: String - - """ - Ordering options for outside collaborators returned from the connection. - """ - orderBy: EnterpriseMemberOrder = {field: LOGIN, direction: ASC} - - """ - Only return outside collaborators within the organizations with these logins - """ - organizationLogins: [String!] - - """ - The search string to look for. - """ - query: String - - """ - Only return outside collaborators on repositories with this visibility. - """ - visibility: RepositoryVisibility - ): EnterpriseOutsideCollaboratorConnection! - - """ - A list of pending administrator invitations for the enterprise. - """ - pendingAdminInvitations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for pending enterprise administrator invitations returned from the connection. - """ - orderBy: EnterpriseAdministratorInvitationOrder = {field: CREATED_AT, direction: DESC} - - """ - The search string to look for. - """ - query: String - - """ - The role to filter by. - """ - role: EnterpriseAdministratorRole - ): EnterpriseAdministratorInvitationConnection! - - """ - A list of pending collaborator invitations across the repositories in the enterprise. - """ - pendingCollaboratorInvitations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for pending repository collaborator invitations returned from the connection. - """ - orderBy: RepositoryInvitationOrder = {field: CREATED_AT, direction: DESC} - - """ - The search string to look for. - """ - query: String - ): RepositoryInvitationConnection! - - """ - A list of pending member invitations for organizations in the enterprise. - """ - pendingMemberInvitations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Only return invitations matching this invitation source - """ - invitationSource: OrganizationInvitationSource - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Only return invitations within the organizations with these logins - """ - organizationLogins: [String!] - - """ - The search string to look for. - """ - query: String - ): EnterprisePendingMemberInvitationConnection! - - """ - The setting value for whether repository projects are enabled in this enterprise. - """ - repositoryProjectsSetting: EnterpriseEnabledDisabledSettingValue! - - """ - A list of enterprise organizations configured with the provided repository projects setting value. - """ - repositoryProjectsSettingOrganizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for organizations with this setting. - """ - orderBy: OrganizationOrder = {field: LOGIN, direction: ASC} - - """ - The setting value to find organizations for. - """ - value: Boolean! - ): OrganizationConnection! - - """ - The SAML Identity Provider for the enterprise. - """ - samlIdentityProvider: EnterpriseIdentityProvider - - """ - A list of enterprise organizations configured with the SAML single sign-on setting value. - """ - samlIdentityProviderSettingOrganizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for organizations with this setting. - """ - orderBy: OrganizationOrder = {field: LOGIN, direction: ASC} - - """ - The setting value to find organizations for. - """ - value: IdentityProviderConfigurationState! - ): OrganizationConnection! - - """ - The setting value for whether team discussions are enabled for organizations in this enterprise. - """ - teamDiscussionsSetting: EnterpriseEnabledDisabledSettingValue! - - """ - A list of enterprise organizations configured with the provided team discussions setting value. - """ - teamDiscussionsSettingOrganizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for organizations with this setting. - """ - orderBy: OrganizationOrder = {field: LOGIN, direction: ASC} - - """ - The setting value to find organizations for. - """ - value: Boolean! - ): OrganizationConnection! - - """ - The setting value for whether the enterprise requires two-factor authentication for its organizations and users. - """ - twoFactorRequiredSetting: EnterpriseEnabledSettingValue! - - """ - A list of enterprise organizations configured with the two-factor authentication setting value. - """ - twoFactorRequiredSettingOrganizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for organizations with this setting. - """ - orderBy: OrganizationOrder = {field: LOGIN, direction: ASC} - - """ - The setting value to find organizations for. - """ - value: Boolean! - ): OrganizationConnection! -} - -""" -The connection type for OrganizationInvitation. -""" -type EnterprisePendingMemberInvitationConnection { - """ - A list of edges. - """ - edges: [EnterprisePendingMemberInvitationEdge] - - """ - A list of nodes. - """ - nodes: [OrganizationInvitation] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! - - """ - Identifies the total count of unique users in the connection. - """ - totalUniqueUserCount: Int! -} - -""" -An invitation to be a member in an enterprise organization. -""" -type EnterprisePendingMemberInvitationEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: OrganizationInvitation -} - -""" -A subset of repository information queryable from an enterprise. -""" -type EnterpriseRepositoryInfo implements Node { - """ - The Node ID of the EnterpriseRepositoryInfo object - """ - id: ID! - - """ - Identifies if the repository is private or internal. - """ - isPrivate: Boolean! - - """ - The repository's name. - """ - name: String! - - """ - The repository's name with owner. - """ - nameWithOwner: String! -} - -""" -The connection type for EnterpriseRepositoryInfo. -""" -type EnterpriseRepositoryInfoConnection { - """ - A list of edges. - """ - edges: [EnterpriseRepositoryInfoEdge] - - """ - A list of nodes. - """ - nodes: [EnterpriseRepositoryInfo] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type EnterpriseRepositoryInfoEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: EnterpriseRepositoryInfo -} - -""" -An Enterprise Server installation. -""" -type EnterpriseServerInstallation implements Node { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The customer name to which the Enterprise Server installation belongs. - """ - customerName: String! - - """ - The host name of the Enterprise Server installation. - """ - hostName: String! - - """ - The Node ID of the EnterpriseServerInstallation object - """ - id: ID! - - """ - Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect. - """ - isConnected: Boolean! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - User accounts on this Enterprise Server installation. - """ - userAccounts( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for Enterprise Server user accounts returned from the connection. - """ - orderBy: EnterpriseServerUserAccountOrder = {field: LOGIN, direction: ASC} - ): EnterpriseServerUserAccountConnection! - - """ - User accounts uploads for the Enterprise Server installation. - """ - userAccountsUploads( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for Enterprise Server user accounts uploads returned from the connection. - """ - orderBy: EnterpriseServerUserAccountsUploadOrder = {field: CREATED_AT, direction: DESC} - ): EnterpriseServerUserAccountsUploadConnection! -} - -""" -The connection type for EnterpriseServerInstallation. -""" -type EnterpriseServerInstallationMembershipConnection { - """ - A list of edges. - """ - edges: [EnterpriseServerInstallationMembershipEdge] - - """ - A list of nodes. - """ - nodes: [EnterpriseServerInstallation] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An Enterprise Server installation that a user is a member of. -""" -type EnterpriseServerInstallationMembershipEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: EnterpriseServerInstallation - - """ - The role of the user in the enterprise membership. - """ - role: EnterpriseUserAccountMembershipRole! -} - -""" -Ordering options for Enterprise Server installation connections. -""" -input EnterpriseServerInstallationOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order Enterprise Server installations by. - """ - field: EnterpriseServerInstallationOrderField! -} - -""" -Properties by which Enterprise Server installation connections can be ordered. -""" -enum EnterpriseServerInstallationOrderField { - """ - Order Enterprise Server installations by creation time - """ - CREATED_AT - - """ - Order Enterprise Server installations by customer name - """ - CUSTOMER_NAME - - """ - Order Enterprise Server installations by host name - """ - HOST_NAME -} - -""" -A user account on an Enterprise Server installation. -""" -type EnterpriseServerUserAccount implements Node { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - User emails belonging to this user account. - """ - emails( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for Enterprise Server user account emails returned from the connection. - """ - orderBy: EnterpriseServerUserAccountEmailOrder = {field: EMAIL, direction: ASC} - ): EnterpriseServerUserAccountEmailConnection! - - """ - The Enterprise Server installation on which this user account exists. - """ - enterpriseServerInstallation: EnterpriseServerInstallation! - - """ - The Node ID of the EnterpriseServerUserAccount object - """ - id: ID! - - """ - Whether the user account is a site administrator on the Enterprise Server installation. - """ - isSiteAdmin: Boolean! - - """ - The login of the user account on the Enterprise Server installation. - """ - login: String! - - """ - The profile name of the user account on the Enterprise Server installation. - """ - profileName: String - - """ - The date and time when the user account was created on the Enterprise Server installation. - """ - remoteCreatedAt: DateTime! - - """ - The ID of the user account on the Enterprise Server installation. - """ - remoteUserId: Int! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -The connection type for EnterpriseServerUserAccount. -""" -type EnterpriseServerUserAccountConnection { - """ - A list of edges. - """ - edges: [EnterpriseServerUserAccountEdge] - - """ - A list of nodes. - """ - nodes: [EnterpriseServerUserAccount] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type EnterpriseServerUserAccountEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: EnterpriseServerUserAccount -} - -""" -An email belonging to a user account on an Enterprise Server installation. -""" -type EnterpriseServerUserAccountEmail implements Node { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The email address. - """ - email: String! - - """ - The Node ID of the EnterpriseServerUserAccountEmail object - """ - id: ID! - - """ - Indicates whether this is the primary email of the associated user account. - """ - isPrimary: Boolean! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The user account to which the email belongs. - """ - userAccount: EnterpriseServerUserAccount! -} - -""" -The connection type for EnterpriseServerUserAccountEmail. -""" -type EnterpriseServerUserAccountEmailConnection { - """ - A list of edges. - """ - edges: [EnterpriseServerUserAccountEmailEdge] - - """ - A list of nodes. - """ - nodes: [EnterpriseServerUserAccountEmail] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type EnterpriseServerUserAccountEmailEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: EnterpriseServerUserAccountEmail -} - -""" -Ordering options for Enterprise Server user account email connections. -""" -input EnterpriseServerUserAccountEmailOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order emails by. - """ - field: EnterpriseServerUserAccountEmailOrderField! -} - -""" -Properties by which Enterprise Server user account email connections can be ordered. -""" -enum EnterpriseServerUserAccountEmailOrderField { - """ - Order emails by email - """ - EMAIL -} - -""" -Ordering options for Enterprise Server user account connections. -""" -input EnterpriseServerUserAccountOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order user accounts by. - """ - field: EnterpriseServerUserAccountOrderField! -} - -""" -Properties by which Enterprise Server user account connections can be ordered. -""" -enum EnterpriseServerUserAccountOrderField { - """ - Order user accounts by login - """ - LOGIN - - """ - Order user accounts by creation time on the Enterprise Server installation - """ - REMOTE_CREATED_AT -} - -""" -A user accounts upload from an Enterprise Server installation. -""" -type EnterpriseServerUserAccountsUpload implements Node { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The enterprise to which this upload belongs. - """ - enterprise: Enterprise! - - """ - The Enterprise Server installation for which this upload was generated. - """ - enterpriseServerInstallation: EnterpriseServerInstallation! - - """ - The Node ID of the EnterpriseServerUserAccountsUpload object - """ - id: ID! - - """ - The name of the file uploaded. - """ - name: String! - - """ - The synchronization state of the upload - """ - syncState: EnterpriseServerUserAccountsUploadSyncState! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -The connection type for EnterpriseServerUserAccountsUpload. -""" -type EnterpriseServerUserAccountsUploadConnection { - """ - A list of edges. - """ - edges: [EnterpriseServerUserAccountsUploadEdge] - - """ - A list of nodes. - """ - nodes: [EnterpriseServerUserAccountsUpload] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type EnterpriseServerUserAccountsUploadEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: EnterpriseServerUserAccountsUpload -} - -""" -Ordering options for Enterprise Server user accounts upload connections. -""" -input EnterpriseServerUserAccountsUploadOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order user accounts uploads by. - """ - field: EnterpriseServerUserAccountsUploadOrderField! -} - -""" -Properties by which Enterprise Server user accounts upload connections can be ordered. -""" -enum EnterpriseServerUserAccountsUploadOrderField { - """ - Order user accounts uploads by creation time - """ - CREATED_AT -} - -""" -Synchronization state of the Enterprise Server user accounts upload -""" -enum EnterpriseServerUserAccountsUploadSyncState { - """ - The synchronization of the upload failed. - """ - FAILURE - - """ - The synchronization of the upload is pending. - """ - PENDING - - """ - The synchronization of the upload succeeded. - """ - SUCCESS -} - -""" -An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations. -""" -type EnterpriseUserAccount implements Actor & Node { - """ - A URL pointing to the enterprise user account's public avatar. - """ - avatarUrl( - """ - The size of the resulting square image. - """ - size: Int - ): URI! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The enterprise in which this user account exists. - """ - enterprise: Enterprise! - - """ - A list of Enterprise Server installations this user is a member of. - """ - enterpriseInstallations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for installations returned from the connection. - """ - orderBy: EnterpriseServerInstallationOrder = {field: HOST_NAME, direction: ASC} - - """ - The search string to look for. - """ - query: String - - """ - The role of the user in the installation. - """ - role: EnterpriseUserAccountMembershipRole - ): EnterpriseServerInstallationMembershipConnection! - - """ - The Node ID of the EnterpriseUserAccount object - """ - id: ID! - - """ - An identifier for the enterprise user account, a login or email address - """ - login: String! - - """ - The name of the enterprise user account - """ - name: String - - """ - A list of enterprise organizations this user is a member of. - """ - organizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for organizations returned from the connection. - """ - orderBy: OrganizationOrder = {field: LOGIN, direction: ASC} - - """ - The search string to look for. - """ - query: String - - """ - The role of the user in the enterprise organization. - """ - role: EnterpriseUserAccountMembershipRole - ): EnterpriseOrganizationMembershipConnection! - - """ - The HTTP path for this user. - """ - resourcePath: URI! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this user. - """ - url: URI! - - """ - The user within the enterprise. - """ - user: User -} - -""" -The possible roles for enterprise membership. -""" -enum EnterpriseUserAccountMembershipRole { - """ - The user is a member of an organization in the enterprise. - """ - MEMBER - - """ - The user is an owner of an organization in the enterprise. - """ - OWNER -} - -""" -The possible GitHub Enterprise deployments where this user can exist. -""" -enum EnterpriseUserDeployment { - """ - The user is part of a GitHub Enterprise Cloud deployment. - """ - CLOUD - - """ - The user is part of a GitHub Enterprise Server deployment. - """ - SERVER -} - -""" -An environment. -""" -type Environment implements Node { - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the Environment object - """ - id: ID! - - """ - Indicates whether or not this environment is currently pinned to the repository - """ - isPinned: Boolean - - """ - The latest completed deployment with status success, failure, or error if it exists - """ - latestCompletedDeployment: Deployment - - """ - The name of the environment - """ - name: String! - - """ - The position of the environment if it is pinned, null if it is not pinned - """ - pinnedPosition: Int - - """ - The protection rules defined for this environment - """ - protectionRules( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): DeploymentProtectionRuleConnection! -} - -""" -The connection type for Environment. -""" -type EnvironmentConnection { - """ - A list of edges. - """ - edges: [EnvironmentEdge] - - """ - A list of nodes. - """ - nodes: [Environment] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type EnvironmentEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Environment -} - -""" -Properties by which environments connections can be ordered -""" -enum EnvironmentOrderField { - """ - Order environments by name. - """ - NAME -} - -""" -Properties by which environments connections can be ordered -""" -enum EnvironmentPinnedFilterField { - """ - All environments will be returned. - """ - ALL - - """ - Environments exclude pinned will be returned - """ - NONE - - """ - Only pinned environment will be returned - """ - ONLY -} - -""" -Ordering options for environments -""" -input Environments { - """ - The direction in which to order environments by the specified field. - """ - direction: OrderDirection! - - """ - The field to order environments by. - """ - field: EnvironmentOrderField! -} - -""" -An external identity provisioned by SAML SSO or SCIM. If SAML is configured on -the organization, the external identity is visible to (1) organization owners, -(2) organization owners' personal access tokens (classic) with read:org or -admin:org scope, (3) GitHub App with an installation token with read or write -access to members. If SAML is configured on the enterprise, the external -identity is visible to (1) enterprise owners, (2) enterprise owners' personal -access tokens (classic) with read:enterprise or admin:enterprise scope. -""" -type ExternalIdentity implements Node { - """ - The GUID for this identity - """ - guid: String! - - """ - The Node ID of the ExternalIdentity object - """ - id: ID! - - """ - Organization invitation for this SCIM-provisioned external identity - """ - organizationInvitation: OrganizationInvitation - - """ - SAML Identity attributes - """ - samlIdentity: ExternalIdentitySamlAttributes - - """ - SCIM Identity attributes - """ - scimIdentity: ExternalIdentityScimAttributes - - """ - User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member. - """ - user: User -} - -""" -An attribute for the External Identity attributes collection -""" -type ExternalIdentityAttribute { - """ - The attribute metadata as JSON - """ - metadata: String - - """ - The attribute name - """ - name: String! - - """ - The attribute value - """ - value: String! -} - -""" -The connection type for ExternalIdentity. -""" -type ExternalIdentityConnection { - """ - A list of edges. - """ - edges: [ExternalIdentityEdge] - - """ - A list of nodes. - """ - nodes: [ExternalIdentity] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type ExternalIdentityEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: ExternalIdentity -} - -""" -SAML attributes for the External Identity -""" -type ExternalIdentitySamlAttributes { - """ - SAML Identity attributes - """ - attributes: [ExternalIdentityAttribute!]! - - """ - The emails associated with the SAML identity - """ - emails: [UserEmailMetadata!] - - """ - Family name of the SAML identity - """ - familyName: String - - """ - Given name of the SAML identity - """ - givenName: String - - """ - The groups linked to this identity in IDP - """ - groups: [String!] - - """ - The NameID of the SAML identity - """ - nameId: String - - """ - The userName of the SAML identity - """ - username: String -} - -""" -SCIM attributes for the External Identity -""" -type ExternalIdentityScimAttributes { - """ - The emails associated with the SCIM identity - """ - emails: [UserEmailMetadata!] - - """ - Family name of the SCIM identity - """ - familyName: String - - """ - Given name of the SCIM identity - """ - givenName: String - - """ - The groups linked to this identity in IDP - """ - groups: [String!] - - """ - The userName of the SCIM identity - """ - username: String -} - -""" -A command to add a file at the given path with the given contents as part of a -commit. Any existing file at that that path will be replaced. -""" -input FileAddition { - """ - The base64 encoded contents of the file - """ - contents: Base64String! - - """ - The path in the repository where the file will be located - """ - path: String! -} - -""" -A description of a set of changes to a file tree to be made as part of -a git commit, modeled as zero or more file `additions` and zero or more -file `deletions`. - -Both fields are optional; omitting both will produce a commit with no -file changes. - -`deletions` and `additions` describe changes to files identified -by their path in the git tree using unix-style path separators, i.e. -`/`. The root of a git tree is an empty string, so paths are not -slash-prefixed. - -`path` values must be unique across all `additions` and `deletions` -provided. Any duplication will result in a validation error. - -### Encoding - -File contents must be provided in full for each `FileAddition`. - -The `contents` of a `FileAddition` must be encoded using RFC 4648 -compliant base64, i.e. correct padding is required and no characters -outside the standard alphabet may be used. Invalid base64 -encoding will be rejected with a validation error. - -The encoded contents may be binary. - -For text files, no assumptions are made about the character encoding of -the file contents (after base64 decoding). No charset transcoding or -line-ending normalization will be performed; it is the client's -responsibility to manage the character encoding of files they provide. -However, for maximum compatibility we recommend using UTF-8 encoding -and ensuring that all files in a repository use a consistent -line-ending convention (`\n` or `\r\n`), and that all files end -with a newline. - -### Modeling file changes - -Each of the the five types of conceptual changes that can be made in a -git commit can be described using the `FileChanges` type as follows: - -1. New file addition: create file `hello world\n` at path `docs/README.txt`: - - { - "additions" [ - { - "path": "docs/README.txt", - "contents": base64encode("hello world\n") - } - ] - } - -2. Existing file modification: change existing `docs/README.txt` to have new - content `new content here\n`: - - { - "additions" [ - { - "path": "docs/README.txt", - "contents": base64encode("new content here\n") - } - ] - } - -3. Existing file deletion: remove existing file `docs/README.txt`. - Note that the path is required to exist -- specifying a - path that does not exist on the given branch will abort the - commit and return an error. - - { - "deletions" [ - { - "path": "docs/README.txt" - } - ] - } - - -4. File rename with no changes: rename `docs/README.txt` with - previous content `hello world\n` to the same content at - `newdocs/README.txt`: - - { - "deletions" [ - { - "path": "docs/README.txt", - } - ], - "additions" [ - { - "path": "newdocs/README.txt", - "contents": base64encode("hello world\n") - } - ] - } - - -5. File rename with changes: rename `docs/README.txt` with - previous content `hello world\n` to a file at path - `newdocs/README.txt` with content `new contents\n`: - - { - "deletions" [ - { - "path": "docs/README.txt", - } - ], - "additions" [ - { - "path": "newdocs/README.txt", - "contents": base64encode("new contents\n") - } - ] - } -""" -input FileChanges { - """ - File to add or change. - """ - additions: [FileAddition!] = [] - - """ - Files to delete. - """ - deletions: [FileDeletion!] = [] -} - -""" -A command to delete the file at the given path as part of a commit. -""" -input FileDeletion { - """ - The path to delete - """ - path: String! -} - -""" -Prevent commits that include files with specified file extensions from being -pushed to the commit graph. NOTE: This rule is in beta and subject to change -""" -type FileExtensionRestrictionParameters { - """ - The file extensions that are restricted from being pushed to the commit graph. - """ - restrictedFileExtensions: [String!]! -} - -""" -Prevent commits that include files with specified file extensions from being -pushed to the commit graph. NOTE: This rule is in beta and subject to change -""" -input FileExtensionRestrictionParametersInput { - """ - The file extensions that are restricted from being pushed to the commit graph. - """ - restrictedFileExtensions: [String!]! -} - -""" -Prevent commits that include changes in specified file paths from being pushed -to the commit graph. NOTE: This rule is in beta and subject to change -""" -type FilePathRestrictionParameters { - """ - The file paths that are restricted from being pushed to the commit graph. - """ - restrictedFilePaths: [String!]! -} - -""" -Prevent commits that include changes in specified file paths from being pushed -to the commit graph. NOTE: This rule is in beta and subject to change -""" -input FilePathRestrictionParametersInput { - """ - The file paths that are restricted from being pushed to the commit graph. - """ - restrictedFilePaths: [String!]! -} - -""" -The possible viewed states of a file . -""" -enum FileViewedState { - """ - The file has new changes since last viewed. - """ - DISMISSED - - """ - The file has not been marked as viewed. - """ - UNVIEWED - - """ - The file has been marked as viewed. - """ - VIEWED -} - -""" -Autogenerated input type of FollowOrganization -""" -input FollowOrganizationInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - ID of the organization to follow. - """ - organizationId: ID! @possibleTypes(concreteTypes: ["Organization"]) -} - -""" -Autogenerated return type of FollowOrganization -""" -type FollowOrganizationPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The organization that was followed. - """ - organization: Organization -} - -""" -Autogenerated input type of FollowUser -""" -input FollowUserInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - ID of the user to follow. - """ - userId: ID! @possibleTypes(concreteTypes: ["User"]) -} - -""" -Autogenerated return type of FollowUser -""" -type FollowUserPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The user that was followed. - """ - user: User -} - -""" -The connection type for User. -""" -type FollowerConnection { - """ - A list of edges. - """ - edges: [UserEdge] - - """ - A list of nodes. - """ - nodes: [User] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -The connection type for User. -""" -type FollowingConnection { - """ - A list of edges. - """ - edges: [UserEdge] - - """ - A list of nodes. - """ - nodes: [User] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -A generic hovercard context with a message and icon -""" -type GenericHovercardContext implements HovercardContext { - """ - A string describing this context - """ - message: String! - - """ - An octicon to accompany this context - """ - octicon: String! -} - -""" -A Gist. -""" -type Gist implements Node & Starrable & UniformResourceLocatable { - """ - A list of comments associated with the gist - """ - comments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): GistCommentConnection! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The gist description. - """ - description: String - - """ - The files in this gist. - """ - files( - """ - The maximum number of files to return. - """ - limit: Int = 10 - - """ - The oid of the files to return - """ - oid: GitObjectID - ): [GistFile] - - """ - A list of forks associated with the gist - """ - forks( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for gists returned from the connection - """ - orderBy: GistOrder - ): GistConnection! - - """ - The Node ID of the Gist object - """ - id: ID! - - """ - Identifies if the gist is a fork. - """ - isFork: Boolean! - - """ - Whether the gist is public or not. - """ - isPublic: Boolean! - - """ - The gist name. - """ - name: String! - - """ - The gist owner. - """ - owner: RepositoryOwner - - """ - Identifies when the gist was last pushed to. - """ - pushedAt: DateTime - - """ - The HTML path to this resource. - """ - resourcePath: URI! - - """ - Returns a count of how many stargazers there are on this object - """ - stargazerCount: Int! - - """ - A list of users who have starred this starrable. - """ - stargazers( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Order for connection - """ - orderBy: StarOrder - ): StargazerConnection! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this Gist. - """ - url: URI! - - """ - Returns a boolean indicating whether the viewing user has starred this starrable. - """ - viewerHasStarred: Boolean! -} - -""" -Represents a comment on an Gist. -""" -type GistComment implements Comment & Deletable & Minimizable & Node & Updatable & UpdatableComment { - """ - The actor who authored the comment. - """ - author: Actor - - """ - Author's association with the gist. - """ - authorAssociation: CommentAuthorAssociation! - - """ - Identifies the comment body. - """ - body: String! - - """ - The body rendered to HTML. - """ - bodyHTML: HTML! - - """ - The body rendered to text. - """ - bodyText: String! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Check if this comment was created via an email reply. - """ - createdViaEmail: Boolean! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The actor who edited the comment. - """ - editor: Actor - - """ - The associated gist. - """ - gist: Gist! - - """ - The Node ID of the GistComment object - """ - id: ID! - - """ - Check if this comment was edited and includes an edit with the creation data - """ - includesCreatedEdit: Boolean! - - """ - Returns whether or not a comment has been minimized. - """ - isMinimized: Boolean! - - """ - The moment the editor made the last edit - """ - lastEditedAt: DateTime - - """ - Returns why the comment was minimized. One of `abuse`, `off-topic`, - `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and - formatting of these values differs from the inputs to the `MinimizeComment` mutation. - """ - minimizedReason: String - - """ - Identifies when the comment was published at. - """ - publishedAt: DateTime - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - A list of edits to this content. - """ - userContentEdits( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserContentEditConnection - - """ - Check if the current viewer can delete this object. - """ - viewerCanDelete: Boolean! - - """ - Check if the current viewer can minimize this object. - """ - viewerCanMinimize: Boolean! - - """ - Check if the current viewer can update this object. - """ - viewerCanUpdate: Boolean! - - """ - Reasons why the current viewer can not update this comment. - """ - viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - - """ - Did the viewer author this comment. - """ - viewerDidAuthor: Boolean! -} - -""" -The connection type for GistComment. -""" -type GistCommentConnection { - """ - A list of edges. - """ - edges: [GistCommentEdge] - - """ - A list of nodes. - """ - nodes: [GistComment] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type GistCommentEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: GistComment -} - -""" -The connection type for Gist. -""" -type GistConnection { - """ - A list of edges. - """ - edges: [GistEdge] - - """ - A list of nodes. - """ - nodes: [Gist] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type GistEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Gist -} - -""" -A file in a gist. -""" -type GistFile { - """ - The file name encoded to remove characters that are invalid in URL paths. - """ - encodedName: String - - """ - The gist file encoding. - """ - encoding: String - - """ - The file extension from the file name. - """ - extension: String - - """ - Indicates if this file is an image. - """ - isImage: Boolean! - - """ - Whether the file's contents were truncated. - """ - isTruncated: Boolean! - - """ - The programming language this file is written in. - """ - language: Language - - """ - The gist file name. - """ - name: String - - """ - The gist file size in bytes. - """ - size: Int - - """ - UTF8 text data or null if the file is binary - """ - text( - """ - Optionally truncate the returned file to this length. - """ - truncate: Int - ): String -} - -""" -Ordering options for gist connections -""" -input GistOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order repositories by. - """ - field: GistOrderField! -} - -""" -Properties by which gist connections can be ordered. -""" -enum GistOrderField { - """ - Order gists by creation time - """ - CREATED_AT - - """ - Order gists by push time - """ - PUSHED_AT - - """ - Order gists by update time - """ - UPDATED_AT -} - -""" -The privacy of a Gist -""" -enum GistPrivacy { - """ - Gists that are public and secret - """ - ALL - - """ - Public - """ - PUBLIC - - """ - Secret - """ - SECRET -} - -""" -Represents an actor in a Git commit (ie. an author or committer). -""" -type GitActor { - """ - A URL pointing to the author's public avatar. - """ - avatarUrl( - """ - The size of the resulting square image. - """ - size: Int - ): URI! - - """ - The timestamp of the Git action (authoring or committing). - """ - date: GitTimestamp - - """ - The email in the Git commit. - """ - email: String - - """ - The name in the Git commit. - """ - name: String - - """ - The GitHub user corresponding to the email field. Null if no such user exists. - """ - user: User -} - -""" -The connection type for GitActor. -""" -type GitActorConnection { - """ - A list of edges. - """ - edges: [GitActorEdge] - - """ - A list of nodes. - """ - nodes: [GitActor] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type GitActorEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: GitActor -} - -""" -Represents information about the GitHub instance. -""" -type GitHubMetadata { - """ - Returns a String that's a SHA of `github-services` - """ - gitHubServicesSha: GitObjectID! - - """ - Whether or not users are verified - """ - isPasswordAuthenticationVerifiable: Boolean! -} - -""" -Represents a Git object. -""" -interface GitObject { - """ - An abbreviated version of the Git object ID - """ - abbreviatedOid: String! - - """ - The HTTP path for this Git object - """ - commitResourcePath: URI! - - """ - The HTTP URL for this Git object - """ - commitUrl: URI! - - """ - The Node ID of the GitObject object - """ - id: ID! - - """ - The Git object ID - """ - oid: GitObjectID! - - """ - The Repository the Git object belongs to - """ - repository: Repository! -} - -""" -A Git object ID. -""" -scalar GitObjectID - -""" -A fully qualified reference name (e.g. `refs/heads/master`). -""" -scalar GitRefname - -""" -Git SSH string -""" -scalar GitSSHRemote - -""" -Information about a signature (GPG or S/MIME) on a Commit or Tag. -""" -interface GitSignature { - """ - Email used to sign this object. - """ - email: String! - - """ - True if the signature is valid and verified by GitHub. - """ - isValid: Boolean! - - """ - Payload for GPG signing object. Raw ODB object without the signature header. - """ - payload: String! - - """ - ASCII-armored signature header from object. - """ - signature: String! - - """ - GitHub user corresponding to the email signing this commit. - """ - signer: User - - """ - The state of this signature. `VALID` if signature is valid and verified by - GitHub, otherwise represents reason why signature is considered invalid. - """ - state: GitSignatureState! - - """ - True if the signature was made with GitHub's signing key. - """ - wasSignedByGitHub: Boolean! -} - -""" -The state of a Git signature. -""" -enum GitSignatureState { - """ - The signing certificate or its chain could not be verified - """ - BAD_CERT - - """ - Invalid email used for signing - """ - BAD_EMAIL - - """ - Signing key expired - """ - EXPIRED_KEY - - """ - Internal error - the GPG verification service misbehaved - """ - GPGVERIFY_ERROR - - """ - Internal error - the GPG verification service is unavailable at the moment - """ - GPGVERIFY_UNAVAILABLE - - """ - Invalid signature - """ - INVALID - - """ - Malformed signature - """ - MALFORMED_SIG - - """ - The usage flags for the key that signed this don't allow signing - """ - NOT_SIGNING_KEY - - """ - Email used for signing not known to GitHub - """ - NO_USER - - """ - Valid signature, though certificate revocation check failed - """ - OCSP_ERROR - - """ - Valid signature, pending certificate revocation checking - """ - OCSP_PENDING - - """ - One or more certificates in chain has been revoked - """ - OCSP_REVOKED - - """ - Key used for signing not known to GitHub - """ - UNKNOWN_KEY - - """ - Unknown signature type - """ - UNKNOWN_SIG_TYPE - - """ - Unsigned - """ - UNSIGNED - - """ - Email used for signing unverified on GitHub - """ - UNVERIFIED_EMAIL - - """ - Valid signature and verified by GitHub - """ - VALID -} - -""" -An ISO-8601 encoded date string. Unlike the DateTime type, GitTimestamp is not converted in UTC. -""" -scalar GitTimestamp - -""" -Represents a GPG signature on a Commit or Tag. -""" -type GpgSignature implements GitSignature { - """ - Email used to sign this object. - """ - email: String! - - """ - True if the signature is valid and verified by GitHub. - """ - isValid: Boolean! - - """ - Hex-encoded ID of the key that signed this object. - """ - keyId: String - - """ - Payload for GPG signing object. Raw ODB object without the signature header. - """ - payload: String! - - """ - ASCII-armored signature header from object. - """ - signature: String! - - """ - GitHub user corresponding to the email signing this commit. - """ - signer: User - - """ - The state of this signature. `VALID` if signature is valid and verified by - GitHub, otherwise represents reason why signature is considered invalid. - """ - state: GitSignatureState! - - """ - True if the signature was made with GitHub's signing key. - """ - wasSignedByGitHub: Boolean! -} - -""" -Autogenerated input type of GrantEnterpriseOrganizationsMigratorRole -""" -input GrantEnterpriseOrganizationsMigratorRoleInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the enterprise to which all organizations managed by it will be granted the migrator role. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The login of the user to grant the migrator role - """ - login: String! -} - -""" -Autogenerated return type of GrantEnterpriseOrganizationsMigratorRole -""" -type GrantEnterpriseOrganizationsMigratorRolePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The organizations that had the migrator role applied to for the given user. - """ - organizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): OrganizationConnection -} - -""" -Autogenerated input type of GrantMigratorRole -""" -input GrantMigratorRoleInput { - """ - The user login or Team slug to grant the migrator role. - """ - actor: String! - - """ - Specifies the type of the actor, can be either USER or TEAM. - """ - actorType: ActorType! - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the organization that the user/team belongs to. - """ - organizationId: ID! @possibleTypes(concreteTypes: ["Organization"]) -} - -""" -Autogenerated return type of GrantMigratorRole -""" -type GrantMigratorRolePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Did the operation succeed? - """ - success: Boolean -} - -""" -A string containing HTML code. -""" -scalar HTML - -""" -Represents a 'head_ref_deleted' event on a given pull request. -""" -type HeadRefDeletedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the Ref associated with the `head_ref_deleted` event. - """ - headRef: Ref - - """ - Identifies the name of the Ref associated with the `head_ref_deleted` event. - """ - headRefName: String! - - """ - The Node ID of the HeadRefDeletedEvent object - """ - id: ID! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest! -} - -""" -Represents a 'head_ref_force_pushed' event on a given pull request. -""" -type HeadRefForcePushedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the after commit SHA for the 'head_ref_force_pushed' event. - """ - afterCommit: Commit - - """ - Identifies the before commit SHA for the 'head_ref_force_pushed' event. - """ - beforeCommit: Commit - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the HeadRefForcePushedEvent object - """ - id: ID! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest! - - """ - Identifies the fully qualified ref name for the 'head_ref_force_pushed' event. - """ - ref: Ref -} - -""" -Represents a 'head_ref_restored' event on a given pull request. -""" -type HeadRefRestoredEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the HeadRefRestoredEvent object - """ - id: ID! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest! -} - -""" -Detail needed to display a hovercard for a user -""" -type Hovercard { - """ - Each of the contexts for this hovercard - """ - contexts: [HovercardContext!]! -} - -""" -An individual line of a hovercard -""" -interface HovercardContext { - """ - A string describing this context - """ - message: String! - - """ - An octicon to accompany this context - """ - octicon: String! -} - -""" -The possible states in which authentication can be configured with an identity provider. -""" -enum IdentityProviderConfigurationState { - """ - Authentication with an identity provider is configured but not enforced. - """ - CONFIGURED - - """ - Authentication with an identity provider is configured and enforced. - """ - ENFORCED - - """ - Authentication with an identity provider is not configured. - """ - UNCONFIGURED -} - -""" -Autogenerated input type of ImportProject -""" -input ImportProjectInput { - """ - The description of Project. - """ - body: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - A list of columns containing issues and pull requests. - """ - columnImports: [ProjectColumnImport!]! - - """ - The name of Project. - """ - name: String! - - """ - The name of the Organization or User to create the Project under. - """ - ownerName: String! - - """ - Whether the Project is public or not. - """ - public: Boolean = false -} - -""" -Autogenerated return type of ImportProject -""" -type ImportProjectPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new Project! - """ - project: Project -} - -""" -The possible values for the IP allow list enabled setting. -""" -enum IpAllowListEnabledSettingValue { - """ - The setting is disabled for the owner. - """ - DISABLED - - """ - The setting is enabled for the owner. - """ - ENABLED -} - -""" -An IP address or range of addresses that is allowed to access an owner's resources. -""" -type IpAllowListEntry implements Node { - """ - A single IP address or range of IP addresses in CIDR notation. - """ - allowListValue: String! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the IpAllowListEntry object - """ - id: ID! - - """ - Whether the entry is currently active. - """ - isActive: Boolean! - - """ - The name of the IP allow list entry. - """ - name: String - - """ - The owner of the IP allow list entry. - """ - owner: IpAllowListOwner! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -The connection type for IpAllowListEntry. -""" -type IpAllowListEntryConnection { - """ - A list of edges. - """ - edges: [IpAllowListEntryEdge] - - """ - A list of nodes. - """ - nodes: [IpAllowListEntry] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type IpAllowListEntryEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: IpAllowListEntry -} - -""" -Ordering options for IP allow list entry connections. -""" -input IpAllowListEntryOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order IP allow list entries by. - """ - field: IpAllowListEntryOrderField! -} - -""" -Properties by which IP allow list entry connections can be ordered. -""" -enum IpAllowListEntryOrderField { - """ - Order IP allow list entries by the allow list value. - """ - ALLOW_LIST_VALUE - - """ - Order IP allow list entries by creation time. - """ - CREATED_AT -} - -""" -The possible values for the IP allow list configuration for installed GitHub Apps setting. -""" -enum IpAllowListForInstalledAppsEnabledSettingValue { - """ - The setting is disabled for the owner. - """ - DISABLED - - """ - The setting is enabled for the owner. - """ - ENABLED -} - -""" -Types that can own an IP allow list. -""" -union IpAllowListOwner = App | Enterprise | Organization - -""" -An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project. -""" -type Issue implements Assignable & Closable & Comment & Deletable & Labelable & Lockable & Node & ProjectV2Owner & Reactable & RepositoryNode & Subscribable & SubscribableThread & UniformResourceLocatable & Updatable & UpdatableComment { - """ - Reason that the conversation was locked. - """ - activeLockReason: LockReason - - """ - A list of Users assigned to this object. - """ - assignees( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserConnection! - - """ - The actor who authored the comment. - """ - author: Actor - - """ - Author's association with the subject of the comment. - """ - authorAssociation: CommentAuthorAssociation! - - """ - Identifies the body of the issue. - """ - body: String! - - """ - The body rendered to HTML. - """ - bodyHTML: HTML! - - """ - The http path for this issue body - """ - bodyResourcePath: URI! - - """ - Identifies the body of the issue rendered to text. - """ - bodyText: String! - - """ - The http URL for this issue body - """ - bodyUrl: URI! - - """ - Indicates if the object is closed (definition of closed may depend on type) - """ - closed: Boolean! - - """ - Identifies the date and time when the object was closed. - """ - closedAt: DateTime - - """ - A list of comments associated with the Issue. - """ - comments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for issue comments returned from the connection. - """ - orderBy: IssueCommentOrder - ): IssueCommentConnection! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Check if this comment was created via an email reply. - """ - createdViaEmail: Boolean! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The actor who edited the comment. - """ - editor: Actor - - """ - Identifies the primary key from the database as a BigInt. - """ - fullDatabaseId: BigInt - - """ - The hovercard information for this issue - """ - hovercard( - """ - Whether or not to include notification contexts - """ - includeNotificationContexts: Boolean = true - ): Hovercard! - - """ - The Node ID of the Issue object - """ - id: ID! - - """ - Check if this comment was edited and includes an edit with the creation data - """ - 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 - """ - isReadByViewer: Boolean - - """ - A list of labels associated with the object. - """ - labels( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for labels returned from the connection. - """ - orderBy: LabelOrder = {field: CREATED_AT, direction: ASC} - ): LabelConnection - - """ - The moment the editor made the last edit - """ - lastEditedAt: DateTime - - """ - Branches linked to this issue. - """ - linkedBranches( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): LinkedBranchConnection! - - """ - `true` if the object is locked - """ - locked: Boolean! - - """ - Identifies the milestone associated with the issue. - """ - milestone: Milestone - - """ - Identifies the issue number. - """ - number: Int! - - """ - A list of Users that are participating in the Issue conversation. - """ - participants( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserConnection! - - """ - List of project cards associated with this issue. - """ - projectCards( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - A list of archived states to filter the cards by - """ - archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED] - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ProjectCardConnection! - - """ - Find a project by number. - """ - projectV2( - """ - The project number. - """ - number: Int! - ): ProjectV2 - - """ - A list of projects under the owner. - """ - projectsV2( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - How to order the returned projects. - """ - orderBy: ProjectV2Order = {field: NUMBER, direction: DESC} - - """ - A project to search for under the the owner. - """ - query: String - ): ProjectV2Connection! - - """ - Identifies when the comment was published at. - """ - publishedAt: DateTime - - """ - A list of reactions grouped by content left on the subject. - """ - reactionGroups: [ReactionGroup!] - - """ - A list of Reactions left on the Issue. - """ - reactions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Allows filtering Reactions by emoji. - """ - content: ReactionContent - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Allows specifying the order in which reactions are returned. - """ - orderBy: ReactionOrder - ): ReactionConnection! - - """ - The repository associated with this node. - """ - repository: Repository! - - """ - The HTTP path for this issue - """ - resourcePath: URI! - - """ - Identifies the state of the issue. - """ - state: IssueState! - - """ - Identifies the reason for the issue state. - """ - stateReason: IssueStateReason - - """ - A list of events, comments, commits, etc. associated with the issue. - """ - timeline( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Allows filtering timeline events by a `since` timestamp. - """ - since: DateTime - ): IssueTimelineConnection! - @deprecated(reason: "`timeline` will be removed Use Issue.timelineItems instead. Removal on 2020-10-01 UTC.") - - """ - A list of events, comments, commits, etc. associated with the issue. - """ - timelineItems( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Filter timeline items by type. - """ - itemTypes: [IssueTimelineItemsItemType!] - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filter timeline items by a `since` timestamp. - """ - since: DateTime - - """ - Skips the first _n_ elements in the list. - """ - skip: Int - ): IssueTimelineItemsConnection! - - """ - Identifies the issue title. - """ - title: String! - - """ - Identifies the issue title rendered to HTML. - """ - titleHTML: String! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this issue - """ - url: URI! - - """ - A list of edits to this content. - """ - userContentEdits( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserContentEditConnection - - """ - Indicates if the object can be closed by the viewer. - """ - viewerCanClose: Boolean! - - """ - Check if the current viewer can delete this object. - """ - viewerCanDelete: Boolean! - - """ - Can user react to this subject - """ - viewerCanReact: Boolean! - - """ - Indicates if the object can be reopened by the viewer. - """ - viewerCanReopen: Boolean! - - """ - Check if the viewer is able to change their subscription status for the repository. - """ - viewerCanSubscribe: Boolean! - - """ - Check if the current viewer can update this object. - """ - viewerCanUpdate: Boolean! - - """ - Reasons why the current viewer can not update this comment. - """ - viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - - """ - Did the viewer author this comment. - """ - viewerDidAuthor: Boolean! - - """ - Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. - """ - viewerSubscription: SubscriptionState - - """ - Identifies the viewer's thread subscription form action. - """ - viewerThreadSubscriptionFormAction: ThreadSubscriptionFormAction - - """ - Identifies the viewer's thread subscription status. - """ - viewerThreadSubscriptionStatus: ThreadSubscriptionState -} - -""" -The possible state reasons of a closed issue. -""" -enum IssueClosedStateReason { - """ - An issue that has been closed as completed - """ - COMPLETED - - """ - An issue that has been closed as not planned - """ - NOT_PLANNED -} - -""" -Represents a comment on an Issue. -""" -type IssueComment implements Comment & Deletable & Minimizable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment { - """ - The actor who authored the comment. - """ - author: Actor - - """ - Author's association with the subject of the comment. - """ - authorAssociation: CommentAuthorAssociation! - - """ - The body as Markdown. - """ - body: String! - - """ - The body rendered to HTML. - """ - bodyHTML: HTML! - - """ - The body rendered to text. - """ - bodyText: String! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Check if this comment was created via an email reply. - """ - createdViaEmail: Boolean! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The actor who edited the comment. - """ - editor: Actor - - """ - Identifies the primary key from the database as a BigInt. - """ - fullDatabaseId: BigInt - - """ - The Node ID of the IssueComment object - """ - id: ID! - - """ - Check if this comment was edited and includes an edit with the creation data - """ - includesCreatedEdit: Boolean! - - """ - Returns whether or not a comment has been minimized. - """ - isMinimized: Boolean! - - """ - Identifies the issue associated with the comment. - """ - issue: Issue! - - """ - The moment the editor made the last edit - """ - lastEditedAt: DateTime - - """ - Returns why the comment was minimized. One of `abuse`, `off-topic`, - `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and - formatting of these values differs from the inputs to the `MinimizeComment` mutation. - """ - minimizedReason: String - - """ - Identifies when the comment was published at. - """ - publishedAt: DateTime - - """ - Returns the pull request associated with the comment, if this comment was made on a - pull request. - """ - pullRequest: PullRequest - - """ - A list of reactions grouped by content left on the subject. - """ - reactionGroups: [ReactionGroup!] - - """ - A list of Reactions left on the Issue. - """ - reactions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Allows filtering Reactions by emoji. - """ - content: ReactionContent - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Allows specifying the order in which reactions are returned. - """ - orderBy: ReactionOrder - ): ReactionConnection! - - """ - The repository associated with this node. - """ - repository: Repository! - - """ - The HTTP path for this issue comment - """ - resourcePath: URI! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this issue comment - """ - url: URI! - - """ - A list of edits to this content. - """ - userContentEdits( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserContentEditConnection - - """ - Check if the current viewer can delete this object. - """ - viewerCanDelete: Boolean! - - """ - Check if the current viewer can minimize this object. - """ - viewerCanMinimize: Boolean! - - """ - Can user react to this subject - """ - viewerCanReact: Boolean! - - """ - Check if the current viewer can update this object. - """ - viewerCanUpdate: Boolean! - - """ - Reasons why the current viewer can not update this comment. - """ - viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - - """ - Did the viewer author this comment. - """ - viewerDidAuthor: Boolean! -} - -""" -The connection type for IssueComment. -""" -type IssueCommentConnection { - """ - A list of edges. - """ - edges: [IssueCommentEdge] - - """ - A list of nodes. - """ - nodes: [IssueComment] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type IssueCommentEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: IssueComment -} - -""" -Ways in which lists of issue comments can be ordered upon return. -""" -input IssueCommentOrder { - """ - The direction in which to order issue comments by the specified field. - """ - direction: OrderDirection! - - """ - The field in which to order issue comments by. - """ - field: IssueCommentOrderField! -} - -""" -Properties by which issue comment connections can be ordered. -""" -enum IssueCommentOrderField { - """ - Order issue comments by update time - """ - UPDATED_AT -} - -""" -The connection type for Issue. -""" -type IssueConnection { - """ - A list of edges. - """ - edges: [IssueEdge] - - """ - A list of nodes. - """ - nodes: [Issue] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -This aggregates issues opened by a user within one repository. -""" -type IssueContributionsByRepository { - """ - The issue contributions. - """ - contributions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for contributions returned from the connection. - """ - orderBy: ContributionOrder = {direction: DESC} - ): CreatedIssueContributionConnection! - - """ - The repository in which the issues were opened. - """ - repository: Repository! -} - -""" -An edge in a connection. -""" -type IssueEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Issue -} - -""" -Ways in which to filter lists of issues. -""" -input IssueFilters { - """ - List issues assigned to given name. Pass in `null` for issues with no assigned - user, and `*` for issues assigned to any user. - """ - assignee: String - - """ - List issues created by given name. - """ - createdBy: String - - """ - List issues where the list of label names exist on the issue. - """ - labels: [String!] - - """ - List issues where the given name is mentioned in the issue. - """ - mentioned: String - - """ - List issues by given milestone argument. If an string representation of an - integer is passed, it should refer to a milestone by its database ID. Pass in - `null` for issues with no milestone, and `*` for issues that are assigned to any milestone. - """ - milestone: String - - """ - List issues by given milestone argument. If an string representation of an - integer is passed, it should refer to a milestone by its number field. Pass in - `null` for issues with no milestone, and `*` for issues that are assigned to any milestone. - """ - milestoneNumber: String - - """ - List issues that have been updated at or after the given date. - """ - since: DateTime - - """ - List issues filtered by the list of states given. - """ - states: [IssueState!] - - """ - List issues subscribed to by viewer. - """ - viewerSubscribed: Boolean = false -} - -""" -Used for return value of Repository.issueOrPullRequest. -""" -union IssueOrPullRequest = Issue | PullRequest - -""" -Ways in which lists of issues can be ordered upon return. -""" -input IssueOrder { - """ - The direction in which to order issues by the specified field. - """ - direction: OrderDirection! - - """ - The field in which to order issues by. - """ - field: IssueOrderField! -} - -""" -Properties by which issue connections can be ordered. -""" -enum IssueOrderField { - """ - Order issues by comment count - """ - COMMENTS - - """ - Order issues by creation time - """ - CREATED_AT - - """ - Order issues by update time - """ - UPDATED_AT -} - -""" -The possible states of an issue. -""" -enum IssueState { - """ - An issue that has been closed - """ - CLOSED - - """ - An issue that is still open - """ - OPEN -} - -""" -The possible state reasons of an issue. -""" -enum IssueStateReason { - """ - An issue that has been closed as completed - """ - COMPLETED - - """ - An issue that has been closed as not planned - """ - NOT_PLANNED - - """ - An issue that has been reopened - """ - REOPENED -} - -""" -A repository issue template. -""" -type IssueTemplate { - """ - The template purpose. - """ - about: String - - """ - The suggested assignees. - """ - assignees( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserConnection! - - """ - The suggested issue body. - """ - body: String - - """ - The template filename. - """ - filename: String! - - """ - The suggested issue labels - """ - labels( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for labels returned from the connection. - """ - orderBy: LabelOrder = {field: CREATED_AT, direction: ASC} - ): LabelConnection - - """ - The template name. - """ - name: String! - - """ - The suggested issue title. - """ - title: String -} - -""" -The connection type for IssueTimelineItem. -""" -type IssueTimelineConnection { - """ - A list of edges. - """ - edges: [IssueTimelineItemEdge] - - """ - A list of nodes. - """ - nodes: [IssueTimelineItem] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An item in an issue timeline -""" -union IssueTimelineItem = - AssignedEvent - | ClosedEvent - | Commit - | CrossReferencedEvent - | DemilestonedEvent - | IssueComment - | LabeledEvent - | LockedEvent - | MilestonedEvent - | ReferencedEvent - | RenamedTitleEvent - | ReopenedEvent - | SubscribedEvent - | TransferredEvent - | UnassignedEvent - | UnlabeledEvent - | UnlockedEvent - | UnsubscribedEvent - | UserBlockedEvent - -""" -An edge in a connection. -""" -type IssueTimelineItemEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: IssueTimelineItem -} - -""" -An item in an issue timeline -""" -union IssueTimelineItems = - AddedToProjectEvent - | AssignedEvent - | ClosedEvent - | CommentDeletedEvent - | ConnectedEvent - | ConvertedNoteToIssueEvent - | ConvertedToDiscussionEvent - | CrossReferencedEvent - | DemilestonedEvent - | DisconnectedEvent - | IssueComment - | LabeledEvent - | LockedEvent - | MarkedAsDuplicateEvent - | MentionedEvent - | MilestonedEvent - | MovedColumnsInProjectEvent - | PinnedEvent - | ReferencedEvent - | RemovedFromProjectEvent - | RenamedTitleEvent - | ReopenedEvent - | SubscribedEvent - | TransferredEvent - | UnassignedEvent - | UnlabeledEvent - | UnlockedEvent - | UnmarkedAsDuplicateEvent - | UnpinnedEvent - | UnsubscribedEvent - | UserBlockedEvent - -""" -The connection type for IssueTimelineItems. -""" -type IssueTimelineItemsConnection { - """ - A list of edges. - """ - edges: [IssueTimelineItemsEdge] - - """ - Identifies the count of items after applying `before` and `after` filters. - """ - filteredCount: Int! - - """ - A list of nodes. - """ - nodes: [IssueTimelineItems] - - """ - Identifies the count of items after applying `before`/`after` filters and `first`/`last`/`skip` slicing. - """ - pageCount: Int! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! - - """ - Identifies the date and time when the timeline was last updated. - """ - updatedAt: DateTime! -} - -""" -An edge in a connection. -""" -type IssueTimelineItemsEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: IssueTimelineItems -} - -""" -The possible item types found in a timeline. -""" -enum IssueTimelineItemsItemType { - """ - Represents a 'added_to_project' event on a given issue or pull request. - """ - ADDED_TO_PROJECT_EVENT - - """ - Represents an 'assigned' event on any assignable object. - """ - ASSIGNED_EVENT - - """ - Represents a 'closed' event on any `Closable`. - """ - CLOSED_EVENT - - """ - Represents a 'comment_deleted' event on a given issue or pull request. - """ - COMMENT_DELETED_EVENT - - """ - Represents a 'connected' event on a given issue or pull request. - """ - CONNECTED_EVENT - - """ - Represents a 'converted_note_to_issue' event on a given issue or pull request. - """ - CONVERTED_NOTE_TO_ISSUE_EVENT - - """ - Represents a 'converted_to_discussion' event on a given issue. - """ - CONVERTED_TO_DISCUSSION_EVENT - - """ - Represents a mention made by one issue or pull request to another. - """ - CROSS_REFERENCED_EVENT - - """ - Represents a 'demilestoned' event on a given issue or pull request. - """ - DEMILESTONED_EVENT - - """ - Represents a 'disconnected' event on a given issue or pull request. - """ - DISCONNECTED_EVENT - - """ - Represents a comment on an Issue. - """ - ISSUE_COMMENT - - """ - Represents a 'labeled' event on a given issue or pull request. - """ - LABELED_EVENT - - """ - Represents a 'locked' event on a given issue or pull request. - """ - LOCKED_EVENT - - """ - Represents a 'marked_as_duplicate' event on a given issue or pull request. - """ - MARKED_AS_DUPLICATE_EVENT - - """ - Represents a 'mentioned' event on a given issue or pull request. - """ - MENTIONED_EVENT - - """ - Represents a 'milestoned' event on a given issue or pull request. - """ - MILESTONED_EVENT - - """ - Represents a 'moved_columns_in_project' event on a given issue or pull request. - """ - MOVED_COLUMNS_IN_PROJECT_EVENT - - """ - Represents a 'pinned' event on a given issue or pull request. - """ - PINNED_EVENT - - """ - Represents a 'referenced' event on a given `ReferencedSubject`. - """ - REFERENCED_EVENT - - """ - Represents a 'removed_from_project' event on a given issue or pull request. - """ - REMOVED_FROM_PROJECT_EVENT - - """ - Represents a 'renamed' event on a given issue or pull request - """ - RENAMED_TITLE_EVENT - - """ - Represents a 'reopened' event on any `Closable`. - """ - REOPENED_EVENT - - """ - Represents a 'subscribed' event on a given `Subscribable`. - """ - SUBSCRIBED_EVENT - - """ - Represents a 'transferred' event on a given issue or pull request. - """ - TRANSFERRED_EVENT - - """ - Represents an 'unassigned' event on any assignable object. - """ - UNASSIGNED_EVENT - - """ - Represents an 'unlabeled' event on a given issue or pull request. - """ - UNLABELED_EVENT - - """ - Represents an 'unlocked' event on a given issue or pull request. - """ - UNLOCKED_EVENT - - """ - Represents an 'unmarked_as_duplicate' event on a given issue or pull request. - """ - UNMARKED_AS_DUPLICATE_EVENT - - """ - Represents an 'unpinned' event on a given issue or pull request. - """ - UNPINNED_EVENT - - """ - Represents an 'unsubscribed' event on a given `Subscribable`. - """ - UNSUBSCRIBED_EVENT - - """ - Represents a 'user_blocked' event on a given user. - """ - USER_BLOCKED_EVENT -} - -""" -Represents a user signing up for a GitHub account. -""" -type JoinedGitHubContribution implements Contribution { - """ - Whether this contribution is associated with a record you do not have access to. For - example, your own 'first issue' contribution may have been made on a repository you can no - longer access. - """ - isRestricted: Boolean! - - """ - When this contribution was made. - """ - occurredAt: DateTime! - - """ - The HTTP path for this contribution. - """ - resourcePath: URI! - - """ - The HTTP URL for this contribution. - """ - url: URI! - - """ - The user who made this contribution. - """ - user: User! -} - -""" -A label for categorizing Issues, Pull Requests, Milestones, or Discussions with a given Repository. -""" -type Label implements Node { - """ - Identifies the label color. - """ - color: String! - - """ - Identifies the date and time when the label was created. - """ - createdAt: DateTime - - """ - A brief description of this label. - """ - description: String - - """ - The Node ID of the Label object - """ - id: ID! - - """ - Indicates whether or not this is a default label. - """ - isDefault: Boolean! - - """ - A list of issues associated with this label. - """ - issues( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Filtering options for issues returned from the connection. - """ - filterBy: IssueFilters - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - A list of label names to filter the pull requests by. - """ - labels: [String!] - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for issues returned from the connection. - """ - orderBy: IssueOrder - - """ - A list of states to filter the issues by. - """ - states: [IssueState!] - ): IssueConnection! - - """ - Identifies the label name. - """ - name: String! - - """ - A list of pull requests associated with this label. - """ - pullRequests( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - The base ref name to filter the pull requests by. - """ - baseRefName: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - The head ref name to filter the pull requests by. - """ - headRefName: String - - """ - A list of label names to filter the pull requests by. - """ - labels: [String!] - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for pull requests returned from the connection. - """ - orderBy: IssueOrder - - """ - A list of states to filter the pull requests by. - """ - states: [PullRequestState!] - ): PullRequestConnection! - - """ - The repository associated with this label. - """ - repository: Repository! - - """ - The HTTP path for this label. - """ - resourcePath: URI! - - """ - Identifies the date and time when the label was last updated. - """ - updatedAt: DateTime - - """ - The HTTP URL for this label. - """ - url: URI! -} - -""" -The connection type for Label. -""" -type LabelConnection { - """ - A list of edges. - """ - edges: [LabelEdge] - - """ - A list of nodes. - """ - nodes: [Label] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type LabelEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Label -} - -""" -Ways in which lists of labels can be ordered upon return. -""" -input LabelOrder { - """ - The direction in which to order labels by the specified field. - """ - direction: OrderDirection! - - """ - The field in which to order labels by. - """ - field: LabelOrderField! -} - -""" -Properties by which label connections can be ordered. -""" -enum LabelOrderField { - """ - Order labels by creation time - """ - CREATED_AT - - """ - Order labels by name - """ - NAME -} - -""" -An object that can have labels assigned to it. -""" -interface Labelable { - """ - A list of labels associated with the object. - """ - labels( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for labels returned from the connection. - """ - orderBy: LabelOrder = {field: CREATED_AT, direction: ASC} - ): LabelConnection -} - -""" -Represents a 'labeled' event on a given issue or pull request. -""" -type LabeledEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the LabeledEvent object - """ - id: ID! - - """ - Identifies the label associated with the 'labeled' event. - """ - label: Label! - - """ - Identifies the `Labelable` associated with the event. - """ - labelable: Labelable! -} - -""" -Represents a given language found in repositories. -""" -type Language implements Node { - """ - The color defined for the current language. - """ - color: String - - """ - The Node ID of the Language object - """ - id: ID! - - """ - The name of the current language. - """ - name: String! -} - -""" -A list of languages associated with the parent. -""" -type LanguageConnection { - """ - A list of edges. - """ - edges: [LanguageEdge] - - """ - A list of nodes. - """ - nodes: [Language] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! - - """ - The total size in bytes of files written in that language. - """ - totalSize: Int! -} - -""" -Represents the language of a repository. -""" -type LanguageEdge { - cursor: String! - node: Language! - - """ - The number of bytes of code written in the language. - """ - size: Int! -} - -""" -Ordering options for language connections. -""" -input LanguageOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order languages by. - """ - field: LanguageOrderField! -} - -""" -Properties by which language connections can be ordered. -""" -enum LanguageOrderField { - """ - Order languages by the size of all files containing the language - """ - SIZE -} - -""" -A repository's open source license -""" -type License implements Node { - """ - The full text of the license - """ - body: String! - - """ - The conditions set by the license - """ - conditions: [LicenseRule]! - - """ - A human-readable description of the license - """ - description: String - - """ - Whether the license should be featured - """ - featured: Boolean! - - """ - Whether the license should be displayed in license pickers - """ - hidden: Boolean! - - """ - The Node ID of the License object - """ - id: ID! - - """ - Instructions on how to implement the license - """ - implementation: String - - """ - The lowercased SPDX ID of the license - """ - key: String! - - """ - The limitations set by the license - """ - limitations: [LicenseRule]! - - """ - The license full name specified by - """ - name: String! - - """ - Customary short name if applicable (e.g, GPLv3) - """ - nickname: String - - """ - The permissions set by the license - """ - permissions: [LicenseRule]! - - """ - Whether the license is a pseudo-license placeholder (e.g., other, no-license) - """ - pseudoLicense: Boolean! - - """ - Short identifier specified by - """ - spdxId: String - - """ - URL to the license on - """ - url: URI -} - -""" -Describes a License's conditions, permissions, and limitations -""" -type LicenseRule { - """ - A description of the rule - """ - description: String! - - """ - The machine-readable rule key - """ - key: String! - - """ - The human-readable rule label - """ - label: String! -} - -""" -Autogenerated input type of LinkProjectV2ToRepository -""" -input LinkProjectV2ToRepositoryInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the project to link to the repository. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) - - """ - The ID of the repository to link to the project. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) -} - -""" -Autogenerated return type of LinkProjectV2ToRepository -""" -type LinkProjectV2ToRepositoryPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The repository the project is linked to. - """ - repository: Repository -} - -""" -Autogenerated input type of LinkProjectV2ToTeam -""" -input LinkProjectV2ToTeamInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the project to link to the team. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) - - """ - The ID of the team to link to the project. - """ - teamId: ID! @possibleTypes(concreteTypes: ["Team"]) -} - -""" -Autogenerated return type of LinkProjectV2ToTeam -""" -type LinkProjectV2ToTeamPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The team the project is linked to - """ - team: Team -} - -""" -Autogenerated input type of LinkRepositoryToProject -""" -input LinkRepositoryToProjectInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the Project to link to a Repository - """ - projectId: ID! @possibleTypes(concreteTypes: ["Project"]) - - """ - The ID of the Repository to link to a Project. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) -} - -""" -Autogenerated return type of LinkRepositoryToProject -""" -type LinkRepositoryToProjectPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The linked Project. - """ - project: Project - - """ - The linked Repository. - """ - repository: Repository -} - -""" -A branch linked to an issue. -""" -type LinkedBranch implements Node { - """ - The Node ID of the LinkedBranch object - """ - id: ID! - - """ - The branch's ref. - """ - ref: Ref -} - -""" -A list of branches linked to an issue. -""" -type LinkedBranchConnection { - """ - A list of edges. - """ - edges: [LinkedBranchEdge] - - """ - A list of nodes. - """ - nodes: [LinkedBranch] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type LinkedBranchEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: LinkedBranch -} - -""" -Autogenerated input type of LockLockable -""" -input LockLockableInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - A reason for why the item will be locked. - """ - lockReason: LockReason - - """ - ID of the item to be locked. - """ - lockableId: ID! @possibleTypes(concreteTypes: ["Discussion", "Issue", "PullRequest"], abstractType: "Lockable") -} - -""" -Autogenerated return type of LockLockable -""" -type LockLockablePayload { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The item that was locked. - """ - lockedRecord: Lockable -} - -""" -The possible reasons that an issue or pull request was locked. -""" -enum LockReason { - """ - The issue or pull request was locked because the conversation was off-topic. - """ - OFF_TOPIC - - """ - The issue or pull request was locked because the conversation was resolved. - """ - RESOLVED - - """ - The issue or pull request was locked because the conversation was spam. - """ - SPAM - - """ - The issue or pull request was locked because the conversation was too heated. - """ - TOO_HEATED -} - -""" -An object that can be locked. -""" -interface Lockable { - """ - Reason that the conversation was locked. - """ - activeLockReason: LockReason - - """ - `true` if the object is locked - """ - locked: Boolean! -} - -""" -Represents a 'locked' event on a given issue or pull request. -""" -type LockedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the LockedEvent object - """ - id: ID! - - """ - Reason that the conversation was locked (optional). - """ - lockReason: LockReason - - """ - Object that was locked. - """ - lockable: Lockable! -} - -""" -A placeholder user for attribution of imported data on GitHub. -""" -type Mannequin implements Actor & Node & UniformResourceLocatable { - """ - A URL pointing to the GitHub App's public avatar. - """ - avatarUrl( - """ - The size of the resulting square image. - """ - size: Int - ): URI! - - """ - The user that has claimed the data attributed to this mannequin. - """ - claimant: User - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The mannequin's email on the source instance. - """ - email: String - - """ - The Node ID of the Mannequin object - """ - id: ID! - - """ - The username of the actor. - """ - login: String! - - """ - The HTML path to this resource. - """ - resourcePath: URI! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The URL to this resource. - """ - url: URI! -} - -""" -A list of mannequins. -""" -type MannequinConnection { - """ - A list of edges. - """ - edges: [MannequinEdge] - - """ - A list of nodes. - """ - nodes: [Mannequin] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -Represents a mannequin. -""" -type MannequinEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Mannequin -} - -""" -Ordering options for mannequins. -""" -input MannequinOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order mannequins by. - """ - field: MannequinOrderField! -} - -""" -Properties by which mannequins can be ordered. -""" -enum MannequinOrderField { - """ - Order mannequins why when they were created. - """ - CREATED_AT - - """ - Order mannequins alphabetically by their source login. - """ - LOGIN -} - -""" -Autogenerated input type of MarkDiscussionCommentAsAnswer -""" -input MarkDiscussionCommentAsAnswerInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the discussion comment to mark as an answer. - """ - id: ID! @possibleTypes(concreteTypes: ["DiscussionComment"]) -} - -""" -Autogenerated return type of MarkDiscussionCommentAsAnswer -""" -type MarkDiscussionCommentAsAnswerPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The discussion that includes the chosen comment. - """ - discussion: Discussion -} - -""" -Autogenerated input type of MarkFileAsViewed -""" -input MarkFileAsViewedInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The path of the file to mark as viewed - """ - path: String! - - """ - The Node ID of the pull request. - """ - pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"]) -} - -""" -Autogenerated return type of MarkFileAsViewed -""" -type MarkFileAsViewedPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated pull request. - """ - pullRequest: PullRequest -} - -""" -Autogenerated input type of MarkNotificationAsDone -""" -input MarkNotificationAsDoneInput - @requiredCapabilities(requiredCapabilities: ["access_internal_graphql_notifications"]) { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The NotificationThread id. - """ - id: ID! -} - -""" -Autogenerated return type of MarkNotificationAsDone -""" -type MarkNotificationAsDonePayload - @requiredCapabilities(requiredCapabilities: ["access_internal_graphql_notifications"]) { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Did the operation succeed? - """ - success: Boolean - - """ - The user that the notification belongs to. - """ - viewer: User -} - -""" -Autogenerated input type of MarkProjectV2AsTemplate -""" -input MarkProjectV2AsTemplateInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the Project to mark as a template. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) -} - -""" -Autogenerated return type of MarkProjectV2AsTemplate -""" -type MarkProjectV2AsTemplatePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The project. - """ - projectV2: ProjectV2 -} - -""" -Autogenerated input type of MarkPullRequestReadyForReview -""" -input MarkPullRequestReadyForReviewInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - ID of the pull request to be marked as ready for review. - """ - pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"]) -} - -""" -Autogenerated return type of MarkPullRequestReadyForReview -""" -type MarkPullRequestReadyForReviewPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The pull request that is ready for review. - """ - pullRequest: PullRequest -} - -""" -Represents a 'marked_as_duplicate' event on a given issue or pull request. -""" -type MarkedAsDuplicateEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - The authoritative issue or pull request which has been duplicated by another. - """ - canonical: IssueOrPullRequest - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The issue or pull request which has been marked as a duplicate of another. - """ - duplicate: IssueOrPullRequest - - """ - The Node ID of the MarkedAsDuplicateEvent object - """ - id: ID! - - """ - Canonical and duplicate belong to different repositories. - """ - isCrossRepository: Boolean! -} - -""" -Prevent commits that include file paths that exceed a specified character limit -from being pushed to the commit graph. NOTE: This rule is in beta and subject to change -""" -type MaxFilePathLengthParameters { - """ - The maximum amount of characters allowed in file paths - """ - maxFilePathLength: Int! -} - -""" -Prevent commits that include file paths that exceed a specified character limit -from being pushed to the commit graph. NOTE: This rule is in beta and subject to change -""" -input MaxFilePathLengthParametersInput { - """ - The maximum amount of characters allowed in file paths - """ - maxFilePathLength: Int! -} - -""" -Prevent commits that exceed a specified file size limit from being pushed to the -commit. NOTE: This rule is in beta and subject to change -""" -type MaxFileSizeParameters { - """ - The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). - """ - maxFileSize: Int! -} - -""" -Prevent commits that exceed a specified file size limit from being pushed to the -commit. NOTE: This rule is in beta and subject to change -""" -input MaxFileSizeParametersInput { - """ - The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). - """ - maxFileSize: Int! -} - -""" -Represents a member feature request notification -""" -type MemberFeatureRequestNotification implements Node { - """ - Represents member feature request body containing entity name and the number of feature requests - """ - body: String! - - """ - The Node ID of the MemberFeatureRequestNotification object - """ - id: ID! - - """ - Represents member feature request notification title - """ - title: String! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -Entities that have members who can set status messages. -""" -interface MemberStatusable { - """ - Get the status messages members of this entity have set that are either public or visible only to the organization. - """ - memberStatuses( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for user statuses returned from the connection. - """ - orderBy: UserStatusOrder = {field: UPDATED_AT, direction: DESC} - ): UserStatusConnection! -} - -""" -Audit log entry for a members_can_delete_repos.clear event. -""" -type MembersCanDeleteReposClearAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The HTTP path for this enterprise. - """ - enterpriseResourcePath: URI - - """ - The slug of the enterprise. - """ - enterpriseSlug: String - - """ - The HTTP URL for this enterprise. - """ - enterpriseUrl: URI - - """ - The Node ID of the MembersCanDeleteReposClearAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a members_can_delete_repos.disable event. -""" -type MembersCanDeleteReposDisableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The HTTP path for this enterprise. - """ - enterpriseResourcePath: URI - - """ - The slug of the enterprise. - """ - enterpriseSlug: String - - """ - The HTTP URL for this enterprise. - """ - enterpriseUrl: URI - - """ - The Node ID of the MembersCanDeleteReposDisableAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a members_can_delete_repos.enable event. -""" -type MembersCanDeleteReposEnableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The HTTP path for this enterprise. - """ - enterpriseResourcePath: URI - - """ - The slug of the enterprise. - """ - enterpriseSlug: String - - """ - The HTTP URL for this enterprise. - """ - enterpriseUrl: URI - - """ - The Node ID of the MembersCanDeleteReposEnableAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Represents a 'mentioned' event on a given issue or pull request. -""" -type MentionedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the MentionedEvent object - """ - id: ID! -} - -""" -Autogenerated input type of MergeBranch -""" -input MergeBranchInput { - """ - The name of the base branch that the provided head will be merged into. - """ - base: String! - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Message to use for the merge commit. If omitted, a default will be used. - """ - commitMessage: String - - """ - The head to merge into the base branch. This can be a branch name or a commit GitObjectID. - """ - head: String! - - """ - The Node ID of the Repository containing the base branch that will be modified. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) -} - -""" -Autogenerated return type of MergeBranch -""" -type MergeBranchPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The resulting merge Commit. - """ - mergeCommit: Commit -} - -""" -The possible default commit messages for merges. -""" -enum MergeCommitMessage { - """ - Default to a blank commit message. - """ - BLANK - - """ - Default to the pull request's body. - """ - PR_BODY - - """ - Default to the pull request's title. - """ - PR_TITLE -} - -""" -The possible default commit titles for merges. -""" -enum MergeCommitTitle { - """ - Default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - """ - MERGE_MESSAGE - - """ - Default to the pull request's title. - """ - PR_TITLE -} - -""" -Autogenerated input type of MergePullRequest -""" -input MergePullRequestInput { - """ - The email address to associate with this merge. - """ - authorEmail: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Commit body to use for the merge commit; if omitted, a default message will be used - """ - commitBody: String - - """ - Commit headline to use for the merge commit; if omitted, a default message will be used. - """ - commitHeadline: String - - """ - OID that the pull request head ref must match to allow merge; if omitted, no check is performed. - """ - expectedHeadOid: GitObjectID - - """ - The merge method to use. If omitted, defaults to 'MERGE' - """ - mergeMethod: PullRequestMergeMethod = MERGE - - """ - ID of the pull request to be merged. - """ - pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"]) -} - -""" -Autogenerated return type of MergePullRequest -""" -type MergePullRequestPayload { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The pull request that was merged. - """ - pullRequest: PullRequest -} - -""" -The queue of pull request entries to be merged into a protected branch in a repository. -""" -type MergeQueue implements Node { - """ - The configuration for this merge queue - """ - configuration: MergeQueueConfiguration - - """ - The entries in the queue - """ - entries( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): MergeQueueEntryConnection - - """ - The Node ID of the MergeQueue object - """ - id: ID! - - """ - The estimated time in seconds until a newly added entry would be merged - """ - nextEntryEstimatedTimeToMerge: Int - - """ - The repository this merge queue belongs to - """ - repository: Repository - - """ - The HTTP path for this merge queue - """ - resourcePath: URI! - - """ - The HTTP URL for this merge queue - """ - url: URI! -} - -""" -Configuration for a MergeQueue -""" -type MergeQueueConfiguration { - """ - The amount of time in minutes to wait for a check response before considering it a failure. - """ - checkResponseTimeout: Int - - """ - The maximum number of entries to build at once. - """ - maximumEntriesToBuild: Int - - """ - The maximum number of entries to merge at once. - """ - maximumEntriesToMerge: Int - - """ - The merge method to use for this queue. - """ - mergeMethod: PullRequestMergeMethod - - """ - The strategy to use when merging entries. - """ - mergingStrategy: MergeQueueMergingStrategy - - """ - The minimum number of entries required to merge at once. - """ - minimumEntriesToMerge: Int - - """ - The amount of time in minutes to wait before ignoring the minumum number of - entries in the queue requirement and merging a collection of entries - """ - minimumEntriesToMergeWaitTime: Int -} - -""" -Entries in a MergeQueue -""" -type MergeQueueEntry implements Node { - """ - The base commit for this entry - """ - baseCommit: Commit - - """ - The date and time this entry was added to the merge queue - """ - enqueuedAt: DateTime! - - """ - The actor that enqueued this entry - """ - enqueuer: Actor! - - """ - The estimated time in seconds until this entry will be merged - """ - estimatedTimeToMerge: Int - - """ - The head commit for this entry - """ - headCommit: Commit - - """ - The Node ID of the MergeQueueEntry object - """ - id: ID! - - """ - Whether this pull request should jump the queue - """ - jump: Boolean! - - """ - The merge queue that this entry belongs to - """ - mergeQueue: MergeQueue - - """ - The position of this entry in the queue - """ - position: Int! - - """ - The pull request that will be added to a merge group - """ - pullRequest: PullRequest - - """ - Does this pull request need to be deployed on its own - """ - solo: Boolean! - - """ - The state of this entry in the queue - """ - state: MergeQueueEntryState! -} - -""" -The connection type for MergeQueueEntry. -""" -type MergeQueueEntryConnection { - """ - A list of edges. - """ - edges: [MergeQueueEntryEdge] - - """ - A list of nodes. - """ - nodes: [MergeQueueEntry] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type MergeQueueEntryEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: MergeQueueEntry -} - -""" -The possible states for a merge queue entry. -""" -enum MergeQueueEntryState { - """ - The entry is currently waiting for checks to pass. - """ - AWAITING_CHECKS - - """ - The entry is currently locked. - """ - LOCKED - - """ - The entry is currently mergeable. - """ - MERGEABLE - - """ - The entry is currently queued. - """ - QUEUED - - """ - The entry is currently unmergeable. - """ - UNMERGEABLE -} - -""" -The possible merging strategies for a merge queue. -""" -enum MergeQueueMergingStrategy { - """ - Entries only allowed to merge if they are passing. - """ - ALLGREEN - - """ - Failing Entires are allowed to merge if they are with a passing entry. - """ - HEADGREEN -} - -""" -Detailed status information about a pull request merge. -""" -enum MergeStateStatus { - """ - The head ref is out of date. - """ - BEHIND - - """ - The merge is blocked. - """ - BLOCKED - - """ - Mergeable and passing commit status. - """ - CLEAN - - """ - The merge commit cannot be cleanly created. - """ - DIRTY - - """ - The merge is blocked due to the pull request being a draft. - """ - DRAFT - @deprecated( - reason: "DRAFT state will be removed from this enum and `isDraft` should be used instead Use PullRequest.isDraft instead. Removal on 2021-01-01 UTC." - ) - - """ - Mergeable with passing commit status and pre-receive hooks. - """ - HAS_HOOKS - - """ - The state cannot currently be determined. - """ - UNKNOWN - - """ - Mergeable with non-passing commit status. - """ - UNSTABLE -} - -""" -Whether or not a PullRequest can be merged. -""" -enum MergeableState { - """ - The pull request cannot be merged due to merge conflicts. - """ - CONFLICTING - - """ - The pull request can be merged. - """ - MERGEABLE - - """ - The mergeability of the pull request is still being calculated. - """ - UNKNOWN -} - -""" -Represents a 'merged' event on a given pull request. -""" -type MergedEvent implements Node & UniformResourceLocatable { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the commit associated with the `merge` event. - """ - commit: Commit - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the MergedEvent object - """ - id: ID! - - """ - Identifies the Ref associated with the `merge` event. - """ - mergeRef: Ref - - """ - Identifies the name of the Ref associated with the `merge` event. - """ - mergeRefName: String! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest! - - """ - The HTTP path for this merged event. - """ - resourcePath: URI! - - """ - The HTTP URL for this merged event. - """ - url: URI! -} - -""" -Represents a GitHub Enterprise Importer (GEI) migration. -""" -interface Migration { - """ - The migration flag to continue on error. - """ - continueOnError: Boolean! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: String - - """ - The reason the migration failed. - """ - failureReason: String - - """ - The Node ID of the Migration object - """ - id: ID! - - """ - The URL for the migration log (expires 1 day after migration completes). - """ - migrationLogUrl: URI - - """ - The migration source. - """ - migrationSource: MigrationSource! - - """ - The target repository name. - """ - repositoryName: String! - - """ - The migration source URL, for example `https://github.com` or `https://monalisa.ghe.com`. - """ - sourceUrl: URI! - - """ - The migration state. - """ - state: MigrationState! - - """ - The number of warnings encountered for this migration. To review the warnings, - check the [Migration Log](https://docs.github.com/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer). - """ - warningsCount: Int! -} - -""" -A GitHub Enterprise Importer (GEI) migration source. -""" -type MigrationSource implements Node { - """ - The Node ID of the MigrationSource object - """ - id: ID! - - """ - The migration source name. - """ - name: String! - - """ - The migration source type. - """ - type: MigrationSourceType! - - """ - The migration source URL, for example `https://github.com` or `https://monalisa.ghe.com`. - """ - url: URI! -} - -""" -Represents the different GitHub Enterprise Importer (GEI) migration sources. -""" -enum MigrationSourceType { - """ - An Azure DevOps migration source. - """ - AZURE_DEVOPS - - """ - A Bitbucket Server migration source. - """ - BITBUCKET_SERVER - - """ - A GitHub Migration API source. - """ - GITHUB_ARCHIVE -} - -""" -The GitHub Enterprise Importer (GEI) migration state. -""" -enum MigrationState { - """ - The migration has failed. - """ - FAILED - - """ - The migration has invalid credentials. - """ - FAILED_VALIDATION - - """ - The migration is in progress. - """ - IN_PROGRESS - - """ - The migration has not started. - """ - NOT_STARTED - - """ - The migration needs to have its credentials validated. - """ - PENDING_VALIDATION - - """ - The migration has been queued. - """ - QUEUED - - """ - The migration has succeeded. - """ - SUCCEEDED -} - -""" -Represents a Milestone object on a given repository. -""" -type Milestone implements Closable & Node & UniformResourceLocatable { - """ - Indicates if the object is closed (definition of closed may depend on type) - """ - closed: Boolean! - - """ - Identifies the date and time when the object was closed. - """ - closedAt: DateTime - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the actor who created the milestone. - """ - creator: Actor - - """ - Identifies the description of the milestone. - """ - description: String - - """ - Identifies the due date of the milestone. - """ - dueOn: DateTime - - """ - The Node ID of the Milestone object - """ - id: ID! - - """ - A list of issues associated with the milestone. - """ - issues( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Filtering options for issues returned from the connection. - """ - filterBy: IssueFilters - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - A list of label names to filter the pull requests by. - """ - labels: [String!] - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for issues returned from the connection. - """ - orderBy: IssueOrder - - """ - A list of states to filter the issues by. - """ - states: [IssueState!] - ): IssueConnection! - - """ - Identifies the number of the milestone. - """ - number: Int! - - """ - Identifies the percentage complete for the milestone - """ - progressPercentage: Float! - - """ - A list of pull requests associated with the milestone. - """ - pullRequests( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - The base ref name to filter the pull requests by. - """ - baseRefName: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - The head ref name to filter the pull requests by. - """ - headRefName: String - - """ - A list of label names to filter the pull requests by. - """ - labels: [String!] - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for pull requests returned from the connection. - """ - orderBy: IssueOrder - - """ - A list of states to filter the pull requests by. - """ - states: [PullRequestState!] - ): PullRequestConnection! - - """ - The repository associated with this milestone. - """ - repository: Repository! - - """ - The HTTP path for this milestone - """ - resourcePath: URI! - - """ - Identifies the state of the milestone. - """ - state: MilestoneState! - - """ - Identifies the title of the milestone. - """ - title: String! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this milestone - """ - url: URI! - - """ - Indicates if the object can be closed by the viewer. - """ - viewerCanClose: Boolean! - - """ - Indicates if the object can be reopened by the viewer. - """ - viewerCanReopen: Boolean! -} - -""" -The connection type for Milestone. -""" -type MilestoneConnection { - """ - A list of edges. - """ - edges: [MilestoneEdge] - - """ - A list of nodes. - """ - nodes: [Milestone] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type MilestoneEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Milestone -} - -""" -Types that can be inside a Milestone. -""" -union MilestoneItem = Issue | PullRequest - -""" -Ordering options for milestone connections. -""" -input MilestoneOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order milestones by. - """ - field: MilestoneOrderField! -} - -""" -Properties by which milestone connections can be ordered. -""" -enum MilestoneOrderField { - """ - Order milestones by when they were created. - """ - CREATED_AT - - """ - Order milestones by when they are due. - """ - DUE_DATE - - """ - Order milestones by their number. - """ - NUMBER - - """ - Order milestones by when they were last updated. - """ - UPDATED_AT -} - -""" -The possible states of a milestone. -""" -enum MilestoneState { - """ - A milestone that has been closed. - """ - CLOSED - - """ - A milestone that is still open. - """ - OPEN -} - -""" -Represents a 'milestoned' event on a given issue or pull request. -""" -type MilestonedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the MilestonedEvent object - """ - id: ID! - - """ - Identifies the milestone title associated with the 'milestoned' event. - """ - milestoneTitle: String! - - """ - Object referenced by event. - """ - subject: MilestoneItem! -} - -""" -Entities that can be minimized. -""" -interface Minimizable { - """ - Returns whether or not a comment has been minimized. - """ - isMinimized: Boolean! - - """ - Returns why the comment was minimized. One of `abuse`, `off-topic`, - `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and - formatting of these values differs from the inputs to the `MinimizeComment` mutation. - """ - minimizedReason: String - - """ - Check if the current viewer can minimize this object. - """ - viewerCanMinimize: Boolean! -} - -""" -Autogenerated input type of MinimizeComment -""" -input MinimizeCommentInput { - """ - The classification of comment - """ - classifier: ReportedContentClassifiers! - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the subject to modify. - """ - subjectId: ID! - @possibleTypes( - concreteTypes: [ - "CommitComment" - "DiscussionComment" - "GistComment" - "IssueComment" - "PullRequestReview" - "PullRequestReviewComment" - ] - abstractType: "Minimizable" - ) -} - -""" -Autogenerated return type of MinimizeComment -""" -type MinimizeCommentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The comment that was minimized. - """ - minimizedComment: Minimizable -} - -""" -Autogenerated input type of MoveProjectCard -""" -input MoveProjectCardInput { - """ - Place the new card after the card with this id. Pass null to place it at the top. - """ - afterCardId: ID @possibleTypes(concreteTypes: ["ProjectCard"]) - - """ - The id of the card to move. - """ - cardId: ID! @possibleTypes(concreteTypes: ["ProjectCard"]) - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The id of the column to move it into. - """ - columnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"]) -} - -""" -Autogenerated return type of MoveProjectCard -""" -type MoveProjectCardPayload { - """ - The new edge of the moved card. - """ - cardEdge: ProjectCardEdge - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of MoveProjectColumn -""" -input MoveProjectColumnInput { - """ - Place the new column after the column with this id. Pass null to place it at the front. - """ - afterColumnId: ID @possibleTypes(concreteTypes: ["ProjectColumn"]) - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The id of the column to move. - """ - columnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"]) -} - -""" -Autogenerated return type of MoveProjectColumn -""" -type MoveProjectColumnPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new edge of the moved column. - """ - columnEdge: ProjectColumnEdge -} - -""" -Represents a 'moved_columns_in_project' event on a given issue or pull request. -""" -type MovedColumnsInProjectEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the MovedColumnsInProjectEvent object - """ - id: ID! - - """ - Column name the issue or pull request was moved from. - """ - previousProjectColumnName: String! - - """ - Project referenced by event. - """ - project: Project - - """ - Project card referenced by this project event. - """ - projectCard: ProjectCard - - """ - Column name the issue or pull request was moved to. - """ - projectColumnName: String! -} - -""" -The root query for implementing GraphQL mutations. -""" -type Mutation { - """ - Clear all of a customer's queued migrations - """ - abortQueuedMigrations( - """ - Parameters for AbortQueuedMigrations - """ - input: AbortQueuedMigrationsInput! - ): AbortQueuedMigrationsPayload - - """ - Abort a repository migration queued or in progress. - """ - abortRepositoryMigration( - """ - Parameters for AbortRepositoryMigration - """ - input: AbortRepositoryMigrationInput! - ): AbortRepositoryMigrationPayload - - """ - Adds assignees to an assignable object. - """ - addAssigneesToAssignable( - """ - Parameters for AddAssigneesToAssignable - """ - input: AddAssigneesToAssignableInput! - ): AddAssigneesToAssignablePayload - - """ - Adds a comment to an Issue or Pull Request. - """ - addComment( - """ - Parameters for AddComment - """ - input: AddCommentInput! - ): AddCommentPayload - - """ - Adds a comment to a Discussion, possibly as a reply to another comment. - """ - addDiscussionComment( - """ - Parameters for AddDiscussionComment - """ - input: AddDiscussionCommentInput! - ): AddDiscussionCommentPayload - - """ - Vote for an option in a discussion poll. - """ - addDiscussionPollVote( - """ - Parameters for AddDiscussionPollVote - """ - input: AddDiscussionPollVoteInput! - ): AddDiscussionPollVotePayload - - """ - Adds an administrator to the global enterprise account. - """ - addEnterpriseAdmin( - """ - Parameters for AddEnterpriseAdmin - """ - input: AddEnterpriseAdminInput! - ): AddEnterpriseAdminPayload - - """ - Adds enterprise members to an organization within the enterprise. - """ - addEnterpriseOrganizationMember( - """ - Parameters for AddEnterpriseOrganizationMember - """ - input: AddEnterpriseOrganizationMemberInput! - ): AddEnterpriseOrganizationMemberPayload - - """ - Adds labels to a labelable object. - """ - addLabelsToLabelable( - """ - Parameters for AddLabelsToLabelable - """ - input: AddLabelsToLabelableInput! - ): AddLabelsToLabelablePayload - - """ - Adds a card to a ProjectColumn. Either `contentId` or `note` must be provided but **not** both. - """ - addProjectCard( - """ - Parameters for AddProjectCard - """ - input: AddProjectCardInput! - ): AddProjectCardPayload - - """ - Adds a column to a Project. - """ - addProjectColumn( - """ - Parameters for AddProjectColumn - """ - input: AddProjectColumnInput! - ): AddProjectColumnPayload - - """ - Creates a new draft issue and add it to a Project. - """ - addProjectV2DraftIssue( - """ - Parameters for AddProjectV2DraftIssue - """ - input: AddProjectV2DraftIssueInput! - ): AddProjectV2DraftIssuePayload - - """ - Links an existing content instance to a Project. - """ - addProjectV2ItemById( - """ - Parameters for AddProjectV2ItemById - """ - input: AddProjectV2ItemByIdInput! - ): AddProjectV2ItemByIdPayload - - """ - Adds a review to a Pull Request. - """ - addPullRequestReview( - """ - Parameters for AddPullRequestReview - """ - input: AddPullRequestReviewInput! - ): AddPullRequestReviewPayload - - """ - Adds a comment to a review. - """ - addPullRequestReviewComment( - """ - Parameters for AddPullRequestReviewComment - """ - input: AddPullRequestReviewCommentInput! - ): AddPullRequestReviewCommentPayload - - """ - Adds a new thread to a pending Pull Request Review. - """ - addPullRequestReviewThread( - """ - Parameters for AddPullRequestReviewThread - """ - input: AddPullRequestReviewThreadInput! - ): AddPullRequestReviewThreadPayload - - """ - Adds a reply to an existing Pull Request Review Thread. - """ - addPullRequestReviewThreadReply( - """ - Parameters for AddPullRequestReviewThreadReply - """ - input: AddPullRequestReviewThreadReplyInput! - ): AddPullRequestReviewThreadReplyPayload - - """ - Adds a reaction to a subject. - """ - addReaction( - """ - Parameters for AddReaction - """ - input: AddReactionInput! - ): AddReactionPayload - - """ - Adds a star to a Starrable. - """ - addStar( - """ - Parameters for AddStar - """ - input: AddStarInput! - ): AddStarPayload - - """ - Add an upvote to a discussion or discussion comment. - """ - addUpvote( - """ - Parameters for AddUpvote - """ - input: AddUpvoteInput! - ): AddUpvotePayload - - """ - Adds a verifiable domain to an owning account. - """ - addVerifiableDomain( - """ - Parameters for AddVerifiableDomain - """ - input: AddVerifiableDomainInput! - ): AddVerifiableDomainPayload - - """ - Approve all pending deployments under one or more environments - """ - approveDeployments( - """ - Parameters for ApproveDeployments - """ - input: ApproveDeploymentsInput! - ): ApproveDeploymentsPayload - - """ - Approve a verifiable domain for notification delivery. - """ - approveVerifiableDomain( - """ - Parameters for ApproveVerifiableDomain - """ - input: ApproveVerifiableDomainInput! - ): ApproveVerifiableDomainPayload - - """ - Archives a ProjectV2Item - """ - archiveProjectV2Item( - """ - Parameters for ArchiveProjectV2Item - """ - input: ArchiveProjectV2ItemInput! - ): ArchiveProjectV2ItemPayload - - """ - Marks a repository as archived. - """ - archiveRepository( - """ - Parameters for ArchiveRepository - """ - input: ArchiveRepositoryInput! - ): ArchiveRepositoryPayload - - """ - Update your status on GitHub. - """ - changeUserStatus( - """ - Parameters for ChangeUserStatus - """ - input: ChangeUserStatusInput! - ): ChangeUserStatusPayload - - """ - Clears all labels from a labelable object. - """ - clearLabelsFromLabelable( - """ - Parameters for ClearLabelsFromLabelable - """ - input: ClearLabelsFromLabelableInput! - ): ClearLabelsFromLabelablePayload - - """ - This mutation clears the value of a field for an item in a Project. Currently - only text, number, date, assignees, labels, single-select, iteration and - milestone fields are supported. - """ - clearProjectV2ItemFieldValue( - """ - Parameters for ClearProjectV2ItemFieldValue - """ - input: ClearProjectV2ItemFieldValueInput! - ): ClearProjectV2ItemFieldValuePayload - - """ - Creates a new project by cloning configuration from an existing project. - """ - cloneProject( - """ - Parameters for CloneProject - """ - input: CloneProjectInput! - ): CloneProjectPayload - - """ - Create a new repository with the same files and directory structure as a template repository. - """ - cloneTemplateRepository( - """ - Parameters for CloneTemplateRepository - """ - input: CloneTemplateRepositoryInput! - ): CloneTemplateRepositoryPayload - - """ - Close a discussion. - """ - closeDiscussion( - """ - Parameters for CloseDiscussion - """ - input: CloseDiscussionInput! - ): CloseDiscussionPayload - - """ - Close an issue. - """ - closeIssue( - """ - Parameters for CloseIssue - """ - input: CloseIssueInput! - ): CloseIssuePayload - - """ - Close a pull request. - """ - closePullRequest( - """ - Parameters for ClosePullRequest - """ - input: ClosePullRequestInput! - ): ClosePullRequestPayload - - """ - Convert a project note card to one associated with a newly created issue. - """ - convertProjectCardNoteToIssue( - """ - Parameters for ConvertProjectCardNoteToIssue - """ - input: ConvertProjectCardNoteToIssueInput! - ): ConvertProjectCardNoteToIssuePayload - - """ - Converts a pull request to draft - """ - convertPullRequestToDraft( - """ - Parameters for ConvertPullRequestToDraft - """ - input: ConvertPullRequestToDraftInput! - ): ConvertPullRequestToDraftPayload - - """ - Copy a project. - """ - copyProjectV2( - """ - Parameters for CopyProjectV2 - """ - input: CopyProjectV2Input! - ): CopyProjectV2Payload - - """ - Invites a user to claim reattributable data - """ - createAttributionInvitation( - """ - Parameters for CreateAttributionInvitation - """ - input: CreateAttributionInvitationInput! - ): CreateAttributionInvitationPayload - - """ - Create a new branch protection rule - """ - createBranchProtectionRule( - """ - Parameters for CreateBranchProtectionRule - """ - input: CreateBranchProtectionRuleInput! - ): CreateBranchProtectionRulePayload - - """ - Create a check run. - """ - createCheckRun( - """ - Parameters for CreateCheckRun - """ - input: CreateCheckRunInput! - ): CreateCheckRunPayload - - """ - Create a check suite - """ - createCheckSuite( - """ - Parameters for CreateCheckSuite - """ - input: CreateCheckSuiteInput! - ): CreateCheckSuitePayload - - """ - Appends a commit to the given branch as the authenticated user. - - This mutation creates a commit whose parent is the HEAD of the provided - branch and also updates that branch to point to the new commit. - It can be thought of as similar to `git commit`. - - ### Locating a Branch - - Commits are appended to a `branch` of type `Ref`. - This must refer to a git branch (i.e. the fully qualified path must - begin with `refs/heads/`, although including this prefix is optional. - - Callers may specify the `branch` to commit to either by its global node - ID or by passing both of `repositoryNameWithOwner` and `refName`. For - more details see the documentation for `CommittableBranch`. - - ### Describing Changes - - `fileChanges` are specified as a `FilesChanges` object describing - `FileAdditions` and `FileDeletions`. - - Please see the documentation for `FileChanges` for more information on - how to use this argument to describe any set of file changes. - - ### Authorship - - Similar to the web commit interface, this mutation does not support - specifying the author or committer of the commit and will not add - support for this in the future. - - A commit created by a successful execution of this mutation will be - authored by the owner of the credential which authenticates the API - request. The committer will be identical to that of commits authored - using the web interface. - - If you need full control over author and committer information, please - use the Git Database REST API instead. - - ### Commit Signing - - Commits made using this mutation are automatically signed by GitHub if - supported and will be marked as verified in the user interface. - """ - createCommitOnBranch( - """ - Parameters for CreateCommitOnBranch - """ - input: CreateCommitOnBranchInput! - ): CreateCommitOnBranchPayload - - """ - Creates a new deployment event. - """ - createDeployment( - """ - Parameters for CreateDeployment - """ - input: CreateDeploymentInput! - ): CreateDeploymentPayload - - """ - Create a deployment status. - """ - createDeploymentStatus( - """ - Parameters for CreateDeploymentStatus - """ - input: CreateDeploymentStatusInput! - ): CreateDeploymentStatusPayload - - """ - Create a discussion. - """ - createDiscussion( - """ - Parameters for CreateDiscussion - """ - input: CreateDiscussionInput! - ): CreateDiscussionPayload - - """ - Creates an organization as part of an enterprise account. A personal access - token used to create an organization is implicitly permitted to update the - organization it created, if the organization is part of an enterprise that has - SAML enabled or uses Enterprise Managed Users. If the organization is not part - of such an enterprise, and instead has SAML enabled for it individually, the - token will then require SAML authorization to continue working against that organization. - """ - createEnterpriseOrganization( - """ - Parameters for CreateEnterpriseOrganization - """ - input: CreateEnterpriseOrganizationInput! - ): CreateEnterpriseOrganizationPayload - - """ - Creates an environment or simply returns it if already exists. - """ - createEnvironment( - """ - Parameters for CreateEnvironment - """ - input: CreateEnvironmentInput! - ): CreateEnvironmentPayload - - """ - Creates a new IP allow list entry. - """ - createIpAllowListEntry( - """ - Parameters for CreateIpAllowListEntry - """ - input: CreateIpAllowListEntryInput! - ): CreateIpAllowListEntryPayload - - """ - Creates a new issue. - """ - createIssue( - """ - Parameters for CreateIssue - """ - input: CreateIssueInput! - ): CreateIssuePayload - - """ - Creates a new label. - """ - createLabel( - """ - Parameters for CreateLabel - """ - input: CreateLabelInput! - ): CreateLabelPayload - - """ - Create a branch linked to an issue. - """ - createLinkedBranch( - """ - Parameters for CreateLinkedBranch - """ - input: CreateLinkedBranchInput! - ): CreateLinkedBranchPayload - - """ - Creates a GitHub Enterprise Importer (GEI) migration source. - """ - createMigrationSource( - """ - Parameters for CreateMigrationSource - """ - input: CreateMigrationSourceInput! - ): CreateMigrationSourcePayload - - """ - Creates a new project. - """ - createProject( - """ - Parameters for CreateProject - """ - input: CreateProjectInput! - ): CreateProjectPayload - - """ - Creates a new project. - """ - createProjectV2( - """ - Parameters for CreateProjectV2 - """ - input: CreateProjectV2Input! - ): CreateProjectV2Payload - - """ - Create a new project field. - """ - createProjectV2Field( - """ - Parameters for CreateProjectV2Field - """ - input: CreateProjectV2FieldInput! - ): CreateProjectV2FieldPayload - - """ - Create a new pull request - """ - createPullRequest( - """ - Parameters for CreatePullRequest - """ - input: CreatePullRequestInput! - ): CreatePullRequestPayload - - """ - Create a new Git Ref. - """ - createRef( - """ - Parameters for CreateRef - """ - input: CreateRefInput! - ): CreateRefPayload - - """ - Create a new repository. - """ - createRepository( - """ - Parameters for CreateRepository - """ - input: CreateRepositoryInput! - ): CreateRepositoryPayload - - """ - Create a repository ruleset - """ - createRepositoryRuleset( - """ - Parameters for CreateRepositoryRuleset - """ - input: CreateRepositoryRulesetInput! - ): CreateRepositoryRulesetPayload - - """ - Creates a new team discussion. - """ - createTeamDiscussion( - """ - Parameters for CreateTeamDiscussion - """ - input: CreateTeamDiscussionInput! - ): CreateTeamDiscussionPayload - - """ - Creates a new team discussion comment. - """ - createTeamDiscussionComment( - """ - Parameters for CreateTeamDiscussionComment - """ - input: CreateTeamDiscussionCommentInput! - ): CreateTeamDiscussionCommentPayload - - """ - Creates a new user list. - """ - createUserList( - """ - Parameters for CreateUserList - """ - input: CreateUserListInput! - ): CreateUserListPayload - - """ - Delete a branch protection rule - """ - deleteBranchProtectionRule( - """ - Parameters for DeleteBranchProtectionRule - """ - input: DeleteBranchProtectionRuleInput! - ): DeleteBranchProtectionRulePayload - - """ - Deletes a deployment. - """ - deleteDeployment( - """ - Parameters for DeleteDeployment - """ - input: DeleteDeploymentInput! - ): DeleteDeploymentPayload - - """ - Delete a discussion and all of its replies. - """ - deleteDiscussion( - """ - Parameters for DeleteDiscussion - """ - input: DeleteDiscussionInput! - ): DeleteDiscussionPayload - - """ - Delete a discussion comment. If it has replies, wipe it instead. - """ - deleteDiscussionComment( - """ - Parameters for DeleteDiscussionComment - """ - input: DeleteDiscussionCommentInput! - ): DeleteDiscussionCommentPayload - - """ - Deletes an environment - """ - deleteEnvironment( - """ - Parameters for DeleteEnvironment - """ - input: DeleteEnvironmentInput! - ): DeleteEnvironmentPayload - - """ - Deletes an IP allow list entry. - """ - deleteIpAllowListEntry( - """ - Parameters for DeleteIpAllowListEntry - """ - input: DeleteIpAllowListEntryInput! - ): DeleteIpAllowListEntryPayload - - """ - Deletes an Issue object. - """ - deleteIssue( - """ - Parameters for DeleteIssue - """ - input: DeleteIssueInput! - ): DeleteIssuePayload - - """ - Deletes an IssueComment object. - """ - deleteIssueComment( - """ - Parameters for DeleteIssueComment - """ - input: DeleteIssueCommentInput! - ): DeleteIssueCommentPayload - - """ - Deletes a label. - """ - deleteLabel( - """ - Parameters for DeleteLabel - """ - input: DeleteLabelInput! - ): DeleteLabelPayload - - """ - Unlink a branch from an issue. - """ - deleteLinkedBranch( - """ - Parameters for DeleteLinkedBranch - """ - input: DeleteLinkedBranchInput! - ): DeleteLinkedBranchPayload - - """ - Delete a package version. - """ - deletePackageVersion( - """ - Parameters for DeletePackageVersion - """ - input: DeletePackageVersionInput! - ): DeletePackageVersionPayload - - """ - Deletes a project. - """ - deleteProject( - """ - Parameters for DeleteProject - """ - input: DeleteProjectInput! - ): DeleteProjectPayload - - """ - Deletes a project card. - """ - deleteProjectCard( - """ - Parameters for DeleteProjectCard - """ - input: DeleteProjectCardInput! - ): DeleteProjectCardPayload - - """ - Deletes a project column. - """ - deleteProjectColumn( - """ - Parameters for DeleteProjectColumn - """ - input: DeleteProjectColumnInput! - ): DeleteProjectColumnPayload - - """ - Delete a project. - """ - deleteProjectV2( - """ - Parameters for DeleteProjectV2 - """ - input: DeleteProjectV2Input! - ): DeleteProjectV2Payload - - """ - Delete a project field. - """ - deleteProjectV2Field( - """ - Parameters for DeleteProjectV2Field - """ - input: DeleteProjectV2FieldInput! - ): DeleteProjectV2FieldPayload - - """ - Deletes an item from a Project. - """ - deleteProjectV2Item( - """ - Parameters for DeleteProjectV2Item - """ - input: DeleteProjectV2ItemInput! - ): DeleteProjectV2ItemPayload - - """ - Deletes a project workflow. - """ - deleteProjectV2Workflow( - """ - Parameters for DeleteProjectV2Workflow - """ - input: DeleteProjectV2WorkflowInput! - ): DeleteProjectV2WorkflowPayload - - """ - Deletes a pull request review. - """ - deletePullRequestReview( - """ - Parameters for DeletePullRequestReview - """ - input: DeletePullRequestReviewInput! - ): DeletePullRequestReviewPayload - - """ - Deletes a pull request review comment. - """ - deletePullRequestReviewComment( - """ - Parameters for DeletePullRequestReviewComment - """ - input: DeletePullRequestReviewCommentInput! - ): DeletePullRequestReviewCommentPayload - - """ - Delete a Git Ref. - """ - deleteRef( - """ - Parameters for DeleteRef - """ - input: DeleteRefInput! - ): DeleteRefPayload - - """ - Delete a repository ruleset - """ - deleteRepositoryRuleset( - """ - Parameters for DeleteRepositoryRuleset - """ - input: DeleteRepositoryRulesetInput! - ): DeleteRepositoryRulesetPayload - - """ - Deletes a team discussion. - """ - deleteTeamDiscussion( - """ - Parameters for DeleteTeamDiscussion - """ - input: DeleteTeamDiscussionInput! - ): DeleteTeamDiscussionPayload - - """ - Deletes a team discussion comment. - """ - deleteTeamDiscussionComment( - """ - Parameters for DeleteTeamDiscussionComment - """ - input: DeleteTeamDiscussionCommentInput! - ): DeleteTeamDiscussionCommentPayload - - """ - Deletes a user list. - """ - deleteUserList( - """ - Parameters for DeleteUserList - """ - input: DeleteUserListInput! - ): DeleteUserListPayload - - """ - Deletes a verifiable domain. - """ - deleteVerifiableDomain( - """ - Parameters for DeleteVerifiableDomain - """ - input: DeleteVerifiableDomainInput! - ): DeleteVerifiableDomainPayload - - """ - Remove a pull request from the merge queue. - """ - dequeuePullRequest( - """ - Parameters for DequeuePullRequest - """ - input: DequeuePullRequestInput! - ): DequeuePullRequestPayload - - """ - Disable auto merge on the given pull request - """ - disablePullRequestAutoMerge( - """ - Parameters for DisablePullRequestAutoMerge - """ - input: DisablePullRequestAutoMergeInput! - ): DisablePullRequestAutoMergePayload - - """ - Dismisses an approved or rejected pull request review. - """ - dismissPullRequestReview( - """ - Parameters for DismissPullRequestReview - """ - input: DismissPullRequestReviewInput! - ): DismissPullRequestReviewPayload - - """ - Dismisses the Dependabot alert. - """ - dismissRepositoryVulnerabilityAlert( - """ - Parameters for DismissRepositoryVulnerabilityAlert - """ - input: DismissRepositoryVulnerabilityAlertInput! - ): DismissRepositoryVulnerabilityAlertPayload - - """ - Enable the default auto-merge on a pull request. - """ - enablePullRequestAutoMerge( - """ - Parameters for EnablePullRequestAutoMerge - """ - input: EnablePullRequestAutoMergeInput! - ): EnablePullRequestAutoMergePayload - - """ - Add a pull request to the merge queue. - """ - enqueuePullRequest( - """ - Parameters for EnqueuePullRequest - """ - input: EnqueuePullRequestInput! - ): EnqueuePullRequestPayload - - """ - Follow an organization. - """ - followOrganization( - """ - Parameters for FollowOrganization - """ - input: FollowOrganizationInput! - ): FollowOrganizationPayload - - """ - Follow a user. - """ - followUser( - """ - Parameters for FollowUser - """ - input: FollowUserInput! - ): FollowUserPayload - - """ - Grant the migrator role to a user for all organizations under an enterprise account. - """ - grantEnterpriseOrganizationsMigratorRole( - """ - Parameters for GrantEnterpriseOrganizationsMigratorRole - """ - input: GrantEnterpriseOrganizationsMigratorRoleInput! - ): GrantEnterpriseOrganizationsMigratorRolePayload - - """ - Grant the migrator role to a user or a team. - """ - grantMigratorRole( - """ - Parameters for GrantMigratorRole - """ - input: GrantMigratorRoleInput! - ): GrantMigratorRolePayload - - """ - Creates a new project by importing columns and a list of issues/PRs. - """ - importProject( - """ - Parameters for ImportProject - """ - input: ImportProjectInput! - ): ImportProjectPayload - - """ - Links a project to a repository. - """ - linkProjectV2ToRepository( - """ - Parameters for LinkProjectV2ToRepository - """ - input: LinkProjectV2ToRepositoryInput! - ): LinkProjectV2ToRepositoryPayload - - """ - Links a project to a team. - """ - linkProjectV2ToTeam( - """ - Parameters for LinkProjectV2ToTeam - """ - input: LinkProjectV2ToTeamInput! - ): LinkProjectV2ToTeamPayload - - """ - Creates a repository link for a project. - """ - linkRepositoryToProject( - """ - Parameters for LinkRepositoryToProject - """ - input: LinkRepositoryToProjectInput! - ): LinkRepositoryToProjectPayload - - """ - Lock a lockable object - """ - lockLockable( - """ - Parameters for LockLockable - """ - input: LockLockableInput! - ): LockLockablePayload - - """ - Mark a discussion comment as the chosen answer for discussions in an answerable category. - """ - markDiscussionCommentAsAnswer( - """ - Parameters for MarkDiscussionCommentAsAnswer - """ - input: MarkDiscussionCommentAsAnswerInput! - ): MarkDiscussionCommentAsAnswerPayload - - """ - Mark a pull request file as viewed - """ - markFileAsViewed( - """ - Parameters for MarkFileAsViewed - """ - input: MarkFileAsViewedInput! - ): MarkFileAsViewedPayload - - """ - Marks a notification as done - """ - markNotificationAsDone( - """ - Parameters for MarkNotificationAsDone - """ - input: MarkNotificationAsDoneInput! - ): MarkNotificationAsDonePayload - - """ - Mark a project as a template. Note that only projects which are owned by an Organization can be marked as a template. - """ - markProjectV2AsTemplate( - """ - Parameters for MarkProjectV2AsTemplate - """ - input: MarkProjectV2AsTemplateInput! - ): MarkProjectV2AsTemplatePayload - - """ - Marks a pull request ready for review. - """ - markPullRequestReadyForReview( - """ - Parameters for MarkPullRequestReadyForReview - """ - input: MarkPullRequestReadyForReviewInput! - ): MarkPullRequestReadyForReviewPayload - - """ - Merge a head into a branch. - """ - mergeBranch( - """ - Parameters for MergeBranch - """ - input: MergeBranchInput! - ): MergeBranchPayload - - """ - Merge a pull request. - """ - mergePullRequest( - """ - Parameters for MergePullRequest - """ - input: MergePullRequestInput! - ): MergePullRequestPayload - - """ - Minimizes a comment on an Issue, Commit, Pull Request, or Gist - """ - minimizeComment( - """ - Parameters for MinimizeComment - """ - input: MinimizeCommentInput! - ): MinimizeCommentPayload - - """ - Moves a project card to another place. - """ - moveProjectCard( - """ - Parameters for MoveProjectCard - """ - input: MoveProjectCardInput! - ): MoveProjectCardPayload - - """ - Moves a project column to another place. - """ - moveProjectColumn( - """ - Parameters for MoveProjectColumn - """ - input: MoveProjectColumnInput! - ): MoveProjectColumnPayload - - """ - Pin an environment to a repository - """ - pinEnvironment( - """ - Parameters for PinEnvironment - """ - input: PinEnvironmentInput! - ): PinEnvironmentPayload - - """ - Pin an issue to a repository - """ - pinIssue( - """ - Parameters for PinIssue - """ - input: PinIssueInput! - ): PinIssuePayload - - """ - Regenerates a verifiable domain's verification token. - """ - regenerateVerifiableDomainToken( - """ - Parameters for RegenerateVerifiableDomainToken - """ - input: RegenerateVerifiableDomainTokenInput! - ): RegenerateVerifiableDomainTokenPayload - - """ - Reject all pending deployments under one or more environments - """ - rejectDeployments( - """ - Parameters for RejectDeployments - """ - input: RejectDeploymentsInput! - ): RejectDeploymentsPayload - - """ - Removes assignees from an assignable object. - """ - removeAssigneesFromAssignable( - """ - Parameters for RemoveAssigneesFromAssignable - """ - input: RemoveAssigneesFromAssignableInput! - ): RemoveAssigneesFromAssignablePayload - - """ - Removes an administrator from the enterprise. - """ - removeEnterpriseAdmin( - """ - Parameters for RemoveEnterpriseAdmin - """ - input: RemoveEnterpriseAdminInput! - ): RemoveEnterpriseAdminPayload - - """ - Removes labels from a Labelable object. - """ - removeLabelsFromLabelable( - """ - Parameters for RemoveLabelsFromLabelable - """ - input: RemoveLabelsFromLabelableInput! - ): RemoveLabelsFromLabelablePayload - - """ - Removes outside collaborator from all repositories in an organization. - """ - removeOutsideCollaborator( - """ - Parameters for RemoveOutsideCollaborator - """ - input: RemoveOutsideCollaboratorInput! - ): RemoveOutsideCollaboratorPayload - - """ - Removes a reaction from a subject. - """ - removeReaction( - """ - Parameters for RemoveReaction - """ - input: RemoveReactionInput! - ): RemoveReactionPayload - - """ - Removes a star from a Starrable. - """ - removeStar( - """ - Parameters for RemoveStar - """ - input: RemoveStarInput! - ): RemoveStarPayload - - """ - Remove an upvote to a discussion or discussion comment. - """ - removeUpvote( - """ - Parameters for RemoveUpvote - """ - input: RemoveUpvoteInput! - ): RemoveUpvotePayload - - """ - Reopen a discussion. - """ - reopenDiscussion( - """ - Parameters for ReopenDiscussion - """ - input: ReopenDiscussionInput! - ): ReopenDiscussionPayload - - """ - Reopen a issue. - """ - reopenIssue( - """ - Parameters for ReopenIssue - """ - input: ReopenIssueInput! - ): ReopenIssuePayload - - """ - Reopen a pull request. - """ - reopenPullRequest( - """ - Parameters for ReopenPullRequest - """ - input: ReopenPullRequestInput! - ): ReopenPullRequestPayload - - """ - Reorder a pinned repository environment - """ - reorderEnvironment( - """ - Parameters for ReorderEnvironment - """ - input: ReorderEnvironmentInput! - ): ReorderEnvironmentPayload - - """ - Set review requests on a pull request. - """ - requestReviews( - """ - Parameters for RequestReviews - """ - input: RequestReviewsInput! - ): RequestReviewsPayload - - """ - Rerequests an existing check suite. - """ - rerequestCheckSuite( - """ - Parameters for RerequestCheckSuite - """ - input: RerequestCheckSuiteInput! - ): RerequestCheckSuitePayload - - """ - Marks a review thread as resolved. - """ - resolveReviewThread( - """ - Parameters for ResolveReviewThread - """ - input: ResolveReviewThreadInput! - ): ResolveReviewThreadPayload - - """ - Create a pull request that reverts the changes from a merged pull request. - """ - revertPullRequest( - """ - Parameters for RevertPullRequest - """ - input: RevertPullRequestInput! - ): RevertPullRequestPayload - - """ - Revoke the migrator role to a user for all organizations under an enterprise account. - """ - revokeEnterpriseOrganizationsMigratorRole( - """ - Parameters for RevokeEnterpriseOrganizationsMigratorRole - """ - input: RevokeEnterpriseOrganizationsMigratorRoleInput! - ): RevokeEnterpriseOrganizationsMigratorRolePayload - - """ - Revoke the migrator role from a user or a team. - """ - revokeMigratorRole( - """ - Parameters for RevokeMigratorRole - """ - input: RevokeMigratorRoleInput! - ): RevokeMigratorRolePayload - - """ - Starts a GitHub Enterprise Importer organization migration. - """ - startOrganizationMigration( - """ - Parameters for StartOrganizationMigration - """ - input: StartOrganizationMigrationInput! - ): StartOrganizationMigrationPayload - - """ - Starts a GitHub Enterprise Importer (GEI) repository migration. - """ - startRepositoryMigration( - """ - Parameters for StartRepositoryMigration - """ - input: StartRepositoryMigrationInput! - ): StartRepositoryMigrationPayload - - """ - Submits a pending pull request review. - """ - submitPullRequestReview( - """ - Parameters for SubmitPullRequestReview - """ - input: SubmitPullRequestReviewInput! - ): SubmitPullRequestReviewPayload - - """ - Transfer an issue to a different repository - """ - transferIssue( - """ - Parameters for TransferIssue - """ - input: TransferIssueInput! - ): TransferIssuePayload - - """ - Unarchives a ProjectV2Item - """ - unarchiveProjectV2Item( - """ - Parameters for UnarchiveProjectV2Item - """ - input: UnarchiveProjectV2ItemInput! - ): UnarchiveProjectV2ItemPayload - - """ - Unarchives a repository. - """ - unarchiveRepository( - """ - Parameters for UnarchiveRepository - """ - input: UnarchiveRepositoryInput! - ): UnarchiveRepositoryPayload - - """ - Unfollow an organization. - """ - unfollowOrganization( - """ - Parameters for UnfollowOrganization - """ - input: UnfollowOrganizationInput! - ): UnfollowOrganizationPayload - - """ - Unfollow a user. - """ - unfollowUser( - """ - Parameters for UnfollowUser - """ - input: UnfollowUserInput! - ): UnfollowUserPayload - - """ - Unlinks a project from a repository. - """ - unlinkProjectV2FromRepository( - """ - Parameters for UnlinkProjectV2FromRepository - """ - input: UnlinkProjectV2FromRepositoryInput! - ): UnlinkProjectV2FromRepositoryPayload - - """ - Unlinks a project to a team. - """ - unlinkProjectV2FromTeam( - """ - Parameters for UnlinkProjectV2FromTeam - """ - input: UnlinkProjectV2FromTeamInput! - ): UnlinkProjectV2FromTeamPayload - - """ - Deletes a repository link from a project. - """ - unlinkRepositoryFromProject( - """ - Parameters for UnlinkRepositoryFromProject - """ - input: UnlinkRepositoryFromProjectInput! - ): UnlinkRepositoryFromProjectPayload - - """ - Unlock a lockable object - """ - unlockLockable( - """ - Parameters for UnlockLockable - """ - input: UnlockLockableInput! - ): UnlockLockablePayload - - """ - Unmark a discussion comment as the chosen answer for discussions in an answerable category. - """ - unmarkDiscussionCommentAsAnswer( - """ - Parameters for UnmarkDiscussionCommentAsAnswer - """ - input: UnmarkDiscussionCommentAsAnswerInput! - ): UnmarkDiscussionCommentAsAnswerPayload - - """ - Unmark a pull request file as viewed - """ - unmarkFileAsViewed( - """ - Parameters for UnmarkFileAsViewed - """ - input: UnmarkFileAsViewedInput! - ): UnmarkFileAsViewedPayload - - """ - Unmark an issue as a duplicate of another issue. - """ - unmarkIssueAsDuplicate( - """ - Parameters for UnmarkIssueAsDuplicate - """ - input: UnmarkIssueAsDuplicateInput! - ): UnmarkIssueAsDuplicatePayload - - """ - Unmark a project as a template. - """ - unmarkProjectV2AsTemplate( - """ - Parameters for UnmarkProjectV2AsTemplate - """ - input: UnmarkProjectV2AsTemplateInput! - ): UnmarkProjectV2AsTemplatePayload - - """ - Unminimizes a comment on an Issue, Commit, Pull Request, or Gist - """ - unminimizeComment( - """ - Parameters for UnminimizeComment - """ - input: UnminimizeCommentInput! - ): UnminimizeCommentPayload - - """ - Unpin a pinned issue from a repository - """ - unpinIssue( - """ - Parameters for UnpinIssue - """ - input: UnpinIssueInput! - ): UnpinIssuePayload - - """ - Marks a review thread as unresolved. - """ - unresolveReviewThread( - """ - Parameters for UnresolveReviewThread - """ - input: UnresolveReviewThreadInput! - ): UnresolveReviewThreadPayload - - """ - Unsubscribes from notifications - """ - unsubscribeFromNotifications( - """ - Parameters for UnsubscribeFromNotifications - """ - input: UnsubscribeFromNotificationsInput! - ): UnsubscribeFromNotificationsPayload - - """ - Update a branch protection rule - """ - updateBranchProtectionRule( - """ - Parameters for UpdateBranchProtectionRule - """ - input: UpdateBranchProtectionRuleInput! - ): UpdateBranchProtectionRulePayload - - """ - Update a check run - """ - updateCheckRun( - """ - Parameters for UpdateCheckRun - """ - input: UpdateCheckRunInput! - ): UpdateCheckRunPayload - - """ - Modifies the settings of an existing check suite - """ - updateCheckSuitePreferences( - """ - Parameters for UpdateCheckSuitePreferences - """ - input: UpdateCheckSuitePreferencesInput! - ): UpdateCheckSuitePreferencesPayload - - """ - Update a discussion - """ - updateDiscussion( - """ - Parameters for UpdateDiscussion - """ - input: UpdateDiscussionInput! - ): UpdateDiscussionPayload - - """ - Update the contents of a comment on a Discussion - """ - updateDiscussionComment( - """ - Parameters for UpdateDiscussionComment - """ - input: UpdateDiscussionCommentInput! - ): UpdateDiscussionCommentPayload - - """ - Sets whether private repository forks are enabled for an enterprise. - """ - updateEnterpriseAllowPrivateRepositoryForkingSetting( - """ - Parameters for UpdateEnterpriseAllowPrivateRepositoryForkingSetting - """ - input: UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput! - ): UpdateEnterpriseAllowPrivateRepositoryForkingSettingPayload - - """ - Sets the base repository permission for organizations in an enterprise. - """ - updateEnterpriseDefaultRepositoryPermissionSetting( - """ - Parameters for UpdateEnterpriseDefaultRepositoryPermissionSetting - """ - input: UpdateEnterpriseDefaultRepositoryPermissionSettingInput! - ): UpdateEnterpriseDefaultRepositoryPermissionSettingPayload - - """ - Sets whether organization members with admin permissions on a repository can change repository visibility. - """ - updateEnterpriseMembersCanChangeRepositoryVisibilitySetting( - """ - Parameters for UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting - """ - input: UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput! - ): UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingPayload - - """ - Sets the members can create repositories setting for an enterprise. - """ - updateEnterpriseMembersCanCreateRepositoriesSetting( - """ - Parameters for UpdateEnterpriseMembersCanCreateRepositoriesSetting - """ - input: UpdateEnterpriseMembersCanCreateRepositoriesSettingInput! - ): UpdateEnterpriseMembersCanCreateRepositoriesSettingPayload - - """ - Sets the members can delete issues setting for an enterprise. - """ - updateEnterpriseMembersCanDeleteIssuesSetting( - """ - Parameters for UpdateEnterpriseMembersCanDeleteIssuesSetting - """ - input: UpdateEnterpriseMembersCanDeleteIssuesSettingInput! - ): UpdateEnterpriseMembersCanDeleteIssuesSettingPayload - - """ - Sets the members can delete repositories setting for an enterprise. - """ - updateEnterpriseMembersCanDeleteRepositoriesSetting( - """ - Parameters for UpdateEnterpriseMembersCanDeleteRepositoriesSetting - """ - input: UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput! - ): UpdateEnterpriseMembersCanDeleteRepositoriesSettingPayload - - """ - Sets whether members can invite collaborators are enabled for an enterprise. - """ - updateEnterpriseMembersCanInviteCollaboratorsSetting( - """ - Parameters for UpdateEnterpriseMembersCanInviteCollaboratorsSetting - """ - input: UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput! - ): UpdateEnterpriseMembersCanInviteCollaboratorsSettingPayload - - """ - Sets whether or not an organization owner can make purchases. - """ - updateEnterpriseMembersCanMakePurchasesSetting( - """ - Parameters for UpdateEnterpriseMembersCanMakePurchasesSetting - """ - input: UpdateEnterpriseMembersCanMakePurchasesSettingInput! - ): UpdateEnterpriseMembersCanMakePurchasesSettingPayload - - """ - Sets the members can update protected branches setting for an enterprise. - """ - updateEnterpriseMembersCanUpdateProtectedBranchesSetting( - """ - Parameters for UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting - """ - input: UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput! - ): UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingPayload - - """ - Sets the members can view dependency insights for an enterprise. - """ - updateEnterpriseMembersCanViewDependencyInsightsSetting( - """ - Parameters for UpdateEnterpriseMembersCanViewDependencyInsightsSetting - """ - input: UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput! - ): UpdateEnterpriseMembersCanViewDependencyInsightsSettingPayload - - """ - Sets whether organization projects are enabled for an enterprise. - """ - updateEnterpriseOrganizationProjectsSetting( - """ - Parameters for UpdateEnterpriseOrganizationProjectsSetting - """ - input: UpdateEnterpriseOrganizationProjectsSettingInput! - ): UpdateEnterpriseOrganizationProjectsSettingPayload - - """ - Updates the role of an enterprise owner with an organization. - """ - updateEnterpriseOwnerOrganizationRole( - """ - Parameters for UpdateEnterpriseOwnerOrganizationRole - """ - input: UpdateEnterpriseOwnerOrganizationRoleInput! - ): UpdateEnterpriseOwnerOrganizationRolePayload - - """ - Updates an enterprise's profile. - """ - updateEnterpriseProfile( - """ - Parameters for UpdateEnterpriseProfile - """ - input: UpdateEnterpriseProfileInput! - ): UpdateEnterpriseProfilePayload - - """ - Sets whether repository projects are enabled for a enterprise. - """ - updateEnterpriseRepositoryProjectsSetting( - """ - Parameters for UpdateEnterpriseRepositoryProjectsSetting - """ - input: UpdateEnterpriseRepositoryProjectsSettingInput! - ): UpdateEnterpriseRepositoryProjectsSettingPayload - - """ - Sets whether team discussions are enabled for an enterprise. - """ - updateEnterpriseTeamDiscussionsSetting( - """ - Parameters for UpdateEnterpriseTeamDiscussionsSetting - """ - input: UpdateEnterpriseTeamDiscussionsSettingInput! - ): UpdateEnterpriseTeamDiscussionsSettingPayload - - """ - Sets whether two factor authentication is required for all users in an enterprise. - """ - updateEnterpriseTwoFactorAuthenticationRequiredSetting( - """ - Parameters for UpdateEnterpriseTwoFactorAuthenticationRequiredSetting - """ - input: UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput! - ): UpdateEnterpriseTwoFactorAuthenticationRequiredSettingPayload - - """ - Updates an environment. - """ - updateEnvironment( - """ - Parameters for UpdateEnvironment - """ - input: UpdateEnvironmentInput! - ): UpdateEnvironmentPayload - - """ - Sets whether an IP allow list is enabled on an owner. - """ - updateIpAllowListEnabledSetting( - """ - Parameters for UpdateIpAllowListEnabledSetting - """ - input: UpdateIpAllowListEnabledSettingInput! - ): UpdateIpAllowListEnabledSettingPayload - - """ - Updates an IP allow list entry. - """ - updateIpAllowListEntry( - """ - Parameters for UpdateIpAllowListEntry - """ - input: UpdateIpAllowListEntryInput! - ): UpdateIpAllowListEntryPayload - - """ - Sets whether IP allow list configuration for installed GitHub Apps is enabled on an owner. - """ - updateIpAllowListForInstalledAppsEnabledSetting( - """ - Parameters for UpdateIpAllowListForInstalledAppsEnabledSetting - """ - input: UpdateIpAllowListForInstalledAppsEnabledSettingInput! - ): UpdateIpAllowListForInstalledAppsEnabledSettingPayload - - """ - Updates an Issue. - """ - updateIssue( - """ - Parameters for UpdateIssue - """ - input: UpdateIssueInput! - ): UpdateIssuePayload - - """ - Updates an IssueComment object. - """ - updateIssueComment( - """ - Parameters for UpdateIssueComment - """ - input: UpdateIssueCommentInput! - ): UpdateIssueCommentPayload - - """ - Updates an existing label. - """ - updateLabel( - """ - Parameters for UpdateLabel - """ - input: UpdateLabelInput! - ): UpdateLabelPayload - - """ - Update the setting to restrict notifications to only verified or approved domains available to an owner. - """ - updateNotificationRestrictionSetting( - """ - Parameters for UpdateNotificationRestrictionSetting - """ - input: UpdateNotificationRestrictionSettingInput! - ): UpdateNotificationRestrictionSettingPayload - - """ - Sets whether private repository forks are enabled for an organization. - """ - updateOrganizationAllowPrivateRepositoryForkingSetting( - """ - Parameters for UpdateOrganizationAllowPrivateRepositoryForkingSetting - """ - input: UpdateOrganizationAllowPrivateRepositoryForkingSettingInput! - ): UpdateOrganizationAllowPrivateRepositoryForkingSettingPayload - - """ - Sets whether contributors are required to sign off on web-based commits for repositories in an organization. - """ - updateOrganizationWebCommitSignoffSetting( - """ - Parameters for UpdateOrganizationWebCommitSignoffSetting - """ - input: UpdateOrganizationWebCommitSignoffSettingInput! - ): UpdateOrganizationWebCommitSignoffSettingPayload - - """ - Updates an existing project. - """ - updateProject( - """ - Parameters for UpdateProject - """ - input: UpdateProjectInput! - ): UpdateProjectPayload - - """ - Updates an existing project card. - """ - updateProjectCard( - """ - Parameters for UpdateProjectCard - """ - input: UpdateProjectCardInput! - ): UpdateProjectCardPayload - - """ - Updates an existing project column. - """ - updateProjectColumn( - """ - Parameters for UpdateProjectColumn - """ - input: UpdateProjectColumnInput! - ): UpdateProjectColumnPayload - - """ - Updates an existing project. - """ - updateProjectV2( - """ - Parameters for UpdateProjectV2 - """ - input: UpdateProjectV2Input! - ): UpdateProjectV2Payload - - """ - Update the collaborators on a team or a project - """ - updateProjectV2Collaborators( - """ - Parameters for UpdateProjectV2Collaborators - """ - input: UpdateProjectV2CollaboratorsInput! - ): UpdateProjectV2CollaboratorsPayload - - """ - Updates a draft issue within a Project. - """ - updateProjectV2DraftIssue( - """ - Parameters for UpdateProjectV2DraftIssue - """ - input: UpdateProjectV2DraftIssueInput! - ): UpdateProjectV2DraftIssuePayload - - """ - This mutation updates the value of a field for an item in a Project. Currently - only single-select, text, number, date, and iteration fields are supported. - """ - updateProjectV2ItemFieldValue( - """ - Parameters for UpdateProjectV2ItemFieldValue - """ - input: UpdateProjectV2ItemFieldValueInput! - ): UpdateProjectV2ItemFieldValuePayload - - """ - This mutation updates the position of the item in the project, where the position represents the priority of an item. - """ - updateProjectV2ItemPosition( - """ - Parameters for UpdateProjectV2ItemPosition - """ - input: UpdateProjectV2ItemPositionInput! - ): UpdateProjectV2ItemPositionPayload - - """ - Update a pull request - """ - updatePullRequest( - """ - Parameters for UpdatePullRequest - """ - input: UpdatePullRequestInput! - ): UpdatePullRequestPayload - - """ - Merge or Rebase HEAD from upstream branch into pull request branch - """ - updatePullRequestBranch( - """ - Parameters for UpdatePullRequestBranch - """ - input: UpdatePullRequestBranchInput! - ): UpdatePullRequestBranchPayload - - """ - Updates the body of a pull request review. - """ - updatePullRequestReview( - """ - Parameters for UpdatePullRequestReview - """ - input: UpdatePullRequestReviewInput! - ): UpdatePullRequestReviewPayload - - """ - Updates a pull request review comment. - """ - updatePullRequestReviewComment( - """ - Parameters for UpdatePullRequestReviewComment - """ - input: UpdatePullRequestReviewCommentInput! - ): UpdatePullRequestReviewCommentPayload - - """ - Update a Git Ref. - """ - updateRef( - """ - Parameters for UpdateRef - """ - input: UpdateRefInput! - ): UpdateRefPayload - - """ - Creates, updates and/or deletes multiple refs in a repository. - - This mutation takes a list of `RefUpdate`s and performs these updates - on the repository. All updates are performed atomically, meaning that - if one of them is rejected, no other ref will be modified. - - `RefUpdate.beforeOid` specifies that the given reference needs to point - to the given value before performing any updates. A value of - `0000000000000000000000000000000000000000` can be used to verify that - the references should not exist. - - `RefUpdate.afterOid` specifies the value that the given reference - will point to after performing all updates. A value of - `0000000000000000000000000000000000000000` can be used to delete a - reference. - - If `RefUpdate.force` is set to `true`, a non-fast-forward updates - for the given reference will be allowed. - """ - updateRefs( - """ - Parameters for UpdateRefs - """ - input: UpdateRefsInput! - ): UpdateRefsPayload - - """ - Update information about a repository. - """ - updateRepository( - """ - Parameters for UpdateRepository - """ - input: UpdateRepositoryInput! - ): UpdateRepositoryPayload - - """ - Update a repository ruleset - """ - updateRepositoryRuleset( - """ - Parameters for UpdateRepositoryRuleset - """ - input: UpdateRepositoryRulesetInput! - ): UpdateRepositoryRulesetPayload - - """ - Sets whether contributors are required to sign off on web-based commits for a repository. - """ - updateRepositoryWebCommitSignoffSetting( - """ - Parameters for UpdateRepositoryWebCommitSignoffSetting - """ - input: UpdateRepositoryWebCommitSignoffSettingInput! - ): UpdateRepositoryWebCommitSignoffSettingPayload - - """ - Updates the state for subscribable subjects. - """ - updateSubscription( - """ - Parameters for UpdateSubscription - """ - input: UpdateSubscriptionInput! - ): UpdateSubscriptionPayload - - """ - Updates a team discussion. - """ - updateTeamDiscussion( - """ - Parameters for UpdateTeamDiscussion - """ - input: UpdateTeamDiscussionInput! - ): UpdateTeamDiscussionPayload - - """ - Updates a discussion comment. - """ - updateTeamDiscussionComment( - """ - Parameters for UpdateTeamDiscussionComment - """ - input: UpdateTeamDiscussionCommentInput! - ): UpdateTeamDiscussionCommentPayload - - """ - Updates team review assignment. - """ - updateTeamReviewAssignment( - """ - Parameters for UpdateTeamReviewAssignment - """ - input: UpdateTeamReviewAssignmentInput! - ): UpdateTeamReviewAssignmentPayload - - """ - Update team repository. - """ - updateTeamsRepository( - """ - Parameters for UpdateTeamsRepository - """ - input: UpdateTeamsRepositoryInput! - ): UpdateTeamsRepositoryPayload - - """ - Replaces the repository's topics with the given topics. - """ - updateTopics( - """ - Parameters for UpdateTopics - """ - input: UpdateTopicsInput! - ): UpdateTopicsPayload - - """ - Updates an existing user list. - """ - updateUserList( - """ - Parameters for UpdateUserList - """ - input: UpdateUserListInput! - ): UpdateUserListPayload - - """ - Updates which of the viewer's lists an item belongs to - """ - updateUserListsForItem( - """ - Parameters for UpdateUserListsForItem - """ - input: UpdateUserListsForItemInput! - ): UpdateUserListsForItemPayload - - """ - Verify that a verifiable domain has the expected DNS record. - """ - verifyVerifiableDomain( - """ - Parameters for VerifyVerifiableDomain - """ - input: VerifyVerifiableDomainInput! - ): VerifyVerifiableDomainPayload -} - -""" -An object with an ID. -""" -interface Node { - """ - ID of the object. - """ - id: ID! -} - -""" -The possible values for the notification restriction setting. -""" -enum NotificationRestrictionSettingValue { - """ - The setting is disabled for the owner. - """ - DISABLED - - """ - The setting is enabled for the owner. - """ - ENABLED -} - -""" -Metadata for an audit entry with action oauth_application.* -""" -interface OauthApplicationAuditEntryData { - """ - The name of the OAuth application. - """ - oauthApplicationName: String - - """ - The HTTP path for the OAuth application - """ - oauthApplicationResourcePath: URI - - """ - The HTTP URL for the OAuth application - """ - oauthApplicationUrl: URI -} - -""" -Audit log entry for a oauth_application.create event. -""" -type OauthApplicationCreateAuditEntry implements AuditEntry & Node & OauthApplicationAuditEntryData & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The application URL of the OAuth application. - """ - applicationUrl: URI - - """ - The callback URL of the OAuth application. - """ - callbackUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OauthApplicationCreateAuditEntry object - """ - id: ID! - - """ - The name of the OAuth application. - """ - oauthApplicationName: String - - """ - The HTTP path for the OAuth application - """ - oauthApplicationResourcePath: URI - - """ - The HTTP URL for the OAuth application - """ - oauthApplicationUrl: URI - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The rate limit of the OAuth application. - """ - rateLimit: Int - - """ - The state of the OAuth application. - """ - state: OauthApplicationCreateAuditEntryState - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -The state of an OAuth application when it was created. -""" -enum OauthApplicationCreateAuditEntryState { - """ - The OAuth application was active and allowed to have OAuth Accesses. - """ - ACTIVE - - """ - The OAuth application was in the process of being deleted. - """ - PENDING_DELETION - - """ - The OAuth application was suspended from generating OAuth Accesses due to abuse or security concerns. - """ - SUSPENDED -} - -""" -The corresponding operation type for the action -""" -enum OperationType { - """ - An existing resource was accessed - """ - ACCESS - - """ - A resource performed an authentication event - """ - AUTHENTICATION - - """ - A new resource was created - """ - CREATE - - """ - An existing resource was modified - """ - MODIFY - - """ - An existing resource was removed - """ - REMOVE - - """ - An existing resource was restored - """ - RESTORE - - """ - An existing resource was transferred between multiple resources - """ - TRANSFER -} - -""" -Possible directions in which to order a list of items when provided an `orderBy` argument. -""" -enum OrderDirection { - """ - Specifies an ascending order for a given `orderBy` argument. - """ - ASC - - """ - Specifies a descending order for a given `orderBy` argument. - """ - DESC -} - -""" -Audit log entry for a org.add_billing_manager -""" -type OrgAddBillingManagerAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgAddBillingManagerAuditEntry object - """ - id: ID! - - """ - The email address used to invite a billing manager for the organization. - """ - invitationEmail: String - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a org.add_member -""" -type OrgAddMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgAddMemberAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The permission level of the member added to the organization. - """ - permission: OrgAddMemberAuditEntryPermission - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -The permissions available to members on an Organization. -""" -enum OrgAddMemberAuditEntryPermission { - """ - Can read, clone, push, and add collaborators to repositories. - """ - ADMIN - - """ - Can read and clone repositories. - """ - READ -} - -""" -Audit log entry for a org.block_user -""" -type OrgBlockUserAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The blocked user. - """ - blockedUser: User - - """ - The username of the blocked user. - """ - blockedUserName: String - - """ - The HTTP path for the blocked user. - """ - blockedUserResourcePath: URI - - """ - The HTTP URL for the blocked user. - """ - blockedUserUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgBlockUserAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a org.config.disable_collaborators_only event. -""" -type OrgConfigDisableCollaboratorsOnlyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgConfigDisableCollaboratorsOnlyAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a org.config.enable_collaborators_only event. -""" -type OrgConfigEnableCollaboratorsOnlyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgConfigEnableCollaboratorsOnlyAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a org.create event. -""" -type OrgCreateAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The billing plan for the Organization. - """ - billingPlan: OrgCreateAuditEntryBillingPlan - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgCreateAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -The billing plans available for organizations. -""" -enum OrgCreateAuditEntryBillingPlan { - """ - Team Plan - """ - BUSINESS - - """ - Enterprise Cloud Plan - """ - BUSINESS_PLUS - - """ - Free Plan - """ - FREE - - """ - Tiered Per Seat Plan - """ - TIERED_PER_SEAT - - """ - Legacy Unlimited Plan - """ - UNLIMITED -} - -""" -Audit log entry for a org.disable_oauth_app_restrictions event. -""" -type OrgDisableOauthAppRestrictionsAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgDisableOauthAppRestrictionsAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a org.disable_saml event. -""" -type OrgDisableSamlAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The SAML provider's digest algorithm URL. - """ - digestMethodUrl: URI - - """ - The Node ID of the OrgDisableSamlAuditEntry object - """ - id: ID! - - """ - The SAML provider's issuer URL. - """ - issuerUrl: URI - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The SAML provider's signature algorithm URL. - """ - signatureMethodUrl: URI - - """ - The SAML provider's single sign-on URL. - """ - singleSignOnUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a org.disable_two_factor_requirement event. -""" -type OrgDisableTwoFactorRequirementAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgDisableTwoFactorRequirementAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a org.enable_oauth_app_restrictions event. -""" -type OrgEnableOauthAppRestrictionsAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgEnableOauthAppRestrictionsAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a org.enable_saml event. -""" -type OrgEnableSamlAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The SAML provider's digest algorithm URL. - """ - digestMethodUrl: URI - - """ - The Node ID of the OrgEnableSamlAuditEntry object - """ - id: ID! - - """ - The SAML provider's issuer URL. - """ - issuerUrl: URI - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The SAML provider's signature algorithm URL. - """ - signatureMethodUrl: URI - - """ - The SAML provider's single sign-on URL. - """ - singleSignOnUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a org.enable_two_factor_requirement event. -""" -type OrgEnableTwoFactorRequirementAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgEnableTwoFactorRequirementAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Ordering options for an organization's enterprise owner connections. -""" -input OrgEnterpriseOwnerOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order enterprise owners by. - """ - field: OrgEnterpriseOwnerOrderField! -} - -""" -Properties by which enterprise owners can be ordered. -""" -enum OrgEnterpriseOwnerOrderField { - """ - Order enterprise owners by login. - """ - LOGIN -} - -""" -Audit log entry for a org.invite_member event. -""" -type OrgInviteMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The email address of the organization invitation. - """ - email: String - - """ - The Node ID of the OrgInviteMemberAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The organization invitation. - """ - organizationInvitation: OrganizationInvitation - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a org.invite_to_business event. -""" -type OrgInviteToBusinessAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The HTTP path for this enterprise. - """ - enterpriseResourcePath: URI - - """ - The slug of the enterprise. - """ - enterpriseSlug: String - - """ - The HTTP URL for this enterprise. - """ - enterpriseUrl: URI - - """ - The Node ID of the OrgInviteToBusinessAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a org.oauth_app_access_approved event. -""" -type OrgOauthAppAccessApprovedAuditEntry implements AuditEntry & Node & OauthApplicationAuditEntryData & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgOauthAppAccessApprovedAuditEntry object - """ - id: ID! - - """ - The name of the OAuth application. - """ - oauthApplicationName: String - - """ - The HTTP path for the OAuth application - """ - oauthApplicationResourcePath: URI - - """ - The HTTP URL for the OAuth application - """ - oauthApplicationUrl: URI - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a org.oauth_app_access_blocked event. -""" -type OrgOauthAppAccessBlockedAuditEntry implements AuditEntry & Node & OauthApplicationAuditEntryData & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgOauthAppAccessBlockedAuditEntry object - """ - id: ID! - - """ - The name of the OAuth application. - """ - oauthApplicationName: String - - """ - The HTTP path for the OAuth application - """ - oauthApplicationResourcePath: URI - - """ - The HTTP URL for the OAuth application - """ - oauthApplicationUrl: URI - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a org.oauth_app_access_denied event. -""" -type OrgOauthAppAccessDeniedAuditEntry implements AuditEntry & Node & OauthApplicationAuditEntryData & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgOauthAppAccessDeniedAuditEntry object - """ - id: ID! - - """ - The name of the OAuth application. - """ - oauthApplicationName: String - - """ - The HTTP path for the OAuth application - """ - oauthApplicationResourcePath: URI - - """ - The HTTP URL for the OAuth application - """ - oauthApplicationUrl: URI - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a org.oauth_app_access_requested event. -""" -type OrgOauthAppAccessRequestedAuditEntry implements AuditEntry & Node & OauthApplicationAuditEntryData & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgOauthAppAccessRequestedAuditEntry object - """ - id: ID! - - """ - The name of the OAuth application. - """ - oauthApplicationName: String - - """ - The HTTP path for the OAuth application - """ - oauthApplicationResourcePath: URI - - """ - The HTTP URL for the OAuth application - """ - oauthApplicationUrl: URI - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a org.oauth_app_access_unblocked event. -""" -type OrgOauthAppAccessUnblockedAuditEntry implements AuditEntry & Node & OauthApplicationAuditEntryData & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgOauthAppAccessUnblockedAuditEntry object - """ - id: ID! - - """ - The name of the OAuth application. - """ - oauthApplicationName: String - - """ - The HTTP path for the OAuth application - """ - oauthApplicationResourcePath: URI - - """ - The HTTP URL for the OAuth application - """ - oauthApplicationUrl: URI - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a org.remove_billing_manager event. -""" -type OrgRemoveBillingManagerAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgRemoveBillingManagerAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The reason for the billing manager being removed. - """ - reason: OrgRemoveBillingManagerAuditEntryReason - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -The reason a billing manager was removed from an Organization. -""" -enum OrgRemoveBillingManagerAuditEntryReason { - """ - SAML external identity missing - """ - SAML_EXTERNAL_IDENTITY_MISSING - - """ - SAML SSO enforcement requires an external identity - """ - SAML_SSO_ENFORCEMENT_REQUIRES_EXTERNAL_IDENTITY - - """ - The organization required 2FA of its billing managers and this user did not have 2FA enabled. - """ - TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE -} - -""" -Audit log entry for a org.remove_member event. -""" -type OrgRemoveMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgRemoveMemberAuditEntry object - """ - id: ID! - - """ - The types of membership the member has with the organization. - """ - membershipTypes: [OrgRemoveMemberAuditEntryMembershipType!] - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The reason for the member being removed. - """ - reason: OrgRemoveMemberAuditEntryReason - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -The type of membership a user has with an Organization. -""" -enum OrgRemoveMemberAuditEntryMembershipType { - """ - Organization owners have full access and can change several settings, - including the names of repositories that belong to the Organization and Owners - team membership. In addition, organization owners can delete the organization - and all of its repositories. - """ - ADMIN - - """ - A billing manager is a user who manages the billing settings for the Organization, such as updating payment information. - """ - BILLING_MANAGER - - """ - A direct member is a user that is a member of the Organization. - """ - DIRECT_MEMBER - - """ - An outside collaborator is a person who isn't explicitly a member of the - Organization, but who has Read, Write, or Admin permissions to one or more - repositories in the organization. - """ - OUTSIDE_COLLABORATOR - - """ - A suspended member. - """ - SUSPENDED - - """ - An unaffiliated collaborator is a person who is not a member of the - Organization and does not have access to any repositories in the Organization. - """ - UNAFFILIATED -} - -""" -The reason a member was removed from an Organization. -""" -enum OrgRemoveMemberAuditEntryReason { - """ - SAML external identity missing - """ - SAML_EXTERNAL_IDENTITY_MISSING - - """ - SAML SSO enforcement requires an external identity - """ - SAML_SSO_ENFORCEMENT_REQUIRES_EXTERNAL_IDENTITY - - """ - User was removed from organization during account recovery - """ - TWO_FACTOR_ACCOUNT_RECOVERY - - """ - The organization required 2FA of its billing managers and this user did not have 2FA enabled. - """ - TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE - - """ - User account has been deleted - """ - USER_ACCOUNT_DELETED -} - -""" -Audit log entry for a org.remove_outside_collaborator event. -""" -type OrgRemoveOutsideCollaboratorAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgRemoveOutsideCollaboratorAuditEntry object - """ - id: ID! - - """ - The types of membership the outside collaborator has with the organization. - """ - membershipTypes: [OrgRemoveOutsideCollaboratorAuditEntryMembershipType!] - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The reason for the outside collaborator being removed from the Organization. - """ - reason: OrgRemoveOutsideCollaboratorAuditEntryReason - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -The type of membership a user has with an Organization. -""" -enum OrgRemoveOutsideCollaboratorAuditEntryMembershipType { - """ - A billing manager is a user who manages the billing settings for the Organization, such as updating payment information. - """ - BILLING_MANAGER - - """ - An outside collaborator is a person who isn't explicitly a member of the - Organization, but who has Read, Write, or Admin permissions to one or more - repositories in the organization. - """ - OUTSIDE_COLLABORATOR - - """ - An unaffiliated collaborator is a person who is not a member of the - Organization and does not have access to any repositories in the organization. - """ - UNAFFILIATED -} - -""" -The reason an outside collaborator was removed from an Organization. -""" -enum OrgRemoveOutsideCollaboratorAuditEntryReason { - """ - SAML external identity missing - """ - SAML_EXTERNAL_IDENTITY_MISSING - - """ - The organization required 2FA of its billing managers and this user did not have 2FA enabled. - """ - TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE -} - -""" -Audit log entry for a org.restore_member event. -""" -type OrgRestoreMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgRestoreMemberAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The number of custom email routings for the restored member. - """ - restoredCustomEmailRoutingsCount: Int - - """ - The number of issue assignments for the restored member. - """ - restoredIssueAssignmentsCount: Int - - """ - Restored organization membership objects. - """ - restoredMemberships: [OrgRestoreMemberAuditEntryMembership!] - - """ - The number of restored memberships. - """ - restoredMembershipsCount: Int - - """ - The number of repositories of the restored member. - """ - restoredRepositoriesCount: Int - - """ - The number of starred repositories for the restored member. - """ - restoredRepositoryStarsCount: Int - - """ - The number of watched repositories for the restored member. - """ - restoredRepositoryWatchesCount: Int - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Types of memberships that can be restored for an Organization member. -""" -union OrgRestoreMemberAuditEntryMembership = - OrgRestoreMemberMembershipOrganizationAuditEntryData - | OrgRestoreMemberMembershipRepositoryAuditEntryData - | OrgRestoreMemberMembershipTeamAuditEntryData - -""" -Metadata for an organization membership for org.restore_member actions -""" -type OrgRestoreMemberMembershipOrganizationAuditEntryData implements OrganizationAuditEntryData { - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI -} - -""" -Metadata for a repository membership for org.restore_member actions -""" -type OrgRestoreMemberMembershipRepositoryAuditEntryData implements RepositoryAuditEntryData { - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI -} - -""" -Metadata for a team membership for org.restore_member actions -""" -type OrgRestoreMemberMembershipTeamAuditEntryData implements TeamAuditEntryData { - """ - The team associated with the action - """ - team: Team - - """ - The name of the team - """ - teamName: String - - """ - The HTTP path for this team - """ - teamResourcePath: URI - - """ - The HTTP URL for this team - """ - teamUrl: URI -} - -""" -Audit log entry for a org.unblock_user -""" -type OrgUnblockUserAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The user being unblocked by the organization. - """ - blockedUser: User - - """ - The username of the blocked user. - """ - blockedUserName: String - - """ - The HTTP path for the blocked user. - """ - blockedUserResourcePath: URI - - """ - The HTTP URL for the blocked user. - """ - blockedUserUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgUnblockUserAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a org.update_default_repository_permission -""" -type OrgUpdateDefaultRepositoryPermissionAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgUpdateDefaultRepositoryPermissionAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The new base repository permission level for the organization. - """ - permission: OrgUpdateDefaultRepositoryPermissionAuditEntryPermission - - """ - The former base repository permission level for the organization. - """ - permissionWas: OrgUpdateDefaultRepositoryPermissionAuditEntryPermission - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -The default permission a repository can have in an Organization. -""" -enum OrgUpdateDefaultRepositoryPermissionAuditEntryPermission { - """ - Can read, clone, push, and add collaborators to repositories. - """ - ADMIN - - """ - No default permission value. - """ - NONE - - """ - Can read and clone repositories. - """ - READ - - """ - Can read, clone and push to repositories. - """ - WRITE -} - -""" -Audit log entry for a org.update_member event. -""" -type OrgUpdateMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgUpdateMemberAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The new member permission level for the organization. - """ - permission: OrgUpdateMemberAuditEntryPermission - - """ - The former member permission level for the organization. - """ - permissionWas: OrgUpdateMemberAuditEntryPermission - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -The permissions available to members on an Organization. -""" -enum OrgUpdateMemberAuditEntryPermission { - """ - Can read, clone, push, and add collaborators to repositories. - """ - ADMIN - - """ - Can read and clone repositories. - """ - READ -} - -""" -Audit log entry for a org.update_member_repository_creation_permission event. -""" -type OrgUpdateMemberRepositoryCreationPermissionAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - Can members create repositories in the organization. - """ - canCreateRepositories: Boolean - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgUpdateMemberRepositoryCreationPermissionAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI - - """ - The permission for visibility level of repositories for this organization. - """ - visibility: OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility -} - -""" -The permissions available for repository creation on an Organization. -""" -enum OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility { - """ - All organization members are restricted from creating any repositories. - """ - ALL - - """ - All organization members are restricted from creating internal repositories. - """ - INTERNAL - - """ - All organization members are allowed to create any repositories. - """ - NONE - - """ - All organization members are restricted from creating private repositories. - """ - PRIVATE - - """ - All organization members are restricted from creating private or internal repositories. - """ - PRIVATE_INTERNAL - - """ - All organization members are restricted from creating public repositories. - """ - PUBLIC - - """ - All organization members are restricted from creating public or internal repositories. - """ - PUBLIC_INTERNAL - - """ - All organization members are restricted from creating public or private repositories. - """ - PUBLIC_PRIVATE -} - -""" -Audit log entry for a org.update_member_repository_invitation_permission event. -""" -type OrgUpdateMemberRepositoryInvitationPermissionAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - Can outside collaborators be invited to repositories in the organization. - """ - canInviteOutsideCollaboratorsToRepositories: Boolean - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the OrgUpdateMemberRepositoryInvitationPermissionAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -An account on GitHub, with one or more owners, that has repositories, members and teams. -""" -type Organization implements Actor & AnnouncementBanner & MemberStatusable & Node & PackageOwner & ProfileOwner & ProjectOwner & ProjectV2Owner & ProjectV2Recent & RepositoryDiscussionAuthor & RepositoryDiscussionCommentAuthor & RepositoryOwner & UniformResourceLocatable { - """ - The text of the announcement - """ - announcement: String - - """ - The date the announcement was created - """ - announcementCreatedAt: DateTime - - """ - The expiration date of the announcement, if any - """ - announcementExpiresAt: DateTime - - """ - Whether the announcement can be dismissed by the user - """ - announcementUserDismissible: Boolean - - """ - Determine if this repository owner has any items that can be pinned to their profile. - """ - anyPinnableItems( - """ - Filter to only a particular kind of pinnable item. - """ - type: PinnableItemType - ): Boolean! - - """ - Identifies the date and time when the organization was archived. - """ - archivedAt: DateTime - - """ - Audit log entries of the organization - """ - auditLog( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for the returned audit log entries. - """ - orderBy: AuditLogOrder = {field: CREATED_AT, direction: DESC} - - """ - The query string to filter audit entries - """ - query: String - ): OrganizationAuditEntryConnection! - - """ - A URL pointing to the organization's public avatar. - """ - avatarUrl( - """ - The size of the resulting square image. - """ - size: Int - ): URI! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The organization's public profile description. - """ - description: String - - """ - The organization's public profile description rendered to HTML. - """ - descriptionHTML: String - - """ - A list of domains owned by the organization. - """ - domains( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Filter by if the domain is approved. - """ - isApproved: Boolean = null - - """ - Filter by if the domain is verified. - """ - isVerified: Boolean = null - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for verifiable domains returned. - """ - orderBy: VerifiableDomainOrder = {field: DOMAIN, direction: ASC} - ): VerifiableDomainConnection - - """ - The organization's public email. - """ - email: String - - """ - A list of owners of the organization's enterprise account. - """ - enterpriseOwners( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for enterprise owners returned from the connection. - """ - orderBy: OrgEnterpriseOwnerOrder = {field: LOGIN, direction: ASC} - - """ - The organization role to filter by. - """ - organizationRole: RoleInOrganization - - """ - The search string to look for. - """ - query: String - ): OrganizationEnterpriseOwnerConnection! - - """ - The Node ID of the Organization object - """ - id: ID! - - """ - The setting value for whether the organization has an IP allow list enabled. - """ - ipAllowListEnabledSetting: IpAllowListEnabledSettingValue! - - """ - The IP addresses that are allowed to access resources owned by the organization. - """ - ipAllowListEntries( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for IP allow list entries returned. - """ - orderBy: IpAllowListEntryOrder = {field: ALLOW_LIST_VALUE, direction: ASC} - ): IpAllowListEntryConnection! - - """ - The setting value for whether the organization has IP allow list configuration for installed GitHub Apps enabled. - """ - ipAllowListForInstalledAppsEnabledSetting: IpAllowListForInstalledAppsEnabledSettingValue! - - """ - Whether the organization has verified its profile email and website. - """ - isVerified: Boolean! - - """ - Showcases a selection of repositories and gists that the profile owner has - either curated or that have been selected automatically based on popularity. - """ - itemShowcase: ProfileItemShowcase! - - """ - The organization's public profile location. - """ - location: String - - """ - The organization's login name. - """ - login: String! - - """ - A list of all mannequins for this organization. - """ - mannequins( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filter mannequins by login. - """ - login: String - - """ - Ordering options for mannequins returned from the connection. - """ - orderBy: MannequinOrder = {field: CREATED_AT, direction: ASC} - ): MannequinConnection! - - """ - Get the status messages members of this entity have set that are either public or visible only to the organization. - """ - memberStatuses( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for user statuses returned from the connection. - """ - orderBy: UserStatusOrder = {field: UPDATED_AT, direction: DESC} - ): UserStatusConnection! - - """ - Members can fork private repositories in this organization - """ - membersCanForkPrivateRepositories: Boolean! - - """ - A list of users who are members of this organization. - """ - membersWithRole( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): OrganizationMemberConnection! - - """ - The organization's public profile name. - """ - name: String - - """ - The HTTP path creating a new team - """ - newTeamResourcePath: URI! - - """ - The HTTP URL creating a new team - """ - newTeamUrl: URI! - - """ - Indicates if email notification delivery for this organization is restricted to verified or approved domains. - """ - notificationDeliveryRestrictionEnabledSetting: NotificationRestrictionSettingValue! - - """ - The billing email for the organization. - """ - organizationBillingEmail: String - - """ - A list of packages under the owner. - """ - packages( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Find packages by their names. - """ - names: [String] - - """ - Ordering of the returned packages. - """ - orderBy: PackageOrder = {field: CREATED_AT, direction: DESC} - - """ - Filter registry package by type. - """ - packageType: PackageType - - """ - Find packages in a repository by ID. - """ - repositoryId: ID - ): PackageConnection! - - """ - A list of users who have been invited to join this organization. - """ - pendingMembers( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserConnection! - - """ - A list of repositories and gists this profile owner can pin to their profile. - """ - pinnableItems( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filter the types of pinnable items that are returned. - """ - types: [PinnableItemType!] - ): PinnableItemConnection! - - """ - A list of repositories and gists this profile owner has pinned to their profile - """ - pinnedItems( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filter the types of pinned items that are returned. - """ - types: [PinnableItemType!] - ): PinnableItemConnection! - - """ - Returns how many more items this profile owner can pin to their profile. - """ - pinnedItemsRemaining: Int! - - """ - Find project by number. - """ - project( - """ - The project number to find. - """ - number: Int! - ): Project - - """ - Find a project by number. - """ - projectV2( - """ - The project number. - """ - number: Int! - ): ProjectV2 - - """ - A list of projects under the owner. - """ - projects( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for projects returned from the connection - """ - orderBy: ProjectOrder - - """ - Query to search projects by, currently only searching by name. - """ - search: String - - """ - A list of states to filter the projects by. - """ - states: [ProjectState!] - ): ProjectConnection! - - """ - The HTTP path listing organization's projects - """ - projectsResourcePath: URI! - - """ - The HTTP URL listing organization's projects - """ - projectsUrl: URI! - - """ - A list of projects under the owner. - """ - projectsV2( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - How to order the returned projects. - """ - orderBy: ProjectV2Order = {field: NUMBER, direction: DESC} - - """ - A project to search for under the the owner. - """ - query: String - ): ProjectV2Connection! - - """ - Recent projects that this user has modified in the context of the owner. - """ - recentProjects( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ProjectV2Connection! - - """ - A list of repositories that the user owns. - """ - repositories( - """ - Array of viewer's affiliation options for repositories returned from the - connection. For example, OWNER will include only repositories that the - current viewer owns. - """ - affiliations: [RepositoryAffiliation] - - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - If non-null, filters repositories according to whether they have issues enabled - """ - hasIssuesEnabled: Boolean - - """ - If non-null, filters repositories according to whether they are archived and not maintained - """ - isArchived: Boolean - - """ - If non-null, filters repositories according to whether they are forks of another repository - """ - isFork: Boolean - - """ - If non-null, filters repositories according to whether they have been locked - """ - isLocked: Boolean - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for repositories returned from the connection - """ - orderBy: RepositoryOrder - - """ - Array of owner's affiliation options for repositories returned from the - connection. For example, OWNER will include only repositories that the - organization or user being viewed owns. - """ - ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR] - - """ - If non-null, filters repositories according to privacy. Internal - repositories are considered private; consider using the visibility argument - if only internal repositories are needed. Cannot be combined with the - visibility argument. - """ - privacy: RepositoryPrivacy - - """ - If non-null, filters repositories according to visibility. Cannot be combined with the privacy argument. - """ - visibility: RepositoryVisibility - ): RepositoryConnection! - - """ - Find Repository. - """ - repository( - """ - Follow repository renames. If disabled, a repository referenced by its old name will return an error. - """ - followRenames: Boolean = true - - """ - Name of Repository to find. - """ - name: String! - ): Repository - - """ - Discussion comments this user has authored. - """ - repositoryDiscussionComments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filter discussion comments to only those that were marked as the answer - """ - onlyAnswers: Boolean = false - - """ - Filter discussion comments to only those in a specific repository. - """ - repositoryId: ID - ): DiscussionCommentConnection! - - """ - Discussions this user has started. - """ - repositoryDiscussions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Filter discussions to only those that have been answered or not. Defaults to - including both answered and unanswered discussions. - """ - answered: Boolean = null - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for discussions returned from the connection. - """ - orderBy: DiscussionOrder = {field: CREATED_AT, direction: DESC} - - """ - Filter discussions to only those in a specific repository. - """ - repositoryId: ID - - """ - A list of states to filter the discussions by. - """ - states: [DiscussionState!] = [] - ): DiscussionConnection! - - """ - A list of all repository migrations for this organization. - """ - repositoryMigrations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for repository migrations returned. - """ - orderBy: RepositoryMigrationOrder = {field: CREATED_AT, direction: ASC} - - """ - Filter repository migrations by repository name. - """ - repositoryName: String - - """ - Filter repository migrations by state. - """ - state: MigrationState - ): RepositoryMigrationConnection! - - """ - When true the organization requires all members, billing managers, and outside - collaborators to enable two-factor authentication. - """ - requiresTwoFactorAuthentication: Boolean - - """ - The HTTP path for this organization. - """ - resourcePath: URI! - - """ - Returns a single ruleset from the current organization by ID. - """ - ruleset( - """ - The ID of the ruleset to be returned. - """ - databaseId: Int! - ): RepositoryRuleset - - """ - A list of rulesets for this organization. - """ - rulesets( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Return rulesets configured at higher levels that apply to this organization - """ - includeParents: Boolean = true - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): RepositoryRulesetConnection - - """ - The Organization's SAML identity provider. Visible to (1) organization owners, - (2) organization owners' personal access tokens (classic) with read:org or - admin:org scope, (3) GitHub App with an installation token with read or write - access to members. - """ - samlIdentityProvider: OrganizationIdentityProvider - - """ - Find an organization's team by its slug. - """ - team( - """ - The name or slug of the team to find. - """ - slug: String! - ): Team - - """ - A list of teams in this organization. - """ - teams( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - If true, filters teams that are mapped to an LDAP Group (Enterprise only) - """ - ldapMapped: Boolean - - """ - If non-null, filters teams according to notification setting - """ - notificationSetting: TeamNotificationSetting - - """ - Ordering options for teams returned from the connection - """ - orderBy: TeamOrder - - """ - If non-null, filters teams according to privacy - """ - privacy: TeamPrivacy - - """ - If non-null, filters teams with query on team name and team slug - """ - query: String - - """ - If non-null, filters teams according to whether the viewer is an admin or member on team - """ - role: TeamRole - - """ - If true, restrict to only root teams - """ - rootTeamsOnly: Boolean = false - - """ - User logins to filter by - """ - userLogins: [String!] - ): TeamConnection! - - """ - The HTTP path listing organization's teams - """ - teamsResourcePath: URI! - - """ - The HTTP URL listing organization's teams - """ - teamsUrl: URI! - - """ - The organization's Twitter username. - """ - twitterUsername: String - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this organization. - """ - url: URI! - - """ - Organization is adminable by the viewer. - """ - viewerCanAdminister: Boolean! - - """ - Can the viewer pin repositories and gists to the profile? - """ - viewerCanChangePinnedItems: Boolean! - - """ - Can the current viewer create new projects on this owner. - """ - viewerCanCreateProjects: Boolean! - - """ - Viewer can create repositories on this organization - """ - viewerCanCreateRepositories: Boolean! - - """ - Viewer can create teams on this organization. - """ - viewerCanCreateTeams: Boolean! - - """ - Viewer is an active member of this organization. - """ - viewerIsAMember: Boolean! - - """ - Whether or not this Organization is followed by the viewer. - """ - viewerIsFollowing: Boolean! - - """ - Whether contributors are required to sign off on web-based commits for repositories in this organization. - """ - webCommitSignoffRequired: Boolean! - - """ - The organization's public profile URL. - """ - websiteUrl: URI -} - -""" -An audit entry in an organization audit log. -""" -union OrganizationAuditEntry = - MembersCanDeleteReposClearAuditEntry - | MembersCanDeleteReposDisableAuditEntry - | MembersCanDeleteReposEnableAuditEntry - | OauthApplicationCreateAuditEntry - | OrgAddBillingManagerAuditEntry - | OrgAddMemberAuditEntry - | OrgBlockUserAuditEntry - | OrgConfigDisableCollaboratorsOnlyAuditEntry - | OrgConfigEnableCollaboratorsOnlyAuditEntry - | OrgCreateAuditEntry - | OrgDisableOauthAppRestrictionsAuditEntry - | OrgDisableSamlAuditEntry - | OrgDisableTwoFactorRequirementAuditEntry - | OrgEnableOauthAppRestrictionsAuditEntry - | OrgEnableSamlAuditEntry - | OrgEnableTwoFactorRequirementAuditEntry - | OrgInviteMemberAuditEntry - | OrgInviteToBusinessAuditEntry - | OrgOauthAppAccessApprovedAuditEntry - | OrgOauthAppAccessBlockedAuditEntry - | OrgOauthAppAccessDeniedAuditEntry - | OrgOauthAppAccessRequestedAuditEntry - | OrgOauthAppAccessUnblockedAuditEntry - | OrgRemoveBillingManagerAuditEntry - | OrgRemoveMemberAuditEntry - | OrgRemoveOutsideCollaboratorAuditEntry - | OrgRestoreMemberAuditEntry - | OrgUnblockUserAuditEntry - | OrgUpdateDefaultRepositoryPermissionAuditEntry - | OrgUpdateMemberAuditEntry - | OrgUpdateMemberRepositoryCreationPermissionAuditEntry - | OrgUpdateMemberRepositoryInvitationPermissionAuditEntry - | PrivateRepositoryForkingDisableAuditEntry - | PrivateRepositoryForkingEnableAuditEntry - | RepoAccessAuditEntry - | RepoAddMemberAuditEntry - | RepoAddTopicAuditEntry - | RepoArchivedAuditEntry - | RepoChangeMergeSettingAuditEntry - | RepoConfigDisableAnonymousGitAccessAuditEntry - | RepoConfigDisableCollaboratorsOnlyAuditEntry - | RepoConfigDisableContributorsOnlyAuditEntry - | RepoConfigDisableSockpuppetDisallowedAuditEntry - | RepoConfigEnableAnonymousGitAccessAuditEntry - | RepoConfigEnableCollaboratorsOnlyAuditEntry - | RepoConfigEnableContributorsOnlyAuditEntry - | RepoConfigEnableSockpuppetDisallowedAuditEntry - | RepoConfigLockAnonymousGitAccessAuditEntry - | RepoConfigUnlockAnonymousGitAccessAuditEntry - | RepoCreateAuditEntry - | RepoDestroyAuditEntry - | RepoRemoveMemberAuditEntry - | RepoRemoveTopicAuditEntry - | RepositoryVisibilityChangeDisableAuditEntry - | RepositoryVisibilityChangeEnableAuditEntry - | TeamAddMemberAuditEntry - | TeamAddRepositoryAuditEntry - | TeamChangeParentTeamAuditEntry - | TeamRemoveMemberAuditEntry - | TeamRemoveRepositoryAuditEntry - -""" -The connection type for OrganizationAuditEntry. -""" -type OrganizationAuditEntryConnection { - """ - A list of edges. - """ - edges: [OrganizationAuditEntryEdge] - - """ - A list of nodes. - """ - nodes: [OrganizationAuditEntry] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -Metadata for an audit entry with action org.* -""" -interface OrganizationAuditEntryData { - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI -} - -""" -An edge in a connection. -""" -type OrganizationAuditEntryEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: OrganizationAuditEntry -} - -""" -A list of organizations managed by an enterprise. -""" -type OrganizationConnection { - """ - A list of edges. - """ - edges: [OrganizationEdge] - - """ - A list of nodes. - """ - nodes: [Organization] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type OrganizationEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Organization -} - -""" -The connection type for User. -""" -type OrganizationEnterpriseOwnerConnection { - """ - A list of edges. - """ - edges: [OrganizationEnterpriseOwnerEdge] - - """ - A list of nodes. - """ - nodes: [User] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An enterprise owner in the context of an organization that is part of the enterprise. -""" -type OrganizationEnterpriseOwnerEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: User - - """ - The role of the owner with respect to the organization. - """ - organizationRole: RoleInOrganization! -} - -""" -An Identity Provider configured to provision SAML and SCIM identities for -Organizations. Visible to (1) organization owners, (2) organization owners' -personal access tokens (classic) with read:org or admin:org scope, (3) GitHub -App with an installation token with read or write access to members. -""" -type OrganizationIdentityProvider implements Node { - """ - The digest algorithm used to sign SAML requests for the Identity Provider. - """ - digestMethod: URI - - """ - External Identities provisioned by this Identity Provider - """ - externalIdentities( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filter to external identities with the users login - """ - login: String - - """ - Filter to external identities with valid org membership only - """ - membersOnly: Boolean - - """ - Filter to external identities with the users userName/NameID attribute - """ - userName: String - ): ExternalIdentityConnection! - - """ - The Node ID of the OrganizationIdentityProvider object - """ - id: ID! - - """ - The x509 certificate used by the Identity Provider to sign assertions and responses. - """ - idpCertificate: X509Certificate - - """ - The Issuer Entity ID for the SAML Identity Provider - """ - issuer: String - - """ - Organization this Identity Provider belongs to - """ - organization: Organization - - """ - The signature algorithm used to sign SAML requests for the Identity Provider. - """ - signatureMethod: URI - - """ - The URL endpoint for the Identity Provider's SAML SSO. - """ - ssoUrl: URI -} - -""" -An Invitation for a user to an organization. -""" -type OrganizationInvitation implements Node { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The email address of the user invited to the organization. - """ - email: String - - """ - The Node ID of the OrganizationInvitation object - """ - id: ID! - - """ - The source of the invitation. - """ - invitationSource: OrganizationInvitationSource! - - """ - The type of invitation that was sent (e.g. email, user). - """ - invitationType: OrganizationInvitationType! - - """ - The user who was invited to the organization. - """ - invitee: User - - """ - The user who created the invitation. - """ - inviter: User! - @deprecated( - reason: "`inviter` will be removed. `inviter` will be replaced by `inviterActor`. Removal on 2024-07-01 UTC." - ) - - """ - The user who created the invitation. - """ - inviterActor: User - - """ - The organization the invite is for - """ - organization: Organization! - - """ - The user's pending role in the organization (e.g. member, owner). - """ - role: OrganizationInvitationRole! -} - -""" -The connection type for OrganizationInvitation. -""" -type OrganizationInvitationConnection { - """ - A list of edges. - """ - edges: [OrganizationInvitationEdge] - - """ - A list of nodes. - """ - nodes: [OrganizationInvitation] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type OrganizationInvitationEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: OrganizationInvitation -} - -""" -The possible organization invitation roles. -""" -enum OrganizationInvitationRole { - """ - The user is invited to be an admin of the organization. - """ - ADMIN - - """ - The user is invited to be a billing manager of the organization. - """ - BILLING_MANAGER - - """ - The user is invited to be a direct member of the organization. - """ - DIRECT_MEMBER - - """ - The user's previous role will be reinstated. - """ - REINSTATE -} - -""" -The possible organization invitation sources. -""" -enum OrganizationInvitationSource { - """ - The invitation was created from the web interface or from API - """ - MEMBER - - """ - The invitation was created from SCIM - """ - SCIM - - """ - The invitation was sent before this feature was added - """ - UNKNOWN -} - -""" -The possible organization invitation types. -""" -enum OrganizationInvitationType { - """ - The invitation was to an email address. - """ - EMAIL - - """ - The invitation was to an existing user. - """ - USER -} - -""" -A list of users who belong to the organization. -""" -type OrganizationMemberConnection { - """ - A list of edges. - """ - edges: [OrganizationMemberEdge] - - """ - A list of nodes. - """ - nodes: [User] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -Represents a user within an organization. -""" -type OrganizationMemberEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer. - """ - hasTwoFactorEnabled: Boolean - - """ - The item at the end of the edge. - """ - node: User - - """ - The role this user has in the organization. - """ - role: OrganizationMemberRole -} - -""" -The possible roles within an organization for its members. -""" -enum OrganizationMemberRole { - """ - The user is an administrator of the organization. - """ - ADMIN - - """ - The user is a member of the organization. - """ - MEMBER -} - -""" -The possible values for the members can create repositories setting on an organization. -""" -enum OrganizationMembersCanCreateRepositoriesSettingValue { - """ - Members will be able to create public and private repositories. - """ - ALL - - """ - Members will not be able to create public or private repositories. - """ - DISABLED - - """ - Members will be able to create only internal repositories. - """ - INTERNAL - - """ - Members will be able to create only private repositories. - """ - PRIVATE -} - -""" -A GitHub Enterprise Importer (GEI) organization migration. -""" -type OrganizationMigration implements Node { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: String - - """ - The reason the organization migration failed. - """ - failureReason: String - - """ - The Node ID of the OrganizationMigration object - """ - id: ID! - - """ - The remaining amount of repos to be migrated. - """ - remainingRepositoriesCount: Int - - """ - The name of the source organization to be migrated. - """ - sourceOrgName: String! - - """ - The URL of the source organization to migrate. - """ - sourceOrgUrl: URI! - - """ - The migration state. - """ - state: OrganizationMigrationState! - - """ - The name of the target organization. - """ - targetOrgName: String! - - """ - The total amount of repositories to be migrated. - """ - totalRepositoriesCount: Int -} - -""" -The Octoshift Organization migration state. -""" -enum OrganizationMigrationState { - """ - The Octoshift migration has failed. - """ - FAILED - - """ - The Octoshift migration has invalid credentials. - """ - FAILED_VALIDATION - - """ - The Octoshift migration is in progress. - """ - IN_PROGRESS - - """ - The Octoshift migration has not started. - """ - NOT_STARTED - - """ - The Octoshift migration needs to have its credentials validated. - """ - PENDING_VALIDATION - - """ - The Octoshift migration is performing post repository migrations. - """ - POST_REPO_MIGRATION - - """ - The Octoshift migration is performing pre repository migrations. - """ - PRE_REPO_MIGRATION - - """ - The Octoshift migration has been queued. - """ - QUEUED - - """ - The Octoshift org migration is performing repository migrations. - """ - REPO_MIGRATION - - """ - The Octoshift migration has succeeded. - """ - SUCCEEDED -} - -""" -Used for argument of CreateProjectV2 mutation. -""" -union OrganizationOrUser = Organization | User - -""" -Ordering options for organization connections. -""" -input OrganizationOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order organizations by. - """ - field: OrganizationOrderField! -} - -""" -Properties by which organization connections can be ordered. -""" -enum OrganizationOrderField { - """ - Order organizations by creation time - """ - CREATED_AT - - """ - Order organizations by login - """ - LOGIN -} - -""" -An organization teams hovercard context -""" -type OrganizationTeamsHovercardContext implements HovercardContext { - """ - A string describing this context - """ - message: String! - - """ - An octicon to accompany this context - """ - octicon: String! - - """ - Teams in this organization the user is a member of that are relevant - """ - relevantTeams( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): TeamConnection! - - """ - The path for the full team list for this user - """ - teamsResourcePath: URI! - - """ - The URL for the full team list for this user - """ - teamsUrl: URI! - - """ - The total number of teams the user is on in the organization - """ - totalTeamCount: Int! -} - -""" -An organization list hovercard context -""" -type OrganizationsHovercardContext implements HovercardContext { - """ - A string describing this context - """ - message: String! - - """ - An octicon to accompany this context - """ - octicon: String! - - """ - Organizations this user is a member of that are relevant - """ - relevantOrganizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for the User's organizations. - """ - orderBy: OrganizationOrder = null - ): OrganizationConnection! - - """ - The total number of organizations this user is in - """ - totalOrganizationCount: Int! -} - -""" -Information for an uploaded package. -""" -type Package implements Node { - """ - The Node ID of the Package object - """ - id: ID! - - """ - Find the latest version for the package. - """ - latestVersion: PackageVersion - - """ - Identifies the name of the package. - """ - name: String! - - """ - Identifies the type of the package. - """ - packageType: PackageType! - - """ - The repository this package belongs to. - """ - repository: Repository - - """ - Statistics about package activity. - """ - statistics: PackageStatistics - - """ - Find package version by version string. - """ - version( - """ - The package version. - """ - version: String! - ): PackageVersion - - """ - list of versions for this package - """ - versions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering of the returned packages. - """ - orderBy: PackageVersionOrder = {field: CREATED_AT, direction: DESC} - ): PackageVersionConnection! -} - -""" -The connection type for Package. -""" -type PackageConnection { - """ - A list of edges. - """ - edges: [PackageEdge] - - """ - A list of nodes. - """ - nodes: [Package] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type PackageEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Package -} - -""" -A file in a package version. -""" -type PackageFile implements Node { - """ - The Node ID of the PackageFile object - """ - id: ID! - - """ - MD5 hash of the file. - """ - md5: String - - """ - Name of the file. - """ - name: String! - - """ - The package version this file belongs to. - """ - packageVersion: PackageVersion - - """ - SHA1 hash of the file. - """ - sha1: String - - """ - SHA256 hash of the file. - """ - sha256: String - - """ - Size of the file in bytes. - """ - size: Int - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - URL to download the asset. - """ - url: URI -} - -""" -The connection type for PackageFile. -""" -type PackageFileConnection { - """ - A list of edges. - """ - edges: [PackageFileEdge] - - """ - A list of nodes. - """ - nodes: [PackageFile] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type PackageFileEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: PackageFile -} - -""" -Ways in which lists of package files can be ordered upon return. -""" -input PackageFileOrder { - """ - The direction in which to order package files by the specified field. - """ - direction: OrderDirection - - """ - The field in which to order package files by. - """ - field: PackageFileOrderField -} - -""" -Properties by which package file connections can be ordered. -""" -enum PackageFileOrderField { - """ - Order package files by creation time - """ - CREATED_AT -} - -""" -Ways in which lists of packages can be ordered upon return. -""" -input PackageOrder { - """ - The direction in which to order packages by the specified field. - """ - direction: OrderDirection - - """ - The field in which to order packages by. - """ - field: PackageOrderField -} - -""" -Properties by which package connections can be ordered. -""" -enum PackageOrderField { - """ - Order packages by creation time - """ - CREATED_AT -} - -""" -Represents an owner of a package. -""" -interface PackageOwner { - """ - The Node ID of the PackageOwner object - """ - id: ID! - - """ - A list of packages under the owner. - """ - packages( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Find packages by their names. - """ - names: [String] - - """ - Ordering of the returned packages. - """ - orderBy: PackageOrder = {field: CREATED_AT, direction: DESC} - - """ - Filter registry package by type. - """ - packageType: PackageType - - """ - Find packages in a repository by ID. - """ - repositoryId: ID - ): PackageConnection! -} - -""" -Represents a object that contains package activity statistics such as downloads. -""" -type PackageStatistics { - """ - Number of times the package was downloaded since it was created. - """ - downloadsTotalCount: Int! -} - -""" -A version tag contains the mapping between a tag name and a version. -""" -type PackageTag implements Node { - """ - The Node ID of the PackageTag object - """ - id: ID! - - """ - Identifies the tag name of the version. - """ - name: String! - - """ - Version that the tag is associated with. - """ - version: PackageVersion -} - -""" -The possible types of a package. -""" -enum PackageType { - """ - A debian package. - """ - DEBIAN - - """ - A docker image. - """ - DOCKER - @deprecated( - reason: "DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API. Removal on 2021-06-21 UTC." - ) - - """ - A maven package. - """ - MAVEN - @deprecated( - reason: "MAVEN will be removed from this enum as this type will be migrated to only be used by the Packages REST API. Removal on 2023-02-10 UTC." - ) - - """ - An npm package. - """ - NPM - @deprecated( - reason: "NPM will be removed from this enum as this type will be migrated to only be used by the Packages REST API. Removal on 2022-11-21 UTC." - ) - - """ - A nuget package. - """ - NUGET - @deprecated( - reason: "NUGET will be removed from this enum as this type will be migrated to only be used by the Packages REST API. Removal on 2022-11-21 UTC." - ) - - """ - A python package. - """ - PYPI - - """ - A rubygems package. - """ - RUBYGEMS - @deprecated( - reason: "RUBYGEMS will be removed from this enum as this type will be migrated to only be used by the Packages REST API. Removal on 2022-12-28 UTC." - ) -} - -""" -Information about a specific package version. -""" -type PackageVersion implements Node { - """ - List of files associated with this package version - """ - files( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering of the returned package files. - """ - orderBy: PackageFileOrder = {field: CREATED_AT, direction: ASC} - ): PackageFileConnection! - - """ - The Node ID of the PackageVersion object - """ - id: ID! - - """ - The package associated with this version. - """ - package: Package - - """ - The platform this version was built for. - """ - platform: String - - """ - Whether or not this version is a pre-release. - """ - preRelease: Boolean! - - """ - The README of this package version. - """ - readme: String - - """ - The release associated with this package version. - """ - release: Release - - """ - Statistics about package activity. - """ - statistics: PackageVersionStatistics - - """ - The package version summary. - """ - summary: String - - """ - The version string. - """ - version: String! -} - -""" -The connection type for PackageVersion. -""" -type PackageVersionConnection { - """ - A list of edges. - """ - edges: [PackageVersionEdge] - - """ - A list of nodes. - """ - nodes: [PackageVersion] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type PackageVersionEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: PackageVersion -} - -""" -Ways in which lists of package versions can be ordered upon return. -""" -input PackageVersionOrder { - """ - The direction in which to order package versions by the specified field. - """ - direction: OrderDirection - - """ - The field in which to order package versions by. - """ - field: PackageVersionOrderField -} - -""" -Properties by which package version connections can be ordered. -""" -enum PackageVersionOrderField { - """ - Order package versions by creation time - """ - CREATED_AT -} - -""" -Represents a object that contains package version activity statistics such as downloads. -""" -type PackageVersionStatistics { - """ - Number of times the package was downloaded since it was created. - """ - downloadsTotalCount: Int! -} - -""" -Information about pagination in a connection. -""" -type PageInfo { - """ - When paginating forwards, the cursor to continue. - """ - endCursor: String - - """ - When paginating forwards, are there more items? - """ - hasNextPage: Boolean! - - """ - When paginating backwards, are there more items? - """ - hasPreviousPage: Boolean! - - """ - When paginating backwards, the cursor to continue. - """ - startCursor: String -} - -""" -The possible types of patch statuses. -""" -enum PatchStatus { - """ - The file was added. Git status 'A'. - """ - ADDED - - """ - The file's type was changed. Git status 'T'. - """ - CHANGED - - """ - The file was copied. Git status 'C'. - """ - COPIED - - """ - The file was deleted. Git status 'D'. - """ - DELETED - - """ - The file's contents were changed. Git status 'M'. - """ - MODIFIED - - """ - The file was renamed. Git status 'R'. - """ - RENAMED -} - -""" -Types that can grant permissions on a repository to a user -""" -union PermissionGranter = Organization | Repository | Team - -""" -A level of permission and source for a user's access to a repository. -""" -type PermissionSource { - """ - The organization the repository belongs to. - """ - organization: Organization! - - """ - The level of access this source has granted to the user. - """ - permission: DefaultRepositoryPermissionField! - - """ - The name of the role this source has granted to the user. - """ - roleName: String - - """ - The source of this permission. - """ - source: PermissionGranter! -} - -""" -Autogenerated input type of PinEnvironment -""" -input PinEnvironmentInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the environment to modify - """ - environmentId: ID! @possibleTypes(concreteTypes: ["Environment"]) - - """ - The desired state of the environment. If true, environment will be pinned. If false, it will be unpinned. - """ - pinned: Boolean! -} - -""" -Autogenerated return type of PinEnvironment -""" -type PinEnvironmentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The environment that was pinned - """ - environment: Environment - - """ - The pinned environment if we pinned - """ - pinnedEnvironment: PinnedEnvironment -} - -""" -Autogenerated input type of PinIssue -""" -input PinIssueInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the issue to be pinned - """ - issueId: ID! @possibleTypes(concreteTypes: ["Issue"]) -} - -""" -Autogenerated return type of PinIssue -""" -type PinIssuePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The issue that was pinned - """ - issue: Issue -} - -""" -Types that can be pinned to a profile page. -""" -union PinnableItem = Gist | Repository - -""" -The connection type for PinnableItem. -""" -type PinnableItemConnection { - """ - A list of edges. - """ - edges: [PinnableItemEdge] - - """ - A list of nodes. - """ - nodes: [PinnableItem] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type PinnableItemEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: PinnableItem -} - -""" -Represents items that can be pinned to a profile page or dashboard. -""" -enum PinnableItemType { - """ - A gist. - """ - GIST - - """ - An issue. - """ - ISSUE - - """ - An organization. - """ - ORGANIZATION - - """ - A project. - """ - PROJECT - - """ - A pull request. - """ - PULL_REQUEST - - """ - A repository. - """ - REPOSITORY - - """ - A team. - """ - TEAM - - """ - A user. - """ - USER -} - -""" -A Pinned Discussion is a discussion pinned to a repository's index page. -""" -type PinnedDiscussion implements Node & RepositoryNode { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The discussion that was pinned. - """ - discussion: Discussion! - - """ - Color stops of the chosen gradient - """ - gradientStopColors: [String!]! - - """ - The Node ID of the PinnedDiscussion object - """ - id: ID! - - """ - Background texture pattern - """ - pattern: PinnedDiscussionPattern! - - """ - The actor that pinned this discussion. - """ - pinnedBy: Actor! - - """ - Preconfigured background gradient option - """ - preconfiguredGradient: PinnedDiscussionGradient - - """ - The repository associated with this node. - """ - repository: Repository! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -The connection type for PinnedDiscussion. -""" -type PinnedDiscussionConnection { - """ - A list of edges. - """ - edges: [PinnedDiscussionEdge] - - """ - A list of nodes. - """ - nodes: [PinnedDiscussion] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type PinnedDiscussionEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: PinnedDiscussion -} - -""" -Preconfigured gradients that may be used to style discussions pinned within a repository. -""" -enum PinnedDiscussionGradient { - """ - A gradient of blue to mint - """ - BLUE_MINT - - """ - A gradient of blue to purple - """ - BLUE_PURPLE - - """ - A gradient of pink to blue - """ - PINK_BLUE - - """ - A gradient of purple to coral - """ - PURPLE_CORAL - - """ - A gradient of red to orange - """ - RED_ORANGE -} - -""" -Preconfigured background patterns that may be used to style discussions pinned within a repository. -""" -enum PinnedDiscussionPattern { - """ - An upward-facing chevron pattern - """ - CHEVRON_UP - - """ - A hollow dot pattern - """ - DOT - - """ - A solid dot pattern - """ - DOT_FILL - - """ - A heart pattern - """ - HEART_FILL - - """ - A plus sign pattern - """ - PLUS - - """ - A lightning bolt pattern - """ - ZAP -} - -""" -Represents a pinned environment on a given repository -""" -type PinnedEnvironment implements Node { - """ - Identifies the date and time when the pinned environment was created - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - Identifies the environment associated. - """ - environment: Environment! - - """ - The Node ID of the PinnedEnvironment object - """ - id: ID! - - """ - Identifies the position of the pinned environment. - """ - position: Int! - - """ - The repository that this environment was pinned to. - """ - repository: Repository! -} - -""" -The connection type for PinnedEnvironment. -""" -type PinnedEnvironmentConnection { - """ - A list of edges. - """ - edges: [PinnedEnvironmentEdge] - - """ - A list of nodes. - """ - nodes: [PinnedEnvironment] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type PinnedEnvironmentEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: PinnedEnvironment -} - -""" -Ordering options for pinned environments -""" -input PinnedEnvironmentOrder { - """ - The direction in which to order pinned environments by the specified field. - """ - direction: OrderDirection! - - """ - The field to order pinned environments by. - """ - field: PinnedEnvironmentOrderField! -} - -""" -Properties by which pinned environments connections can be ordered -""" -enum PinnedEnvironmentOrderField { - """ - Order pinned environments by position - """ - POSITION -} - -""" -Represents a 'pinned' event on a given issue or pull request. -""" -type PinnedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the PinnedEvent object - """ - id: ID! - - """ - Identifies the issue associated with the event. - """ - issue: Issue! -} - -""" -A Pinned Issue is a issue pinned to a repository's index page. -""" -type PinnedIssue implements Node { - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - Identifies the primary key from the database as a BigInt. - """ - fullDatabaseId: BigInt - - """ - The Node ID of the PinnedIssue object - """ - id: ID! - - """ - The issue that was pinned. - """ - issue: Issue! - - """ - The actor that pinned this issue. - """ - pinnedBy: Actor! - - """ - The repository that this issue was pinned to. - """ - repository: Repository! -} - -""" -The connection type for PinnedIssue. -""" -type PinnedIssueConnection { - """ - A list of edges. - """ - edges: [PinnedIssueEdge] - - """ - A list of nodes. - """ - nodes: [PinnedIssue] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type PinnedIssueEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: PinnedIssue -} - -""" -An ISO-8601 encoded UTC date string with millisecond precision. -""" -scalar PreciseDateTime - -""" -Audit log entry for a private_repository_forking.disable event. -""" -type PrivateRepositoryForkingDisableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The HTTP path for this enterprise. - """ - enterpriseResourcePath: URI - - """ - The slug of the enterprise. - """ - enterpriseSlug: String - - """ - The HTTP URL for this enterprise. - """ - enterpriseUrl: URI - - """ - The Node ID of the PrivateRepositoryForkingDisableAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a private_repository_forking.enable event. -""" -type PrivateRepositoryForkingEnableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The HTTP path for this enterprise. - """ - enterpriseResourcePath: URI - - """ - The slug of the enterprise. - """ - enterpriseSlug: String - - """ - The HTTP URL for this enterprise. - """ - enterpriseUrl: URI - - """ - The Node ID of the PrivateRepositoryForkingEnableAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -A curatable list of repositories relating to a repository owner, which defaults -to showing the most popular repositories they own. -""" -type ProfileItemShowcase { - """ - Whether or not the owner has pinned any repositories or gists. - """ - hasPinnedItems: Boolean! - - """ - The repositories and gists in the showcase. If the profile owner has any - pinned items, those will be returned. Otherwise, the profile owner's popular - repositories will be returned. - """ - items( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): PinnableItemConnection! -} - -""" -Represents any entity on GitHub that has a profile page. -""" -interface ProfileOwner { - """ - Determine if this repository owner has any items that can be pinned to their profile. - """ - anyPinnableItems( - """ - Filter to only a particular kind of pinnable item. - """ - type: PinnableItemType - ): Boolean! - - """ - The public profile email. - """ - email: String - - """ - The Node ID of the ProfileOwner object - """ - id: ID! - - """ - Showcases a selection of repositories and gists that the profile owner has - either curated or that have been selected automatically based on popularity. - """ - itemShowcase: ProfileItemShowcase! - - """ - The public profile location. - """ - location: String - - """ - The username used to login. - """ - login: String! - - """ - The public profile name. - """ - name: String - - """ - A list of repositories and gists this profile owner can pin to their profile. - """ - pinnableItems( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filter the types of pinnable items that are returned. - """ - types: [PinnableItemType!] - ): PinnableItemConnection! - - """ - A list of repositories and gists this profile owner has pinned to their profile - """ - pinnedItems( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filter the types of pinned items that are returned. - """ - types: [PinnableItemType!] - ): PinnableItemConnection! - - """ - Returns how many more items this profile owner can pin to their profile. - """ - pinnedItemsRemaining: Int! - - """ - Can the viewer pin repositories and gists to the profile? - """ - viewerCanChangePinnedItems: Boolean! - - """ - The public profile website URL. - """ - websiteUrl: URI -} - -""" -Projects manage issues, pull requests and notes within a project owner. -""" -type Project implements Closable & Node & Updatable { - """ - The project's description body. - """ - body: String - - """ - The projects description body rendered to HTML. - """ - bodyHTML: HTML! - - """ - Indicates if the object is closed (definition of closed may depend on type) - """ - closed: Boolean! - - """ - Identifies the date and time when the object was closed. - """ - closedAt: DateTime - - """ - List of columns in the project - """ - columns( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ProjectColumnConnection! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The actor who originally created the project. - """ - creator: Actor - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the Project object - """ - id: ID! - - """ - The project's name. - """ - name: String! - - """ - The project's number. - """ - number: Int! - - """ - The project's owner. Currently limited to repositories, organizations, and users. - """ - owner: ProjectOwner! - - """ - List of pending cards in this project - """ - pendingCards( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - A list of archived states to filter the cards by - """ - archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED] - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ProjectCardConnection! - - """ - Project progress details. - """ - progress: ProjectProgress! - - """ - The HTTP path for this project - """ - resourcePath: URI! - - """ - Whether the project is open or closed. - """ - state: ProjectState! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this project - """ - url: URI! - - """ - Indicates if the object can be closed by the viewer. - """ - viewerCanClose: Boolean! - - """ - Indicates if the object can be reopened by the viewer. - """ - viewerCanReopen: Boolean! - - """ - Check if the current viewer can update this object. - """ - viewerCanUpdate: Boolean! -} - -""" -A card in a project. -""" -type ProjectCard implements Node { - """ - The project column this card is associated under. A card may only belong to one - project column at a time. The column field will be null if the card is created - in a pending state and has yet to be associated with a column. Once cards are - associated with a column, they will not become pending in the future. - """ - column: ProjectColumn - - """ - The card content item - """ - content: ProjectCardItem - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The actor who created this card - """ - creator: Actor - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the ProjectCard object - """ - id: ID! - - """ - Whether the card is archived - """ - isArchived: Boolean! - - """ - The card note - """ - note: String - - """ - The project that contains this card. - """ - project: Project! - - """ - The HTTP path for this card - """ - resourcePath: URI! - - """ - The state of ProjectCard - """ - state: ProjectCardState - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this card - """ - url: URI! -} - -""" -The possible archived states of a project card. -""" -enum ProjectCardArchivedState { - """ - A project card that is archived - """ - ARCHIVED - - """ - A project card that is not archived - """ - NOT_ARCHIVED -} - -""" -The connection type for ProjectCard. -""" -type ProjectCardConnection { - """ - A list of edges. - """ - edges: [ProjectCardEdge] - - """ - A list of nodes. - """ - nodes: [ProjectCard] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type ProjectCardEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: ProjectCard -} - -""" -An issue or PR and its owning repository to be used in a project card. -""" -input ProjectCardImport { - """ - The issue or pull request number. - """ - number: Int! - - """ - Repository name with owner (owner/repository). - """ - repository: String! -} - -""" -Types that can be inside Project Cards. -""" -union ProjectCardItem = Issue | PullRequest - -""" -Various content states of a ProjectCard -""" -enum ProjectCardState { - """ - The card has content only. - """ - CONTENT_ONLY - - """ - The card has a note only. - """ - NOTE_ONLY - - """ - The card is redacted. - """ - REDACTED -} - -""" -A column inside a project. -""" -type ProjectColumn implements Node { - """ - List of cards in the column - """ - cards( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - A list of archived states to filter the cards by - """ - archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED] - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ProjectCardConnection! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the ProjectColumn object - """ - id: ID! - - """ - The project column's name. - """ - name: String! - - """ - The project that contains this column. - """ - project: Project! - - """ - The semantic purpose of the column - """ - purpose: ProjectColumnPurpose - - """ - The HTTP path for this project column - """ - resourcePath: URI! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this project column - """ - url: URI! -} - -""" -The connection type for ProjectColumn. -""" -type ProjectColumnConnection { - """ - A list of edges. - """ - edges: [ProjectColumnEdge] - - """ - A list of nodes. - """ - nodes: [ProjectColumn] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type ProjectColumnEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: ProjectColumn -} - -""" -A project column and a list of its issues and PRs. -""" -input ProjectColumnImport { - """ - The name of the column. - """ - columnName: String! - - """ - A list of issues and pull requests in the column. - """ - issues: [ProjectCardImport!] - - """ - The position of the column, starting from 0. - """ - position: Int! -} - -""" -The semantic purpose of the column - todo, in progress, or done. -""" -enum ProjectColumnPurpose { - """ - The column contains cards which are complete - """ - DONE - - """ - The column contains cards which are currently being worked on - """ - IN_PROGRESS - - """ - The column contains cards still to be worked on - """ - TODO -} - -""" -A list of projects associated with the owner. -""" -type ProjectConnection { - """ - A list of edges. - """ - edges: [ProjectEdge] - - """ - A list of nodes. - """ - nodes: [Project] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type ProjectEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Project -} - -""" -Ways in which lists of projects can be ordered upon return. -""" -input ProjectOrder { - """ - The direction in which to order projects by the specified field. - """ - direction: OrderDirection! - - """ - The field in which to order projects by. - """ - field: ProjectOrderField! -} - -""" -Properties by which project connections can be ordered. -""" -enum ProjectOrderField { - """ - Order projects by creation time - """ - CREATED_AT - - """ - Order projects by name - """ - NAME - - """ - Order projects by update time - """ - UPDATED_AT -} - -""" -Represents an owner of a Project. -""" -interface ProjectOwner { - """ - The Node ID of the ProjectOwner object - """ - id: ID! - - """ - Find project by number. - """ - project( - """ - The project number to find. - """ - number: Int! - ): Project - - """ - A list of projects under the owner. - """ - projects( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for projects returned from the connection - """ - orderBy: ProjectOrder - - """ - Query to search projects by, currently only searching by name. - """ - search: String - - """ - A list of states to filter the projects by. - """ - states: [ProjectState!] - ): ProjectConnection! - - """ - The HTTP path listing owners projects - """ - projectsResourcePath: URI! - - """ - The HTTP URL listing owners projects - """ - projectsUrl: URI! - - """ - Can the current viewer create new projects on this owner. - """ - viewerCanCreateProjects: Boolean! -} - -""" -Project progress stats. -""" -type ProjectProgress { - """ - The number of done cards. - """ - doneCount: Int! - - """ - The percentage of done cards. - """ - donePercentage: Float! - - """ - Whether progress tracking is enabled and cards with purpose exist for this project - """ - enabled: Boolean! - - """ - The number of in-progress cards. - """ - inProgressCount: Int! - - """ - The percentage of in-progress cards. - """ - inProgressPercentage: Float! - - """ - The number of to do cards. - """ - todoCount: Int! - - """ - The percentage of to do cards. - """ - todoPercentage: Float! -} - -""" -State of the project; either 'open' or 'closed' -""" -enum ProjectState { - """ - The project is closed. - """ - CLOSED - - """ - The project is open. - """ - OPEN -} - -""" -GitHub-provided templates for Projects -""" -enum ProjectTemplate { - """ - Create a board with v2 triggers to automatically move cards across To do, In progress and Done columns. - """ - AUTOMATED_KANBAN_V2 - - """ - Create a board with triggers to automatically move cards across columns with review automation. - """ - AUTOMATED_REVIEWS_KANBAN - - """ - Create a board with columns for To do, In progress and Done. - """ - BASIC_KANBAN - - """ - Create a board to triage and prioritize bugs with To do, priority, and Done columns. - """ - BUG_TRIAGE -} - -""" -New projects that manage issues, pull requests and drafts using tables and boards. -""" -type ProjectV2 implements Closable & Node & Updatable { - """ - Returns true if the project is closed. - """ - closed: Boolean! - - """ - Identifies the date and time when the object was closed. - """ - closedAt: DateTime - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The actor who originally created the project. - """ - creator: Actor - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - A field of the project - """ - field( - """ - The name of the field - """ - name: String! - ): ProjectV2FieldConfiguration - - """ - List of fields and their constraints in the project - """ - fields( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for project v2 fields returned from the connection - """ - orderBy: ProjectV2FieldOrder = {field: POSITION, direction: ASC} - ): ProjectV2FieldConfigurationConnection! - - """ - The Node ID of the ProjectV2 object - """ - id: ID! - - """ - List of items in the project - """ - items( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for project v2 items returned from the connection - """ - orderBy: ProjectV2ItemOrder = {field: POSITION, direction: ASC} - ): ProjectV2ItemConnection! - - """ - The project's number. - """ - number: Int! - - """ - The project's owner. Currently limited to organizations and users. - """ - owner: ProjectV2Owner! - - """ - Returns true if the project is public. - """ - public: Boolean! - - """ - The project's readme. - """ - readme: String - - """ - The repositories the project is linked to. - """ - repositories( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for repositories returned from the connection - """ - orderBy: RepositoryOrder = {field: CREATED_AT, direction: DESC} - ): RepositoryConnection! - - """ - The HTTP path for this project - """ - resourcePath: URI! - - """ - The project's short description. - """ - shortDescription: String - - """ - The teams the project is linked to. - """ - teams( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for teams returned from this connection. - """ - orderBy: TeamOrder = {field: NAME, direction: ASC} - ): TeamConnection! - - """ - Returns true if this project is a template. - """ - template: Boolean! - - """ - The project's name. - """ - title: String! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this project - """ - url: URI! - - """ - A view of the project - """ - view( - """ - The number of a view belonging to the project - """ - number: Int! - ): ProjectV2View - - """ - Indicates if the object can be closed by the viewer. - """ - viewerCanClose: Boolean! - - """ - Indicates if the object can be reopened by the viewer. - """ - viewerCanReopen: Boolean! - - """ - Check if the current viewer can update this object. - """ - viewerCanUpdate: Boolean! - - """ - List of views in the project - """ - views( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for project v2 views returned from the connection - """ - orderBy: ProjectV2ViewOrder = {field: POSITION, direction: ASC} - ): ProjectV2ViewConnection! - - """ - A workflow of the project - """ - workflow( - """ - The number of a workflow belonging to the project - """ - number: Int! - ): ProjectV2Workflow - - """ - List of the workflows in the project - """ - workflows( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for project v2 workflows returned from the connection - """ - orderBy: ProjectV2WorkflowOrder = {field: NAME, direction: ASC} - ): ProjectV2WorkflowConnection! -} - -""" -Possible collaborators for a project. -""" -union ProjectV2Actor = Team | User - -""" -The connection type for ProjectV2Actor. -""" -type ProjectV2ActorConnection { - """ - A list of edges. - """ - edges: [ProjectV2ActorEdge] - - """ - A list of nodes. - """ - nodes: [ProjectV2Actor] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type ProjectV2ActorEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: ProjectV2Actor -} - -""" -A collaborator to update on a project. Only one of the userId or teamId should be provided. -""" -input ProjectV2Collaborator { - """ - The role to grant the collaborator - """ - role: ProjectV2Roles! - - """ - The ID of the team as a collaborator. - """ - teamId: ID @possibleTypes(concreteTypes: ["Team"]) - - """ - The ID of the user as a collaborator. - """ - userId: ID @possibleTypes(concreteTypes: ["User"]) -} - -""" -The connection type for ProjectV2. -""" -type ProjectV2Connection { - """ - A list of edges. - """ - edges: [ProjectV2Edge] - - """ - A list of nodes. - """ - nodes: [ProjectV2] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -The type of a project field. -""" -enum ProjectV2CustomFieldType { - """ - Date - """ - DATE - - """ - Number - """ - NUMBER - - """ - Single Select - """ - SINGLE_SELECT - - """ - Text - """ - TEXT -} - -""" -An edge in a connection. -""" -type ProjectV2Edge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: ProjectV2 -} - -""" -A field inside a project. -""" -type ProjectV2Field implements Node & ProjectV2FieldCommon { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The field's type. - """ - dataType: ProjectV2FieldType! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the ProjectV2Field object - """ - id: ID! - - """ - The project field's name. - """ - name: String! - - """ - The project that contains this field. - """ - project: ProjectV2! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -Common fields across different project field types -""" -interface ProjectV2FieldCommon { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The field's type. - """ - dataType: ProjectV2FieldType! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the ProjectV2FieldCommon object - """ - id: ID! - - """ - The project field's name. - """ - name: String! - - """ - The project that contains this field. - """ - project: ProjectV2! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -Configurations for project fields. -""" -union ProjectV2FieldConfiguration = ProjectV2Field | ProjectV2IterationField | ProjectV2SingleSelectField - -""" -The connection type for ProjectV2FieldConfiguration. -""" -type ProjectV2FieldConfigurationConnection { - """ - A list of edges. - """ - edges: [ProjectV2FieldConfigurationEdge] - - """ - A list of nodes. - """ - nodes: [ProjectV2FieldConfiguration] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type ProjectV2FieldConfigurationEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: ProjectV2FieldConfiguration -} - -""" -The connection type for ProjectV2Field. -""" -type ProjectV2FieldConnection { - """ - A list of edges. - """ - edges: [ProjectV2FieldEdge] - - """ - A list of nodes. - """ - nodes: [ProjectV2Field] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type ProjectV2FieldEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: ProjectV2Field -} - -""" -Ordering options for project v2 field connections -""" -input ProjectV2FieldOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order the project v2 fields by. - """ - field: ProjectV2FieldOrderField! -} - -""" -Properties by which project v2 field connections can be ordered. -""" -enum ProjectV2FieldOrderField { - """ - Order project v2 fields by creation time - """ - CREATED_AT - - """ - Order project v2 fields by name - """ - NAME - - """ - Order project v2 fields by position - """ - POSITION -} - -""" -The type of a project field. -""" -enum ProjectV2FieldType { - """ - Assignees - """ - ASSIGNEES - - """ - Date - """ - DATE - - """ - Iteration - """ - ITERATION - - """ - Labels - """ - LABELS - - """ - Linked Pull Requests - """ - LINKED_PULL_REQUESTS - - """ - Milestone - """ - MILESTONE - - """ - Number - """ - NUMBER - - """ - Repository - """ - REPOSITORY - - """ - Reviewers - """ - REVIEWERS - - """ - Single Select - """ - SINGLE_SELECT - - """ - Text - """ - TEXT - - """ - Title - """ - TITLE - - """ - Tracked by - """ - TRACKED_BY - - """ - Tracks - """ - TRACKS -} - -""" -The values that can be used to update a field of an item inside a Project. Only 1 value can be updated at a time. -""" -input ProjectV2FieldValue { - """ - The ISO 8601 date to set on the field. - """ - date: Date - - """ - The id of the iteration to set on the field. - """ - iterationId: String - - """ - The number to set on the field. - """ - number: Float - - """ - The id of the single select option to set on the field. - """ - singleSelectOptionId: String - - """ - The text to set on the field. - """ - text: String -} - -""" -An item within a Project. -""" -type ProjectV2Item implements Node { - """ - The content of the referenced draft issue, issue, or pull request - """ - content: ProjectV2ItemContent - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The actor who created the item. - """ - creator: Actor - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The field value of the first project field which matches the 'name' argument that is set on the item. - """ - fieldValueByName( - """ - The name of the field to return the field value of - """ - name: String! - ): ProjectV2ItemFieldValue - - """ - The field values that are set on the item. - """ - fieldValues( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for project v2 item field values returned from the connection - """ - orderBy: ProjectV2ItemFieldValueOrder = {field: POSITION, direction: ASC} - ): ProjectV2ItemFieldValueConnection! - - """ - Identifies the primary key from the database as a BigInt. - """ - fullDatabaseId: BigInt - - """ - The Node ID of the ProjectV2Item object - """ - id: ID! - - """ - Whether the item is archived. - """ - isArchived: Boolean! - - """ - The project that contains this item. - """ - project: ProjectV2! - - """ - The type of the item. - """ - type: ProjectV2ItemType! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -The connection type for ProjectV2Item. -""" -type ProjectV2ItemConnection { - """ - A list of edges. - """ - edges: [ProjectV2ItemEdge] - - """ - A list of nodes. - """ - nodes: [ProjectV2Item] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -Types that can be inside Project Items. -""" -union ProjectV2ItemContent = DraftIssue | Issue | PullRequest - -""" -An edge in a connection. -""" -type ProjectV2ItemEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: ProjectV2Item -} - -""" -The value of a date field in a Project item. -""" -type ProjectV2ItemFieldDateValue implements Node & ProjectV2ItemFieldValueCommon { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The actor who created the item. - """ - creator: Actor - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - Date value for the field - """ - date: Date - - """ - The project field that contains this value. - """ - field: ProjectV2FieldConfiguration! - - """ - The Node ID of the ProjectV2ItemFieldDateValue object - """ - id: ID! - - """ - The project item that contains this value. - """ - item: ProjectV2Item! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -The value of an iteration field in a Project item. -""" -type ProjectV2ItemFieldIterationValue implements Node & ProjectV2ItemFieldValueCommon { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The actor who created the item. - """ - creator: Actor - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The duration of the iteration in days. - """ - duration: Int! - - """ - The project field that contains this value. - """ - field: ProjectV2FieldConfiguration! - - """ - The Node ID of the ProjectV2ItemFieldIterationValue object - """ - id: ID! - - """ - The project item that contains this value. - """ - item: ProjectV2Item! - - """ - The ID of the iteration. - """ - iterationId: String! - - """ - The start date of the iteration. - """ - startDate: Date! - - """ - The title of the iteration. - """ - title: String! - - """ - The title of the iteration, with HTML. - """ - titleHTML: String! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -The value of the labels field in a Project item. -""" -type ProjectV2ItemFieldLabelValue { - """ - The field that contains this value. - """ - field: ProjectV2FieldConfiguration! - - """ - Labels value of a field - """ - labels( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): LabelConnection -} - -""" -The value of a milestone field in a Project item. -""" -type ProjectV2ItemFieldMilestoneValue { - """ - The field that contains this value. - """ - field: ProjectV2FieldConfiguration! - - """ - Milestone value of a field - """ - milestone: Milestone -} - -""" -The value of a number field in a Project item. -""" -type ProjectV2ItemFieldNumberValue implements Node & ProjectV2ItemFieldValueCommon { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The actor who created the item. - """ - creator: Actor - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The project field that contains this value. - """ - field: ProjectV2FieldConfiguration! - - """ - The Node ID of the ProjectV2ItemFieldNumberValue object - """ - id: ID! - - """ - The project item that contains this value. - """ - item: ProjectV2Item! - - """ - Number as a float(8) - """ - number: Float - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -The value of a pull request field in a Project item. -""" -type ProjectV2ItemFieldPullRequestValue { - """ - The field that contains this value. - """ - field: ProjectV2FieldConfiguration! - - """ - The pull requests for this field - """ - pullRequests( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for pull requests. - """ - orderBy: PullRequestOrder = {field: CREATED_AT, direction: ASC} - ): PullRequestConnection -} - -""" -The value of a repository field in a Project item. -""" -type ProjectV2ItemFieldRepositoryValue { - """ - The field that contains this value. - """ - field: ProjectV2FieldConfiguration! - - """ - The repository for this field. - """ - repository: Repository -} - -""" -The value of a reviewers field in a Project item. -""" -type ProjectV2ItemFieldReviewerValue { - """ - The field that contains this value. - """ - field: ProjectV2FieldConfiguration! - - """ - The reviewers for this field. - """ - reviewers( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): RequestedReviewerConnection -} - -""" -The value of a single select field in a Project item. -""" -type ProjectV2ItemFieldSingleSelectValue implements Node & ProjectV2ItemFieldValueCommon { - """ - The color applied to the selected single-select option. - """ - color: ProjectV2SingleSelectFieldOptionColor! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The actor who created the item. - """ - creator: Actor - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - A plain-text description of the selected single-select option, such as what the option means. - """ - description: String - - """ - The description of the selected single-select option, including HTML tags. - """ - descriptionHTML: String - - """ - The project field that contains this value. - """ - field: ProjectV2FieldConfiguration! - - """ - The Node ID of the ProjectV2ItemFieldSingleSelectValue object - """ - id: ID! - - """ - The project item that contains this value. - """ - item: ProjectV2Item! - - """ - The name of the selected single select option. - """ - name: String - - """ - The html name of the selected single select option. - """ - nameHTML: String - - """ - The id of the selected single select option. - """ - optionId: String - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -The value of a text field in a Project item. -""" -type ProjectV2ItemFieldTextValue implements Node & ProjectV2ItemFieldValueCommon { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The actor who created the item. - """ - creator: Actor - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The project field that contains this value. - """ - field: ProjectV2FieldConfiguration! - - """ - The Node ID of the ProjectV2ItemFieldTextValue object - """ - id: ID! - - """ - The project item that contains this value. - """ - item: ProjectV2Item! - - """ - Text value of a field - """ - text: String - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -The value of a user field in a Project item. -""" -type ProjectV2ItemFieldUserValue { - """ - The field that contains this value. - """ - field: ProjectV2FieldConfiguration! - - """ - The users for this field - """ - users( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserConnection -} - -""" -Project field values -""" -union ProjectV2ItemFieldValue = - ProjectV2ItemFieldDateValue - | ProjectV2ItemFieldIterationValue - | ProjectV2ItemFieldLabelValue - | ProjectV2ItemFieldMilestoneValue - | ProjectV2ItemFieldNumberValue - | ProjectV2ItemFieldPullRequestValue - | ProjectV2ItemFieldRepositoryValue - | ProjectV2ItemFieldReviewerValue - | ProjectV2ItemFieldSingleSelectValue - | ProjectV2ItemFieldTextValue - | ProjectV2ItemFieldUserValue - -""" -Common fields across different project field value types -""" -interface ProjectV2ItemFieldValueCommon { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The actor who created the item. - """ - creator: Actor - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The project field that contains this value. - """ - field: ProjectV2FieldConfiguration! - - """ - The Node ID of the ProjectV2ItemFieldValueCommon object - """ - id: ID! - - """ - The project item that contains this value. - """ - item: ProjectV2Item! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -The connection type for ProjectV2ItemFieldValue. -""" -type ProjectV2ItemFieldValueConnection { - """ - A list of edges. - """ - edges: [ProjectV2ItemFieldValueEdge] - - """ - A list of nodes. - """ - nodes: [ProjectV2ItemFieldValue] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type ProjectV2ItemFieldValueEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: ProjectV2ItemFieldValue -} - -""" -Ordering options for project v2 item field value connections -""" -input ProjectV2ItemFieldValueOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order the project v2 item field values by. - """ - field: ProjectV2ItemFieldValueOrderField! -} - -""" -Properties by which project v2 item field value connections can be ordered. -""" -enum ProjectV2ItemFieldValueOrderField { - """ - Order project v2 item field values by the their position in the project - """ - POSITION -} - -""" -Ordering options for project v2 item connections -""" -input ProjectV2ItemOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order the project v2 items by. - """ - field: ProjectV2ItemOrderField! -} - -""" -Properties by which project v2 item connections can be ordered. -""" -enum ProjectV2ItemOrderField { - """ - Order project v2 items by the their position in the project - """ - POSITION -} - -""" -The type of a project item. -""" -enum ProjectV2ItemType { - """ - Draft Issue - """ - DRAFT_ISSUE - - """ - Issue - """ - ISSUE - - """ - Pull Request - """ - PULL_REQUEST - - """ - Redacted Item - """ - REDACTED -} - -""" -An iteration field inside a project. -""" -type ProjectV2IterationField implements Node & ProjectV2FieldCommon { - """ - Iteration configuration settings - """ - configuration: ProjectV2IterationFieldConfiguration! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The field's type. - """ - dataType: ProjectV2FieldType! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the ProjectV2IterationField object - """ - id: ID! - - """ - The project field's name. - """ - name: String! - - """ - The project that contains this field. - """ - project: ProjectV2! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -Iteration field configuration for a project. -""" -type ProjectV2IterationFieldConfiguration { - """ - The iteration's completed iterations - """ - completedIterations: [ProjectV2IterationFieldIteration!]! - - """ - The iteration's duration in days - """ - duration: Int! - - """ - The iteration's iterations - """ - iterations: [ProjectV2IterationFieldIteration!]! - - """ - The iteration's start day of the week - """ - startDay: Int! -} - -""" -Iteration field iteration settings for a project. -""" -type ProjectV2IterationFieldIteration { - """ - The iteration's duration in days - """ - duration: Int! - - """ - The iteration's ID. - """ - id: String! - - """ - The iteration's start date - """ - startDate: Date! - - """ - The iteration's title. - """ - title: String! - - """ - The iteration's html title. - """ - titleHTML: String! -} - -""" -Ways in which lists of projects can be ordered upon return. -""" -input ProjectV2Order { - """ - The direction in which to order projects by the specified field. - """ - direction: OrderDirection! - - """ - The field in which to order projects by. - """ - field: ProjectV2OrderField! -} - -""" -Properties by which projects can be ordered. -""" -enum ProjectV2OrderField { - """ - The project's date and time of creation - """ - CREATED_AT - - """ - The project's number - """ - NUMBER - - """ - The project's title - """ - TITLE - - """ - The project's date and time of update - """ - UPDATED_AT -} - -""" -Represents an owner of a project. -""" -interface ProjectV2Owner { - """ - The Node ID of the ProjectV2Owner object - """ - id: ID! - - """ - Find a project by number. - """ - projectV2( - """ - The project number. - """ - number: Int! - ): ProjectV2 - - """ - A list of projects under the owner. - """ - projectsV2( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - How to order the returned projects. - """ - orderBy: ProjectV2Order = {field: NUMBER, direction: DESC} - - """ - A project to search for under the the owner. - """ - query: String - ): ProjectV2Connection! -} - -""" -Recent projects for the owner. -""" -interface ProjectV2Recent { - """ - Recent projects that this user has modified in the context of the owner. - """ - recentProjects( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ProjectV2Connection! -} - -""" -The possible roles of a collaborator on a project. -""" -enum ProjectV2Roles { - """ - The collaborator can view, edit, and maange the settings of the project - """ - ADMIN - - """ - The collaborator has no direct access to the project - """ - NONE - - """ - The collaborator can view the project - """ - READER - - """ - The collaborator can view and edit the project - """ - WRITER -} - -""" -A single select field inside a project. -""" -type ProjectV2SingleSelectField implements Node & ProjectV2FieldCommon { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The field's type. - """ - dataType: ProjectV2FieldType! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the ProjectV2SingleSelectField object - """ - id: ID! - - """ - The project field's name. - """ - name: String! - - """ - Options for the single select field - """ - options( - """ - Filter returned options to only those matching these names, case insensitive. - """ - names: [String!] - ): [ProjectV2SingleSelectFieldOption!]! - - """ - The project that contains this field. - """ - project: ProjectV2! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -Single select field option for a configuration for a project. -""" -type ProjectV2SingleSelectFieldOption { - """ - The option's display color. - """ - color: ProjectV2SingleSelectFieldOptionColor! - - """ - The option's plain-text description. - """ - description: String! - - """ - The option's description, possibly containing HTML. - """ - descriptionHTML: String! - - """ - The option's ID. - """ - id: String! - - """ - The option's name. - """ - name: String! - - """ - The option's html name. - """ - nameHTML: String! -} - -""" -The display color of a single-select field option. -""" -enum ProjectV2SingleSelectFieldOptionColor { - """ - BLUE - """ - BLUE - - """ - GRAY - """ - GRAY - - """ - GREEN - """ - GREEN - - """ - ORANGE - """ - ORANGE - - """ - PINK - """ - PINK - - """ - PURPLE - """ - PURPLE - - """ - RED - """ - RED - - """ - YELLOW - """ - YELLOW -} - -""" -Represents a single select field option -""" -input ProjectV2SingleSelectFieldOptionInput { - """ - The display color of the option - """ - color: ProjectV2SingleSelectFieldOptionColor! - - """ - The description text of the option - """ - description: String! - - """ - The name of the option - """ - name: String! -} - -""" -Represents a sort by field and direction. -""" -type ProjectV2SortBy { - """ - The direction of the sorting. Possible values are ASC and DESC. - """ - direction: OrderDirection! - - """ - The field by which items are sorted. - """ - field: ProjectV2Field! -} - -""" -The connection type for ProjectV2SortBy. -""" -type ProjectV2SortByConnection { - """ - A list of edges. - """ - edges: [ProjectV2SortByEdge] - - """ - A list of nodes. - """ - nodes: [ProjectV2SortBy] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type ProjectV2SortByEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: ProjectV2SortBy -} - -""" -Represents a sort by field and direction. -""" -type ProjectV2SortByField { - """ - The direction of the sorting. Possible values are ASC and DESC. - """ - direction: OrderDirection! - - """ - The field by which items are sorted. - """ - field: ProjectV2FieldConfiguration! -} - -""" -The connection type for ProjectV2SortByField. -""" -type ProjectV2SortByFieldConnection { - """ - A list of edges. - """ - edges: [ProjectV2SortByFieldEdge] - - """ - A list of nodes. - """ - nodes: [ProjectV2SortByField] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type ProjectV2SortByFieldEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: ProjectV2SortByField -} - -""" -A view within a ProjectV2. -""" -type ProjectV2View implements Node { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The view's visible fields. - """ - fields( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for the project v2 fields returned from the connection. - """ - orderBy: ProjectV2FieldOrder = {field: POSITION, direction: ASC} - ): ProjectV2FieldConfigurationConnection - - """ - The project view's filter. - """ - filter: String - - """ - The view's group-by field. - """ - groupBy( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for the project v2 fields returned from the connection. - """ - orderBy: ProjectV2FieldOrder = {field: POSITION, direction: ASC} - ): ProjectV2FieldConnection - @deprecated( - reason: "The `ProjectV2View#order_by` API is deprecated in favour of the more capable `ProjectV2View#group_by_field` API. Check out the `ProjectV2View#group_by_fields` API as an example for the more capable alternative. Removal on 2023-04-01 UTC." - ) - - """ - The view's group-by field. - """ - groupByFields( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for the project v2 fields returned from the connection. - """ - orderBy: ProjectV2FieldOrder = {field: POSITION, direction: ASC} - ): ProjectV2FieldConfigurationConnection - - """ - The Node ID of the ProjectV2View object - """ - id: ID! - - """ - The project view's layout. - """ - layout: ProjectV2ViewLayout! - - """ - The project view's name. - """ - name: String! - - """ - The project view's number. - """ - number: Int! - - """ - The project that contains this view. - """ - project: ProjectV2! - - """ - The view's sort-by config. - """ - sortBy( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ProjectV2SortByConnection - @deprecated( - reason: "The `ProjectV2View#sort_by` API is deprecated in favour of the more capable `ProjectV2View#sort_by_fields` API. Check out the `ProjectV2View#sort_by_fields` API as an example for the more capable alternative. Removal on 2023-04-01 UTC." - ) - - """ - The view's sort-by config. - """ - sortByFields( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ProjectV2SortByFieldConnection - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The view's vertical-group-by field. - """ - verticalGroupBy( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for the project v2 fields returned from the connection. - """ - orderBy: ProjectV2FieldOrder = {field: POSITION, direction: ASC} - ): ProjectV2FieldConnection - @deprecated( - reason: "The `ProjectV2View#vertical_group_by` API is deprecated in favour of the more capable `ProjectV2View#vertical_group_by_fields` API. Check out the `ProjectV2View#vertical_group_by_fields` API as an example for the more capable alternative. Removal on 2023-04-01 UTC." - ) - - """ - The view's vertical-group-by field. - """ - verticalGroupByFields( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for the project v2 fields returned from the connection. - """ - orderBy: ProjectV2FieldOrder = {field: POSITION, direction: ASC} - ): ProjectV2FieldConfigurationConnection - - """ - The view's visible fields. - """ - visibleFields( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for the project v2 fields returned from the connection. - """ - orderBy: ProjectV2FieldOrder = {field: POSITION, direction: ASC} - ): ProjectV2FieldConnection - @deprecated( - reason: "The `ProjectV2View#visibleFields` API is deprecated in favour of the more capable `ProjectV2View#fields` API. Check out the `ProjectV2View#fields` API as an example for the more capable alternative. Removal on 2023-01-01 UTC." - ) -} - -""" -The connection type for ProjectV2View. -""" -type ProjectV2ViewConnection { - """ - A list of edges. - """ - edges: [ProjectV2ViewEdge] - - """ - A list of nodes. - """ - nodes: [ProjectV2View] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type ProjectV2ViewEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: ProjectV2View -} - -""" -The layout of a project v2 view. -""" -enum ProjectV2ViewLayout { - """ - Board layout - """ - BOARD_LAYOUT - - """ - Roadmap layout - """ - ROADMAP_LAYOUT - - """ - Table layout - """ - TABLE_LAYOUT -} - -""" -Ordering options for project v2 view connections -""" -input ProjectV2ViewOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order the project v2 views by. - """ - field: ProjectV2ViewOrderField! -} - -""" -Properties by which project v2 view connections can be ordered. -""" -enum ProjectV2ViewOrderField { - """ - Order project v2 views by creation time - """ - CREATED_AT - - """ - Order project v2 views by name - """ - NAME - - """ - Order project v2 views by position - """ - POSITION -} - -""" -A workflow inside a project. -""" -type ProjectV2Workflow implements Node { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - Whether the workflow is enabled. - """ - enabled: Boolean! - - """ - The Node ID of the ProjectV2Workflow object - """ - id: ID! - - """ - The name of the workflow. - """ - name: String! - - """ - The number of the workflow. - """ - number: Int! - - """ - The project that contains this workflow. - """ - project: ProjectV2! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -The connection type for ProjectV2Workflow. -""" -type ProjectV2WorkflowConnection { - """ - A list of edges. - """ - edges: [ProjectV2WorkflowEdge] - - """ - A list of nodes. - """ - nodes: [ProjectV2Workflow] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type ProjectV2WorkflowEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: ProjectV2Workflow -} - -""" -Ordering options for project v2 workflows connections -""" -input ProjectV2WorkflowOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order the project v2 workflows by. - """ - field: ProjectV2WorkflowsOrderField! -} - -""" -Properties by which project workflows can be ordered. -""" -enum ProjectV2WorkflowsOrderField { - """ - The date and time of the workflow creation - """ - CREATED_AT - - """ - The name of the workflow - """ - NAME - - """ - The number of the workflow - """ - NUMBER - - """ - The date and time of the workflow update - """ - UPDATED_AT -} - -""" -A property that must match -""" -type PropertyTargetDefinition { - """ - The name of the property - """ - name: String! - - """ - The values to match for - """ - propertyValues: [String!]! -} - -""" -A property that must match -""" -input PropertyTargetDefinitionInput { - """ - The name of the property - """ - name: String! - - """ - The values to match for - """ - propertyValues: [String!]! -} - -""" -A user's public key. -""" -type PublicKey implements Node { - """ - The last time this authorization was used to perform an action. Values will be null for keys not owned by the user. - """ - accessedAt: DateTime - - """ - Identifies the date and time when the key was created. Keys created before - March 5th, 2014 have inaccurate values. Values will be null for keys not owned by the user. - """ - createdAt: DateTime - - """ - The fingerprint for this PublicKey. - """ - fingerprint: String! - - """ - The Node ID of the PublicKey object - """ - id: ID! - - """ - Whether this PublicKey is read-only or not. Values will be null for keys not owned by the user. - """ - isReadOnly: Boolean - - """ - The public key string. - """ - key: String! - - """ - Identifies the date and time when the key was updated. Keys created before - March 5th, 2014 may have inaccurate values. Values will be null for keys not - owned by the user. - """ - updatedAt: DateTime -} - -""" -The connection type for PublicKey. -""" -type PublicKeyConnection { - """ - A list of edges. - """ - edges: [PublicKeyEdge] - - """ - A list of nodes. - """ - nodes: [PublicKey] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type PublicKeyEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: PublicKey -} - -""" -A repository pull request. -""" -type PullRequest implements Assignable & Closable & Comment & Labelable & Lockable & Node & ProjectV2Owner & Reactable & RepositoryNode & Subscribable & UniformResourceLocatable & Updatable & UpdatableComment { - """ - Reason that the conversation was locked. - """ - activeLockReason: LockReason - - """ - The number of additions in this pull request. - """ - additions: Int! - - """ - A list of Users assigned to this object. - """ - assignees( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserConnection! - - """ - The actor who authored the comment. - """ - author: Actor - - """ - Author's association with the subject of the comment. - """ - authorAssociation: CommentAuthorAssociation! - - """ - Returns the auto-merge request object if one exists for this pull request. - """ - autoMergeRequest: AutoMergeRequest - - """ - Identifies the base Ref associated with the pull request. - """ - baseRef: Ref - - """ - Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted. - """ - baseRefName: String! - - """ - Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted. - """ - baseRefOid: GitObjectID! - - """ - The repository associated with this pull request's base Ref. - """ - baseRepository: Repository - - """ - The body as Markdown. - """ - body: String! - - """ - The body rendered to HTML. - """ - bodyHTML: HTML! - - """ - The body rendered to text. - """ - bodyText: String! - - """ - Whether or not the pull request is rebaseable. - """ - canBeRebased: Boolean! - - """ - The number of changed files in this pull request. - """ - changedFiles: Int! - - """ - The HTTP path for the checks of this pull request. - """ - checksResourcePath: URI! - - """ - The HTTP URL for the checks of this pull request. - """ - checksUrl: URI! - - """ - `true` if the pull request is closed - """ - closed: Boolean! - - """ - Identifies the date and time when the object was closed. - """ - closedAt: DateTime - - """ - List of issues that were may be closed by this pull request - """ - closingIssuesReferences( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for issues returned from the connection - """ - orderBy: IssueOrder - - """ - Return only manually linked Issues - """ - userLinkedOnly: Boolean = false - ): IssueConnection - - """ - A list of comments associated with the pull request. - """ - comments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for issue comments returned from the connection. - """ - orderBy: IssueCommentOrder - ): IssueCommentConnection! - - """ - A list of commits present in this pull request's head branch not present in the base branch. - """ - commits( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): PullRequestCommitConnection! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Check if this comment was created via an email reply. - """ - createdViaEmail: Boolean! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - @deprecated( - reason: "`databaseId` will be removed because it does not support 64-bit signed integer identifiers. Use `fullDatabaseId` instead. Removal on 2024-07-01 UTC." - ) - - """ - The number of deletions in this pull request. - """ - deletions: Int! - - """ - The actor who edited this pull request's body. - """ - editor: Actor - - """ - Lists the files changed within this pull request. - """ - files( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): PullRequestChangedFileConnection - - """ - Identifies the primary key from the database as a BigInt. - """ - fullDatabaseId: BigInt - - """ - Identifies the head Ref associated with the pull request. - """ - headRef: Ref - - """ - Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted. - """ - headRefName: String! - - """ - Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted. - """ - headRefOid: GitObjectID! - - """ - The repository associated with this pull request's head Ref. - """ - headRepository: Repository - - """ - The owner of the repository associated with this pull request's head Ref. - """ - headRepositoryOwner: RepositoryOwner - - """ - The hovercard information for this issue - """ - hovercard( - """ - Whether or not to include notification contexts - """ - includeNotificationContexts: Boolean = true - ): Hovercard! - - """ - The Node ID of the PullRequest object - """ - id: ID! - - """ - Check if this comment was edited and includes an edit with the creation data - """ - includesCreatedEdit: Boolean! - - """ - The head and base repositories are different. - """ - isCrossRepository: Boolean! - - """ - Identifies if the pull request is a draft. - """ - isDraft: Boolean! - - """ - Indicates whether the pull request is in a merge queue - """ - isInMergeQueue: Boolean! - - """ - Indicates whether the pull request's base ref has a merge queue enabled. - """ - isMergeQueueEnabled: Boolean! - - """ - Is this pull request read by the viewer - """ - isReadByViewer: Boolean - - """ - A list of labels associated with the object. - """ - labels( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for labels returned from the connection. - """ - orderBy: LabelOrder = {field: CREATED_AT, direction: ASC} - ): LabelConnection - - """ - The moment the editor made the last edit - """ - lastEditedAt: DateTime - - """ - A list of latest reviews per user associated with the pull request. - """ - latestOpinionatedReviews( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Only return reviews from user who have write access to the repository - """ - writersOnly: Boolean = false - ): PullRequestReviewConnection - - """ - A list of latest reviews per user associated with the pull request that are not also pending review. - """ - latestReviews( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): PullRequestReviewConnection - - """ - `true` if the pull request is locked - """ - locked: Boolean! - - """ - Indicates whether maintainers can modify the pull request. - """ - maintainerCanModify: Boolean! - - """ - The commit that was created when this pull request was merged. - """ - mergeCommit: Commit - - """ - The merge queue for the pull request's base branch - """ - mergeQueue: MergeQueue - - """ - The merge queue entry of the pull request in the base branch's merge queue - """ - mergeQueueEntry: MergeQueueEntry - - """ - Detailed information about the current pull request merge state status. - """ - mergeStateStatus: MergeStateStatus! - - """ - Whether or not the pull request can be merged based on the existence of merge conflicts. - """ - mergeable: MergeableState! - - """ - Whether or not the pull request was merged. - """ - merged: Boolean! - - """ - The date and time that the pull request was merged. - """ - mergedAt: DateTime - - """ - The actor who merged the pull request. - """ - mergedBy: Actor - - """ - Identifies the milestone associated with the pull request. - """ - milestone: Milestone - - """ - Identifies the pull request number. - """ - number: Int! - - """ - A list of Users that are participating in the Pull Request conversation. - """ - participants( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserConnection! - - """ - The permalink to the pull request. - """ - permalink: URI! - - """ - The commit that GitHub automatically generated to test if this pull request - could be merged. This field will not return a value if the pull request is - merged, or if the test merge commit is still being generated. See the - `mergeable` field for more details on the mergeability of the pull request. - """ - potentialMergeCommit: Commit - - """ - List of project cards associated with this pull request. - """ - projectCards( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - A list of archived states to filter the cards by - """ - archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED] - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ProjectCardConnection! - - """ - Find a project by number. - """ - projectV2( - """ - The project number. - """ - number: Int! - ): ProjectV2 - - """ - A list of projects under the owner. - """ - projectsV2( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - How to order the returned projects. - """ - orderBy: ProjectV2Order = {field: NUMBER, direction: DESC} - - """ - A project to search for under the the owner. - """ - query: String - ): ProjectV2Connection! - - """ - Identifies when the comment was published at. - """ - publishedAt: DateTime - - """ - A list of reactions grouped by content left on the subject. - """ - reactionGroups: [ReactionGroup!] - - """ - A list of Reactions left on the Issue. - """ - reactions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Allows filtering Reactions by emoji. - """ - content: ReactionContent - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Allows specifying the order in which reactions are returned. - """ - orderBy: ReactionOrder - ): ReactionConnection! - - """ - The repository associated with this node. - """ - repository: Repository! - - """ - The HTTP path for this pull request. - """ - resourcePath: URI! - - """ - The HTTP path for reverting this pull request. - """ - revertResourcePath: URI! - - """ - The HTTP URL for reverting this pull request. - """ - revertUrl: URI! - - """ - The current status of this pull request with respect to code review. - """ - reviewDecision: PullRequestReviewDecision - - """ - A list of review requests associated with the pull request. - """ - reviewRequests( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ReviewRequestConnection - - """ - The list of all review threads for this pull request. - """ - reviewThreads( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): PullRequestReviewThreadConnection! - - """ - A list of reviews associated with the pull request. - """ - reviews( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Filter by author of the review. - """ - author: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - A list of states to filter the reviews. - """ - states: [PullRequestReviewState!] - ): PullRequestReviewConnection - - """ - Identifies the state of the pull request. - """ - state: PullRequestState! - - """ - Check and Status rollup information for the PR's head ref. - """ - statusCheckRollup: StatusCheckRollup - - """ - A list of reviewer suggestions based on commit history and past review comments. - """ - suggestedReviewers: [SuggestedReviewer]! - - """ - A list of events, comments, commits, etc. associated with the pull request. - """ - timeline( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Allows filtering timeline events by a `since` timestamp. - """ - since: DateTime - ): PullRequestTimelineConnection! - @deprecated(reason: "`timeline` will be removed Use PullRequest.timelineItems instead. Removal on 2020-10-01 UTC.") - - """ - A list of events, comments, commits, etc. associated with the pull request. - """ - timelineItems( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Filter timeline items by type. - """ - itemTypes: [PullRequestTimelineItemsItemType!] - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filter timeline items by a `since` timestamp. - """ - since: DateTime - - """ - Skips the first _n_ elements in the list. - """ - skip: Int - ): PullRequestTimelineItemsConnection! - - """ - Identifies the pull request title. - """ - title: String! - - """ - Identifies the pull request title rendered to HTML. - """ - titleHTML: HTML! - - """ - Returns a count of how many comments this pull request has received. - """ - totalCommentsCount: Int - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this pull request. - """ - url: URI! - - """ - A list of edits to this content. - """ - userContentEdits( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserContentEditConnection - - """ - Whether or not the viewer can apply suggestion. - """ - viewerCanApplySuggestion: Boolean! - - """ - Indicates if the object can be closed by the viewer. - """ - viewerCanClose: Boolean! - - """ - Check if the viewer can restore the deleted head ref. - """ - viewerCanDeleteHeadRef: Boolean! - - """ - Whether or not the viewer can disable auto-merge - """ - viewerCanDisableAutoMerge: Boolean! - - """ - Can the viewer edit files within this pull request. - """ - viewerCanEditFiles: Boolean! - - """ - Whether or not the viewer can enable auto-merge - """ - viewerCanEnableAutoMerge: Boolean! - - """ - Indicates whether the viewer can bypass branch protections and merge the pull request immediately - """ - viewerCanMergeAsAdmin: Boolean! - - """ - Can user react to this subject - """ - viewerCanReact: Boolean! - - """ - Indicates if the object can be reopened by the viewer. - """ - viewerCanReopen: Boolean! - - """ - Check if the viewer is able to change their subscription status for the repository. - """ - viewerCanSubscribe: Boolean! - - """ - Check if the current viewer can update this object. - """ - viewerCanUpdate: Boolean! - - """ - Whether or not the viewer can update the head ref of this PR, by merging or rebasing the base ref. - If the head ref is up to date or unable to be updated by this user, this will return false. - """ - viewerCanUpdateBranch: Boolean! - - """ - Reasons why the current viewer can not update this comment. - """ - viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - - """ - Did the viewer author this comment. - """ - viewerDidAuthor: Boolean! - - """ - The latest review given from the viewer. - """ - viewerLatestReview: PullRequestReview - - """ - The person who has requested the viewer for review on this pull request. - """ - viewerLatestReviewRequest: ReviewRequest - - """ - The merge body text for the viewer and method. - """ - viewerMergeBodyText( - """ - The merge method for the message. - """ - mergeType: PullRequestMergeMethod - ): String! - - """ - The merge headline text for the viewer and method. - """ - viewerMergeHeadlineText( - """ - The merge method for the message. - """ - mergeType: PullRequestMergeMethod - ): String! - - """ - Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. - """ - viewerSubscription: SubscriptionState -} - -""" -The possible methods for updating a pull request's head branch with the base branch. -""" -enum PullRequestBranchUpdateMethod { - """ - Update branch via merge - """ - MERGE - - """ - Update branch via rebase - """ - REBASE -} - -""" -A file changed in a pull request. -""" -type PullRequestChangedFile { - """ - The number of additions to the file. - """ - additions: Int! - - """ - How the file was changed in this PullRequest - """ - changeType: PatchStatus! - - """ - The number of deletions to the file. - """ - deletions: Int! - - """ - The path of the file. - """ - path: String! - - """ - The state of the file for the viewer. - """ - viewerViewedState: FileViewedState! -} - -""" -The connection type for PullRequestChangedFile. -""" -type PullRequestChangedFileConnection { - """ - A list of edges. - """ - edges: [PullRequestChangedFileEdge] - - """ - A list of nodes. - """ - nodes: [PullRequestChangedFile] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type PullRequestChangedFileEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: PullRequestChangedFile -} - -""" -Represents a Git commit part of a pull request. -""" -type PullRequestCommit implements Node & UniformResourceLocatable { - """ - The Git commit object - """ - commit: Commit! - - """ - The Node ID of the PullRequestCommit object - """ - id: ID! - - """ - The pull request this commit belongs to - """ - pullRequest: PullRequest! - - """ - The HTTP path for this pull request commit - """ - resourcePath: URI! - - """ - The HTTP URL for this pull request commit - """ - url: URI! -} - -""" -Represents a commit comment thread part of a pull request. -""" -type PullRequestCommitCommentThread implements Node & RepositoryNode { - """ - The comments that exist in this thread. - """ - comments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): CommitCommentConnection! - - """ - The commit the comments were made on. - """ - commit: Commit! - - """ - The Node ID of the PullRequestCommitCommentThread object - """ - id: ID! - - """ - The file the comments were made on. - """ - path: String - - """ - The position in the diff for the commit that the comment was made on. - """ - position: Int - - """ - The pull request this commit comment thread belongs to - """ - pullRequest: PullRequest! - - """ - The repository associated with this node. - """ - repository: Repository! -} - -""" -The connection type for PullRequestCommit. -""" -type PullRequestCommitConnection { - """ - A list of edges. - """ - edges: [PullRequestCommitEdge] - - """ - A list of nodes. - """ - nodes: [PullRequestCommit] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type PullRequestCommitEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: PullRequestCommit -} - -""" -The connection type for PullRequest. -""" -type PullRequestConnection { - """ - A list of edges. - """ - edges: [PullRequestEdge] - - """ - A list of nodes. - """ - nodes: [PullRequest] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -This aggregates pull requests opened by a user within one repository. -""" -type PullRequestContributionsByRepository { - """ - The pull request contributions. - """ - contributions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for contributions returned from the connection. - """ - orderBy: ContributionOrder = {direction: DESC} - ): CreatedPullRequestContributionConnection! - - """ - The repository in which the pull requests were opened. - """ - repository: Repository! -} - -""" -An edge in a connection. -""" -type PullRequestEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: PullRequest -} - -""" -Represents available types of methods to use when merging a pull request. -""" -enum PullRequestMergeMethod { - """ - Add all commits from the head branch to the base branch with a merge commit. - """ - MERGE - - """ - Add all commits from the head branch onto the base branch individually. - """ - REBASE - - """ - Combine all commits from the head branch into a single commit in the base branch. - """ - SQUASH -} - -""" -Ways in which lists of issues can be ordered upon return. -""" -input PullRequestOrder { - """ - The direction in which to order pull requests by the specified field. - """ - direction: OrderDirection! - - """ - The field in which to order pull requests by. - """ - field: PullRequestOrderField! -} - -""" -Properties by which pull_requests connections can be ordered. -""" -enum PullRequestOrderField { - """ - Order pull_requests by creation time - """ - CREATED_AT - - """ - Order pull_requests by update time - """ - UPDATED_AT -} - -""" -Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. -""" -type PullRequestParameters { - """ - New, reviewable commits pushed will dismiss previous pull request review approvals. - """ - dismissStaleReviewsOnPush: Boolean! - - """ - Require an approving review in pull requests that modify files that have a designated code owner. - """ - requireCodeOwnerReview: Boolean! - - """ - Whether the most recent reviewable push must be approved by someone other than the person who pushed it. - """ - requireLastPushApproval: Boolean! - - """ - The number of approving reviews that are required before a pull request can be merged. - """ - requiredApprovingReviewCount: Int! - - """ - All conversations on code must be resolved before a pull request can be merged. - """ - requiredReviewThreadResolution: Boolean! -} - -""" -Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. -""" -input PullRequestParametersInput { - """ - New, reviewable commits pushed will dismiss previous pull request review approvals. - """ - dismissStaleReviewsOnPush: Boolean! - - """ - Require an approving review in pull requests that modify files that have a designated code owner. - """ - requireCodeOwnerReview: Boolean! - - """ - Whether the most recent reviewable push must be approved by someone other than the person who pushed it. - """ - requireLastPushApproval: Boolean! - - """ - The number of approving reviews that are required before a pull request can be merged. - """ - requiredApprovingReviewCount: Int! - - """ - All conversations on code must be resolved before a pull request can be merged. - """ - requiredReviewThreadResolution: Boolean! -} - -""" -A review object for a given pull request. -""" -type PullRequestReview implements Comment & Deletable & Minimizable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment { - """ - The actor who authored the comment. - """ - author: Actor - - """ - Author's association with the subject of the comment. - """ - authorAssociation: CommentAuthorAssociation! - - """ - Indicates whether the author of this review has push access to the repository. - """ - authorCanPushToRepository: Boolean! - - """ - Identifies the pull request review body. - """ - body: String! - - """ - The body rendered to HTML. - """ - bodyHTML: HTML! - - """ - The body of this review rendered as plain text. - """ - bodyText: String! - - """ - A list of review comments for the current pull request review. - """ - comments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): PullRequestReviewCommentConnection! - - """ - Identifies the commit associated with this pull request review. - """ - commit: Commit - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Check if this comment was created via an email reply. - """ - createdViaEmail: Boolean! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - @deprecated( - reason: "`databaseId` will be removed because it does not support 64-bit signed integer identifiers. Use `fullDatabaseId` instead. Removal on 2024-07-01 UTC." - ) - - """ - The actor who edited the comment. - """ - editor: Actor - - """ - Identifies the primary key from the database as a BigInt. - """ - fullDatabaseId: BigInt - - """ - The Node ID of the PullRequestReview object - """ - id: ID! - - """ - Check if this comment was edited and includes an edit with the creation data - """ - includesCreatedEdit: Boolean! - - """ - Returns whether or not a comment has been minimized. - """ - isMinimized: Boolean! - - """ - The moment the editor made the last edit - """ - lastEditedAt: DateTime - - """ - Returns why the comment was minimized. One of `abuse`, `off-topic`, - `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and - formatting of these values differs from the inputs to the `MinimizeComment` mutation. - """ - minimizedReason: String - - """ - A list of teams that this review was made on behalf of. - """ - onBehalfOf( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): TeamConnection! - - """ - Identifies when the comment was published at. - """ - publishedAt: DateTime - - """ - Identifies the pull request associated with this pull request review. - """ - pullRequest: PullRequest! - - """ - A list of reactions grouped by content left on the subject. - """ - reactionGroups: [ReactionGroup!] - - """ - A list of Reactions left on the Issue. - """ - reactions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Allows filtering Reactions by emoji. - """ - content: ReactionContent - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Allows specifying the order in which reactions are returned. - """ - orderBy: ReactionOrder - ): ReactionConnection! - - """ - The repository associated with this node. - """ - repository: Repository! - - """ - The HTTP path permalink for this PullRequestReview. - """ - resourcePath: URI! - - """ - Identifies the current state of the pull request review. - """ - state: PullRequestReviewState! - - """ - Identifies when the Pull Request Review was submitted - """ - submittedAt: DateTime - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL permalink for this PullRequestReview. - """ - url: URI! - - """ - A list of edits to this content. - """ - userContentEdits( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserContentEditConnection - - """ - Check if the current viewer can delete this object. - """ - viewerCanDelete: Boolean! - - """ - Check if the current viewer can minimize this object. - """ - viewerCanMinimize: Boolean! - - """ - Can user react to this subject - """ - viewerCanReact: Boolean! - - """ - Check if the current viewer can update this object. - """ - viewerCanUpdate: Boolean! - - """ - Reasons why the current viewer can not update this comment. - """ - viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - - """ - Did the viewer author this comment. - """ - viewerDidAuthor: Boolean! -} - -""" -A review comment associated with a given repository pull request. -""" -type PullRequestReviewComment implements Comment & Deletable & Minimizable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment { - """ - The actor who authored the comment. - """ - author: Actor - - """ - Author's association with the subject of the comment. - """ - authorAssociation: CommentAuthorAssociation! - - """ - The comment body of this review comment. - """ - body: String! - - """ - The body rendered to HTML. - """ - bodyHTML: HTML! - - """ - The comment body of this review comment rendered as plain text. - """ - bodyText: String! - - """ - Identifies the commit associated with the comment. - """ - commit: Commit - - """ - Identifies when the comment was created. - """ - createdAt: DateTime! - - """ - Check if this comment was created via an email reply. - """ - createdViaEmail: Boolean! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - @deprecated( - reason: "`databaseId` will be removed because it does not support 64-bit signed integer identifiers. Use `fullDatabaseId` instead. Removal on 2024-07-01 UTC." - ) - - """ - The diff hunk to which the comment applies. - """ - diffHunk: String! - - """ - Identifies when the comment was created in a draft state. - """ - draftedAt: DateTime! - - """ - The actor who edited the comment. - """ - editor: Actor - - """ - Identifies the primary key from the database as a BigInt. - """ - fullDatabaseId: BigInt - - """ - The Node ID of the PullRequestReviewComment object - """ - id: ID! - - """ - Check if this comment was edited and includes an edit with the creation data - """ - includesCreatedEdit: Boolean! - - """ - Returns whether or not a comment has been minimized. - """ - isMinimized: Boolean! - - """ - The moment the editor made the last edit - """ - lastEditedAt: DateTime - - """ - The end line number on the file to which the comment applies - """ - line: Int - - """ - Returns why the comment was minimized. One of `abuse`, `off-topic`, - `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and - formatting of these values differs from the inputs to the `MinimizeComment` mutation. - """ - minimizedReason: String - - """ - Identifies the original commit associated with the comment. - """ - originalCommit: Commit - - """ - The end line number on the file to which the comment applied when it was first created - """ - originalLine: Int - - """ - The original line index in the diff to which the comment applies. - """ - originalPosition: Int! - @deprecated(reason: "We are phasing out diff-relative positioning for PR comments Removal on 2023-10-01 UTC.") - - """ - The start line number on the file to which the comment applied when it was first created - """ - originalStartLine: Int - - """ - Identifies when the comment body is outdated - """ - outdated: Boolean! - - """ - The path to which the comment applies. - """ - path: String! - - """ - The line index in the diff to which the comment applies. - """ - position: Int - @deprecated( - reason: "We are phasing out diff-relative positioning for PR comments Use the `line` and `startLine` fields instead, which are file line numbers instead of diff line numbers Removal on 2023-10-01 UTC." - ) - - """ - Identifies when the comment was published at. - """ - publishedAt: DateTime - - """ - The pull request associated with this review comment. - """ - pullRequest: PullRequest! - - """ - The pull request review associated with this review comment. - """ - pullRequestReview: PullRequestReview - - """ - A list of reactions grouped by content left on the subject. - """ - reactionGroups: [ReactionGroup!] - - """ - A list of Reactions left on the Issue. - """ - reactions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Allows filtering Reactions by emoji. - """ - content: ReactionContent - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Allows specifying the order in which reactions are returned. - """ - orderBy: ReactionOrder - ): ReactionConnection! - - """ - The comment this is a reply to. - """ - replyTo: PullRequestReviewComment - - """ - The repository associated with this node. - """ - repository: Repository! - - """ - The HTTP path permalink for this review comment. - """ - resourcePath: URI! - - """ - The start line number on the file to which the comment applies - """ - startLine: Int - - """ - Identifies the state of the comment. - """ - state: PullRequestReviewCommentState! - - """ - The level at which the comments in the corresponding thread are targeted, can be a diff line or a file - """ - subjectType: PullRequestReviewThreadSubjectType! - - """ - Identifies when the comment was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL permalink for this review comment. - """ - url: URI! - - """ - A list of edits to this content. - """ - userContentEdits( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserContentEditConnection - - """ - Check if the current viewer can delete this object. - """ - viewerCanDelete: Boolean! - - """ - Check if the current viewer can minimize this object. - """ - viewerCanMinimize: Boolean! - - """ - Can user react to this subject - """ - viewerCanReact: Boolean! - - """ - Check if the current viewer can update this object. - """ - viewerCanUpdate: Boolean! - - """ - Reasons why the current viewer can not update this comment. - """ - viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - - """ - Did the viewer author this comment. - """ - viewerDidAuthor: Boolean! -} - -""" -The connection type for PullRequestReviewComment. -""" -type PullRequestReviewCommentConnection { - """ - A list of edges. - """ - edges: [PullRequestReviewCommentEdge] - - """ - A list of nodes. - """ - nodes: [PullRequestReviewComment] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type PullRequestReviewCommentEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: PullRequestReviewComment -} - -""" -The possible states of a pull request review comment. -""" -enum PullRequestReviewCommentState { - """ - A comment that is part of a pending review - """ - PENDING - - """ - A comment that is part of a submitted review - """ - SUBMITTED -} - -""" -The connection type for PullRequestReview. -""" -type PullRequestReviewConnection { - """ - A list of edges. - """ - edges: [PullRequestReviewEdge] - - """ - A list of nodes. - """ - nodes: [PullRequestReview] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -This aggregates pull request reviews made by a user within one repository. -""" -type PullRequestReviewContributionsByRepository { - """ - The pull request review contributions. - """ - contributions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for contributions returned from the connection. - """ - orderBy: ContributionOrder = {direction: DESC} - ): CreatedPullRequestReviewContributionConnection! - - """ - The repository in which the pull request reviews were made. - """ - repository: Repository! -} - -""" -The review status of a pull request. -""" -enum PullRequestReviewDecision { - """ - The pull request has received an approving review. - """ - APPROVED - - """ - Changes have been requested on the pull request. - """ - CHANGES_REQUESTED - - """ - A review is required before the pull request can be merged. - """ - REVIEW_REQUIRED -} - -""" -An edge in a connection. -""" -type PullRequestReviewEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: PullRequestReview -} - -""" -The possible events to perform on a pull request review. -""" -enum PullRequestReviewEvent { - """ - Submit feedback and approve merging these changes. - """ - APPROVE - - """ - Submit general feedback without explicit approval. - """ - COMMENT - - """ - Dismiss review so it now longer effects merging. - """ - DISMISS - - """ - Submit feedback that must be addressed before merging. - """ - REQUEST_CHANGES -} - -""" -The possible states of a pull request review. -""" -enum PullRequestReviewState { - """ - A review allowing the pull request to merge. - """ - APPROVED - - """ - A review blocking the pull request from merging. - """ - CHANGES_REQUESTED - - """ - An informational review. - """ - COMMENTED - - """ - A review that has been dismissed. - """ - DISMISSED - - """ - A review that has not yet been submitted. - """ - PENDING -} - -""" -A threaded list of comments for a given pull request. -""" -type PullRequestReviewThread implements Node { - """ - A list of pull request comments associated with the thread. - """ - comments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Skips the first _n_ elements in the list. - """ - skip: Int - ): PullRequestReviewCommentConnection! - - """ - The side of the diff on which this thread was placed. - """ - diffSide: DiffSide! - - """ - The Node ID of the PullRequestReviewThread object - """ - id: ID! - - """ - Whether or not the thread has been collapsed (resolved) - """ - isCollapsed: Boolean! - - """ - Indicates whether this thread was outdated by newer changes. - """ - isOutdated: Boolean! - - """ - Whether this thread has been resolved - """ - isResolved: Boolean! - - """ - The line in the file to which this thread refers - """ - line: Int - - """ - The original line in the file to which this thread refers. - """ - originalLine: Int - - """ - The original start line in the file to which this thread refers (multi-line only). - """ - originalStartLine: Int - - """ - Identifies the file path of this thread. - """ - path: String! - - """ - Identifies the pull request associated with this thread. - """ - pullRequest: PullRequest! - - """ - Identifies the repository associated with this thread. - """ - repository: Repository! - - """ - The user who resolved this thread - """ - resolvedBy: User - - """ - The side of the diff that the first line of the thread starts on (multi-line only) - """ - startDiffSide: DiffSide - - """ - The start line in the file to which this thread refers (multi-line only) - """ - startLine: Int - - """ - The level at which the comments in the corresponding thread are targeted, can be a diff line or a file - """ - subjectType: PullRequestReviewThreadSubjectType! - - """ - Indicates whether the current viewer can reply to this thread. - """ - viewerCanReply: Boolean! - - """ - Whether or not the viewer can resolve this thread - """ - viewerCanResolve: Boolean! - - """ - Whether or not the viewer can unresolve this thread - """ - viewerCanUnresolve: Boolean! -} - -""" -Review comment threads for a pull request review. -""" -type PullRequestReviewThreadConnection { - """ - A list of edges. - """ - edges: [PullRequestReviewThreadEdge] - - """ - A list of nodes. - """ - nodes: [PullRequestReviewThread] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type PullRequestReviewThreadEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: PullRequestReviewThread -} - -""" -The possible subject types of a pull request review comment. -""" -enum PullRequestReviewThreadSubjectType { - """ - A comment that has been made against the file of a pull request - """ - FILE - - """ - A comment that has been made against the line of a pull request - """ - LINE -} - -""" -Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits. -""" -type PullRequestRevisionMarker { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The last commit the viewer has seen. - """ - lastSeenCommit: Commit! - - """ - The pull request to which the marker belongs. - """ - pullRequest: PullRequest! -} - -""" -The possible states of a pull request. -""" -enum PullRequestState { - """ - A pull request that has been closed without being merged. - """ - CLOSED - - """ - A pull request that has been closed by being merged. - """ - MERGED - - """ - A pull request that is still open. - """ - OPEN -} - -""" -A repository pull request template. -""" -type PullRequestTemplate { - """ - The body of the template - """ - body: String - - """ - The filename of the template - """ - filename: String - - """ - The repository the template belongs to - """ - repository: Repository! -} - -""" -A threaded list of comments for a given pull request. -""" -type PullRequestThread implements Node { - """ - A list of pull request comments associated with the thread. - """ - comments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Skips the first _n_ elements in the list. - """ - skip: Int - ): PullRequestReviewCommentConnection! - - """ - The side of the diff on which this thread was placed. - """ - diffSide: DiffSide! - - """ - The Node ID of the PullRequestThread object - """ - id: ID! - - """ - Whether or not the thread has been collapsed (resolved) - """ - isCollapsed: Boolean! - - """ - Indicates whether this thread was outdated by newer changes. - """ - isOutdated: Boolean! - - """ - Whether this thread has been resolved - """ - isResolved: Boolean! - - """ - The line in the file to which this thread refers - """ - line: Int - - """ - Identifies the file path of this thread. - """ - path: String! - - """ - Identifies the pull request associated with this thread. - """ - pullRequest: PullRequest! - - """ - Identifies the repository associated with this thread. - """ - repository: Repository! - - """ - The user who resolved this thread - """ - resolvedBy: User - - """ - The side of the diff that the first line of the thread starts on (multi-line only) - """ - startDiffSide: DiffSide - - """ - The line of the first file diff in the thread. - """ - startLine: Int - - """ - The level at which the comments in the corresponding thread are targeted, can be a diff line or a file - """ - subjectType: PullRequestReviewThreadSubjectType! - - """ - Indicates whether the current viewer can reply to this thread. - """ - viewerCanReply: Boolean! - - """ - Whether or not the viewer can resolve this thread - """ - viewerCanResolve: Boolean! - - """ - Whether or not the viewer can unresolve this thread - """ - viewerCanUnresolve: Boolean! -} - -""" -The connection type for PullRequestTimelineItem. -""" -type PullRequestTimelineConnection { - """ - A list of edges. - """ - edges: [PullRequestTimelineItemEdge] - - """ - A list of nodes. - """ - nodes: [PullRequestTimelineItem] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An item in a pull request timeline -""" -union PullRequestTimelineItem = - AssignedEvent - | BaseRefDeletedEvent - | BaseRefForcePushedEvent - | ClosedEvent - | Commit - | CommitCommentThread - | CrossReferencedEvent - | DemilestonedEvent - | DeployedEvent - | DeploymentEnvironmentChangedEvent - | HeadRefDeletedEvent - | HeadRefForcePushedEvent - | HeadRefRestoredEvent - | IssueComment - | LabeledEvent - | LockedEvent - | MergedEvent - | MilestonedEvent - | PullRequestReview - | PullRequestReviewComment - | PullRequestReviewThread - | ReferencedEvent - | RenamedTitleEvent - | ReopenedEvent - | ReviewDismissedEvent - | ReviewRequestRemovedEvent - | ReviewRequestedEvent - | SubscribedEvent - | UnassignedEvent - | UnlabeledEvent - | UnlockedEvent - | UnsubscribedEvent - | UserBlockedEvent - -""" -An edge in a connection. -""" -type PullRequestTimelineItemEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: PullRequestTimelineItem -} - -""" -An item in a pull request timeline -""" -union PullRequestTimelineItems = - AddedToMergeQueueEvent - | AddedToProjectEvent - | AssignedEvent - | AutoMergeDisabledEvent - | AutoMergeEnabledEvent - | AutoRebaseEnabledEvent - | AutoSquashEnabledEvent - | AutomaticBaseChangeFailedEvent - | AutomaticBaseChangeSucceededEvent - | BaseRefChangedEvent - | BaseRefDeletedEvent - | BaseRefForcePushedEvent - | ClosedEvent - | CommentDeletedEvent - | ConnectedEvent - | ConvertToDraftEvent - | ConvertedNoteToIssueEvent - | ConvertedToDiscussionEvent - | CrossReferencedEvent - | DemilestonedEvent - | DeployedEvent - | DeploymentEnvironmentChangedEvent - | DisconnectedEvent - | HeadRefDeletedEvent - | HeadRefForcePushedEvent - | HeadRefRestoredEvent - | IssueComment - | LabeledEvent - | LockedEvent - | MarkedAsDuplicateEvent - | MentionedEvent - | MergedEvent - | MilestonedEvent - | MovedColumnsInProjectEvent - | PinnedEvent - | PullRequestCommit - | PullRequestCommitCommentThread - | PullRequestReview - | PullRequestReviewThread - | PullRequestRevisionMarker - | ReadyForReviewEvent - | ReferencedEvent - | RemovedFromMergeQueueEvent - | RemovedFromProjectEvent - | RenamedTitleEvent - | ReopenedEvent - | ReviewDismissedEvent - | ReviewRequestRemovedEvent - | ReviewRequestedEvent - | SubscribedEvent - | TransferredEvent - | UnassignedEvent - | UnlabeledEvent - | UnlockedEvent - | UnmarkedAsDuplicateEvent - | UnpinnedEvent - | UnsubscribedEvent - | UserBlockedEvent - -""" -The connection type for PullRequestTimelineItems. -""" -type PullRequestTimelineItemsConnection { - """ - A list of edges. - """ - edges: [PullRequestTimelineItemsEdge] - - """ - Identifies the count of items after applying `before` and `after` filters. - """ - filteredCount: Int! - - """ - A list of nodes. - """ - nodes: [PullRequestTimelineItems] - - """ - Identifies the count of items after applying `before`/`after` filters and `first`/`last`/`skip` slicing. - """ - pageCount: Int! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! - - """ - Identifies the date and time when the timeline was last updated. - """ - updatedAt: DateTime! -} - -""" -An edge in a connection. -""" -type PullRequestTimelineItemsEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: PullRequestTimelineItems -} - -""" -The possible item types found in a timeline. -""" -enum PullRequestTimelineItemsItemType { - """ - Represents an 'added_to_merge_queue' event on a given pull request. - """ - ADDED_TO_MERGE_QUEUE_EVENT - - """ - Represents a 'added_to_project' event on a given issue or pull request. - """ - ADDED_TO_PROJECT_EVENT - - """ - Represents an 'assigned' event on any assignable object. - """ - ASSIGNED_EVENT - - """ - Represents a 'automatic_base_change_failed' event on a given pull request. - """ - AUTOMATIC_BASE_CHANGE_FAILED_EVENT - - """ - Represents a 'automatic_base_change_succeeded' event on a given pull request. - """ - AUTOMATIC_BASE_CHANGE_SUCCEEDED_EVENT - - """ - Represents a 'auto_merge_disabled' event on a given pull request. - """ - AUTO_MERGE_DISABLED_EVENT - - """ - Represents a 'auto_merge_enabled' event on a given pull request. - """ - AUTO_MERGE_ENABLED_EVENT - - """ - Represents a 'auto_rebase_enabled' event on a given pull request. - """ - AUTO_REBASE_ENABLED_EVENT - - """ - Represents a 'auto_squash_enabled' event on a given pull request. - """ - AUTO_SQUASH_ENABLED_EVENT - - """ - Represents a 'base_ref_changed' event on a given issue or pull request. - """ - BASE_REF_CHANGED_EVENT - - """ - Represents a 'base_ref_deleted' event on a given pull request. - """ - BASE_REF_DELETED_EVENT - - """ - Represents a 'base_ref_force_pushed' event on a given pull request. - """ - BASE_REF_FORCE_PUSHED_EVENT - - """ - Represents a 'closed' event on any `Closable`. - """ - CLOSED_EVENT - - """ - Represents a 'comment_deleted' event on a given issue or pull request. - """ - COMMENT_DELETED_EVENT - - """ - Represents a 'connected' event on a given issue or pull request. - """ - CONNECTED_EVENT - - """ - Represents a 'converted_note_to_issue' event on a given issue or pull request. - """ - CONVERTED_NOTE_TO_ISSUE_EVENT - - """ - Represents a 'converted_to_discussion' event on a given issue. - """ - CONVERTED_TO_DISCUSSION_EVENT - - """ - Represents a 'convert_to_draft' event on a given pull request. - """ - CONVERT_TO_DRAFT_EVENT - - """ - Represents a mention made by one issue or pull request to another. - """ - CROSS_REFERENCED_EVENT - - """ - Represents a 'demilestoned' event on a given issue or pull request. - """ - DEMILESTONED_EVENT - - """ - Represents a 'deployed' event on a given pull request. - """ - DEPLOYED_EVENT - - """ - Represents a 'deployment_environment_changed' event on a given pull request. - """ - DEPLOYMENT_ENVIRONMENT_CHANGED_EVENT - - """ - Represents a 'disconnected' event on a given issue or pull request. - """ - DISCONNECTED_EVENT - - """ - Represents a 'head_ref_deleted' event on a given pull request. - """ - HEAD_REF_DELETED_EVENT - - """ - Represents a 'head_ref_force_pushed' event on a given pull request. - """ - HEAD_REF_FORCE_PUSHED_EVENT - - """ - Represents a 'head_ref_restored' event on a given pull request. - """ - HEAD_REF_RESTORED_EVENT - - """ - Represents a comment on an Issue. - """ - ISSUE_COMMENT - - """ - Represents a 'labeled' event on a given issue or pull request. - """ - LABELED_EVENT - - """ - Represents a 'locked' event on a given issue or pull request. - """ - LOCKED_EVENT - - """ - Represents a 'marked_as_duplicate' event on a given issue or pull request. - """ - MARKED_AS_DUPLICATE_EVENT - - """ - Represents a 'mentioned' event on a given issue or pull request. - """ - MENTIONED_EVENT - - """ - Represents a 'merged' event on a given pull request. - """ - MERGED_EVENT - - """ - Represents a 'milestoned' event on a given issue or pull request. - """ - MILESTONED_EVENT - - """ - Represents a 'moved_columns_in_project' event on a given issue or pull request. - """ - MOVED_COLUMNS_IN_PROJECT_EVENT - - """ - Represents a 'pinned' event on a given issue or pull request. - """ - PINNED_EVENT - - """ - Represents a Git commit part of a pull request. - """ - PULL_REQUEST_COMMIT - - """ - Represents a commit comment thread part of a pull request. - """ - PULL_REQUEST_COMMIT_COMMENT_THREAD - - """ - A review object for a given pull request. - """ - PULL_REQUEST_REVIEW - - """ - A threaded list of comments for a given pull request. - """ - PULL_REQUEST_REVIEW_THREAD - - """ - Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits. - """ - PULL_REQUEST_REVISION_MARKER - - """ - Represents a 'ready_for_review' event on a given pull request. - """ - READY_FOR_REVIEW_EVENT - - """ - Represents a 'referenced' event on a given `ReferencedSubject`. - """ - REFERENCED_EVENT - - """ - Represents a 'removed_from_merge_queue' event on a given pull request. - """ - REMOVED_FROM_MERGE_QUEUE_EVENT - - """ - Represents a 'removed_from_project' event on a given issue or pull request. - """ - REMOVED_FROM_PROJECT_EVENT - - """ - Represents a 'renamed' event on a given issue or pull request - """ - RENAMED_TITLE_EVENT - - """ - Represents a 'reopened' event on any `Closable`. - """ - REOPENED_EVENT - - """ - Represents a 'review_dismissed' event on a given issue or pull request. - """ - REVIEW_DISMISSED_EVENT - - """ - Represents an 'review_requested' event on a given pull request. - """ - REVIEW_REQUESTED_EVENT - - """ - Represents an 'review_request_removed' event on a given pull request. - """ - REVIEW_REQUEST_REMOVED_EVENT - - """ - Represents a 'subscribed' event on a given `Subscribable`. - """ - SUBSCRIBED_EVENT - - """ - Represents a 'transferred' event on a given issue or pull request. - """ - TRANSFERRED_EVENT - - """ - Represents an 'unassigned' event on any assignable object. - """ - UNASSIGNED_EVENT - - """ - Represents an 'unlabeled' event on a given issue or pull request. - """ - UNLABELED_EVENT - - """ - Represents an 'unlocked' event on a given issue or pull request. - """ - UNLOCKED_EVENT - - """ - Represents an 'unmarked_as_duplicate' event on a given issue or pull request. - """ - UNMARKED_AS_DUPLICATE_EVENT - - """ - Represents an 'unpinned' event on a given issue or pull request. - """ - UNPINNED_EVENT - - """ - Represents an 'unsubscribed' event on a given `Subscribable`. - """ - UNSUBSCRIBED_EVENT - - """ - Represents a 'user_blocked' event on a given user. - """ - USER_BLOCKED_EVENT -} - -""" -The possible target states when updating a pull request. -""" -enum PullRequestUpdateState { - """ - A pull request that has been closed without being merged. - """ - CLOSED - - """ - A pull request that is still open. - """ - OPEN -} - -""" -A Git push. -""" -type Push implements Node { - """ - The Node ID of the Push object - """ - id: ID! - - """ - The SHA after the push - """ - nextSha: GitObjectID - - """ - The permalink for this push. - """ - permalink: URI! - - """ - The SHA before the push - """ - previousSha: GitObjectID - - """ - The actor who pushed - """ - pusher: Actor! - - """ - The repository that was pushed to - """ - repository: Repository! -} - -""" -A team, user, or app who has the ability to push to a protected branch. -""" -type PushAllowance implements Node { - """ - The actor that can push. - """ - actor: PushAllowanceActor - - """ - Identifies the branch protection rule associated with the allowed user, team, or app. - """ - branchProtectionRule: BranchProtectionRule - - """ - The Node ID of the PushAllowance object - """ - id: ID! -} - -""" -Types that can be an actor. -""" -union PushAllowanceActor = App | Team | User - -""" -The connection type for PushAllowance. -""" -type PushAllowanceConnection { - """ - A list of edges. - """ - edges: [PushAllowanceEdge] - - """ - A list of nodes. - """ - nodes: [PushAllowance] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type PushAllowanceEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: PushAllowance -} - -""" -The query root of GitHub's GraphQL interface. -""" -type Query { - """ - Look up a code of conduct by its key - """ - codeOfConduct( - """ - The code of conduct's key - """ - key: String! - ): CodeOfConduct - - """ - Look up a code of conduct by its key - """ - codesOfConduct: [CodeOfConduct] - - """ - Look up an enterprise by URL slug. - """ - enterprise( - """ - The enterprise invitation token. - """ - invitationToken: String - - """ - The enterprise URL slug. - """ - slug: String! - ): Enterprise - - """ - Look up an open source license by its key - """ - license( - """ - The license's downcased SPDX ID - """ - key: String! - ): License - - """ - Return a list of known open source licenses - """ - licenses: [License]! - - """ - Return information about the GitHub instance - """ - meta: GitHubMetadata! - - """ - Fetches an object given its ID. - """ - node( - """ - ID of the object. - """ - id: ID! - ): Node - - """ - Lookup nodes by a list of IDs. - """ - nodes( - """ - The list of node IDs. - """ - ids: [ID!]! - ): [Node]! - - """ - Lookup a organization by login. - """ - organization( - """ - The organization's login. - """ - login: String! - ): Organization - - """ - A list of organizations. - """ - organizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for the User's organizations. - """ - orderBy: OrganizationOrder = null - ): OrganizationConnection! - - """ - The client's rate limit information. - """ - rateLimit( - """ - If true, calculate the cost for the query without evaluating it - """ - dryRun: Boolean = false - ): RateLimit - - """ - Workaround for re-exposing the root query object. (Refer to - https://github.com/facebook/relay/issues/112 for more information.) - """ - relay: Query! - - """ - Lookup a given repository by the owner and repository name. - """ - repository( - """ - Follow repository renames. If disabled, a repository referenced by its old name will return an error. - """ - followRenames: Boolean = true - - """ - The name of the repository - """ - name: String! - - """ - The login field of a user or organization - """ - owner: String! - ): Repository - - """ - Lookup a repository owner (ie. either a User or an Organization) by login. - """ - repositoryOwner( - """ - The username to lookup the owner by. - """ - login: String! - ): RepositoryOwner - - """ - Lookup resource by a URL. - """ - resource( - """ - The URL. - """ - url: URI! - ): UniformResourceLocatable - - """ - Perform a search across resources, returning a maximum of 1,000 results. - """ - search( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - The search string to look for. GitHub search syntax is supported. For more - information, see "[Searching on - GitHub](https://docs.github.com/search-github/searching-on-github)," - "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)," - and "[Sorting search results](https://docs.github.com/search-github/getting-started-with-searching-on-github/sorting-search-results)." - """ - query: String! - - """ - The types of search items to search within. - """ - type: SearchType! - ): SearchResultItemConnection! - - """ - GitHub Security Advisories - """ - securityAdvisories( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - A list of classifications to filter advisories by. - """ - classifications: [SecurityAdvisoryClassification!] - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filter advisories to those published since a time in the past. - """ - publishedSince: DateTime - - """ - Filter advisories to those updated since a time in the past. - """ - updatedSince: DateTime - ): SecurityAdvisoryConnection! - - """ - Fetch a Security Advisory by its GHSA ID - """ - securityAdvisory( - """ - GitHub Security Advisory ID. - """ - ghsaId: String! - ): SecurityAdvisory - - """ - Software Vulnerabilities documented by GitHub Security Advisories - """ - securityVulnerabilities( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - A list of advisory classifications to filter vulnerabilities by. - """ - classifications: [SecurityAdvisoryClassification!] - - """ - An ecosystem to filter vulnerabilities by. - """ - ecosystem: SecurityAdvisoryEcosystem - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - A package name to filter vulnerabilities by. - """ - package: String - - """ - A list of severities to filter vulnerabilities by. - """ - severities: [SecurityAdvisorySeverity!] - ): SecurityVulnerabilityConnection! - - """ - Look up a topic by name. - """ - topic( - """ - The topic's name. - """ - name: String! - ): Topic - - """ - Lookup a user by login. - """ - user( - """ - The user's login. - """ - login: String! - ): User - - """ - A list of users. - """ - users( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserConnection! - - """ - The currently authenticated user. - """ - viewer: User! -} - -""" -Represents the client's rate limit. -""" -type RateLimit { - """ - The point cost for the current query counting against the rate limit. - """ - cost: Int! - - """ - The maximum number of points the client is permitted to consume in a 60 minute window. - """ - limit: Int! - - """ - The maximum number of nodes this query may return - """ - nodeCount: Int! - - """ - The number of points remaining in the current rate limit window. - """ - remaining: Int! - - """ - The time at which the current rate limit window resets in UTC epoch seconds. - """ - resetAt: DateTime! - - """ - The number of points used in the current rate limit window. - """ - used: Int! -} - -""" -Represents a subject that can be reacted on. -""" -interface Reactable { - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the Reactable object - """ - id: ID! - - """ - A list of reactions grouped by content left on the subject. - """ - reactionGroups: [ReactionGroup!] - - """ - A list of Reactions left on the Issue. - """ - reactions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Allows filtering Reactions by emoji. - """ - content: ReactionContent - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Allows specifying the order in which reactions are returned. - """ - orderBy: ReactionOrder - ): ReactionConnection! - - """ - Can user react to this subject - """ - viewerCanReact: Boolean! -} - -""" -The connection type for User. -""" -type ReactingUserConnection { - """ - A list of edges. - """ - edges: [ReactingUserEdge] - - """ - A list of nodes. - """ - nodes: [User] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -Represents a user that's made a reaction. -""" -type ReactingUserEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - node: User! - - """ - The moment when the user made the reaction. - """ - reactedAt: DateTime! -} - -""" -An emoji reaction to a particular piece of content. -""" -type Reaction implements Node { - """ - Identifies the emoji reaction. - """ - content: ReactionContent! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the Reaction object - """ - id: ID! - - """ - The reactable piece of content - """ - reactable: Reactable! - - """ - Identifies the user who created this reaction. - """ - user: User -} - -""" -A list of reactions that have been left on the subject. -""" -type ReactionConnection { - """ - A list of edges. - """ - edges: [ReactionEdge] - - """ - A list of nodes. - """ - nodes: [Reaction] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! - - """ - Whether or not the authenticated user has left a reaction on the subject. - """ - viewerHasReacted: Boolean! -} - -""" -Emojis that can be attached to Issues, Pull Requests and Comments. -""" -enum ReactionContent { - """ - Represents the `:confused:` emoji. - """ - CONFUSED - - """ - Represents the `:eyes:` emoji. - """ - EYES - - """ - Represents the `:heart:` emoji. - """ - HEART - - """ - Represents the `:hooray:` emoji. - """ - HOORAY - - """ - Represents the `:laugh:` emoji. - """ - LAUGH - - """ - Represents the `:rocket:` emoji. - """ - ROCKET - - """ - Represents the `:-1:` emoji. - """ - THUMBS_DOWN - - """ - Represents the `:+1:` emoji. - """ - THUMBS_UP -} - -""" -An edge in a connection. -""" -type ReactionEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Reaction -} - -""" -A group of emoji reactions to a particular piece of content. -""" -type ReactionGroup { - """ - Identifies the emoji reaction. - """ - content: ReactionContent! - - """ - Identifies when the reaction was created. - """ - createdAt: DateTime - - """ - Reactors to the reaction subject with the emotion represented by this reaction group. - """ - reactors( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ReactorConnection! - - """ - The subject that was reacted to. - """ - subject: Reactable! - - """ - Users who have reacted to the reaction subject with the emotion represented by this reaction group - """ - users( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ReactingUserConnection! - @deprecated( - reason: "Reactors can now be mannequins, bots, and organizations. Use the `reactors` field instead. Removal on 2021-10-01 UTC." - ) - - """ - Whether or not the authenticated user has left a reaction on the subject. - """ - viewerHasReacted: Boolean! -} - -""" -Ways in which lists of reactions can be ordered upon return. -""" -input ReactionOrder { - """ - The direction in which to order reactions by the specified field. - """ - direction: OrderDirection! - - """ - The field in which to order reactions by. - """ - field: ReactionOrderField! -} - -""" -A list of fields that reactions can be ordered by. -""" -enum ReactionOrderField { - """ - Allows ordering a list of reactions by when they were created. - """ - CREATED_AT -} - -""" -Types that can be assigned to reactions. -""" -union Reactor = Bot | Mannequin | Organization | User - -""" -The connection type for Reactor. -""" -type ReactorConnection { - """ - A list of edges. - """ - edges: [ReactorEdge] - - """ - A list of nodes. - """ - nodes: [Reactor] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -Represents an author of a reaction. -""" -type ReactorEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The author of the reaction. - """ - node: Reactor! - - """ - The moment when the user made the reaction. - """ - reactedAt: DateTime! -} - -""" -Represents a 'ready_for_review' event on a given pull request. -""" -type ReadyForReviewEvent implements Node & UniformResourceLocatable { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the ReadyForReviewEvent object - """ - id: ID! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest! - - """ - The HTTP path for this ready for review event. - """ - resourcePath: URI! - - """ - The HTTP URL for this ready for review event. - """ - url: URI! -} - -""" -Represents a Git reference. -""" -type Ref implements Node { - """ - A list of pull requests with this ref as the head ref. - """ - associatedPullRequests( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - The base ref name to filter the pull requests by. - """ - baseRefName: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - The head ref name to filter the pull requests by. - """ - headRefName: String - - """ - A list of label names to filter the pull requests by. - """ - labels: [String!] - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for pull requests returned from the connection. - """ - orderBy: IssueOrder - - """ - A list of states to filter the pull requests by. - """ - states: [PullRequestState!] - ): PullRequestConnection! - - """ - Branch protection rules for this ref - """ - branchProtectionRule: BranchProtectionRule - - """ - Compares the current ref as a base ref to another head ref, if the comparison can be made. - """ - compare( - """ - The head ref to compare against. - """ - headRef: String! - ): Comparison - - """ - The Node ID of the Ref object - """ - id: ID! - - """ - The ref name. - """ - name: String! - - """ - The ref's prefix, such as `refs/heads/` or `refs/tags/`. - """ - prefix: String! - - """ - Branch protection rules that are viewable by non-admins - """ - refUpdateRule: RefUpdateRule - - """ - The repository the ref belongs to. - """ - repository: Repository! - - """ - A list of rules from active Repository and Organization rulesets that apply to this ref. - """ - rules( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for repository rules. - """ - orderBy: RepositoryRuleOrder = {field: UPDATED_AT, direction: DESC} - ): RepositoryRuleConnection - - """ - The object the ref points to. Returns null when object does not exist. - """ - target: GitObject -} - -""" -The connection type for Ref. -""" -type RefConnection { - """ - A list of edges. - """ - edges: [RefEdge] - - """ - A list of nodes. - """ - nodes: [Ref] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type RefEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Ref -} - -""" -Parameters to be used for the ref_name condition -""" -type RefNameConditionTarget { - """ - Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. - """ - exclude: [String!]! - - """ - Array of ref names or patterns to include. One of these patterns must match - for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the - default branch or `~ALL` to include all branches. - """ - include: [String!]! -} - -""" -Parameters to be used for the ref_name condition -""" -input RefNameConditionTargetInput { - """ - Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. - """ - exclude: [String!]! - - """ - Array of ref names or patterns to include. One of these patterns must match - for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the - default branch or `~ALL` to include all branches. - """ - include: [String!]! -} - -""" -Ways in which lists of git refs can be ordered upon return. -""" -input RefOrder { - """ - The direction in which to order refs by the specified field. - """ - direction: OrderDirection! - - """ - The field in which to order refs by. - """ - field: RefOrderField! -} - -""" -Properties by which ref connections can be ordered. -""" -enum RefOrderField { - """ - Order refs by their alphanumeric name - """ - ALPHABETICAL - - """ - Order refs by underlying commit date if the ref prefix is refs/tags/ - """ - TAG_COMMIT_DATE -} - -""" -A ref update -""" -input RefUpdate { - """ - The value this ref should be updated to. - """ - afterOid: GitObjectID! - - """ - The value this ref needs to point to before the update. - """ - beforeOid: GitObjectID - - """ - Force a non fast-forward update. - """ - force: Boolean = false - - """ - The fully qualified name of the ref to be update. For example `refs/heads/branch-name` - """ - name: GitRefname! -} - -""" -Branch protection rules that are enforced on the viewer. -""" -type RefUpdateRule { - """ - Can this branch be deleted. - """ - allowsDeletions: Boolean! - - """ - Are force pushes allowed on this branch. - """ - allowsForcePushes: Boolean! - - """ - Can matching branches be created. - """ - blocksCreations: Boolean! - - """ - Identifies the protection rule pattern. - """ - pattern: String! - - """ - Number of approving reviews required to update matching branches. - """ - requiredApprovingReviewCount: Int - - """ - List of required status check contexts that must pass for commits to be accepted to matching branches. - """ - requiredStatusCheckContexts: [String] - - """ - Are reviews from code owners required to update matching branches. - """ - requiresCodeOwnerReviews: Boolean! - - """ - Are conversations required to be resolved before merging. - """ - requiresConversationResolution: Boolean! - - """ - Are merge commits prohibited from being pushed to this branch. - """ - requiresLinearHistory: Boolean! - - """ - Are commits required to be signed. - """ - requiresSignatures: Boolean! - - """ - Is the viewer allowed to dismiss reviews. - """ - viewerAllowedToDismissReviews: Boolean! - - """ - Can the viewer push to the branch - """ - viewerCanPush: Boolean! -} - -""" -Represents a 'referenced' event on a given `ReferencedSubject`. -""" -type ReferencedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the commit associated with the 'referenced' event. - """ - commit: Commit - - """ - Identifies the repository associated with the 'referenced' event. - """ - commitRepository: Repository! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the ReferencedEvent object - """ - id: ID! - - """ - Reference originated in a different repository. - """ - isCrossRepository: Boolean! - - """ - Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference. - """ - isDirectReference: Boolean! - - """ - Object referenced by event. - """ - subject: ReferencedSubject! -} - -""" -Any referencable object -""" -union ReferencedSubject = Issue | PullRequest - -""" -Autogenerated input type of RegenerateVerifiableDomainToken -""" -input RegenerateVerifiableDomainTokenInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the verifiable domain to regenerate the verification token of. - """ - id: ID! @possibleTypes(concreteTypes: ["VerifiableDomain"]) -} - -""" -Autogenerated return type of RegenerateVerifiableDomainToken -""" -type RegenerateVerifiableDomainTokenPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The verification token that was generated. - """ - verificationToken: String -} - -""" -Autogenerated input type of RejectDeployments -""" -input RejectDeploymentsInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Optional comment for rejecting deployments - """ - comment: String = "" - - """ - The ids of environments to reject deployments - """ - environmentIds: [ID!]! - - """ - The node ID of the workflow run containing the pending deployments. - """ - workflowRunId: ID! @possibleTypes(concreteTypes: ["WorkflowRun"]) -} - -""" -Autogenerated return type of RejectDeployments -""" -type RejectDeploymentsPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The affected deployments. - """ - deployments: [Deployment!] -} - -""" -A release contains the content for a release. -""" -type Release implements Node & Reactable & UniformResourceLocatable { - """ - The author of the release - """ - author: User - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The description of the release. - """ - description: String - - """ - The description of this release rendered to HTML. - """ - descriptionHTML: HTML - - """ - The Node ID of the Release object - """ - id: ID! - - """ - Whether or not the release is a draft - """ - isDraft: Boolean! - - """ - Whether or not the release is the latest releast - """ - isLatest: Boolean! - - """ - Whether or not the release is a prerelease - """ - isPrerelease: Boolean! - - """ - A list of users mentioned in the release description - """ - mentions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserConnection - - """ - The title of the release. - """ - name: String - - """ - Identifies the date and time when the release was created. - """ - publishedAt: DateTime - - """ - A list of reactions grouped by content left on the subject. - """ - reactionGroups: [ReactionGroup!] - - """ - A list of Reactions left on the Issue. - """ - reactions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Allows filtering Reactions by emoji. - """ - content: ReactionContent - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Allows specifying the order in which reactions are returned. - """ - orderBy: ReactionOrder - ): ReactionConnection! - - """ - List of releases assets which are dependent on this release. - """ - releaseAssets( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - A name to filter the assets by. - """ - name: String - ): ReleaseAssetConnection! - - """ - The repository that the release belongs to. - """ - repository: Repository! - - """ - The HTTP path for this issue - """ - resourcePath: URI! - - """ - A description of the release, rendered to HTML without any links in it. - """ - shortDescriptionHTML( - """ - How many characters to return. - """ - limit: Int = 200 - ): HTML - - """ - The Git tag the release points to - """ - tag: Ref - - """ - The tag commit for this release. - """ - tagCommit: Commit - - """ - The name of the release's Git tag - """ - tagName: String! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this issue - """ - url: URI! - - """ - Can user react to this subject - """ - viewerCanReact: Boolean! -} - -""" -A release asset contains the content for a release asset. -""" -type ReleaseAsset implements Node { - """ - The asset's content-type - """ - contentType: String! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The number of times this asset was downloaded - """ - downloadCount: Int! - - """ - Identifies the URL where you can download the release asset via the browser. - """ - downloadUrl: URI! - - """ - The Node ID of the ReleaseAsset object - """ - id: ID! - - """ - Identifies the title of the release asset. - """ - name: String! - - """ - Release that the asset is associated with - """ - release: Release - - """ - The size (in bytes) of the asset - """ - size: Int! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The user that performed the upload - """ - uploadedBy: User! - - """ - Identifies the URL of the release asset. - """ - url: URI! -} - -""" -The connection type for ReleaseAsset. -""" -type ReleaseAssetConnection { - """ - A list of edges. - """ - edges: [ReleaseAssetEdge] - - """ - A list of nodes. - """ - nodes: [ReleaseAsset] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type ReleaseAssetEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: ReleaseAsset -} - -""" -The connection type for Release. -""" -type ReleaseConnection { - """ - A list of edges. - """ - edges: [ReleaseEdge] - - """ - A list of nodes. - """ - nodes: [Release] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type ReleaseEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Release -} - -""" -Ways in which lists of releases can be ordered upon return. -""" -input ReleaseOrder { - """ - The direction in which to order releases by the specified field. - """ - direction: OrderDirection! - - """ - The field in which to order releases by. - """ - field: ReleaseOrderField! -} - -""" -Properties by which release connections can be ordered. -""" -enum ReleaseOrderField { - """ - Order releases by creation time - """ - CREATED_AT - - """ - Order releases alphabetically by name - """ - NAME -} - -""" -Autogenerated input type of RemoveAssigneesFromAssignable -""" -input RemoveAssigneesFromAssignableInput { - """ - The id of the assignable object to remove assignees from. - """ - assignableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Assignable") - - """ - The id of users to remove as assignees. - """ - assigneeIds: [ID!]! @possibleTypes(concreteTypes: ["User"]) - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated return type of RemoveAssigneesFromAssignable -""" -type RemoveAssigneesFromAssignablePayload { - """ - The item that was unassigned. - """ - assignable: Assignable - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of RemoveEnterpriseAdmin -""" -input RemoveEnterpriseAdminInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Enterprise ID from which to remove the administrator. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The login of the user to remove as an administrator. - """ - login: String! -} - -""" -Autogenerated return type of RemoveEnterpriseAdmin -""" -type RemoveEnterpriseAdminPayload { - """ - The user who was removed as an administrator. - """ - admin: User - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated enterprise. - """ - enterprise: Enterprise - - """ - A message confirming the result of removing an administrator. - """ - message: String - - """ - The viewer performing the mutation. - """ - viewer: User -} - -""" -Autogenerated input type of RemoveLabelsFromLabelable -""" -input RemoveLabelsFromLabelableInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ids of labels to remove. - """ - labelIds: [ID!]! @possibleTypes(concreteTypes: ["Label"]) - - """ - The id of the Labelable to remove labels from. - """ - labelableId: ID! @possibleTypes(concreteTypes: ["Discussion", "Issue", "PullRequest"], abstractType: "Labelable") -} - -""" -Autogenerated return type of RemoveLabelsFromLabelable -""" -type RemoveLabelsFromLabelablePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Labelable the labels were removed from. - """ - labelable: Labelable -} - -""" -Autogenerated input type of RemoveOutsideCollaborator -""" -input RemoveOutsideCollaboratorInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the organization to remove the outside collaborator from. - """ - organizationId: ID! @possibleTypes(concreteTypes: ["Organization"]) - - """ - The ID of the outside collaborator to remove. - """ - userId: ID! @possibleTypes(concreteTypes: ["User"]) -} - -""" -Autogenerated return type of RemoveOutsideCollaborator -""" -type RemoveOutsideCollaboratorPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The user that was removed as an outside collaborator. - """ - removedUser: User -} - -""" -Autogenerated input type of RemoveReaction -""" -input RemoveReactionInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The name of the emoji reaction to remove. - """ - content: ReactionContent! - - """ - The Node ID of the subject to modify. - """ - subjectId: ID! - @possibleTypes( - concreteTypes: [ - "CommitComment" - "Discussion" - "DiscussionComment" - "Issue" - "IssueComment" - "PullRequest" - "PullRequestReview" - "PullRequestReviewComment" - "Release" - "TeamDiscussion" - "TeamDiscussionComment" - ] - abstractType: "Reactable" - ) -} - -""" -Autogenerated return type of RemoveReaction -""" -type RemoveReactionPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The reaction object. - """ - reaction: Reaction - - """ - The reaction groups for the subject. - """ - reactionGroups: [ReactionGroup!] - - """ - The reactable subject. - """ - subject: Reactable -} - -""" -Autogenerated input type of RemoveStar -""" -input RemoveStarInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Starrable ID to unstar. - """ - starrableId: ID! @possibleTypes(concreteTypes: ["Gist", "Repository", "Topic"], abstractType: "Starrable") -} - -""" -Autogenerated return type of RemoveStar -""" -type RemoveStarPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The starrable. - """ - starrable: Starrable -} - -""" -Autogenerated input type of RemoveUpvote -""" -input RemoveUpvoteInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the discussion or comment to remove upvote. - """ - subjectId: ID! @possibleTypes(concreteTypes: ["Discussion", "DiscussionComment"], abstractType: "Votable") -} - -""" -Autogenerated return type of RemoveUpvote -""" -type RemoveUpvotePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The votable subject. - """ - subject: Votable -} - -""" -Represents a 'removed_from_merge_queue' event on a given pull request. -""" -type RemovedFromMergeQueueEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the before commit SHA for the 'removed_from_merge_queue' event. - """ - beforeCommit: Commit - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The user who removed this Pull Request from the merge queue - """ - enqueuer: User - - """ - The Node ID of the RemovedFromMergeQueueEvent object - """ - id: ID! - - """ - The merge queue where this pull request was removed from. - """ - mergeQueue: MergeQueue - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest - - """ - The reason this pull request was removed from the queue. - """ - reason: String -} - -""" -Represents a 'removed_from_project' event on a given issue or pull request. -""" -type RemovedFromProjectEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the RemovedFromProjectEvent object - """ - id: ID! - - """ - Project referenced by event. - """ - project: Project - - """ - Column name referenced by this project event. - """ - projectColumnName: String! -} - -""" -Represents a 'renamed' event on a given issue or pull request -""" -type RenamedTitleEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the current title of the issue or pull request. - """ - currentTitle: String! - - """ - The Node ID of the RenamedTitleEvent object - """ - id: ID! - - """ - Identifies the previous title of the issue or pull request. - """ - previousTitle: String! - - """ - Subject that was renamed. - """ - subject: RenamedTitleSubject! -} - -""" -An object which has a renamable title -""" -union RenamedTitleSubject = Issue | PullRequest - -""" -Autogenerated input type of ReopenDiscussion -""" -input ReopenDiscussionInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - ID of the discussion to be reopened. - """ - discussionId: ID! @possibleTypes(concreteTypes: ["Discussion"]) -} - -""" -Autogenerated return type of ReopenDiscussion -""" -type ReopenDiscussionPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The discussion that was reopened. - """ - discussion: Discussion -} - -""" -Autogenerated input type of ReopenIssue -""" -input ReopenIssueInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - ID of the issue to be opened. - """ - issueId: ID! @possibleTypes(concreteTypes: ["Issue"]) -} - -""" -Autogenerated return type of ReopenIssue -""" -type ReopenIssuePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The issue that was opened. - """ - issue: Issue -} - -""" -Autogenerated input type of ReopenPullRequest -""" -input ReopenPullRequestInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - ID of the pull request to be reopened. - """ - pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"]) -} - -""" -Autogenerated return type of ReopenPullRequest -""" -type ReopenPullRequestPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The pull request that was reopened. - """ - pullRequest: PullRequest -} - -""" -Represents a 'reopened' event on any `Closable`. -""" -type ReopenedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Object that was reopened. - """ - closable: Closable! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the ReopenedEvent object - """ - id: ID! - - """ - The reason the issue state was changed to open. - """ - stateReason: IssueStateReason -} - -""" -Autogenerated input type of ReorderEnvironment -""" -input ReorderEnvironmentInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the environment to modify - """ - environmentId: ID! @possibleTypes(concreteTypes: ["Environment"]) - - """ - The desired position of the environment - """ - position: Int! -} - -""" -Autogenerated return type of ReorderEnvironment -""" -type ReorderEnvironmentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The environment that was reordered - """ - environment: Environment -} - -""" -Audit log entry for a repo.access event. -""" -type RepoAccessAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the RepoAccessAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI - - """ - The visibility of the repository - """ - visibility: RepoAccessAuditEntryVisibility -} - -""" -The privacy of a repository -""" -enum RepoAccessAuditEntryVisibility { - """ - The repository is visible only to users in the same business. - """ - INTERNAL - - """ - The repository is visible only to those with explicit access. - """ - PRIVATE - - """ - The repository is visible to everyone. - """ - PUBLIC -} - -""" -Audit log entry for a repo.add_member event. -""" -type RepoAddMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the RepoAddMemberAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI - - """ - The visibility of the repository - """ - visibility: RepoAddMemberAuditEntryVisibility -} - -""" -The privacy of a repository -""" -enum RepoAddMemberAuditEntryVisibility { - """ - The repository is visible only to users in the same business. - """ - INTERNAL - - """ - The repository is visible only to those with explicit access. - """ - PRIVATE - - """ - The repository is visible to everyone. - """ - PUBLIC -} - -""" -Audit log entry for a repo.add_topic event. -""" -type RepoAddTopicAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData & TopicAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the RepoAddTopicAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The name of the topic added to the repository - """ - topic: Topic - - """ - The name of the topic added to the repository - """ - topicName: String - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a repo.archived event. -""" -type RepoArchivedAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the RepoArchivedAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI - - """ - The visibility of the repository - """ - visibility: RepoArchivedAuditEntryVisibility -} - -""" -The privacy of a repository -""" -enum RepoArchivedAuditEntryVisibility { - """ - The repository is visible only to users in the same business. - """ - INTERNAL - - """ - The repository is visible only to those with explicit access. - """ - PRIVATE - - """ - The repository is visible to everyone. - """ - PUBLIC -} - -""" -Audit log entry for a repo.change_merge_setting event. -""" -type RepoChangeMergeSettingAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the RepoChangeMergeSettingAuditEntry object - """ - id: ID! - - """ - Whether the change was to enable (true) or disable (false) the merge type - """ - isEnabled: Boolean - - """ - The merge method affected by the change - """ - mergeType: RepoChangeMergeSettingAuditEntryMergeType - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -The merge options available for pull requests to this repository. -""" -enum RepoChangeMergeSettingAuditEntryMergeType { - """ - The pull request is added to the base branch in a merge commit. - """ - MERGE - - """ - Commits from the pull request are added onto the base branch individually without a merge commit. - """ - REBASE - - """ - The pull request's commits are squashed into a single commit before they are merged to the base branch. - """ - SQUASH -} - -""" -Audit log entry for a repo.config.disable_anonymous_git_access event. -""" -type RepoConfigDisableAnonymousGitAccessAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the RepoConfigDisableAnonymousGitAccessAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a repo.config.disable_collaborators_only event. -""" -type RepoConfigDisableCollaboratorsOnlyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the RepoConfigDisableCollaboratorsOnlyAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a repo.config.disable_contributors_only event. -""" -type RepoConfigDisableContributorsOnlyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the RepoConfigDisableContributorsOnlyAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a repo.config.disable_sockpuppet_disallowed event. -""" -type RepoConfigDisableSockpuppetDisallowedAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the RepoConfigDisableSockpuppetDisallowedAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a repo.config.enable_anonymous_git_access event. -""" -type RepoConfigEnableAnonymousGitAccessAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the RepoConfigEnableAnonymousGitAccessAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a repo.config.enable_collaborators_only event. -""" -type RepoConfigEnableCollaboratorsOnlyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the RepoConfigEnableCollaboratorsOnlyAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a repo.config.enable_contributors_only event. -""" -type RepoConfigEnableContributorsOnlyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the RepoConfigEnableContributorsOnlyAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a repo.config.enable_sockpuppet_disallowed event. -""" -type RepoConfigEnableSockpuppetDisallowedAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the RepoConfigEnableSockpuppetDisallowedAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a repo.config.lock_anonymous_git_access event. -""" -type RepoConfigLockAnonymousGitAccessAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the RepoConfigLockAnonymousGitAccessAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a repo.config.unlock_anonymous_git_access event. -""" -type RepoConfigUnlockAnonymousGitAccessAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the RepoConfigUnlockAnonymousGitAccessAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a repo.create event. -""" -type RepoCreateAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The name of the parent repository for this forked repository. - """ - forkParentName: String - - """ - The name of the root repository for this network. - """ - forkSourceName: String - - """ - The Node ID of the RepoCreateAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI - - """ - The visibility of the repository - """ - visibility: RepoCreateAuditEntryVisibility -} - -""" -The privacy of a repository -""" -enum RepoCreateAuditEntryVisibility { - """ - The repository is visible only to users in the same business. - """ - INTERNAL - - """ - The repository is visible only to those with explicit access. - """ - PRIVATE - - """ - The repository is visible to everyone. - """ - PUBLIC -} - -""" -Audit log entry for a repo.destroy event. -""" -type RepoDestroyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the RepoDestroyAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI - - """ - The visibility of the repository - """ - visibility: RepoDestroyAuditEntryVisibility -} - -""" -The privacy of a repository -""" -enum RepoDestroyAuditEntryVisibility { - """ - The repository is visible only to users in the same business. - """ - INTERNAL - - """ - The repository is visible only to those with explicit access. - """ - PRIVATE - - """ - The repository is visible to everyone. - """ - PUBLIC -} - -""" -Audit log entry for a repo.remove_member event. -""" -type RepoRemoveMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the RepoRemoveMemberAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI - - """ - The visibility of the repository - """ - visibility: RepoRemoveMemberAuditEntryVisibility -} - -""" -The privacy of a repository -""" -enum RepoRemoveMemberAuditEntryVisibility { - """ - The repository is visible only to users in the same business. - """ - INTERNAL - - """ - The repository is visible only to those with explicit access. - """ - PRIVATE - - """ - The repository is visible to everyone. - """ - PUBLIC -} - -""" -Audit log entry for a repo.remove_topic event. -""" -type RepoRemoveTopicAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData & TopicAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the RepoRemoveTopicAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The name of the topic added to the repository - """ - topic: Topic - - """ - The name of the topic added to the repository - """ - topicName: String - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -The reasons a piece of content can be reported or minimized. -""" -enum ReportedContentClassifiers { - """ - A duplicated piece of content - """ - DUPLICATE - - """ - An irrelevant piece of content - """ - OFF_TOPIC - - """ - An outdated piece of content - """ - OUTDATED - - """ - The content has been resolved - """ - RESOLVED -} - -""" -A repository contains the content for a project. -""" -type Repository implements Node & PackageOwner & ProjectOwner & ProjectV2Recent & RepositoryInfo & Starrable & Subscribable & UniformResourceLocatable { - """ - Whether or not a pull request head branch that is behind its base branch can - always be updated even if it is not required to be up to date before merging. - """ - allowUpdateBranch: Boolean! - - """ - Identifies the date and time when the repository was archived. - """ - archivedAt: DateTime - - """ - A list of users that can be assigned to issues in this repository. - """ - assignableUsers( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filters users with query on user name and login. - """ - query: String - ): UserConnection! - - """ - Whether or not Auto-merge can be enabled on pull requests in this repository. - """ - autoMergeAllowed: Boolean! - - """ - A list of branch protection rules for this repository. - """ - branchProtectionRules( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): BranchProtectionRuleConnection! - - """ - Returns the code of conduct for this repository - """ - codeOfConduct: CodeOfConduct - - """ - Information extracted from the repository's `CODEOWNERS` file. - """ - codeowners( - """ - The ref name used to return the associated `CODEOWNERS` file. - """ - refName: String - ): RepositoryCodeowners - - """ - A list of collaborators associated with the repository. - """ - collaborators( - """ - Collaborators affiliation level with a repository. - """ - affiliation: CollaboratorAffiliation - - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - The login of one specific collaborator. - """ - login: String - - """ - Filters users with query on user name and login - """ - query: String - ): RepositoryCollaboratorConnection - - """ - A list of commit comments associated with the repository. - """ - commitComments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): CommitCommentConnection! - - """ - Returns a list of contact links associated to the repository - """ - contactLinks: [RepositoryContactLink!] - - """ - Returns the contributing guidelines for this repository. - """ - contributingGuidelines: ContributingGuidelines - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Ref associated with the repository's default branch. - """ - defaultBranchRef: Ref - - """ - Whether or not branches are automatically deleted when merged in this repository. - """ - deleteBranchOnMerge: Boolean! - - """ - A list of dependency manifests contained in the repository - """ - dependencyGraphManifests( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Cursor to paginate dependencies - """ - dependenciesAfter: String - - """ - Number of dependencies to fetch - """ - dependenciesFirst: Int - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Flag to scope to only manifests with dependencies - """ - withDependencies: Boolean - ): DependencyGraphManifestConnection - - """ - A list of deploy keys that are on this repository. - """ - deployKeys( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): DeployKeyConnection! - - """ - Deployments associated with the repository - """ - deployments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Environments to list deployments for - """ - environments: [String!] - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for deployments returned from the connection. - """ - orderBy: DeploymentOrder = {field: CREATED_AT, direction: ASC} - ): DeploymentConnection! - - """ - The description of the repository. - """ - description: String - - """ - The description of the repository rendered to HTML. - """ - descriptionHTML: HTML! - - """ - Returns a single discussion from the current repository by number. - """ - discussion( - """ - The number for the discussion to be returned. - """ - number: Int! - ): Discussion - - """ - A list of discussion categories that are available in the repository. - """ - discussionCategories( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Filter by categories that are assignable by the viewer. - """ - filterByAssignable: Boolean = false - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): DiscussionCategoryConnection! - - """ - A discussion category by slug. - """ - discussionCategory( - """ - The slug of the discussion category to be returned. - """ - slug: String! - ): DiscussionCategory - - """ - A list of discussions that have been opened in the repository. - """ - discussions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Only show answered or unanswered discussions - """ - answered: Boolean = null - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Only include discussions that belong to the category with this ID. - """ - categoryId: ID = null - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for discussions returned from the connection. - """ - orderBy: DiscussionOrder = {field: UPDATED_AT, direction: DESC} - - """ - A list of states to filter the discussions by. - """ - states: [DiscussionState!] = [] - ): DiscussionConnection! - - """ - The number of kilobytes this repository occupies on disk. - """ - diskUsage: Int - - """ - Returns a single active environment from the current repository by name. - """ - environment( - """ - The name of the environment to be returned. - """ - name: String! - ): Environment - - """ - A list of environments that are in this repository. - """ - environments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - The names of the environments to be returned. - """ - names: [String!] = [] - - """ - Ordering options for the environments - """ - orderBy: Environments = {field: NAME, direction: ASC} - - """ - Filter to control pinned environments return - """ - pinnedEnvironmentFilter: EnvironmentPinnedFilterField = ALL - ): EnvironmentConnection! - - """ - Returns how many forks there are of this repository in the whole network. - """ - forkCount: Int! - - """ - Whether this repository allows forks. - """ - forkingAllowed: Boolean! - - """ - A list of direct forked repositories. - """ - forks( - """ - Array of viewer's affiliation options for repositories returned from the - connection. For example, OWNER will include only repositories that the - current viewer owns. - """ - affiliations: [RepositoryAffiliation] - - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - If non-null, filters repositories according to whether they have issues enabled - """ - hasIssuesEnabled: Boolean - - """ - If non-null, filters repositories according to whether they have been locked - """ - isLocked: Boolean - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for repositories returned from the connection - """ - orderBy: RepositoryOrder - - """ - Array of owner's affiliation options for repositories returned from the - connection. For example, OWNER will include only repositories that the - organization or user being viewed owns. - """ - ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR] - - """ - If non-null, filters repositories according to privacy. Internal - repositories are considered private; consider using the visibility argument - if only internal repositories are needed. Cannot be combined with the - visibility argument. - """ - privacy: RepositoryPrivacy - - """ - If non-null, filters repositories according to visibility. Cannot be combined with the privacy argument. - """ - visibility: RepositoryVisibility - ): RepositoryConnection! - - """ - Indicates if the repository has anonymous Git read access feature enabled. - """ - hasAnonymousAccessEnabled: Boolean! - - """ - Indicates if the repository has the Discussions feature enabled. - """ - hasDiscussionsEnabled: Boolean! - - """ - Indicates if the repository has issues feature enabled. - """ - hasIssuesEnabled: Boolean! - - """ - Indicates if the repository has the Projects feature enabled. - """ - hasProjectsEnabled: Boolean! - - """ - Whether vulnerability alerts are enabled for the repository. - """ - hasVulnerabilityAlertsEnabled: Boolean! - - """ - Indicates if the repository has wiki feature enabled. - """ - hasWikiEnabled: Boolean! - - """ - The repository's URL. - """ - homepageUrl: URI - - """ - The Node ID of the Repository object - """ - id: ID! - - """ - Indicates if the repository is unmaintained. - """ - isArchived: Boolean! - - """ - Returns true if blank issue creation is allowed - """ - isBlankIssuesEnabled: Boolean! - - """ - Returns whether or not this repository disabled. - """ - isDisabled: Boolean! - - """ - Returns whether or not this repository is empty. - """ - isEmpty: Boolean! - - """ - Identifies if the repository is a fork. - """ - isFork: Boolean! - - """ - Indicates if a repository is either owned by an organization, or is a private fork of an organization repository. - """ - isInOrganization: Boolean! - - """ - Indicates if the repository has been locked or not. - """ - isLocked: Boolean! - - """ - Identifies if the repository is a mirror. - """ - isMirror: Boolean! - - """ - Identifies if the repository is private or internal. - """ - isPrivate: Boolean! - - """ - Returns true if this repository has a security policy - """ - isSecurityPolicyEnabled: Boolean - - """ - Identifies if the repository is a template that can be used to generate new repositories. - """ - isTemplate: Boolean! - - """ - Is this repository a user configuration repository? - """ - isUserConfigurationRepository: Boolean! - - """ - Returns a single issue from the current repository by number. - """ - issue( - """ - The number for the issue to be returned. - """ - number: Int! - ): Issue - - """ - Returns a single issue-like object from the current repository by number. - """ - issueOrPullRequest( - """ - The number for the issue to be returned. - """ - number: Int! - ): IssueOrPullRequest - - """ - Returns a list of issue templates associated to the repository - """ - issueTemplates: [IssueTemplate!] - - """ - A list of issues that have been opened in the repository. - """ - issues( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Filtering options for issues returned from the connection. - """ - filterBy: IssueFilters - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - A list of label names to filter the pull requests by. - """ - labels: [String!] - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for issues returned from the connection. - """ - orderBy: IssueOrder - - """ - A list of states to filter the issues by. - """ - states: [IssueState!] - ): IssueConnection! - - """ - Returns a single label by name - """ - label( - """ - Label name - """ - name: String! - ): Label - - """ - A list of labels associated with the repository. - """ - labels( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for labels returned from the connection. - """ - orderBy: LabelOrder = {field: CREATED_AT, direction: ASC} - - """ - If provided, searches labels by name and description. - """ - query: String - ): LabelConnection - - """ - A list containing a breakdown of the language composition of the repository. - """ - languages( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Order for connection - """ - orderBy: LanguageOrder - ): LanguageConnection - - """ - Get the latest release for the repository if one exists. - """ - latestRelease: Release - - """ - The license associated with the repository - """ - licenseInfo: License - - """ - The reason the repository has been locked. - """ - lockReason: RepositoryLockReason - - """ - A list of Users that can be mentioned in the context of the repository. - """ - mentionableUsers( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filters users with query on user name and login - """ - query: String - ): UserConnection! - - """ - Whether or not PRs are merged with a merge commit on this repository. - """ - mergeCommitAllowed: Boolean! - - """ - How the default commit message will be generated when merging a pull request. - """ - mergeCommitMessage: MergeCommitMessage! - - """ - How the default commit title will be generated when merging a pull request. - """ - mergeCommitTitle: MergeCommitTitle! - - """ - The merge queue for a specified branch, otherwise the default branch if not provided. - """ - mergeQueue( - """ - The name of the branch to get the merge queue for. Case sensitive. - """ - branch: String - ): MergeQueue - - """ - Returns a single milestone from the current repository by number. - """ - milestone( - """ - The number for the milestone to be returned. - """ - number: Int! - ): Milestone - - """ - A list of milestones associated with the repository. - """ - milestones( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for milestones. - """ - orderBy: MilestoneOrder - - """ - Filters milestones with a query on the title - """ - query: String - - """ - Filter by the state of the milestones. - """ - states: [MilestoneState!] - ): MilestoneConnection - - """ - The repository's original mirror URL. - """ - mirrorUrl: URI - - """ - The name of the repository. - """ - name: String! - - """ - The repository's name with owner. - """ - nameWithOwner: String! - - """ - A Git object in the repository - """ - object( - """ - A Git revision expression suitable for rev-parse - """ - expression: String - - """ - The Git object ID - """ - oid: GitObjectID - ): GitObject - - """ - The image used to represent this repository in Open Graph data. - """ - openGraphImageUrl: URI! - - """ - The User owner of the repository. - """ - owner: RepositoryOwner! - - """ - A list of packages under the owner. - """ - packages( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Find packages by their names. - """ - names: [String] - - """ - Ordering of the returned packages. - """ - orderBy: PackageOrder = {field: CREATED_AT, direction: DESC} - - """ - Filter registry package by type. - """ - packageType: PackageType - - """ - Find packages in a repository by ID. - """ - repositoryId: ID - ): PackageConnection! - - """ - The repository parent, if this is a fork. - """ - parent: Repository - - """ - A list of discussions that have been pinned in this repository. - """ - pinnedDiscussions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): PinnedDiscussionConnection! - - """ - A list of pinned environments for this repository. - """ - pinnedEnvironments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for the environments - """ - orderBy: PinnedEnvironmentOrder = {field: POSITION, direction: ASC} - ): PinnedEnvironmentConnection - - """ - A list of pinned issues for this repository. - """ - pinnedIssues( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): PinnedIssueConnection - - """ - Returns information about the availability of certain features and limits based on the repository's billing plan. - """ - planFeatures: RepositoryPlanFeatures! - - """ - The primary language of the repository's code. - """ - primaryLanguage: Language - - """ - Find project by number. - """ - project( - """ - The project number to find. - """ - number: Int! - ): Project - - """ - A list of projects under the owner. - """ - projects( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for projects returned from the connection - """ - orderBy: ProjectOrder - - """ - Query to search projects by, currently only searching by name. - """ - search: String - - """ - A list of states to filter the projects by. - """ - states: [ProjectState!] - ): ProjectConnection! - - """ - The HTTP path listing the repository's projects - """ - projectsResourcePath: URI! - - """ - The HTTP URL listing the repository's projects - """ - projectsUrl: URI! - - """ - Returns a single pull request from the current repository by number. - """ - pullRequest( - """ - The number for the pull request to be returned. - """ - number: Int! - ): PullRequest - - """ - Returns a list of pull request templates associated to the repository - """ - pullRequestTemplates: [PullRequestTemplate!] - - """ - A list of pull requests that have been opened in the repository. - """ - pullRequests( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - The base ref name to filter the pull requests by. - """ - baseRefName: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - The head ref name to filter the pull requests by. - """ - headRefName: String - - """ - A list of label names to filter the pull requests by. - """ - labels: [String!] - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for pull requests returned from the connection. - """ - orderBy: IssueOrder - - """ - A list of states to filter the pull requests by. - """ - states: [PullRequestState!] - ): PullRequestConnection! - - """ - Identifies the date and time when the repository was last pushed to. - """ - pushedAt: DateTime - - """ - Whether or not rebase-merging is enabled on this repository. - """ - rebaseMergeAllowed: Boolean! - - """ - Recent projects that this user has modified in the context of the owner. - """ - recentProjects( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ProjectV2Connection! - - """ - Fetch a given ref from the repository - """ - ref( - """ - The ref to retrieve. Fully qualified matches are checked in order - (`refs/heads/master`) before falling back onto checks for short name matches (`master`). - """ - qualifiedName: String! - ): Ref - - """ - Fetch a list of refs from the repository - """ - refs( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - DEPRECATED: use orderBy. The ordering direction. - """ - direction: OrderDirection - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for refs returned from the connection. - """ - orderBy: RefOrder - - """ - Filters refs with query on name - """ - query: String - - """ - A ref name prefix like `refs/heads/`, `refs/tags/`, etc. - """ - refPrefix: String! - ): RefConnection - - """ - Lookup a single release given various criteria. - """ - release( - """ - The name of the Tag the Release was created from - """ - tagName: String! - ): Release - - """ - List of releases which are dependent on this repository. - """ - releases( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Order for connection - """ - orderBy: ReleaseOrder - ): ReleaseConnection! - - """ - A list of applied repository-topic associations for this repository. - """ - repositoryTopics( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): RepositoryTopicConnection! - - """ - The HTTP path for this repository - """ - resourcePath: URI! - - """ - Returns a single ruleset from the current repository by ID. - """ - ruleset( - """ - The ID of the ruleset to be returned. - """ - databaseId: Int! - - """ - Include rulesets configured at higher levels that apply to this repository - """ - includeParents: Boolean = true - ): RepositoryRuleset - - """ - A list of rulesets for this repository. - """ - rulesets( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Return rulesets configured at higher levels that apply to this repository - """ - includeParents: Boolean = true - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): RepositoryRulesetConnection - - """ - The security policy URL. - """ - securityPolicyUrl: URI - - """ - A description of the repository, rendered to HTML without any links in it. - """ - shortDescriptionHTML( - """ - How many characters to return. - """ - limit: Int = 200 - ): HTML! - - """ - Whether or not squash-merging is enabled on this repository. - """ - squashMergeAllowed: Boolean! - - """ - How the default commit message will be generated when squash merging a pull request. - """ - squashMergeCommitMessage: SquashMergeCommitMessage! - - """ - How the default commit title will be generated when squash merging a pull request. - """ - squashMergeCommitTitle: SquashMergeCommitTitle! - - """ - Whether a squash merge commit can use the pull request title as default. - """ - squashPrTitleUsedAsDefault: Boolean! - @deprecated( - reason: "`squashPrTitleUsedAsDefault` will be removed. Use `Repository.squashMergeCommitTitle` instead. Removal on 2023-04-01 UTC." - ) - - """ - The SSH URL to clone this repository - """ - sshUrl: GitSSHRemote! - - """ - Returns a count of how many stargazers there are on this object - """ - stargazerCount: Int! - - """ - A list of users who have starred this starrable. - """ - stargazers( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Order for connection - """ - orderBy: StarOrder - ): StargazerConnection! - - """ - Returns a list of all submodules in this repository parsed from the - .gitmodules file as of the default branch's HEAD commit. - """ - submodules( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): SubmoduleConnection! - - """ - Temporary authentication token for cloning this repository. - """ - tempCloneToken: String - - """ - The repository from which this repository was generated, if any. - """ - templateRepository: Repository - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this repository - """ - url: URI! - - """ - Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar. - """ - usesCustomOpenGraphImage: Boolean! - - """ - Indicates whether the viewer has admin permissions on this repository. - """ - viewerCanAdminister: Boolean! - - """ - Can the current viewer create new projects on this owner. - """ - viewerCanCreateProjects: Boolean! - - """ - Check if the viewer is able to change their subscription status for the repository. - """ - viewerCanSubscribe: Boolean! - - """ - Indicates whether the viewer can update the topics of this repository. - """ - viewerCanUpdateTopics: Boolean! - - """ - The last commit email for the viewer. - """ - viewerDefaultCommitEmail: String - - """ - The last used merge method by the viewer or the default for the repository. - """ - viewerDefaultMergeMethod: PullRequestMergeMethod! - - """ - Returns a boolean indicating whether the viewing user has starred this starrable. - """ - viewerHasStarred: Boolean! - - """ - The users permission level on the repository. Will return null if authenticated as an GitHub App. - """ - viewerPermission: RepositoryPermission - - """ - A list of emails this viewer can commit with. - """ - viewerPossibleCommitEmails: [String!] - - """ - Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. - """ - viewerSubscription: SubscriptionState - - """ - Indicates the repository's visibility level. - """ - visibility: RepositoryVisibility! - - """ - Returns a single vulnerability alert from the current repository by number. - """ - vulnerabilityAlert( - """ - The number for the vulnerability alert to be returned. - """ - number: Int! - ): RepositoryVulnerabilityAlert - - """ - A list of vulnerability alerts that are on this repository. - """ - vulnerabilityAlerts( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Filter by the scope of the alert's dependency - """ - dependencyScopes: [RepositoryVulnerabilityAlertDependencyScope!] - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filter by the state of the alert - """ - states: [RepositoryVulnerabilityAlertState!] - ): RepositoryVulnerabilityAlertConnection - - """ - A list of users watching the repository. - """ - watchers( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserConnection! - - """ - Whether contributors are required to sign off on web-based commits in this repository. - """ - webCommitSignoffRequired: Boolean! -} - -""" -The affiliation of a user to a repository -""" -enum RepositoryAffiliation { - """ - Repositories that the user has been added to as a collaborator. - """ - COLLABORATOR - - """ - Repositories that the user has access to through being a member of an - organization. This includes every repository on every team that the user is on. - """ - ORGANIZATION_MEMBER - - """ - Repositories that are owned by the authenticated user. - """ - OWNER -} - -""" -Metadata for an audit entry with action repo.* -""" -interface RepositoryAuditEntryData { - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI -} - -""" -Information extracted from a repository's `CODEOWNERS` file. -""" -type RepositoryCodeowners { - """ - Any problems that were encountered while parsing the `CODEOWNERS` file. - """ - errors: [RepositoryCodeownersError!]! -} - -""" -An error in a `CODEOWNERS` file. -""" -type RepositoryCodeownersError { - """ - The column number where the error occurs. - """ - column: Int! - - """ - A short string describing the type of error. - """ - kind: String! - - """ - The line number where the error occurs. - """ - line: Int! - - """ - A complete description of the error, combining information from other fields. - """ - message: String! - - """ - The path to the file when the error occurs. - """ - path: String! - - """ - The content of the line where the error occurs. - """ - source: String! - - """ - A suggestion of how to fix the error. - """ - suggestion: String -} - -""" -The connection type for User. -""" -type RepositoryCollaboratorConnection { - """ - A list of edges. - """ - edges: [RepositoryCollaboratorEdge] - - """ - A list of nodes. - """ - nodes: [User] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -Represents a user who is a collaborator of a repository. -""" -type RepositoryCollaboratorEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - node: User! - - """ - The permission the user has on the repository. - """ - permission: RepositoryPermission! - - """ - A list of sources for the user's access to the repository. - """ - permissionSources: [PermissionSource!] -} - -""" -A list of repositories owned by the subject. -""" -type RepositoryConnection { - """ - A list of edges. - """ - edges: [RepositoryEdge] - - """ - A list of nodes. - """ - nodes: [Repository] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! - - """ - The total size in kilobytes of all repositories in the connection. Value will - never be larger than max 32-bit signed integer. - """ - totalDiskUsage: Int! -} - -""" -A repository contact link. -""" -type RepositoryContactLink { - """ - The contact link purpose. - """ - about: String! - - """ - The contact link name. - """ - name: String! - - """ - The contact link URL. - """ - url: URI! -} - -""" -The reason a repository is listed as 'contributed'. -""" -enum RepositoryContributionType { - """ - Created a commit - """ - COMMIT - - """ - Created an issue - """ - ISSUE - - """ - Created a pull request - """ - PULL_REQUEST - - """ - Reviewed a pull request - """ - PULL_REQUEST_REVIEW - - """ - Created the repository - """ - REPOSITORY -} - -""" -Represents an author of discussions in repositories. -""" -interface RepositoryDiscussionAuthor { - """ - Discussions this user has started. - """ - repositoryDiscussions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Filter discussions to only those that have been answered or not. Defaults to - including both answered and unanswered discussions. - """ - answered: Boolean = null - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for discussions returned from the connection. - """ - orderBy: DiscussionOrder = {field: CREATED_AT, direction: DESC} - - """ - Filter discussions to only those in a specific repository. - """ - repositoryId: ID - - """ - A list of states to filter the discussions by. - """ - states: [DiscussionState!] = [] - ): DiscussionConnection! -} - -""" -Represents an author of discussion comments in repositories. -""" -interface RepositoryDiscussionCommentAuthor { - """ - Discussion comments this user has authored. - """ - repositoryDiscussionComments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filter discussion comments to only those that were marked as the answer - """ - onlyAnswers: Boolean = false - - """ - Filter discussion comments to only those in a specific repository. - """ - repositoryId: ID - ): DiscussionCommentConnection! -} - -""" -An edge in a connection. -""" -type RepositoryEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Repository -} - -""" -Parameters to be used for the repository_id condition -""" -type RepositoryIdConditionTarget { - """ - One of these repo IDs must match the repo. - """ - repositoryIds: [ID!]! -} - -""" -Parameters to be used for the repository_id condition -""" -input RepositoryIdConditionTargetInput { - """ - One of these repo IDs must match the repo. - """ - repositoryIds: [ID!]! -} - -""" -A subset of repository info. -""" -interface RepositoryInfo { - """ - Identifies the date and time when the repository was archived. - """ - archivedAt: DateTime - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The description of the repository. - """ - description: String - - """ - The description of the repository rendered to HTML. - """ - descriptionHTML: HTML! - - """ - Returns how many forks there are of this repository in the whole network. - """ - forkCount: Int! - - """ - Indicates if the repository has anonymous Git read access feature enabled. - """ - hasAnonymousAccessEnabled: Boolean! - - """ - Indicates if the repository has the Discussions feature enabled. - """ - hasDiscussionsEnabled: Boolean! - - """ - Indicates if the repository has issues feature enabled. - """ - hasIssuesEnabled: Boolean! - - """ - Indicates if the repository has the Projects feature enabled. - """ - hasProjectsEnabled: Boolean! - - """ - Indicates if the repository has wiki feature enabled. - """ - hasWikiEnabled: Boolean! - - """ - The repository's URL. - """ - homepageUrl: URI - - """ - Indicates if the repository is unmaintained. - """ - isArchived: Boolean! - - """ - Identifies if the repository is a fork. - """ - isFork: Boolean! - - """ - Indicates if a repository is either owned by an organization, or is a private fork of an organization repository. - """ - isInOrganization: Boolean! - - """ - Indicates if the repository has been locked or not. - """ - isLocked: Boolean! - - """ - Identifies if the repository is a mirror. - """ - isMirror: Boolean! - - """ - Identifies if the repository is private or internal. - """ - isPrivate: Boolean! - - """ - Identifies if the repository is a template that can be used to generate new repositories. - """ - isTemplate: Boolean! - - """ - The license associated with the repository - """ - licenseInfo: License - - """ - The reason the repository has been locked. - """ - lockReason: RepositoryLockReason - - """ - The repository's original mirror URL. - """ - mirrorUrl: URI - - """ - The name of the repository. - """ - name: String! - - """ - The repository's name with owner. - """ - nameWithOwner: String! - - """ - The image used to represent this repository in Open Graph data. - """ - openGraphImageUrl: URI! - - """ - The User owner of the repository. - """ - owner: RepositoryOwner! - - """ - Identifies the date and time when the repository was last pushed to. - """ - pushedAt: DateTime - - """ - The HTTP path for this repository - """ - resourcePath: URI! - - """ - A description of the repository, rendered to HTML without any links in it. - """ - shortDescriptionHTML( - """ - How many characters to return. - """ - limit: Int = 200 - ): HTML! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this repository - """ - url: URI! - - """ - Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar. - """ - usesCustomOpenGraphImage: Boolean! - - """ - Indicates the repository's visibility level. - """ - visibility: RepositoryVisibility! -} - -""" -An invitation for a user to be added to a repository. -""" -type RepositoryInvitation implements Node { - """ - The email address that received the invitation. - """ - email: String - - """ - The Node ID of the RepositoryInvitation object - """ - id: ID! - - """ - The user who received the invitation. - """ - invitee: User - - """ - The user who created the invitation. - """ - inviter: User! - - """ - The permalink for this repository invitation. - """ - permalink: URI! - - """ - The permission granted on this repository by this invitation. - """ - permission: RepositoryPermission! - - """ - The Repository the user is invited to. - """ - repository: RepositoryInfo -} - -""" -A list of repository invitations. -""" -type RepositoryInvitationConnection { - """ - A list of edges. - """ - edges: [RepositoryInvitationEdge] - - """ - A list of nodes. - """ - nodes: [RepositoryInvitation] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type RepositoryInvitationEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: RepositoryInvitation -} - -""" -Ordering options for repository invitation connections. -""" -input RepositoryInvitationOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order repository invitations by. - """ - field: RepositoryInvitationOrderField! -} - -""" -Properties by which repository invitation connections can be ordered. -""" -enum RepositoryInvitationOrderField { - """ - Order repository invitations by creation time - """ - CREATED_AT -} - -""" -The possible reasons a given repository could be in a locked state. -""" -enum RepositoryLockReason { - """ - The repository is locked due to a billing related reason. - """ - BILLING - - """ - The repository is locked due to a migration. - """ - MIGRATING - - """ - The repository is locked due to a move. - """ - MOVING - - """ - The repository is locked due to a rename. - """ - RENAME - - """ - The repository is locked due to a trade controls related reason. - """ - TRADE_RESTRICTION - - """ - The repository is locked due to an ownership transfer. - """ - TRANSFERRING_OWNERSHIP -} - -""" -A GitHub Enterprise Importer (GEI) repository migration. -""" -type RepositoryMigration implements Migration & Node { - """ - The migration flag to continue on error. - """ - continueOnError: Boolean! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: String - - """ - The reason the migration failed. - """ - failureReason: String - - """ - The Node ID of the RepositoryMigration object - """ - id: ID! - - """ - The URL for the migration log (expires 1 day after migration completes). - """ - migrationLogUrl: URI - - """ - The migration source. - """ - migrationSource: MigrationSource! - - """ - The target repository name. - """ - repositoryName: String! - - """ - The migration source URL, for example `https://github.com` or `https://monalisa.ghe.com`. - """ - sourceUrl: URI! - - """ - The migration state. - """ - state: MigrationState! - - """ - The number of warnings encountered for this migration. To review the warnings, - check the [Migration Log](https://docs.github.com/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer). - """ - warningsCount: Int! -} - -""" -A list of migrations. -""" -type RepositoryMigrationConnection { - """ - A list of edges. - """ - edges: [RepositoryMigrationEdge] - - """ - A list of nodes. - """ - nodes: [RepositoryMigration] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -Represents a repository migration. -""" -type RepositoryMigrationEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: RepositoryMigration -} - -""" -Ordering options for repository migrations. -""" -input RepositoryMigrationOrder { - """ - The ordering direction. - """ - direction: RepositoryMigrationOrderDirection! - - """ - The field to order repository migrations by. - """ - field: RepositoryMigrationOrderField! -} - -""" -Possible directions in which to order a list of repository migrations when provided an `orderBy` argument. -""" -enum RepositoryMigrationOrderDirection { - """ - Specifies an ascending order for a given `orderBy` argument. - """ - ASC - - """ - Specifies a descending order for a given `orderBy` argument. - """ - DESC -} - -""" -Properties by which repository migrations can be ordered. -""" -enum RepositoryMigrationOrderField { - """ - Order mannequins why when they were created. - """ - CREATED_AT -} - -""" -Parameters to be used for the repository_name condition -""" -type RepositoryNameConditionTarget { - """ - Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. - """ - exclude: [String!]! - - """ - Array of repository names or patterns to include. One of these patterns must - match for the condition to pass. Also accepts `~ALL` to include all repositories. - """ - include: [String!]! - - """ - Target changes that match these patterns will be prevented except by those with bypass permissions. - """ - protected: Boolean! -} - -""" -Parameters to be used for the repository_name condition -""" -input RepositoryNameConditionTargetInput { - """ - Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. - """ - exclude: [String!]! - - """ - Array of repository names or patterns to include. One of these patterns must - match for the condition to pass. Also accepts `~ALL` to include all repositories. - """ - include: [String!]! - - """ - Target changes that match these patterns will be prevented except by those with bypass permissions. - """ - protected: Boolean -} - -""" -Represents a object that belongs to a repository. -""" -interface RepositoryNode { - """ - The repository associated with this node. - """ - repository: Repository! -} - -""" -Ordering options for repository connections -""" -input RepositoryOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order repositories by. - """ - field: RepositoryOrderField! -} - -""" -Properties by which repository connections can be ordered. -""" -enum RepositoryOrderField { - """ - Order repositories by creation time - """ - CREATED_AT - - """ - Order repositories by name - """ - NAME - - """ - Order repositories by push time - """ - PUSHED_AT - - """ - Order repositories by number of stargazers - """ - STARGAZERS - - """ - Order repositories by update time - """ - UPDATED_AT -} - -""" -Represents an owner of a Repository. -""" -interface RepositoryOwner { - """ - A URL pointing to the owner's public avatar. - """ - avatarUrl( - """ - The size of the resulting square image. - """ - size: Int - ): URI! - - """ - The Node ID of the RepositoryOwner object - """ - id: ID! - - """ - The username used to login. - """ - login: String! - - """ - A list of repositories that the user owns. - """ - repositories( - """ - Array of viewer's affiliation options for repositories returned from the - connection. For example, OWNER will include only repositories that the - current viewer owns. - """ - affiliations: [RepositoryAffiliation] - - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - If non-null, filters repositories according to whether they have issues enabled - """ - hasIssuesEnabled: Boolean - - """ - If non-null, filters repositories according to whether they are archived and not maintained - """ - isArchived: Boolean - - """ - If non-null, filters repositories according to whether they are forks of another repository - """ - isFork: Boolean - - """ - If non-null, filters repositories according to whether they have been locked - """ - isLocked: Boolean - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for repositories returned from the connection - """ - orderBy: RepositoryOrder - - """ - Array of owner's affiliation options for repositories returned from the - connection. For example, OWNER will include only repositories that the - organization or user being viewed owns. - """ - ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR] - - """ - If non-null, filters repositories according to privacy. Internal - repositories are considered private; consider using the visibility argument - if only internal repositories are needed. Cannot be combined with the - visibility argument. - """ - privacy: RepositoryPrivacy - - """ - If non-null, filters repositories according to visibility. Cannot be combined with the privacy argument. - """ - visibility: RepositoryVisibility - ): RepositoryConnection! - - """ - Find Repository. - """ - repository( - """ - Follow repository renames. If disabled, a repository referenced by its old name will return an error. - """ - followRenames: Boolean = true - - """ - Name of Repository to find. - """ - name: String! - ): Repository - - """ - The HTTP URL for the owner. - """ - resourcePath: URI! - - """ - The HTTP URL for the owner. - """ - url: URI! -} - -""" -The access level to a repository -""" -enum RepositoryPermission { - """ - Can read, clone, and push to this repository. Can also manage issues, pull - requests, and repository settings, including adding collaborators - """ - ADMIN - - """ - Can read, clone, and push to this repository. They can also manage issues, pull requests, and some repository settings - """ - MAINTAIN - - """ - Can read and clone this repository. Can also open and comment on issues and pull requests - """ - READ - - """ - Can read and clone this repository. Can also manage issues and pull requests - """ - TRIAGE - - """ - Can read, clone, and push to this repository. Can also manage issues and pull requests - """ - WRITE -} - -""" -Information about the availability of features and limits for a repository based on its billing plan. -""" -type RepositoryPlanFeatures { - """ - Whether reviews can be automatically requested and enforced with a CODEOWNERS file - """ - codeowners: Boolean! - - """ - Whether pull requests can be created as or converted to draft - """ - draftPullRequests: Boolean! - - """ - Maximum number of users that can be assigned to an issue or pull request - """ - maximumAssignees: Int! - - """ - Maximum number of manually-requested reviews on a pull request - """ - maximumManualReviewRequests: Int! - - """ - Whether teams can be requested to review pull requests - """ - teamReviewRequests: Boolean! -} - -""" -The privacy of a repository -""" -enum RepositoryPrivacy { - """ - Private - """ - PRIVATE - - """ - Public - """ - PUBLIC -} - -""" -Parameters to be used for the repository_property condition -""" -type RepositoryPropertyConditionTarget { - """ - Array of repository properties that must not match. - """ - exclude: [PropertyTargetDefinition!]! - - """ - Array of repository properties that must match - """ - include: [PropertyTargetDefinition!]! -} - -""" -Parameters to be used for the repository_property condition -""" -input RepositoryPropertyConditionTargetInput { - """ - Array of repository properties that must not match. - """ - exclude: [PropertyTargetDefinitionInput!]! - - """ - Array of repository properties that must match - """ - include: [PropertyTargetDefinitionInput!]! -} - -""" -A repository rule. -""" -type RepositoryRule implements Node { - """ - The Node ID of the RepositoryRule object - """ - id: ID! - - """ - The parameters for this rule. - """ - parameters: RuleParameters - - """ - The repository ruleset associated with this rule configuration - """ - repositoryRuleset: RepositoryRuleset - - """ - The type of rule. - """ - type: RepositoryRuleType! -} - -""" -Set of conditions that determine if a ruleset will evaluate -""" -type RepositoryRuleConditions { - """ - Configuration for the ref_name condition - """ - refName: RefNameConditionTarget - - """ - Configuration for the repository_id condition - """ - repositoryId: RepositoryIdConditionTarget - - """ - Configuration for the repository_name condition - """ - repositoryName: RepositoryNameConditionTarget - - """ - Configuration for the repository_property condition - """ - repositoryProperty: RepositoryPropertyConditionTarget -} - -""" -Specifies the conditions required for a ruleset to evaluate -""" -input RepositoryRuleConditionsInput { - """ - Configuration for the ref_name condition - """ - refName: RefNameConditionTargetInput - - """ - Configuration for the repository_id condition - """ - repositoryId: RepositoryIdConditionTargetInput - - """ - Configuration for the repository_name condition - """ - repositoryName: RepositoryNameConditionTargetInput - - """ - Configuration for the repository_property condition - """ - repositoryProperty: RepositoryPropertyConditionTargetInput -} - -""" -The connection type for RepositoryRule. -""" -type RepositoryRuleConnection { - """ - A list of edges. - """ - edges: [RepositoryRuleEdge] - - """ - A list of nodes. - """ - nodes: [RepositoryRule] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type RepositoryRuleEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: RepositoryRule -} - -""" -Specifies the attributes for a new or updated rule. -""" -input RepositoryRuleInput { - """ - Optional ID of this rule when updating - """ - id: ID @possibleTypes(concreteTypes: ["RepositoryRule"]) - - """ - The parameters for the rule. - """ - parameters: RuleParametersInput - - """ - The type of rule to create. - """ - type: RepositoryRuleType! -} - -""" -Ordering options for repository rules. -""" -input RepositoryRuleOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order repository rules by. - """ - field: RepositoryRuleOrderField! -} - -""" -Properties by which repository rule connections can be ordered. -""" -enum RepositoryRuleOrderField { - """ - Order repository rules by created time - """ - CREATED_AT - - """ - Order repository rules by type - """ - TYPE - - """ - Order repository rules by updated time - """ - UPDATED_AT -} - -""" -The rule types supported in rulesets -""" -enum RepositoryRuleType { - """ - Authorization - """ - AUTHORIZATION - - """ - Branch name pattern - """ - BRANCH_NAME_PATTERN - - """ - Choose which tools must provide code scanning results before the reference is - updated. When configured, code scanning must be enabled and have results for - both the commit and the reference being updated. - """ - CODE_SCANNING - - """ - Committer email pattern - """ - COMMITTER_EMAIL_PATTERN - - """ - Commit author email pattern - """ - COMMIT_AUTHOR_EMAIL_PATTERN - - """ - Commit message pattern - """ - COMMIT_MESSAGE_PATTERN - - """ - Only allow users with bypass permission to create matching refs. - """ - CREATION - - """ - Only allow users with bypass permissions to delete matching refs. - """ - DELETION - - """ - Prevent commits that include files with specified file extensions from being - pushed to the commit graph. NOTE: Thie rule is in beta and subject to change - """ - FILE_EXTENSION_RESTRICTION - - """ - Prevent commits that include changes in specified file paths from being pushed - to the commit graph. NOTE: Thie rule is in beta and subject to change - """ - FILE_PATH_RESTRICTION - - """ - Branch is read-only. Users cannot push to the branch. - """ - LOCK_BRANCH - - """ - Prevent commits that include file paths that exceed a specified character - limit from being pushed to the commit graph. NOTE: Thie rule is in beta and - subject to change - """ - MAX_FILE_PATH_LENGTH - - """ - Prevent commits that exceed a specified file size limit from being pushed to - the commit. NOTE: Thie rule is in beta and subject to change - """ - MAX_FILE_SIZE - - """ - Max ref updates - """ - MAX_REF_UPDATES - - """ - Merges must be performed via a merge queue. - """ - MERGE_QUEUE - - """ - Merge queue locked ref - """ - MERGE_QUEUE_LOCKED_REF - - """ - Prevent users with push access from force pushing to refs. - """ - NON_FAST_FORWARD - - """ - Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. - """ - PULL_REQUEST - - """ - Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. - """ - REQUIRED_DEPLOYMENTS - - """ - Prevent merge commits from being pushed to matching refs. - """ - REQUIRED_LINEAR_HISTORY - - """ - When enabled, all conversations on code must be resolved before a pull request - can be merged into a branch that matches this rule. - """ - REQUIRED_REVIEW_THREAD_RESOLUTION - - """ - Commits pushed to matching refs must have verified signatures. - """ - REQUIRED_SIGNATURES - - """ - Choose which status checks must pass before the ref is updated. When enabled, - commits must first be pushed to another ref where the checks pass. - """ - REQUIRED_STATUS_CHECKS - - """ - Require all commits be made to a non-target branch and submitted via a pull - request and required workflow checks to pass before they can be merged. - """ - REQUIRED_WORKFLOW_STATUS_CHECKS - - """ - Secret scanning - """ - SECRET_SCANNING - - """ - Tag - """ - TAG - - """ - Tag name pattern - """ - TAG_NAME_PATTERN - - """ - Only allow users with bypass permission to update matching refs. - """ - UPDATE - - """ - Require all changes made to a targeted branch to pass the specified workflows before they can be merged. - """ - WORKFLOWS - - """ - Workflow files cannot be modified. - """ - WORKFLOW_UPDATES -} - -""" -A repository ruleset. -""" -type RepositoryRuleset implements Node { - """ - The actors that can bypass this ruleset - """ - bypassActors( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): RepositoryRulesetBypassActorConnection - - """ - The set of conditions that must evaluate to true for this ruleset to apply - """ - conditions: RepositoryRuleConditions! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The enforcement level of this ruleset - """ - enforcement: RuleEnforcement! - - """ - The Node ID of the RepositoryRuleset object - """ - id: ID! - - """ - Name of the ruleset. - """ - name: String! - - """ - List of rules. - """ - rules( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - The type of rule. - """ - type: RepositoryRuleType - ): RepositoryRuleConnection - - """ - Source of ruleset. - """ - source: RuleSource! - - """ - Target of the ruleset. - """ - target: RepositoryRulesetTarget - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -A team or app that has the ability to bypass a rules defined on a ruleset -""" -type RepositoryRulesetBypassActor implements Node { - """ - The actor that can bypass rules. - """ - actor: BypassActor - - """ - The mode for the bypass actor - """ - bypassMode: RepositoryRulesetBypassActorBypassMode - - """ - This actor represents the ability for a deploy key to bypass - """ - deployKey: Boolean! - - """ - The Node ID of the RepositoryRulesetBypassActor object - """ - id: ID! - - """ - This actor represents the ability for an organization owner to bypass - """ - organizationAdmin: Boolean! - - """ - If the actor is a repository role, the repository role's ID that can bypass - """ - repositoryRoleDatabaseId: Int - - """ - If the actor is a repository role, the repository role's name that can bypass - """ - repositoryRoleName: String - - """ - Identifies the ruleset associated with the allowed actor - """ - repositoryRuleset: RepositoryRuleset -} - -""" -The bypass mode for a specific actor on a ruleset. -""" -enum RepositoryRulesetBypassActorBypassMode { - """ - The actor can always bypass rules - """ - ALWAYS - - """ - The actor can only bypass rules via a pull request - """ - PULL_REQUEST -} - -""" -The connection type for RepositoryRulesetBypassActor. -""" -type RepositoryRulesetBypassActorConnection { - """ - A list of edges. - """ - edges: [RepositoryRulesetBypassActorEdge] - - """ - A list of nodes. - """ - nodes: [RepositoryRulesetBypassActor] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type RepositoryRulesetBypassActorEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: RepositoryRulesetBypassActor -} - -""" -Specifies the attributes for a new or updated ruleset bypass actor. Only one of -`actor_id`, `repository_role_database_id`, `organization_admin`, or `deploy_key` -should be specified. -""" -input RepositoryRulesetBypassActorInput { - """ - For Team and Integration bypasses, the Team or Integration ID - """ - actorId: ID - - """ - The bypass mode for this actor. - """ - bypassMode: RepositoryRulesetBypassActorBypassMode! - - """ - For deploy key bypasses, true. Can only use ALWAYS as the bypass mode - """ - deployKey: Boolean - - """ - For organization owner bypasses, true - """ - organizationAdmin: Boolean - - """ - For role bypasses, the role database ID - """ - repositoryRoleDatabaseId: Int -} - -""" -The connection type for RepositoryRuleset. -""" -type RepositoryRulesetConnection { - """ - A list of edges. - """ - edges: [RepositoryRulesetEdge] - - """ - A list of nodes. - """ - nodes: [RepositoryRuleset] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type RepositoryRulesetEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: RepositoryRuleset -} - -""" -The targets supported for rulesets. NOTE: The push target is in beta and subject to change. -""" -enum RepositoryRulesetTarget { - """ - Branch - """ - BRANCH - - """ - Push - """ - PUSH - - """ - Tag - """ - TAG -} - -""" -A repository-topic connects a repository to a topic. -""" -type RepositoryTopic implements Node & UniformResourceLocatable { - """ - The Node ID of the RepositoryTopic object - """ - id: ID! - - """ - The HTTP path for this repository-topic. - """ - resourcePath: URI! - - """ - The topic. - """ - topic: Topic! - - """ - The HTTP URL for this repository-topic. - """ - url: URI! -} - -""" -The connection type for RepositoryTopic. -""" -type RepositoryTopicConnection { - """ - A list of edges. - """ - edges: [RepositoryTopicEdge] - - """ - A list of nodes. - """ - nodes: [RepositoryTopic] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type RepositoryTopicEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: RepositoryTopic -} - -""" -The repository's visibility level. -""" -enum RepositoryVisibility { - """ - The repository is visible only to users in the same business. - """ - INTERNAL - - """ - The repository is visible only to those with explicit access. - """ - PRIVATE - - """ - The repository is visible to everyone. - """ - PUBLIC -} - -""" -Audit log entry for a repository_visibility_change.disable event. -""" -type RepositoryVisibilityChangeDisableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The HTTP path for this enterprise. - """ - enterpriseResourcePath: URI - - """ - The slug of the enterprise. - """ - enterpriseSlug: String - - """ - The HTTP URL for this enterprise. - """ - enterpriseUrl: URI - - """ - The Node ID of the RepositoryVisibilityChangeDisableAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a repository_visibility_change.enable event. -""" -type RepositoryVisibilityChangeEnableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The HTTP path for this enterprise. - """ - enterpriseResourcePath: URI - - """ - The slug of the enterprise. - """ - enterpriseSlug: String - - """ - The HTTP URL for this enterprise. - """ - enterpriseUrl: URI - - """ - The Node ID of the RepositoryVisibilityChangeEnableAuditEntry object - """ - id: ID! - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -A Dependabot alert for a repository with a dependency affected by a security vulnerability. -""" -type RepositoryVulnerabilityAlert implements Node & RepositoryNode { - """ - When was the alert auto-dismissed? - """ - autoDismissedAt: DateTime - - """ - When was the alert created? - """ - createdAt: DateTime! - - """ - The associated Dependabot update - """ - dependabotUpdate: DependabotUpdate - - """ - The scope of an alert's dependency - """ - dependencyScope: RepositoryVulnerabilityAlertDependencyScope - - """ - Comment explaining the reason the alert was dismissed - """ - dismissComment: String - - """ - The reason the alert was dismissed - """ - dismissReason: String - - """ - When was the alert dismissed? - """ - dismissedAt: DateTime - - """ - The user who dismissed the alert - """ - dismisser: User - - """ - When was the alert fixed? - """ - fixedAt: DateTime - - """ - The Node ID of the RepositoryVulnerabilityAlert object - """ - id: ID! - - """ - Identifies the alert number. - """ - number: Int! - - """ - The associated repository - """ - repository: Repository! - - """ - The associated security advisory - """ - securityAdvisory: SecurityAdvisory - - """ - The associated security vulnerability - """ - securityVulnerability: SecurityVulnerability - - """ - Identifies the state of the alert. - """ - state: RepositoryVulnerabilityAlertState! - - """ - The vulnerable manifest filename - """ - vulnerableManifestFilename: String! - - """ - The vulnerable manifest path - """ - vulnerableManifestPath: String! - - """ - The vulnerable requirements - """ - vulnerableRequirements: String -} - -""" -The connection type for RepositoryVulnerabilityAlert. -""" -type RepositoryVulnerabilityAlertConnection { - """ - A list of edges. - """ - edges: [RepositoryVulnerabilityAlertEdge] - - """ - A list of nodes. - """ - nodes: [RepositoryVulnerabilityAlert] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -The possible scopes of an alert's dependency. -""" -enum RepositoryVulnerabilityAlertDependencyScope { - """ - A dependency that is only used in development - """ - DEVELOPMENT - - """ - A dependency that is leveraged during application runtime - """ - RUNTIME -} - -""" -An edge in a connection. -""" -type RepositoryVulnerabilityAlertEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: RepositoryVulnerabilityAlert -} - -""" -The possible states of an alert -""" -enum RepositoryVulnerabilityAlertState { - """ - An alert that has been automatically closed by Dependabot. - """ - AUTO_DISMISSED - - """ - An alert that has been manually closed by a user. - """ - DISMISSED - - """ - An alert that has been resolved by a code change. - """ - FIXED - - """ - An alert that is still open. - """ - OPEN -} - -""" -Autogenerated input type of RequestReviews -""" -input RequestReviewsInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the pull request to modify. - """ - pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"]) - - """ - The Node IDs of the team to request. - """ - teamIds: [ID!] @possibleTypes(concreteTypes: ["Team"]) - - """ - Add users to the set rather than replace. - """ - union: Boolean = false - - """ - The Node IDs of the user to request. - """ - userIds: [ID!] @possibleTypes(concreteTypes: ["User"]) -} - -""" -Autogenerated return type of RequestReviews -""" -type RequestReviewsPayload { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The pull request that is getting requests. - """ - pullRequest: PullRequest - - """ - The edge from the pull request to the requested reviewers. - """ - requestedReviewersEdge: UserEdge -} - -""" -The possible states that can be requested when creating a check run. -""" -enum RequestableCheckStatusState { - """ - The check suite or run has been completed. - """ - COMPLETED - - """ - The check suite or run is in progress. - """ - IN_PROGRESS - - """ - The check suite or run is in pending state. - """ - PENDING - - """ - The check suite or run has been queued. - """ - QUEUED - - """ - The check suite or run is in waiting state. - """ - WAITING -} - -""" -Types that can be requested reviewers. -""" -union RequestedReviewer = Bot | Mannequin | Team | User - -""" -The connection type for RequestedReviewer. -""" -type RequestedReviewerConnection { - """ - A list of edges. - """ - edges: [RequestedReviewerEdge] - - """ - A list of nodes. - """ - nodes: [RequestedReviewer] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type RequestedReviewerEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: RequestedReviewer -} - -""" -Represents a type that can be required by a pull request for merging. -""" -interface RequirableByPullRequest { - """ - Whether this is required to pass before merging for a specific pull request. - """ - isRequired( - """ - The id of the pull request this is required for - """ - pullRequestId: ID - - """ - The number of the pull request this is required for - """ - pullRequestNumber: Int - ): Boolean! -} - -""" -Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. -""" -type RequiredDeploymentsParameters { - """ - The environments that must be successfully deployed to before branches can be merged. - """ - requiredDeploymentEnvironments: [String!]! -} - -""" -Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. -""" -input RequiredDeploymentsParametersInput { - """ - The environments that must be successfully deployed to before branches can be merged. - """ - requiredDeploymentEnvironments: [String!]! -} - -""" -Represents a required status check for a protected branch, but not any specific run of that check. -""" -type RequiredStatusCheckDescription { - """ - The App that must provide this status in order for it to be accepted. - """ - app: App - - """ - The name of this status. - """ - context: String! -} - -""" -Specifies the attributes for a new or updated required status check. -""" -input RequiredStatusCheckInput { - """ - The ID of the App that must set the status in order for it to be accepted. - Omit this value to use whichever app has recently been setting this status, or - use "any" to allow any app to set the status. - """ - appId: ID - - """ - Status check context that must pass for commits to be accepted to the matching branch. - """ - context: String! -} - -""" -Choose which status checks must pass before the ref is updated. When enabled, -commits must first be pushed to another ref where the checks pass. -""" -type RequiredStatusChecksParameters { - """ - Status checks that are required. - """ - requiredStatusChecks: [StatusCheckConfiguration!]! - - """ - Whether pull requests targeting a matching branch must be tested with the - latest code. This setting will not take effect unless at least one status - check is enabled. - """ - strictRequiredStatusChecksPolicy: Boolean! -} - -""" -Choose which status checks must pass before the ref is updated. When enabled, -commits must first be pushed to another ref where the checks pass. -""" -input RequiredStatusChecksParametersInput { - """ - Status checks that are required. - """ - requiredStatusChecks: [StatusCheckConfigurationInput!]! - - """ - Whether pull requests targeting a matching branch must be tested with the - latest code. This setting will not take effect unless at least one status - check is enabled. - """ - strictRequiredStatusChecksPolicy: Boolean! -} - -""" -Autogenerated input type of RerequestCheckSuite -""" -input RerequestCheckSuiteInput { - """ - The Node ID of the check suite. - """ - checkSuiteId: ID! @possibleTypes(concreteTypes: ["CheckSuite"]) - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the repository. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) -} - -""" -Autogenerated return type of RerequestCheckSuite -""" -type RerequestCheckSuitePayload { - """ - The requested check suite. - """ - checkSuite: CheckSuite - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of ResolveReviewThread -""" -input ResolveReviewThreadInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the thread to resolve - """ - threadId: ID! @possibleTypes(concreteTypes: ["PullRequestReviewThread"]) -} - -""" -Autogenerated return type of ResolveReviewThread -""" -type ResolveReviewThreadPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The thread to resolve. - """ - thread: PullRequestReviewThread -} - -""" -Represents a private contribution a user made on GitHub. -""" -type RestrictedContribution implements Contribution { - """ - Whether this contribution is associated with a record you do not have access to. For - example, your own 'first issue' contribution may have been made on a repository you can no - longer access. - """ - isRestricted: Boolean! - - """ - When this contribution was made. - """ - occurredAt: DateTime! - - """ - The HTTP path for this contribution. - """ - resourcePath: URI! - - """ - The HTTP URL for this contribution. - """ - url: URI! - - """ - The user who made this contribution. - """ - user: User! -} - -""" -Autogenerated input type of RevertPullRequest -""" -input RevertPullRequestInput { - """ - The description of the revert pull request. - """ - body: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Indicates whether the revert pull request should be a draft. - """ - draft: Boolean = false - - """ - The ID of the pull request to revert. - """ - pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"]) - - """ - The title of the revert pull request. - """ - title: String -} - -""" -Autogenerated return type of RevertPullRequest -""" -type RevertPullRequestPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The pull request that was reverted. - """ - pullRequest: PullRequest - - """ - The new pull request that reverts the input pull request. - """ - revertPullRequest: PullRequest -} - -""" -A user, team, or app who has the ability to dismiss a review on a protected branch. -""" -type ReviewDismissalAllowance implements Node { - """ - The actor that can dismiss. - """ - actor: ReviewDismissalAllowanceActor - - """ - Identifies the branch protection rule associated with the allowed user, team, or app. - """ - branchProtectionRule: BranchProtectionRule - - """ - The Node ID of the ReviewDismissalAllowance object - """ - id: ID! -} - -""" -Types that can be an actor. -""" -union ReviewDismissalAllowanceActor = App | Team | User - -""" -The connection type for ReviewDismissalAllowance. -""" -type ReviewDismissalAllowanceConnection { - """ - A list of edges. - """ - edges: [ReviewDismissalAllowanceEdge] - - """ - A list of nodes. - """ - nodes: [ReviewDismissalAllowance] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type ReviewDismissalAllowanceEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: ReviewDismissalAllowance -} - -""" -Represents a 'review_dismissed' event on a given issue or pull request. -""" -type ReviewDismissedEvent implements Node & UniformResourceLocatable { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - Identifies the optional message associated with the 'review_dismissed' event. - """ - dismissalMessage: String - - """ - Identifies the optional message associated with the event, rendered to HTML. - """ - dismissalMessageHTML: String - - """ - The Node ID of the ReviewDismissedEvent object - """ - id: ID! - - """ - Identifies the previous state of the review with the 'review_dismissed' event. - """ - previousReviewState: PullRequestReviewState! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest! - - """ - Identifies the commit which caused the review to become stale. - """ - pullRequestCommit: PullRequestCommit - - """ - The HTTP path for this review dismissed event. - """ - resourcePath: URI! - - """ - Identifies the review associated with the 'review_dismissed' event. - """ - review: PullRequestReview - - """ - The HTTP URL for this review dismissed event. - """ - url: URI! -} - -""" -A request for a user to review a pull request. -""" -type ReviewRequest implements Node { - """ - Whether this request was created for a code owner - """ - asCodeOwner: Boolean! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the ReviewRequest object - """ - id: ID! - - """ - Identifies the pull request associated with this review request. - """ - pullRequest: PullRequest! - - """ - The reviewer that is requested. - """ - requestedReviewer: RequestedReviewer -} - -""" -The connection type for ReviewRequest. -""" -type ReviewRequestConnection { - """ - A list of edges. - """ - edges: [ReviewRequestEdge] - - """ - A list of nodes. - """ - nodes: [ReviewRequest] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type ReviewRequestEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: ReviewRequest -} - -""" -Represents an 'review_request_removed' event on a given pull request. -""" -type ReviewRequestRemovedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the ReviewRequestRemovedEvent object - """ - id: ID! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest! - - """ - Identifies the reviewer whose review request was removed. - """ - requestedReviewer: RequestedReviewer -} - -""" -Represents an 'review_requested' event on a given pull request. -""" -type ReviewRequestedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the ReviewRequestedEvent object - """ - id: ID! - - """ - PullRequest referenced by event. - """ - pullRequest: PullRequest! - - """ - Identifies the reviewer whose review was requested. - """ - requestedReviewer: RequestedReviewer -} - -""" -A hovercard context with a message describing the current code review state of the pull -request. -""" -type ReviewStatusHovercardContext implements HovercardContext { - """ - A string describing this context - """ - message: String! - - """ - An octicon to accompany this context - """ - octicon: String! - - """ - The current status of the pull request with respect to code review. - """ - reviewDecision: PullRequestReviewDecision -} - -""" -Autogenerated input type of RevokeEnterpriseOrganizationsMigratorRole -""" -input RevokeEnterpriseOrganizationsMigratorRoleInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the enterprise to which all organizations managed by it will be granted the migrator role. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The login of the user to revoke the migrator role - """ - login: String! -} - -""" -Autogenerated return type of RevokeEnterpriseOrganizationsMigratorRole -""" -type RevokeEnterpriseOrganizationsMigratorRolePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The organizations that had the migrator role revoked for the given user. - """ - organizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): OrganizationConnection -} - -""" -Autogenerated input type of RevokeMigratorRole -""" -input RevokeMigratorRoleInput { - """ - The user login or Team slug to revoke the migrator role from. - """ - actor: String! - - """ - Specifies the type of the actor, can be either USER or TEAM. - """ - actorType: ActorType! - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the organization that the user/team belongs to. - """ - organizationId: ID! @possibleTypes(concreteTypes: ["Organization"]) -} - -""" -Autogenerated return type of RevokeMigratorRole -""" -type RevokeMigratorRolePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Did the operation succeed? - """ - success: Boolean -} - -""" -Possible roles a user may have in relation to an organization. -""" -enum RoleInOrganization { - """ - A user who is a direct member of the organization. - """ - DIRECT_MEMBER - - """ - A user with full administrative access to the organization. - """ - OWNER - - """ - A user who is unaffiliated with the organization. - """ - UNAFFILIATED -} - -""" -The level of enforcement for a rule or ruleset. -""" -enum RuleEnforcement { - """ - Rules will be enforced - """ - ACTIVE - - """ - Do not evaluate or enforce rules - """ - DISABLED - - """ - Allow admins to test rules before enforcing them. Admins can view insights on - the Rule Insights page (`evaluate` is only available with GitHub Enterprise). - """ - EVALUATE -} - -""" -Types which can be parameters for `RepositoryRule` objects. -""" -union RuleParameters = - BranchNamePatternParameters - | CodeScanningParameters - | CommitAuthorEmailPatternParameters - | CommitMessagePatternParameters - | CommitterEmailPatternParameters - | FileExtensionRestrictionParameters - | FilePathRestrictionParameters - | MaxFilePathLengthParameters - | MaxFileSizeParameters - | PullRequestParameters - | RequiredDeploymentsParameters - | RequiredStatusChecksParameters - | TagNamePatternParameters - | UpdateParameters - | WorkflowsParameters - -""" -Specifies the parameters for a `RepositoryRule` object. Only one of the fields should be specified. -""" -input RuleParametersInput { - """ - Parameters used for the `branch_name_pattern` rule type - """ - branchNamePattern: BranchNamePatternParametersInput - - """ - Parameters used for the `code_scanning` rule type - """ - codeScanning: CodeScanningParametersInput - - """ - Parameters used for the `commit_author_email_pattern` rule type - """ - commitAuthorEmailPattern: CommitAuthorEmailPatternParametersInput - - """ - Parameters used for the `commit_message_pattern` rule type - """ - commitMessagePattern: CommitMessagePatternParametersInput - - """ - Parameters used for the `committer_email_pattern` rule type - """ - committerEmailPattern: CommitterEmailPatternParametersInput - - """ - Parameters used for the `file_extension_restriction` rule type - """ - fileExtensionRestriction: FileExtensionRestrictionParametersInput - - """ - Parameters used for the `file_path_restriction` rule type - """ - filePathRestriction: FilePathRestrictionParametersInput - - """ - Parameters used for the `max_file_path_length` rule type - """ - maxFilePathLength: MaxFilePathLengthParametersInput - - """ - Parameters used for the `max_file_size` rule type - """ - maxFileSize: MaxFileSizeParametersInput - - """ - Parameters used for the `pull_request` rule type - """ - pullRequest: PullRequestParametersInput - - """ - Parameters used for the `required_deployments` rule type - """ - requiredDeployments: RequiredDeploymentsParametersInput - - """ - Parameters used for the `required_status_checks` rule type - """ - requiredStatusChecks: RequiredStatusChecksParametersInput - - """ - Parameters used for the `tag_name_pattern` rule type - """ - tagNamePattern: TagNamePatternParametersInput - - """ - Parameters used for the `update` rule type - """ - update: UpdateParametersInput - - """ - Parameters used for the `workflows` rule type - """ - workflows: WorkflowsParametersInput -} - -""" -Types which can have `RepositoryRule` objects. -""" -union RuleSource = Organization | Repository - -""" -The possible digest algorithms used to sign SAML requests for an identity provider. -""" -enum SamlDigestAlgorithm { - """ - SHA1 - """ - SHA1 - - """ - SHA256 - """ - SHA256 - - """ - SHA384 - """ - SHA384 - - """ - SHA512 - """ - SHA512 -} - -""" -The possible signature algorithms used to sign SAML requests for a Identity Provider. -""" -enum SamlSignatureAlgorithm { - """ - RSA-SHA1 - """ - RSA_SHA1 - - """ - RSA-SHA256 - """ - RSA_SHA256 - - """ - RSA-SHA384 - """ - RSA_SHA384 - - """ - RSA-SHA512 - """ - RSA_SHA512 -} - -""" -A Saved Reply is text a user can use to reply quickly. -""" -type SavedReply implements Node { - """ - The body of the saved reply. - """ - body: String! - - """ - The saved reply body rendered to HTML. - """ - bodyHTML: HTML! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the SavedReply object - """ - id: ID! - - """ - The title of the saved reply. - """ - title: String! - - """ - The user that saved this reply. - """ - user: Actor -} - -""" -The connection type for SavedReply. -""" -type SavedReplyConnection { - """ - A list of edges. - """ - edges: [SavedReplyEdge] - - """ - A list of nodes. - """ - nodes: [SavedReply] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type SavedReplyEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: SavedReply -} - -""" -Ordering options for saved reply connections. -""" -input SavedReplyOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order saved replies by. - """ - field: SavedReplyOrderField! -} - -""" -Properties by which saved reply connections can be ordered. -""" -enum SavedReplyOrderField { - """ - Order saved reply by when they were updated. - """ - UPDATED_AT -} - -""" -The results of a search. -""" -union SearchResultItem = App | Discussion | Issue | Organization | PullRequest | Repository | User - -""" -A list of results that matched against a search query. Regardless of the number -of matches, a maximum of 1,000 results will be available across all types, -potentially split across many pages. -""" -type SearchResultItemConnection { - """ - The total number of pieces of code that matched the search query. Regardless - of the total number of matches, a maximum of 1,000 results will be available - across all types. - """ - codeCount: Int! - - """ - The total number of discussions that matched the search query. Regardless of - the total number of matches, a maximum of 1,000 results will be available - across all types. - """ - discussionCount: Int! - - """ - A list of edges. - """ - edges: [SearchResultItemEdge] - - """ - The total number of issues that matched the search query. Regardless of the - total number of matches, a maximum of 1,000 results will be available across all types. - """ - issueCount: Int! - - """ - A list of nodes. - """ - nodes: [SearchResultItem] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - The total number of repositories that matched the search query. Regardless of - the total number of matches, a maximum of 1,000 results will be available - across all types. - """ - repositoryCount: Int! - - """ - The total number of users that matched the search query. Regardless of the - total number of matches, a maximum of 1,000 results will be available across all types. - """ - userCount: Int! - - """ - The total number of wiki pages that matched the search query. Regardless of - the total number of matches, a maximum of 1,000 results will be available - across all types. - """ - wikiCount: Int! -} - -""" -An edge in a connection. -""" -type SearchResultItemEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: SearchResultItem - - """ - Text matches on the result found. - """ - textMatches: [TextMatch] -} - -""" -Represents the individual results of a search. -""" -enum SearchType { - """ - Returns matching discussions in repositories. - """ - DISCUSSION - - """ - Returns results matching issues in repositories. - """ - ISSUE - - """ - Returns results matching repositories. - """ - REPOSITORY - - """ - Returns results matching users and organizations on GitHub. - """ - USER -} - -""" -A GitHub Security Advisory -""" -type SecurityAdvisory implements Node { - """ - The classification of the advisory - """ - classification: SecurityAdvisoryClassification! - - """ - The CVSS associated with this advisory - """ - cvss: CVSS! - - """ - CWEs associated with this Advisory - """ - cwes( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): CWEConnection! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - This is a long plaintext description of the advisory - """ - description: String! - - """ - The GitHub Security Advisory ID - """ - ghsaId: String! - - """ - The Node ID of the SecurityAdvisory object - """ - id: ID! - - """ - A list of identifiers for this advisory - """ - identifiers: [SecurityAdvisoryIdentifier!]! - - """ - The permalink for the advisory's dependabot alerts page - """ - notificationsPermalink: URI - - """ - The organization that originated the advisory - """ - origin: String! - - """ - The permalink for the advisory - """ - permalink: URI - - """ - When the advisory was published - """ - publishedAt: DateTime! - - """ - A list of references for this advisory - """ - references: [SecurityAdvisoryReference!]! - - """ - The severity of the advisory - """ - severity: SecurityAdvisorySeverity! - - """ - A short plaintext summary of the advisory - """ - summary: String! - - """ - When the advisory was last updated - """ - updatedAt: DateTime! - - """ - Vulnerabilities associated with this Advisory - """ - vulnerabilities( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - A list of advisory classifications to filter vulnerabilities by. - """ - classifications: [SecurityAdvisoryClassification!] - - """ - An ecosystem to filter vulnerabilities by. - """ - ecosystem: SecurityAdvisoryEcosystem - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - A package name to filter vulnerabilities by. - """ - package: String - - """ - A list of severities to filter vulnerabilities by. - """ - severities: [SecurityAdvisorySeverity!] - ): SecurityVulnerabilityConnection! - - """ - When the advisory was withdrawn, if it has been withdrawn - """ - withdrawnAt: DateTime -} - -""" -Classification of the advisory. -""" -enum SecurityAdvisoryClassification { - """ - Classification of general advisories. - """ - GENERAL - - """ - Classification of malware advisories. - """ - MALWARE -} - -""" -The connection type for SecurityAdvisory. -""" -type SecurityAdvisoryConnection { - """ - A list of edges. - """ - edges: [SecurityAdvisoryEdge] - - """ - A list of nodes. - """ - nodes: [SecurityAdvisory] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -The possible ecosystems of a security vulnerability's package. -""" -enum SecurityAdvisoryEcosystem { - """ - GitHub Actions - """ - ACTIONS - - """ - PHP packages hosted at packagist.org - """ - COMPOSER - - """ - Erlang/Elixir packages hosted at hex.pm - """ - ERLANG - - """ - Go modules - """ - GO - - """ - Java artifacts hosted at the Maven central repository - """ - MAVEN - - """ - JavaScript packages hosted at npmjs.com - """ - NPM - - """ - .NET packages hosted at the NuGet Gallery - """ - NUGET - - """ - Python packages hosted at PyPI.org - """ - PIP - - """ - Dart packages hosted at pub.dev - """ - PUB - - """ - Ruby gems hosted at RubyGems.org - """ - RUBYGEMS - - """ - Rust crates - """ - RUST - - """ - Swift packages - """ - SWIFT -} - -""" -An edge in a connection. -""" -type SecurityAdvisoryEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: SecurityAdvisory -} - -""" -A GitHub Security Advisory Identifier -""" -type SecurityAdvisoryIdentifier { - """ - The identifier type, e.g. GHSA, CVE - """ - type: String! - - """ - The identifier - """ - value: String! -} - -""" -An individual package -""" -type SecurityAdvisoryPackage { - """ - The ecosystem the package belongs to, e.g. RUBYGEMS, NPM - """ - ecosystem: SecurityAdvisoryEcosystem! - - """ - The package name - """ - name: String! -} - -""" -An individual package version -""" -type SecurityAdvisoryPackageVersion { - """ - The package name or version - """ - identifier: String! -} - -""" -A GitHub Security Advisory Reference -""" -type SecurityAdvisoryReference { - """ - A publicly accessible reference - """ - url: URI! -} - -""" -Severity of the vulnerability. -""" -enum SecurityAdvisorySeverity { - """ - Critical. - """ - CRITICAL - - """ - High. - """ - HIGH - - """ - Low. - """ - LOW - - """ - Moderate. - """ - MODERATE -} - -""" -An individual vulnerability within an Advisory -""" -type SecurityVulnerability { - """ - The Advisory associated with this Vulnerability - """ - advisory: SecurityAdvisory! - - """ - The first version containing a fix for the vulnerability - """ - firstPatchedVersion: SecurityAdvisoryPackageVersion - - """ - A description of the vulnerable package - """ - package: SecurityAdvisoryPackage! - - """ - The severity of the vulnerability within this package - """ - severity: SecurityAdvisorySeverity! - - """ - When the vulnerability was last updated - """ - updatedAt: DateTime! - - """ - A string that describes the vulnerable package versions. - This string follows a basic syntax with a few forms. - + `= 0.2.0` denotes a single vulnerable version. - + `<= 1.0.8` denotes a version range up to and including the specified version - + `< 0.1.11` denotes a version range up to, but excluding, the specified version - + `>= 4.3.0, < 4.3.5` denotes a version range with a known minimum and maximum version. - + `>= 0.0.1` denotes a version range with a known minimum, but no known maximum - """ - vulnerableVersionRange: String! -} - -""" -The connection type for SecurityVulnerability. -""" -type SecurityVulnerabilityConnection { - """ - A list of edges. - """ - edges: [SecurityVulnerabilityEdge] - - """ - A list of nodes. - """ - nodes: [SecurityVulnerability] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type SecurityVulnerabilityEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: SecurityVulnerability -} - -""" -Represents an S/MIME signature on a Commit or Tag. -""" -type SmimeSignature implements GitSignature { - """ - Email used to sign this object. - """ - email: String! - - """ - True if the signature is valid and verified by GitHub. - """ - isValid: Boolean! - - """ - Payload for GPG signing object. Raw ODB object without the signature header. - """ - payload: String! - - """ - ASCII-armored signature header from object. - """ - signature: String! - - """ - GitHub user corresponding to the email signing this commit. - """ - signer: User - - """ - The state of this signature. `VALID` if signature is valid and verified by - GitHub, otherwise represents reason why signature is considered invalid. - """ - state: GitSignatureState! - - """ - True if the signature was made with GitHub's signing key. - """ - wasSignedByGitHub: Boolean! -} - -""" -Social media profile associated with a user. -""" -type SocialAccount { - """ - Name of the social media account as it appears on the profile. - """ - displayName: String! - - """ - Software or company that hosts the social media account. - """ - provider: SocialAccountProvider! - - """ - URL of the social media account. - """ - url: URI! -} - -""" -The connection type for SocialAccount. -""" -type SocialAccountConnection { - """ - A list of edges. - """ - edges: [SocialAccountEdge] - - """ - A list of nodes. - """ - nodes: [SocialAccount] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type SocialAccountEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: SocialAccount -} - -""" -Software or company that hosts social media accounts. -""" -enum SocialAccountProvider { - """ - Social media and networking website. - """ - FACEBOOK - - """ - Catch-all for social media providers that do not yet have specific handling. - """ - GENERIC - - """ - Fork of Mastodon with a greater focus on local posting. - """ - HOMETOWN - - """ - Social media website with a focus on photo and video sharing. - """ - INSTAGRAM - - """ - Professional networking website. - """ - LINKEDIN - - """ - Open-source federated microblogging service. - """ - MASTODON - - """ - JavaScript package registry. - """ - NPM - - """ - Social news aggregation and discussion website. - """ - REDDIT - - """ - Live-streaming service. - """ - TWITCH - - """ - Microblogging website. - """ - TWITTER - - """ - Online video platform. - """ - YOUTUBE -} - -""" -The possible default commit messages for squash merges. -""" -enum SquashMergeCommitMessage { - """ - Default to a blank commit message. - """ - BLANK - - """ - Default to the branch's commit messages. - """ - COMMIT_MESSAGES - - """ - Default to the pull request's body. - """ - PR_BODY -} - -""" -The possible default commit titles for squash merges. -""" -enum SquashMergeCommitTitle { - """ - Default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - """ - COMMIT_OR_PR_TITLE - - """ - Default to the pull request's title. - """ - PR_TITLE -} - -""" -Represents an SSH signature on a Commit or Tag. -""" -type SshSignature implements GitSignature { - """ - Email used to sign this object. - """ - email: String! - - """ - True if the signature is valid and verified by GitHub. - """ - isValid: Boolean! - - """ - Hex-encoded fingerprint of the key that signed this object. - """ - keyFingerprint: String - - """ - Payload for GPG signing object. Raw ODB object without the signature header. - """ - payload: String! - - """ - ASCII-armored signature header from object. - """ - signature: String! - - """ - GitHub user corresponding to the email signing this commit. - """ - signer: User - - """ - The state of this signature. `VALID` if signature is valid and verified by - GitHub, otherwise represents reason why signature is considered invalid. - """ - state: GitSignatureState! - - """ - True if the signature was made with GitHub's signing key. - """ - wasSignedByGitHub: Boolean! -} - -""" -Ways in which star connections can be ordered. -""" -input StarOrder { - """ - The direction in which to order nodes. - """ - direction: OrderDirection! - - """ - The field in which to order nodes by. - """ - field: StarOrderField! -} - -""" -Properties by which star connections can be ordered. -""" -enum StarOrderField { - """ - Allows ordering a list of stars by when they were created. - """ - STARRED_AT -} - -""" -The connection type for User. -""" -type StargazerConnection { - """ - A list of edges. - """ - edges: [StargazerEdge] - - """ - A list of nodes. - """ - nodes: [User] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -Represents a user that's starred a repository. -""" -type StargazerEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - node: User! - - """ - Identifies when the item was starred. - """ - starredAt: DateTime! -} - -""" -Things that can be starred. -""" -interface Starrable { - """ - The Node ID of the Starrable object - """ - id: ID! - - """ - Returns a count of how many stargazers there are on this object - """ - stargazerCount: Int! - - """ - A list of users who have starred this starrable. - """ - stargazers( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Order for connection - """ - orderBy: StarOrder - ): StargazerConnection! - - """ - Returns a boolean indicating whether the viewing user has starred this starrable. - """ - viewerHasStarred: Boolean! -} - -""" -The connection type for Repository. -""" -type StarredRepositoryConnection { - """ - A list of edges. - """ - edges: [StarredRepositoryEdge] - - """ - Is the list of stars for this user truncated? This is true for users that have many stars. - """ - isOverLimit: Boolean! - - """ - A list of nodes. - """ - nodes: [Repository] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -Represents a starred repository. -""" -type StarredRepositoryEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - node: Repository! - - """ - Identifies when the item was starred. - """ - starredAt: DateTime! -} - -""" -Autogenerated input type of StartOrganizationMigration -""" -input StartOrganizationMigrationInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The migration source access token. - """ - sourceAccessToken: String! - - """ - The URL of the organization to migrate. - """ - sourceOrgUrl: URI! - - """ - The ID of the enterprise the target organization belongs to. - """ - targetEnterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The name of the target organization. - """ - targetOrgName: String! -} - -""" -Autogenerated return type of StartOrganizationMigration -""" -type StartOrganizationMigrationPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new organization migration. - """ - orgMigration: OrganizationMigration -} - -""" -Autogenerated input type of StartRepositoryMigration -""" -input StartRepositoryMigrationInput { - """ - The migration source access token. - """ - accessToken: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Whether to continue the migration on error. Defaults to `true`. - """ - continueOnError: Boolean - - """ - The signed URL to access the user-uploaded git archive. - """ - gitArchiveUrl: String - - """ - The GitHub personal access token of the user importing to the target repository. - """ - githubPat: String - - """ - Whether to lock the source repository. - """ - lockSource: Boolean - - """ - The signed URL to access the user-uploaded metadata archive. - """ - metadataArchiveUrl: String - - """ - The ID of the organization that will own the imported repository. - """ - ownerId: ID! @possibleTypes(concreteTypes: ["Organization"]) - - """ - The name of the imported repository. - """ - repositoryName: String! - - """ - Whether to skip migrating releases for the repository. - """ - skipReleases: Boolean - - """ - The ID of the migration source. - """ - sourceId: ID! @possibleTypes(concreteTypes: ["MigrationSource"]) - - """ - The URL of the source repository. - """ - sourceRepositoryUrl: URI! - - """ - The visibility of the imported repository. - """ - targetRepoVisibility: String -} - -""" -Autogenerated return type of StartRepositoryMigration -""" -type StartRepositoryMigrationPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new repository migration. - """ - repositoryMigration: RepositoryMigration -} - -""" -Represents a commit status. -""" -type Status implements Node { - """ - A list of status contexts and check runs for this commit. - """ - combinedContexts( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): StatusCheckRollupContextConnection! - - """ - The commit this status is attached to. - """ - commit: Commit - - """ - Looks up an individual status context by context name. - """ - context( - """ - The context name. - """ - name: String! - ): StatusContext - - """ - The individual status contexts for this commit. - """ - contexts: [StatusContext!]! - - """ - The Node ID of the Status object - """ - id: ID! - - """ - The combined commit status. - """ - state: StatusState! -} - -""" -Required status check -""" -type StatusCheckConfiguration { - """ - The status check context name that must be present on the commit. - """ - context: String! - - """ - The optional integration ID that this status check must originate from. - """ - integrationId: Int -} - -""" -Required status check -""" -input StatusCheckConfigurationInput { - """ - The status check context name that must be present on the commit. - """ - context: String! - - """ - The optional integration ID that this status check must originate from. - """ - integrationId: Int -} - -""" -Represents the rollup for both the check runs and status for a commit. -""" -type StatusCheckRollup implements Node { - """ - The commit the status and check runs are attached to. - """ - commit: Commit - - """ - A list of status contexts and check runs for this commit. - """ - contexts( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): StatusCheckRollupContextConnection! - - """ - The Node ID of the StatusCheckRollup object - """ - id: ID! - - """ - The combined status for the commit. - """ - state: StatusState! -} - -""" -Types that can be inside a StatusCheckRollup context. -""" -union StatusCheckRollupContext = CheckRun | StatusContext - -""" -The connection type for StatusCheckRollupContext. -""" -type StatusCheckRollupContextConnection { - """ - The number of check runs in this rollup. - """ - checkRunCount: Int! - - """ - Counts of check runs by state. - """ - checkRunCountsByState: [CheckRunStateCount!] - - """ - A list of edges. - """ - edges: [StatusCheckRollupContextEdge] - - """ - A list of nodes. - """ - nodes: [StatusCheckRollupContext] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - The number of status contexts in this rollup. - """ - statusContextCount: Int! - - """ - Counts of status contexts by state. - """ - statusContextCountsByState: [StatusContextStateCount!] - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type StatusCheckRollupContextEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: StatusCheckRollupContext -} - -""" -Represents an individual commit status context -""" -type StatusContext implements Node & RequirableByPullRequest { - """ - The avatar of the OAuth application or the user that created the status - """ - avatarUrl( - """ - The size of the resulting square image. - """ - size: Int = 40 - ): URI - - """ - This commit this status context is attached to. - """ - commit: Commit - - """ - The name of this status context. - """ - context: String! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The actor who created this status context. - """ - creator: Actor - - """ - The description for this status context. - """ - description: String - - """ - The Node ID of the StatusContext object - """ - id: ID! - - """ - Whether this is required to pass before merging for a specific pull request. - """ - isRequired( - """ - The id of the pull request this is required for - """ - pullRequestId: ID - - """ - The number of the pull request this is required for - """ - pullRequestNumber: Int - ): Boolean! - - """ - The state of this status context. - """ - state: StatusState! - - """ - The URL for this status context. - """ - targetUrl: URI -} - -""" -Represents a count of the state of a status context. -""" -type StatusContextStateCount { - """ - The number of statuses with this state. - """ - count: Int! - - """ - The state of a status context. - """ - state: StatusState! -} - -""" -The possible commit status states. -""" -enum StatusState { - """ - Status is errored. - """ - ERROR - - """ - Status is expected. - """ - EXPECTED - - """ - Status is failing. - """ - FAILURE - - """ - Status is pending. - """ - PENDING - - """ - Status is successful. - """ - SUCCESS -} - -""" -Autogenerated input type of SubmitPullRequestReview -""" -input SubmitPullRequestReviewInput { - """ - The text field to set on the Pull Request Review. - """ - body: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The event to send to the Pull Request Review. - """ - event: PullRequestReviewEvent! - - """ - The Pull Request ID to submit any pending reviews. - """ - pullRequestId: ID @possibleTypes(concreteTypes: ["PullRequest"]) - - """ - The Pull Request Review ID to submit. - """ - pullRequestReviewId: ID @possibleTypes(concreteTypes: ["PullRequestReview"]) -} - -""" -Autogenerated return type of SubmitPullRequestReview -""" -type SubmitPullRequestReviewPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The submitted pull request review. - """ - pullRequestReview: PullRequestReview -} - -""" -A pointer to a repository at a specific revision embedded inside another repository. -""" -type Submodule { - """ - The branch of the upstream submodule for tracking updates - """ - branch: String - - """ - The git URL of the submodule repository - """ - gitUrl: URI! - - """ - The name of the submodule in .gitmodules - """ - name: String! - - """ - The name of the submodule in .gitmodules (Base64-encoded) - """ - nameRaw: Base64String! - - """ - The path in the superproject that this submodule is located in - """ - path: String! - - """ - The path in the superproject that this submodule is located in (Base64-encoded) - """ - pathRaw: Base64String! - - """ - The commit revision of the subproject repository being tracked by the submodule - """ - subprojectCommitOid: GitObjectID -} - -""" -The connection type for Submodule. -""" -type SubmoduleConnection { - """ - A list of edges. - """ - edges: [SubmoduleEdge] - - """ - A list of nodes. - """ - nodes: [Submodule] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type SubmoduleEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Submodule -} - -""" -Entities that can be subscribed to for web and email notifications. -""" -interface Subscribable { - """ - The Node ID of the Subscribable object - """ - id: ID! - - """ - Check if the viewer is able to change their subscription status for the repository. - """ - viewerCanSubscribe: Boolean! - - """ - Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. - """ - viewerSubscription: SubscriptionState -} - -""" -Entities that can be subscribed to for web and email notifications. -""" -interface SubscribableThread { - """ - The Node ID of the SubscribableThread object - """ - id: ID! - - """ - Identifies the viewer's thread subscription form action. - """ - viewerThreadSubscriptionFormAction: ThreadSubscriptionFormAction - - """ - Identifies the viewer's thread subscription status. - """ - viewerThreadSubscriptionStatus: ThreadSubscriptionState -} - -""" -Represents a 'subscribed' event on a given `Subscribable`. -""" -type SubscribedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the SubscribedEvent object - """ - id: ID! - - """ - Object referenced by event. - """ - subscribable: Subscribable! -} - -""" -The possible states of a subscription. -""" -enum SubscriptionState { - """ - The User is never notified. - """ - IGNORED - - """ - The User is notified of all conversations. - """ - SUBSCRIBED - - """ - The User is only notified when participating or @mentioned. - """ - UNSUBSCRIBED -} - -""" -A suggestion to review a pull request based on a user's commit history and review comments. -""" -type SuggestedReviewer { - """ - Is this suggestion based on past commits? - """ - isAuthor: Boolean! - - """ - Is this suggestion based on past review comments? - """ - isCommenter: Boolean! - - """ - Identifies the user suggested to review the pull request. - """ - reviewer: User! -} - -""" -Represents a Git tag. -""" -type Tag implements GitObject & Node { - """ - An abbreviated version of the Git object ID - """ - abbreviatedOid: String! - - """ - The HTTP path for this Git object - """ - commitResourcePath: URI! - - """ - The HTTP URL for this Git object - """ - commitUrl: URI! - - """ - The Node ID of the Tag object - """ - id: ID! - - """ - The Git tag message. - """ - message: String - - """ - The Git tag name. - """ - name: String! - - """ - The Git object ID - """ - oid: GitObjectID! - - """ - The Repository the Git object belongs to - """ - repository: Repository! - - """ - Details about the tag author. - """ - tagger: GitActor - - """ - The Git object the tag points to. - """ - target: GitObject! -} - -""" -Parameters to be used for the tag_name_pattern rule -""" -type TagNamePatternParameters { - """ - How this rule will appear to users. - """ - name: String - - """ - If true, the rule will fail if the pattern matches. - """ - negate: Boolean! - - """ - The operator to use for matching. - """ - operator: String! - - """ - The pattern to match with. - """ - pattern: String! -} - -""" -Parameters to be used for the tag_name_pattern rule -""" -input TagNamePatternParametersInput { - """ - How this rule will appear to users. - """ - name: String - - """ - If true, the rule will fail if the pattern matches. - """ - negate: Boolean - - """ - The operator to use for matching. - """ - operator: String! - - """ - The pattern to match with. - """ - pattern: String! -} - -""" -A team of users in an organization. -""" -type Team implements MemberStatusable & Node & Subscribable { - """ - A list of teams that are ancestors of this team. - """ - ancestors( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): TeamConnection! - - """ - A URL pointing to the team's avatar. - """ - avatarUrl( - """ - The size in pixels of the resulting square image. - """ - size: Int = 400 - ): URI - - """ - List of child teams belonging to this team - """ - childTeams( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Whether to list immediate child teams or all descendant child teams. - """ - immediateOnly: Boolean = true - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Order for connection - """ - orderBy: TeamOrder - - """ - User logins to filter by - """ - userLogins: [String!] - ): TeamConnection! - - """ - The slug corresponding to the organization and team. - """ - combinedSlug: String! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The description of the team. - """ - description: String - - """ - Find a team discussion by its number. - """ - discussion( - """ - The sequence number of the discussion to find. - """ - number: Int! - ): TeamDiscussion - - """ - A list of team discussions. - """ - discussions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - If provided, filters discussions according to whether or not they are pinned. - """ - isPinned: Boolean - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Order for connection - """ - orderBy: TeamDiscussionOrder - ): TeamDiscussionConnection! - - """ - The HTTP path for team discussions - """ - discussionsResourcePath: URI! - - """ - The HTTP URL for team discussions - """ - discussionsUrl: URI! - - """ - The HTTP path for editing this team - """ - editTeamResourcePath: URI! - - """ - The HTTP URL for editing this team - """ - editTeamUrl: URI! - - """ - The Node ID of the Team object - """ - id: ID! - - """ - A list of pending invitations for users to this team - """ - invitations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): OrganizationInvitationConnection - - """ - Get the status messages members of this entity have set that are either public or visible only to the organization. - """ - memberStatuses( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for user statuses returned from the connection. - """ - orderBy: UserStatusOrder = {field: UPDATED_AT, direction: DESC} - ): UserStatusConnection! - - """ - A list of users who are members of this team. - """ - members( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filter by membership type - """ - membership: TeamMembershipType = ALL - - """ - Order for the connection. - """ - orderBy: TeamMemberOrder - - """ - The search string to look for. - """ - query: String - - """ - Filter by team member role - """ - role: TeamMemberRole - ): TeamMemberConnection! - - """ - The HTTP path for the team' members - """ - membersResourcePath: URI! - - """ - The HTTP URL for the team' members - """ - membersUrl: URI! - - """ - The name of the team. - """ - name: String! - - """ - The HTTP path creating a new team - """ - newTeamResourcePath: URI! - - """ - The HTTP URL creating a new team - """ - newTeamUrl: URI! - - """ - The notification setting that the team has set. - """ - notificationSetting: TeamNotificationSetting! - - """ - The organization that owns this team. - """ - organization: Organization! - - """ - The parent team of the team. - """ - parentTeam: Team - - """ - The level of privacy the team has. - """ - privacy: TeamPrivacy! - - """ - A list of repositories this team has access to. - """ - repositories( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Order for the connection. - """ - orderBy: TeamRepositoryOrder - - """ - The search string to look for. Repositories will be returned where the name contains your search string. - """ - query: String - ): TeamRepositoryConnection! - - """ - The HTTP path for this team's repositories - """ - repositoriesResourcePath: URI! - - """ - The HTTP URL for this team's repositories - """ - repositoriesUrl: URI! - - """ - The HTTP path for this team - """ - resourcePath: URI! - - """ - What algorithm is used for review assignment for this team - """ - reviewRequestDelegationAlgorithm: TeamReviewAssignmentAlgorithm - - """ - True if review assignment is enabled for this team - """ - reviewRequestDelegationEnabled: Boolean! - - """ - How many team members are required for review assignment for this team - """ - reviewRequestDelegationMemberCount: Int - - """ - When assigning team members via delegation, whether the entire team should be notified as well. - """ - reviewRequestDelegationNotifyTeam: Boolean! - - """ - The slug corresponding to the team. - """ - slug: String! - - """ - The HTTP path for this team's teams - """ - teamsResourcePath: URI! - - """ - The HTTP URL for this team's teams - """ - teamsUrl: URI! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this team - """ - url: URI! - - """ - Team is adminable by the viewer. - """ - viewerCanAdminister: Boolean! - - """ - Check if the viewer is able to change their subscription status for the repository. - """ - viewerCanSubscribe: Boolean! - - """ - Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. - """ - viewerSubscription: SubscriptionState -} - -""" -Audit log entry for a team.add_member event. -""" -type TeamAddMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & TeamAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the TeamAddMemberAuditEntry object - """ - id: ID! - - """ - Whether the team was mapped to an LDAP Group. - """ - isLdapMapped: Boolean - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The team associated with the action - """ - team: Team - - """ - The name of the team - """ - teamName: String - - """ - The HTTP path for this team - """ - teamResourcePath: URI - - """ - The HTTP URL for this team - """ - teamUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a team.add_repository event. -""" -type TeamAddRepositoryAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData & TeamAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the TeamAddRepositoryAuditEntry object - """ - id: ID! - - """ - Whether the team was mapped to an LDAP Group. - """ - isLdapMapped: Boolean - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The team associated with the action - """ - team: Team - - """ - The name of the team - """ - teamName: String - - """ - The HTTP path for this team - """ - teamResourcePath: URI - - """ - The HTTP URL for this team - """ - teamUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Metadata for an audit entry with action team.* -""" -interface TeamAuditEntryData { - """ - The team associated with the action - """ - team: Team - - """ - The name of the team - """ - teamName: String - - """ - The HTTP path for this team - """ - teamResourcePath: URI - - """ - The HTTP URL for this team - """ - teamUrl: URI -} - -""" -Audit log entry for a team.change_parent_team event. -""" -type TeamChangeParentTeamAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & TeamAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the TeamChangeParentTeamAuditEntry object - """ - id: ID! - - """ - Whether the team was mapped to an LDAP Group. - """ - isLdapMapped: Boolean - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The new parent team. - """ - parentTeam: Team - - """ - The name of the new parent team - """ - parentTeamName: String - - """ - The name of the former parent team - """ - parentTeamNameWas: String - - """ - The HTTP path for the parent team - """ - parentTeamResourcePath: URI - - """ - The HTTP URL for the parent team - """ - parentTeamUrl: URI - - """ - The former parent team. - """ - parentTeamWas: Team - - """ - The HTTP path for the previous parent team - """ - parentTeamWasResourcePath: URI - - """ - The HTTP URL for the previous parent team - """ - parentTeamWasUrl: URI - - """ - The team associated with the action - """ - team: Team - - """ - The name of the team - """ - teamName: String - - """ - The HTTP path for this team - """ - teamResourcePath: URI - - """ - The HTTP URL for this team - """ - teamUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -The connection type for Team. -""" -type TeamConnection { - """ - A list of edges. - """ - edges: [TeamEdge] - - """ - A list of nodes. - """ - nodes: [Team] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -A team discussion. -""" -type TeamDiscussion implements Comment & Deletable & Node & Reactable & Subscribable & UniformResourceLocatable & Updatable & UpdatableComment { - """ - The actor who authored the comment. - """ - author: Actor - - """ - Author's association with the discussion's team. - """ - authorAssociation: CommentAuthorAssociation! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - The body as Markdown. - """ - body: String! - - """ - The body rendered to HTML. - """ - bodyHTML: HTML! - - """ - The body rendered to text. - """ - bodyText: String! - - """ - Identifies the discussion body hash. - """ - bodyVersion: String! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - A list of comments on this discussion. - """ - comments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - When provided, filters the connection such that results begin with the comment with this number. - """ - fromComment: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Order for connection - """ - orderBy: TeamDiscussionCommentOrder - ): TeamDiscussionCommentConnection! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - The HTTP path for discussion comments - """ - commentsResourcePath: URI! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - The HTTP URL for discussion comments - """ - commentsUrl: URI! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Check if this comment was created via an email reply. - """ - createdViaEmail: Boolean! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The actor who edited the comment. - """ - editor: Actor - - """ - The Node ID of the TeamDiscussion object - """ - id: ID! - - """ - Check if this comment was edited and includes an edit with the creation data - """ - includesCreatedEdit: Boolean! - - """ - Whether or not the discussion is pinned. - """ - isPinned: Boolean! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - Whether or not the discussion is only visible to team members and organization owners. - """ - isPrivate: Boolean! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - The moment the editor made the last edit - """ - lastEditedAt: DateTime - - """ - Identifies the discussion within its team. - """ - number: Int! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - Identifies when the comment was published at. - """ - publishedAt: DateTime - - """ - A list of reactions grouped by content left on the subject. - """ - reactionGroups: [ReactionGroup!] - - """ - A list of Reactions left on the Issue. - """ - reactions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Allows filtering Reactions by emoji. - """ - content: ReactionContent - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Allows specifying the order in which reactions are returned. - """ - orderBy: ReactionOrder - ): ReactionConnection! - - """ - The HTTP path for this discussion - """ - resourcePath: URI! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - The team that defines the context of this discussion. - """ - team: Team! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - The title of the discussion - """ - title: String! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this discussion - """ - url: URI! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - A list of edits to this content. - """ - userContentEdits( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserContentEditConnection - - """ - Check if the current viewer can delete this object. - """ - viewerCanDelete: Boolean! - - """ - Whether or not the current viewer can pin this discussion. - """ - viewerCanPin: Boolean! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - Can user react to this subject - """ - viewerCanReact: Boolean! - - """ - Check if the viewer is able to change their subscription status for the repository. - """ - viewerCanSubscribe: Boolean! - - """ - Check if the current viewer can update this object. - """ - viewerCanUpdate: Boolean! - - """ - Reasons why the current viewer can not update this comment. - """ - viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - - """ - Did the viewer author this comment. - """ - viewerDidAuthor: Boolean! - - """ - Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. - """ - viewerSubscription: SubscriptionState -} - -""" -A comment on a team discussion. -""" -type TeamDiscussionComment implements Comment & Deletable & Node & Reactable & UniformResourceLocatable & Updatable & UpdatableComment { - """ - The actor who authored the comment. - """ - author: Actor - - """ - Author's association with the comment's team. - """ - authorAssociation: CommentAuthorAssociation! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - The body as Markdown. - """ - body: String! - - """ - The body rendered to HTML. - """ - bodyHTML: HTML! - - """ - The body rendered to text. - """ - bodyText: String! - - """ - The current version of the body content. - """ - bodyVersion: String! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Check if this comment was created via an email reply. - """ - createdViaEmail: Boolean! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The discussion this comment is about. - """ - discussion: TeamDiscussion! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - The actor who edited the comment. - """ - editor: Actor - - """ - The Node ID of the TeamDiscussionComment object - """ - id: ID! - - """ - Check if this comment was edited and includes an edit with the creation data - """ - includesCreatedEdit: Boolean! - - """ - The moment the editor made the last edit - """ - lastEditedAt: DateTime - - """ - Identifies the comment number. - """ - number: Int! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - Identifies when the comment was published at. - """ - publishedAt: DateTime - - """ - A list of reactions grouped by content left on the subject. - """ - reactionGroups: [ReactionGroup!] - - """ - A list of Reactions left on the Issue. - """ - reactions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Allows filtering Reactions by emoji. - """ - content: ReactionContent - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Allows specifying the order in which reactions are returned. - """ - orderBy: ReactionOrder - ): ReactionConnection! - - """ - The HTTP path for this comment - """ - resourcePath: URI! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this comment - """ - url: URI! - @deprecated( - reason: "The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC." - ) - - """ - A list of edits to this content. - """ - userContentEdits( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserContentEditConnection - - """ - Check if the current viewer can delete this object. - """ - viewerCanDelete: Boolean! - - """ - Can user react to this subject - """ - viewerCanReact: Boolean! - - """ - Check if the current viewer can update this object. - """ - viewerCanUpdate: Boolean! - - """ - Reasons why the current viewer can not update this comment. - """ - viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - - """ - Did the viewer author this comment. - """ - viewerDidAuthor: Boolean! -} - -""" -The connection type for TeamDiscussionComment. -""" -type TeamDiscussionCommentConnection { - """ - A list of edges. - """ - edges: [TeamDiscussionCommentEdge] - - """ - A list of nodes. - """ - nodes: [TeamDiscussionComment] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type TeamDiscussionCommentEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: TeamDiscussionComment -} - -""" -Ways in which team discussion comment connections can be ordered. -""" -input TeamDiscussionCommentOrder { - """ - The direction in which to order nodes. - """ - direction: OrderDirection! - - """ - The field by which to order nodes. - """ - field: TeamDiscussionCommentOrderField! -} - -""" -Properties by which team discussion comment connections can be ordered. -""" -enum TeamDiscussionCommentOrderField { - """ - Allows sequential ordering of team discussion comments (which is equivalent to chronological ordering). - """ - NUMBER -} - -""" -The connection type for TeamDiscussion. -""" -type TeamDiscussionConnection { - """ - A list of edges. - """ - edges: [TeamDiscussionEdge] - - """ - A list of nodes. - """ - nodes: [TeamDiscussion] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type TeamDiscussionEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: TeamDiscussion -} - -""" -Ways in which team discussion connections can be ordered. -""" -input TeamDiscussionOrder { - """ - The direction in which to order nodes. - """ - direction: OrderDirection! - - """ - The field by which to order nodes. - """ - field: TeamDiscussionOrderField! -} - -""" -Properties by which team discussion connections can be ordered. -""" -enum TeamDiscussionOrderField { - """ - Allows chronological ordering of team discussions. - """ - CREATED_AT -} - -""" -An edge in a connection. -""" -type TeamEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: Team -} - -""" -The connection type for User. -""" -type TeamMemberConnection { - """ - A list of edges. - """ - edges: [TeamMemberEdge] - - """ - A list of nodes. - """ - nodes: [User] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -Represents a user who is a member of a team. -""" -type TeamMemberEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The HTTP path to the organization's member access page. - """ - memberAccessResourcePath: URI! - - """ - The HTTP URL to the organization's member access page. - """ - memberAccessUrl: URI! - node: User! - - """ - The role the member has on the team. - """ - role: TeamMemberRole! -} - -""" -Ordering options for team member connections -""" -input TeamMemberOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order team members by. - """ - field: TeamMemberOrderField! -} - -""" -Properties by which team member connections can be ordered. -""" -enum TeamMemberOrderField { - """ - Order team members by creation time - """ - CREATED_AT - - """ - Order team members by login - """ - LOGIN -} - -""" -The possible team member roles; either 'maintainer' or 'member'. -""" -enum TeamMemberRole { - """ - A team maintainer has permission to add and remove team members. - """ - MAINTAINER - - """ - A team member has no administrative permissions on the team. - """ - MEMBER -} - -""" -Defines which types of team members are included in the returned list. Can be one of IMMEDIATE, CHILD_TEAM or ALL. -""" -enum TeamMembershipType { - """ - Includes immediate and child team members for the team. - """ - ALL - - """ - Includes only child team members for the team. - """ - CHILD_TEAM - - """ - Includes only immediate members of the team. - """ - IMMEDIATE -} - -""" -The possible team notification values. -""" -enum TeamNotificationSetting { - """ - No one will receive notifications. - """ - NOTIFICATIONS_DISABLED - - """ - Everyone will receive notifications when the team is @mentioned. - """ - NOTIFICATIONS_ENABLED -} - -""" -Ways in which team connections can be ordered. -""" -input TeamOrder { - """ - The direction in which to order nodes. - """ - direction: OrderDirection! - - """ - The field in which to order nodes by. - """ - field: TeamOrderField! -} - -""" -Properties by which team connections can be ordered. -""" -enum TeamOrderField { - """ - Allows ordering a list of teams by name. - """ - NAME -} - -""" -The possible team privacy values. -""" -enum TeamPrivacy { - """ - A secret team can only be seen by its members. - """ - SECRET - - """ - A visible team can be seen and @mentioned by every member of the organization. - """ - VISIBLE -} - -""" -Audit log entry for a team.remove_member event. -""" -type TeamRemoveMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & TeamAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the TeamRemoveMemberAuditEntry object - """ - id: ID! - - """ - Whether the team was mapped to an LDAP Group. - """ - isLdapMapped: Boolean - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The team associated with the action - """ - team: Team - - """ - The name of the team - """ - teamName: String - - """ - The HTTP path for this team - """ - teamResourcePath: URI - - """ - The HTTP URL for this team - """ - teamUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -Audit log entry for a team.remove_repository event. -""" -type TeamRemoveRepositoryAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData & TeamAuditEntryData { - """ - The action name - """ - action: String! - - """ - The user who initiated the action - """ - actor: AuditEntryActor - - """ - The IP address of the actor - """ - actorIp: String - - """ - A readable representation of the actor's location - """ - actorLocation: ActorLocation - - """ - The username of the user who initiated the action - """ - actorLogin: String - - """ - The HTTP path for the actor. - """ - actorResourcePath: URI - - """ - The HTTP URL for the actor. - """ - actorUrl: URI - - """ - The time the action was initiated - """ - createdAt: PreciseDateTime! - - """ - The Node ID of the TeamRemoveRepositoryAuditEntry object - """ - id: ID! - - """ - Whether the team was mapped to an LDAP Group. - """ - isLdapMapped: Boolean - - """ - The corresponding operation type for the action - """ - operationType: OperationType - - """ - The Organization associated with the Audit Entry. - """ - organization: Organization - - """ - The name of the Organization. - """ - organizationName: String - - """ - The HTTP path for the organization - """ - organizationResourcePath: URI - - """ - The HTTP URL for the organization - """ - organizationUrl: URI - - """ - The repository associated with the action - """ - repository: Repository - - """ - The name of the repository - """ - repositoryName: String - - """ - The HTTP path for the repository - """ - repositoryResourcePath: URI - - """ - The HTTP URL for the repository - """ - repositoryUrl: URI - - """ - The team associated with the action - """ - team: Team - - """ - The name of the team - """ - teamName: String - - """ - The HTTP path for this team - """ - teamResourcePath: URI - - """ - The HTTP URL for this team - """ - teamUrl: URI - - """ - The user affected by the action - """ - user: User - - """ - For actions involving two users, the actor is the initiator and the user is the affected user. - """ - userLogin: String - - """ - The HTTP path for the user. - """ - userResourcePath: URI - - """ - The HTTP URL for the user. - """ - userUrl: URI -} - -""" -The connection type for Repository. -""" -type TeamRepositoryConnection { - """ - A list of edges. - """ - edges: [TeamRepositoryEdge] - - """ - A list of nodes. - """ - nodes: [Repository] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -Represents a team repository. -""" -type TeamRepositoryEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - node: Repository! - - """ - The permission level the team has on the repository - """ - permission: RepositoryPermission! -} - -""" -Ordering options for team repository connections -""" -input TeamRepositoryOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order repositories by. - """ - field: TeamRepositoryOrderField! -} - -""" -Properties by which team repository connections can be ordered. -""" -enum TeamRepositoryOrderField { - """ - Order repositories by creation time - """ - CREATED_AT - - """ - Order repositories by name - """ - NAME - - """ - Order repositories by permission - """ - PERMISSION - - """ - Order repositories by push time - """ - PUSHED_AT - - """ - Order repositories by number of stargazers - """ - STARGAZERS - - """ - Order repositories by update time - """ - UPDATED_AT -} - -""" -The possible team review assignment algorithms -""" -enum TeamReviewAssignmentAlgorithm { - """ - Balance review load across the entire team - """ - LOAD_BALANCE - - """ - Alternate reviews between each team member - """ - ROUND_ROBIN -} - -""" -The role of a user on a team. -""" -enum TeamRole { - """ - User has admin rights on the team. - """ - ADMIN - - """ - User is a member of the team. - """ - MEMBER -} - -""" -A text match within a search result. -""" -type TextMatch { - """ - The specific text fragment within the property matched on. - """ - fragment: String! - - """ - Highlights within the matched fragment. - """ - highlights: [TextMatchHighlight!]! - - """ - The property matched on. - """ - property: String! -} - -""" -Represents a single highlight in a search result match. -""" -type TextMatchHighlight { - """ - The indice in the fragment where the matched text begins. - """ - beginIndice: Int! - - """ - The indice in the fragment where the matched text ends. - """ - endIndice: Int! - - """ - The text matched. - """ - text: String! -} - -""" -The possible states of a thread subscription form action -""" -enum ThreadSubscriptionFormAction { - """ - The User cannot subscribe or unsubscribe to the thread - """ - NONE - - """ - The User can subscribe to the thread - """ - SUBSCRIBE - - """ - The User can unsubscribe to the thread - """ - UNSUBSCRIBE -} - -""" -The possible states of a subscription. -""" -enum ThreadSubscriptionState { - """ - The subscription status is currently disabled. - """ - DISABLED - - """ - The User is never notified because they are ignoring the list - """ - IGNORING_LIST - - """ - The User is never notified because they are ignoring the thread - """ - IGNORING_THREAD - - """ - The User is not recieving notifications from this thread - """ - NONE - - """ - The User is notified becuase they are watching the list - """ - SUBSCRIBED_TO_LIST - - """ - The User is notified because they are subscribed to the thread - """ - SUBSCRIBED_TO_THREAD - - """ - The User is notified because they chose custom settings for this thread. - """ - SUBSCRIBED_TO_THREAD_EVENTS - - """ - The User is notified because they chose custom settings for this thread. - """ - SUBSCRIBED_TO_THREAD_TYPE - - """ - The subscription status is currently unavailable. - """ - UNAVAILABLE -} - -""" -A topic aggregates entities that are related to a subject. -""" -type Topic implements Node & Starrable { - """ - The Node ID of the Topic object - """ - id: ID! - - """ - The topic's name. - """ - name: String! - - """ - A list of related topics, including aliases of this topic, sorted with the most relevant - first. Returns up to 10 Topics. - """ - relatedTopics( - """ - How many topics to return. - """ - first: Int = 3 - ): [Topic!]! - - """ - A list of repositories. - """ - repositories( - """ - Array of viewer's affiliation options for repositories returned from the - connection. For example, OWNER will include only repositories that the - current viewer owns. - """ - affiliations: [RepositoryAffiliation] - - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - If non-null, filters repositories according to whether they have issues enabled - """ - hasIssuesEnabled: Boolean - - """ - If non-null, filters repositories according to whether they have been locked - """ - isLocked: Boolean - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for repositories returned from the connection - """ - orderBy: RepositoryOrder - - """ - Array of owner's affiliation options for repositories returned from the - connection. For example, OWNER will include only repositories that the - organization or user being viewed owns. - """ - ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR] - - """ - If non-null, filters repositories according to privacy. Internal - repositories are considered private; consider using the visibility argument - if only internal repositories are needed. Cannot be combined with the - visibility argument. - """ - privacy: RepositoryPrivacy - - """ - If non-null, filters repositories according to visibility. Cannot be combined with the privacy argument. - """ - visibility: RepositoryVisibility - ): RepositoryConnection! - - """ - Returns a count of how many stargazers there are on this object - """ - stargazerCount: Int! - - """ - A list of users who have starred this starrable. - """ - stargazers( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Order for connection - """ - orderBy: StarOrder - ): StargazerConnection! - - """ - Returns a boolean indicating whether the viewing user has starred this starrable. - """ - viewerHasStarred: Boolean! -} - -""" -Metadata for an audit entry with a topic. -""" -interface TopicAuditEntryData { - """ - The name of the topic added to the repository - """ - topic: Topic - - """ - The name of the topic added to the repository - """ - topicName: String -} - -""" -Autogenerated input type of TransferIssue -""" -input TransferIssueInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Whether to create labels if they don't exist in the target repository (matched by name) - """ - createLabelsIfMissing: Boolean = false - - """ - The Node ID of the issue to be transferred - """ - issueId: ID! @possibleTypes(concreteTypes: ["Issue"]) - - """ - The Node ID of the repository the issue should be transferred to - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) -} - -""" -Autogenerated return type of TransferIssue -""" -type TransferIssuePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The issue that was transferred - """ - issue: Issue -} - -""" -Represents a 'transferred' event on a given issue or pull request. -""" -type TransferredEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The repository this came from - """ - fromRepository: Repository - - """ - The Node ID of the TransferredEvent object - """ - id: ID! - - """ - Identifies the issue associated with the event. - """ - issue: Issue! -} - -""" -Represents a Git tree. -""" -type Tree implements GitObject & Node { - """ - An abbreviated version of the Git object ID - """ - abbreviatedOid: String! - - """ - The HTTP path for this Git object - """ - commitResourcePath: URI! - - """ - The HTTP URL for this Git object - """ - commitUrl: URI! - - """ - A list of tree entries. - """ - entries: [TreeEntry!] - - """ - The Node ID of the Tree object - """ - id: ID! - - """ - The Git object ID - """ - oid: GitObjectID! - - """ - The Repository the Git object belongs to - """ - repository: Repository! -} - -""" -Represents a Git tree entry. -""" -type TreeEntry { - """ - The extension of the file - """ - extension: String - - """ - Whether or not this tree entry is generated - """ - isGenerated: Boolean! - - """ - The programming language this file is written in. - """ - language: Language - - """ - Number of lines in the file. - """ - lineCount: Int - - """ - Entry file mode. - """ - mode: Int! - - """ - Entry file name. - """ - name: String! - - """ - Entry file name. (Base64-encoded) - """ - nameRaw: Base64String! - - """ - Entry file object. - """ - object: GitObject - - """ - Entry file Git object ID. - """ - oid: GitObjectID! - - """ - The full path of the file. - """ - path: String - - """ - The full path of the file. (Base64-encoded) - """ - pathRaw: Base64String - - """ - The Repository the tree entry belongs to - """ - repository: Repository! - - """ - Entry byte size - """ - size: Int! - - """ - If the TreeEntry is for a directory occupied by a submodule project, this returns the corresponding submodule - """ - submodule: Submodule - - """ - Entry file type. - """ - type: String! -} - -""" -An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string. -""" -scalar URI - -""" -Autogenerated input type of UnarchiveProjectV2Item -""" -input UnarchiveProjectV2ItemInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the ProjectV2Item to unarchive. - """ - itemId: ID! @possibleTypes(concreteTypes: ["ProjectV2Item"]) - - """ - The ID of the Project to archive the item from. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) -} - -""" -Autogenerated return type of UnarchiveProjectV2Item -""" -type UnarchiveProjectV2ItemPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The item unarchived from the project. - """ - item: ProjectV2Item -} - -""" -Autogenerated input type of UnarchiveRepository -""" -input UnarchiveRepositoryInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the repository to unarchive. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) -} - -""" -Autogenerated return type of UnarchiveRepository -""" -type UnarchiveRepositoryPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The repository that was unarchived. - """ - repository: Repository -} - -""" -Represents an 'unassigned' event on any assignable object. -""" -type UnassignedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the assignable associated with the event. - """ - assignable: Assignable! - - """ - Identifies the user or mannequin that was unassigned. - """ - assignee: Assignee - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the UnassignedEvent object - """ - id: ID! - - """ - Identifies the subject (user) who was unassigned. - """ - user: User - @deprecated(reason: "Assignees can now be mannequins. Use the `assignee` field instead. Removal on 2020-01-01 UTC.") -} - -""" -Autogenerated input type of UnfollowOrganization -""" -input UnfollowOrganizationInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - ID of the organization to unfollow. - """ - organizationId: ID! @possibleTypes(concreteTypes: ["Organization"]) -} - -""" -Autogenerated return type of UnfollowOrganization -""" -type UnfollowOrganizationPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The organization that was unfollowed. - """ - organization: Organization -} - -""" -Autogenerated input type of UnfollowUser -""" -input UnfollowUserInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - ID of the user to unfollow. - """ - userId: ID! @possibleTypes(concreteTypes: ["User"]) -} - -""" -Autogenerated return type of UnfollowUser -""" -type UnfollowUserPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The user that was unfollowed. - """ - user: User -} - -""" -Represents a type that can be retrieved by a URL. -""" -interface UniformResourceLocatable { - """ - The HTML path to this resource. - """ - resourcePath: URI! - - """ - The URL to this resource. - """ - url: URI! -} - -""" -Represents an unknown signature on a Commit or Tag. -""" -type UnknownSignature implements GitSignature { - """ - Email used to sign this object. - """ - email: String! - - """ - True if the signature is valid and verified by GitHub. - """ - isValid: Boolean! - - """ - Payload for GPG signing object. Raw ODB object without the signature header. - """ - payload: String! - - """ - ASCII-armored signature header from object. - """ - signature: String! - - """ - GitHub user corresponding to the email signing this commit. - """ - signer: User - - """ - The state of this signature. `VALID` if signature is valid and verified by - GitHub, otherwise represents reason why signature is considered invalid. - """ - state: GitSignatureState! - - """ - True if the signature was made with GitHub's signing key. - """ - wasSignedByGitHub: Boolean! -} - -""" -Represents an 'unlabeled' event on a given issue or pull request. -""" -type UnlabeledEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the UnlabeledEvent object - """ - id: ID! - - """ - Identifies the label associated with the 'unlabeled' event. - """ - label: Label! - - """ - Identifies the `Labelable` associated with the event. - """ - labelable: Labelable! -} - -""" -Autogenerated input type of UnlinkProjectV2FromRepository -""" -input UnlinkProjectV2FromRepositoryInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the project to unlink from the repository. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) - - """ - The ID of the repository to unlink from the project. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) -} - -""" -Autogenerated return type of UnlinkProjectV2FromRepository -""" -type UnlinkProjectV2FromRepositoryPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The repository the project is no longer linked to. - """ - repository: Repository -} - -""" -Autogenerated input type of UnlinkProjectV2FromTeam -""" -input UnlinkProjectV2FromTeamInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the project to unlink from the team. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) - - """ - The ID of the team to unlink from the project. - """ - teamId: ID! @possibleTypes(concreteTypes: ["Team"]) -} - -""" -Autogenerated return type of UnlinkProjectV2FromTeam -""" -type UnlinkProjectV2FromTeamPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The team the project is unlinked from - """ - team: Team -} - -""" -Autogenerated input type of UnlinkRepositoryFromProject -""" -input UnlinkRepositoryFromProjectInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the Project linked to the Repository. - """ - projectId: ID! @possibleTypes(concreteTypes: ["Project"]) - - """ - The ID of the Repository linked to the Project. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) -} - -""" -Autogenerated return type of UnlinkRepositoryFromProject -""" -type UnlinkRepositoryFromProjectPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The linked Project. - """ - project: Project - - """ - The linked Repository. - """ - repository: Repository -} - -""" -Autogenerated input type of UnlockLockable -""" -input UnlockLockableInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - ID of the item to be unlocked. - """ - lockableId: ID! @possibleTypes(concreteTypes: ["Discussion", "Issue", "PullRequest"], abstractType: "Lockable") -} - -""" -Autogenerated return type of UnlockLockable -""" -type UnlockLockablePayload { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The item that was unlocked. - """ - unlockedRecord: Lockable -} - -""" -Represents an 'unlocked' event on a given issue or pull request. -""" -type UnlockedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the UnlockedEvent object - """ - id: ID! - - """ - Object that was unlocked. - """ - lockable: Lockable! -} - -""" -Autogenerated input type of UnmarkDiscussionCommentAsAnswer -""" -input UnmarkDiscussionCommentAsAnswerInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the discussion comment to unmark as an answer. - """ - id: ID! @possibleTypes(concreteTypes: ["DiscussionComment"]) -} - -""" -Autogenerated return type of UnmarkDiscussionCommentAsAnswer -""" -type UnmarkDiscussionCommentAsAnswerPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The discussion that includes the comment. - """ - discussion: Discussion -} - -""" -Autogenerated input type of UnmarkFileAsViewed -""" -input UnmarkFileAsViewedInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The path of the file to mark as unviewed - """ - path: String! - - """ - The Node ID of the pull request. - """ - pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"]) -} - -""" -Autogenerated return type of UnmarkFileAsViewed -""" -type UnmarkFileAsViewedPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated pull request. - """ - pullRequest: PullRequest -} - -""" -Autogenerated input type of UnmarkIssueAsDuplicate -""" -input UnmarkIssueAsDuplicateInput { - """ - ID of the issue or pull request currently considered canonical/authoritative/original. - """ - canonicalId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "IssueOrPullRequest") - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - ID of the issue or pull request currently marked as a duplicate. - """ - duplicateId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "IssueOrPullRequest") -} - -""" -Autogenerated return type of UnmarkIssueAsDuplicate -""" -type UnmarkIssueAsDuplicatePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The issue or pull request that was marked as a duplicate. - """ - duplicate: IssueOrPullRequest -} - -""" -Autogenerated input type of UnmarkProjectV2AsTemplate -""" -input UnmarkProjectV2AsTemplateInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the Project to unmark as a template. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) -} - -""" -Autogenerated return type of UnmarkProjectV2AsTemplate -""" -type UnmarkProjectV2AsTemplatePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The project. - """ - projectV2: ProjectV2 -} - -""" -Represents an 'unmarked_as_duplicate' event on a given issue or pull request. -""" -type UnmarkedAsDuplicateEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - The authoritative issue or pull request which has been duplicated by another. - """ - canonical: IssueOrPullRequest - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The issue or pull request which has been marked as a duplicate of another. - """ - duplicate: IssueOrPullRequest - - """ - The Node ID of the UnmarkedAsDuplicateEvent object - """ - id: ID! - - """ - Canonical and duplicate belong to different repositories. - """ - isCrossRepository: Boolean! -} - -""" -Autogenerated input type of UnminimizeComment -""" -input UnminimizeCommentInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the subject to modify. - """ - subjectId: ID! - @possibleTypes( - concreteTypes: [ - "CommitComment" - "DiscussionComment" - "GistComment" - "IssueComment" - "PullRequestReview" - "PullRequestReviewComment" - ] - abstractType: "Minimizable" - ) -} - -""" -Autogenerated return type of UnminimizeComment -""" -type UnminimizeCommentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The comment that was unminimized. - """ - unminimizedComment: Minimizable -} - -""" -Autogenerated input type of UnpinIssue -""" -input UnpinIssueInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the issue to be unpinned - """ - issueId: ID! @possibleTypes(concreteTypes: ["Issue"]) -} - -""" -Autogenerated return type of UnpinIssue -""" -type UnpinIssuePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The id of the pinned issue that was unpinned - """ - id: ID - - """ - The issue that was unpinned - """ - issue: Issue -} - -""" -Represents an 'unpinned' event on a given issue or pull request. -""" -type UnpinnedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the UnpinnedEvent object - """ - id: ID! - - """ - Identifies the issue associated with the event. - """ - issue: Issue! -} - -""" -Autogenerated input type of UnresolveReviewThread -""" -input UnresolveReviewThreadInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the thread to unresolve - """ - threadId: ID! @possibleTypes(concreteTypes: ["PullRequestReviewThread"]) -} - -""" -Autogenerated return type of UnresolveReviewThread -""" -type UnresolveReviewThreadPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The thread to resolve. - """ - thread: PullRequestReviewThread -} - -""" -Autogenerated input type of UnsubscribeFromNotifications -""" -input UnsubscribeFromNotificationsInput - @requiredCapabilities(requiredCapabilities: ["access_internal_graphql_notifications"]) { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The NotificationThread IDs of the objects to unsubscribe from. - """ - ids: [ID!]! - @possibleTypes( - concreteTypes: ["Commit", "Discussion", "Issue", "PullRequest", "Repository", "Team", "TeamDiscussion"] - abstractType: "Subscribable" - ) -} - -""" -Autogenerated return type of UnsubscribeFromNotifications -""" -type UnsubscribeFromNotificationsPayload - @requiredCapabilities(requiredCapabilities: ["access_internal_graphql_notifications"]) { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Did the operation succeed? - """ - success: Boolean -} - -""" -Represents an 'unsubscribed' event on a given `Subscribable`. -""" -type UnsubscribedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the UnsubscribedEvent object - """ - id: ID! - - """ - Object referenced by event. - """ - subscribable: Subscribable! -} - -""" -Entities that can be updated. -""" -interface Updatable { - """ - Check if the current viewer can update this object. - """ - viewerCanUpdate: Boolean! -} - -""" -Comments that can be updated. -""" -interface UpdatableComment { - """ - Reasons why the current viewer can not update this comment. - """ - viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! -} - -""" -Autogenerated input type of UpdateBranchProtectionRule -""" -input UpdateBranchProtectionRuleInput { - """ - Can this branch be deleted. - """ - allowsDeletions: Boolean - - """ - Are force pushes allowed on this branch. - """ - allowsForcePushes: Boolean - - """ - Is branch creation a protected operation. - """ - blocksCreations: Boolean - - """ - The global relay id of the branch protection rule to be updated. - """ - branchProtectionRuleId: ID! @possibleTypes(concreteTypes: ["BranchProtectionRule"]) - - """ - A list of User, Team, or App IDs allowed to bypass force push targeting matching branches. - """ - bypassForcePushActorIds: [ID!] - - """ - A list of User, Team, or App IDs allowed to bypass pull requests targeting matching branches. - """ - bypassPullRequestActorIds: [ID!] - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Will new commits pushed to matching branches dismiss pull request review approvals. - """ - dismissesStaleReviews: Boolean - - """ - Can admins override branch protection. - """ - isAdminEnforced: Boolean - - """ - Whether users can pull changes from upstream when the branch is locked. Set to - `true` to allow fork syncing. Set to `false` to prevent fork syncing. - """ - lockAllowsFetchAndMerge: Boolean - - """ - Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. - """ - lockBranch: Boolean - - """ - The glob-like pattern used to determine matching branches. - """ - pattern: String - - """ - A list of User, Team, or App IDs allowed to push to matching branches. - """ - pushActorIds: [ID!] - - """ - Whether the most recent push must be approved by someone other than the person who pushed it - """ - requireLastPushApproval: Boolean - - """ - Number of approving reviews required to update matching branches. - """ - requiredApprovingReviewCount: Int - - """ - The list of required deployment environments - """ - requiredDeploymentEnvironments: [String!] - - """ - List of required status check contexts that must pass for commits to be accepted to matching branches. - """ - requiredStatusCheckContexts: [String!] - - """ - The list of required status checks - """ - requiredStatusChecks: [RequiredStatusCheckInput!] - - """ - Are approving reviews required to update matching branches. - """ - requiresApprovingReviews: Boolean - - """ - Are reviews from code owners required to update matching branches. - """ - requiresCodeOwnerReviews: Boolean - - """ - Are commits required to be signed. - """ - requiresCommitSignatures: Boolean - - """ - Are conversations required to be resolved before merging. - """ - requiresConversationResolution: Boolean - - """ - Are successful deployments required before merging. - """ - requiresDeployments: Boolean - - """ - Are merge commits prohibited from being pushed to this branch. - """ - requiresLinearHistory: Boolean - - """ - Are status checks required to update matching branches. - """ - requiresStatusChecks: Boolean - - """ - Are branches required to be up to date before merging. - """ - requiresStrictStatusChecks: Boolean - - """ - Is pushing to matching branches restricted. - """ - restrictsPushes: Boolean - - """ - Is dismissal of pull request reviews restricted. - """ - restrictsReviewDismissals: Boolean - - """ - A list of User, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches. - """ - reviewDismissalActorIds: [ID!] -} - -""" -Autogenerated return type of UpdateBranchProtectionRule -""" -type UpdateBranchProtectionRulePayload { - """ - The newly created BranchProtectionRule. - """ - branchProtectionRule: BranchProtectionRule - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of UpdateCheckRun -""" -input UpdateCheckRunInput { - """ - Possible further actions the integrator can perform, which a user may trigger. - """ - actions: [CheckRunAction!] - - """ - The node of the check. - """ - checkRunId: ID! @possibleTypes(concreteTypes: ["CheckRun"]) - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The time that the check run finished. - """ - completedAt: DateTime - - """ - The final conclusion of the check. - """ - conclusion: CheckConclusionState - - """ - The URL of the integrator's site that has the full details of the check. - """ - detailsUrl: URI - - """ - A reference for the run on the integrator's system. - """ - externalId: String - - """ - The name of the check. - """ - name: String - - """ - Descriptive details about the run. - """ - output: CheckRunOutput - - """ - The node ID of the repository. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) - - """ - The time that the check run began. - """ - startedAt: DateTime - - """ - The current status. - """ - status: RequestableCheckStatusState -} - -""" -Autogenerated return type of UpdateCheckRun -""" -type UpdateCheckRunPayload { - """ - The updated check run. - """ - checkRun: CheckRun - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of UpdateCheckSuitePreferences -""" -input UpdateCheckSuitePreferencesInput { - """ - The check suite preferences to modify. - """ - autoTriggerPreferences: [CheckSuiteAutoTriggerPreference!]! - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the repository. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) -} - -""" -Autogenerated return type of UpdateCheckSuitePreferences -""" -type UpdateCheckSuitePreferencesPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated repository. - """ - repository: Repository -} - -""" -Autogenerated input type of UpdateDiscussionComment -""" -input UpdateDiscussionCommentInput { - """ - The new contents of the comment body. - """ - body: String! - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the discussion comment to update. - """ - commentId: ID! @possibleTypes(concreteTypes: ["DiscussionComment"]) -} - -""" -Autogenerated return type of UpdateDiscussionComment -""" -type UpdateDiscussionCommentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The modified discussion comment. - """ - comment: DiscussionComment -} - -""" -Autogenerated input type of UpdateDiscussion -""" -input UpdateDiscussionInput { - """ - The new contents of the discussion body. - """ - body: String - - """ - The Node ID of a discussion category within the same repository to change this discussion to. - """ - categoryId: ID @possibleTypes(concreteTypes: ["DiscussionCategory"]) - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the discussion to update. - """ - discussionId: ID! @possibleTypes(concreteTypes: ["Discussion"]) - - """ - The new discussion title. - """ - title: String -} - -""" -Autogenerated return type of UpdateDiscussion -""" -type UpdateDiscussionPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The modified discussion. - """ - discussion: Discussion -} - -""" -Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting -""" -input UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the enterprise on which to set the allow private repository forking setting. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The value for the allow private repository forking policy on the enterprise. - """ - policyValue: EnterpriseAllowPrivateRepositoryForkingPolicyValue - - """ - The value for the allow private repository forking setting on the enterprise. - """ - settingValue: EnterpriseEnabledDisabledSettingValue! -} - -""" -Autogenerated return type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting -""" -type UpdateEnterpriseAllowPrivateRepositoryForkingSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The enterprise with the updated allow private repository forking setting. - """ - enterprise: Enterprise - - """ - A message confirming the result of updating the allow private repository forking setting. - """ - message: String -} - -""" -Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting -""" -input UpdateEnterpriseDefaultRepositoryPermissionSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the enterprise on which to set the base repository permission setting. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The value for the base repository permission setting on the enterprise. - """ - settingValue: EnterpriseDefaultRepositoryPermissionSettingValue! -} - -""" -Autogenerated return type of UpdateEnterpriseDefaultRepositoryPermissionSetting -""" -type UpdateEnterpriseDefaultRepositoryPermissionSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The enterprise with the updated base repository permission setting. - """ - enterprise: Enterprise - - """ - A message confirming the result of updating the base repository permission setting. - """ - message: String -} - -""" -Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting -""" -input UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the enterprise on which to set the members can change repository visibility setting. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The value for the members can change repository visibility setting on the enterprise. - """ - settingValue: EnterpriseEnabledDisabledSettingValue! -} - -""" -Autogenerated return type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting -""" -type UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The enterprise with the updated members can change repository visibility setting. - """ - enterprise: Enterprise - - """ - A message confirming the result of updating the members can change repository visibility setting. - """ - message: String -} - -""" -Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting -""" -input UpdateEnterpriseMembersCanCreateRepositoriesSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the enterprise on which to set the members can create repositories setting. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - Allow members to create internal repositories. Defaults to current value. - """ - membersCanCreateInternalRepositories: Boolean - - """ - Allow members to create private repositories. Defaults to current value. - """ - membersCanCreatePrivateRepositories: Boolean - - """ - Allow members to create public repositories. Defaults to current value. - """ - membersCanCreatePublicRepositories: Boolean - - """ - When false, allow member organizations to set their own repository creation member privileges. - """ - membersCanCreateRepositoriesPolicyEnabled: Boolean - - """ - Value for the members can create repositories setting on the enterprise. This - or the granular public/private/internal allowed fields (but not both) must be provided. - """ - settingValue: EnterpriseMembersCanCreateRepositoriesSettingValue -} - -""" -Autogenerated return type of UpdateEnterpriseMembersCanCreateRepositoriesSetting -""" -type UpdateEnterpriseMembersCanCreateRepositoriesSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The enterprise with the updated members can create repositories setting. - """ - enterprise: Enterprise - - """ - A message confirming the result of updating the members can create repositories setting. - """ - message: String -} - -""" -Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting -""" -input UpdateEnterpriseMembersCanDeleteIssuesSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the enterprise on which to set the members can delete issues setting. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The value for the members can delete issues setting on the enterprise. - """ - settingValue: EnterpriseEnabledDisabledSettingValue! -} - -""" -Autogenerated return type of UpdateEnterpriseMembersCanDeleteIssuesSetting -""" -type UpdateEnterpriseMembersCanDeleteIssuesSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The enterprise with the updated members can delete issues setting. - """ - enterprise: Enterprise - - """ - A message confirming the result of updating the members can delete issues setting. - """ - message: String -} - -""" -Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting -""" -input UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the enterprise on which to set the members can delete repositories setting. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The value for the members can delete repositories setting on the enterprise. - """ - settingValue: EnterpriseEnabledDisabledSettingValue! -} - -""" -Autogenerated return type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting -""" -type UpdateEnterpriseMembersCanDeleteRepositoriesSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The enterprise with the updated members can delete repositories setting. - """ - enterprise: Enterprise - - """ - A message confirming the result of updating the members can delete repositories setting. - """ - message: String -} - -""" -Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting -""" -input UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the enterprise on which to set the members can invite collaborators setting. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The value for the members can invite collaborators setting on the enterprise. - """ - settingValue: EnterpriseEnabledDisabledSettingValue! -} - -""" -Autogenerated return type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting -""" -type UpdateEnterpriseMembersCanInviteCollaboratorsSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The enterprise with the updated members can invite collaborators setting. - """ - enterprise: Enterprise - - """ - A message confirming the result of updating the members can invite collaborators setting. - """ - message: String -} - -""" -Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting -""" -input UpdateEnterpriseMembersCanMakePurchasesSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the enterprise on which to set the members can make purchases setting. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The value for the members can make purchases setting on the enterprise. - """ - settingValue: EnterpriseMembersCanMakePurchasesSettingValue! -} - -""" -Autogenerated return type of UpdateEnterpriseMembersCanMakePurchasesSetting -""" -type UpdateEnterpriseMembersCanMakePurchasesSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The enterprise with the updated members can make purchases setting. - """ - enterprise: Enterprise - - """ - A message confirming the result of updating the members can make purchases setting. - """ - message: String -} - -""" -Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting -""" -input UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the enterprise on which to set the members can update protected branches setting. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The value for the members can update protected branches setting on the enterprise. - """ - settingValue: EnterpriseEnabledDisabledSettingValue! -} - -""" -Autogenerated return type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting -""" -type UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The enterprise with the updated members can update protected branches setting. - """ - enterprise: Enterprise - - """ - A message confirming the result of updating the members can update protected branches setting. - """ - message: String -} - -""" -Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting -""" -input UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the enterprise on which to set the members can view dependency insights setting. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The value for the members can view dependency insights setting on the enterprise. - """ - settingValue: EnterpriseEnabledDisabledSettingValue! -} - -""" -Autogenerated return type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting -""" -type UpdateEnterpriseMembersCanViewDependencyInsightsSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The enterprise with the updated members can view dependency insights setting. - """ - enterprise: Enterprise - - """ - A message confirming the result of updating the members can view dependency insights setting. - """ - message: String -} - -""" -Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting -""" -input UpdateEnterpriseOrganizationProjectsSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the enterprise on which to set the organization projects setting. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The value for the organization projects setting on the enterprise. - """ - settingValue: EnterpriseEnabledDisabledSettingValue! -} - -""" -Autogenerated return type of UpdateEnterpriseOrganizationProjectsSetting -""" -type UpdateEnterpriseOrganizationProjectsSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The enterprise with the updated organization projects setting. - """ - enterprise: Enterprise - - """ - A message confirming the result of updating the organization projects setting. - """ - message: String -} - -""" -Autogenerated input type of UpdateEnterpriseOwnerOrganizationRole -""" -input UpdateEnterpriseOwnerOrganizationRoleInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the Enterprise which the owner belongs to. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The ID of the organization for membership change. - """ - organizationId: ID! @possibleTypes(concreteTypes: ["Organization"]) - - """ - The role to assume in the organization. - """ - organizationRole: RoleInOrganization! -} - -""" -Autogenerated return type of UpdateEnterpriseOwnerOrganizationRole -""" -type UpdateEnterpriseOwnerOrganizationRolePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - A message confirming the result of changing the owner's organization role. - """ - message: String -} - -""" -Autogenerated input type of UpdateEnterpriseProfile -""" -input UpdateEnterpriseProfileInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The description of the enterprise. - """ - description: String - - """ - The Enterprise ID to update. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The location of the enterprise. - """ - location: String - - """ - The name of the enterprise. - """ - name: String - - """ - The URL of the enterprise's website. - """ - websiteUrl: String -} - -""" -Autogenerated return type of UpdateEnterpriseProfile -""" -type UpdateEnterpriseProfilePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated enterprise. - """ - enterprise: Enterprise -} - -""" -Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting -""" -input UpdateEnterpriseRepositoryProjectsSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the enterprise on which to set the repository projects setting. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The value for the repository projects setting on the enterprise. - """ - settingValue: EnterpriseEnabledDisabledSettingValue! -} - -""" -Autogenerated return type of UpdateEnterpriseRepositoryProjectsSetting -""" -type UpdateEnterpriseRepositoryProjectsSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The enterprise with the updated repository projects setting. - """ - enterprise: Enterprise - - """ - A message confirming the result of updating the repository projects setting. - """ - message: String -} - -""" -Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting -""" -input UpdateEnterpriseTeamDiscussionsSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the enterprise on which to set the team discussions setting. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The value for the team discussions setting on the enterprise. - """ - settingValue: EnterpriseEnabledDisabledSettingValue! -} - -""" -Autogenerated return type of UpdateEnterpriseTeamDiscussionsSetting -""" -type UpdateEnterpriseTeamDiscussionsSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The enterprise with the updated team discussions setting. - """ - enterprise: Enterprise - - """ - A message confirming the result of updating the team discussions setting. - """ - message: String -} - -""" -Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting -""" -input UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the enterprise on which to set the two factor authentication required setting. - """ - enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) - - """ - The value for the two factor authentication required setting on the enterprise. - """ - settingValue: EnterpriseEnabledSettingValue! -} - -""" -Autogenerated return type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting -""" -type UpdateEnterpriseTwoFactorAuthenticationRequiredSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The enterprise with the updated two factor authentication required setting. - """ - enterprise: Enterprise - - """ - A message confirming the result of updating the two factor authentication required setting. - """ - message: String -} - -""" -Autogenerated input type of UpdateEnvironment -""" -input UpdateEnvironmentInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The node ID of the environment. - """ - environmentId: ID! @possibleTypes(concreteTypes: ["Environment"]) - - """ - Whether deployments to this environment can be approved by the user who created the deployment. - """ - preventSelfReview: Boolean - - """ - The ids of users or teams that can approve deployments to this environment - """ - reviewers: [ID!] - - """ - The wait timer in minutes. - """ - waitTimer: Int -} - -""" -Autogenerated return type of UpdateEnvironment -""" -type UpdateEnvironmentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated environment. - """ - environment: Environment -} - -""" -Autogenerated input type of UpdateIpAllowListEnabledSetting -""" -input UpdateIpAllowListEnabledSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the owner on which to set the IP allow list enabled setting. - """ - ownerId: ID! @possibleTypes(concreteTypes: ["App", "Enterprise", "Organization"], abstractType: "IpAllowListOwner") - - """ - The value for the IP allow list enabled setting. - """ - settingValue: IpAllowListEnabledSettingValue! -} - -""" -Autogenerated return type of UpdateIpAllowListEnabledSetting -""" -type UpdateIpAllowListEnabledSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The IP allow list owner on which the setting was updated. - """ - owner: IpAllowListOwner -} - -""" -Autogenerated input type of UpdateIpAllowListEntry -""" -input UpdateIpAllowListEntryInput { - """ - An IP address or range of addresses in CIDR notation. - """ - allowListValue: String! - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the IP allow list entry to update. - """ - ipAllowListEntryId: ID! @possibleTypes(concreteTypes: ["IpAllowListEntry"]) - - """ - Whether the IP allow list entry is active when an IP allow list is enabled. - """ - isActive: Boolean! - - """ - An optional name for the IP allow list entry. - """ - name: String -} - -""" -Autogenerated return type of UpdateIpAllowListEntry -""" -type UpdateIpAllowListEntryPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The IP allow list entry that was updated. - """ - ipAllowListEntry: IpAllowListEntry -} - -""" -Autogenerated input type of UpdateIpAllowListForInstalledAppsEnabledSetting -""" -input UpdateIpAllowListForInstalledAppsEnabledSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the owner. - """ - ownerId: ID! @possibleTypes(concreteTypes: ["App", "Enterprise", "Organization"], abstractType: "IpAllowListOwner") - - """ - The value for the IP allow list configuration for installed GitHub Apps setting. - """ - settingValue: IpAllowListForInstalledAppsEnabledSettingValue! -} - -""" -Autogenerated return type of UpdateIpAllowListForInstalledAppsEnabledSetting -""" -type UpdateIpAllowListForInstalledAppsEnabledSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The IP allow list owner on which the setting was updated. - """ - owner: IpAllowListOwner -} - -""" -Autogenerated input type of UpdateIssueComment -""" -input UpdateIssueCommentInput { - """ - The updated text of the comment. - """ - body: String! - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the IssueComment to modify. - """ - id: ID! @possibleTypes(concreteTypes: ["IssueComment"]) -} - -""" -Autogenerated return type of UpdateIssueComment -""" -type UpdateIssueCommentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated comment. - """ - issueComment: IssueComment -} - -""" -Autogenerated input type of UpdateIssue -""" -input UpdateIssueInput { - """ - An array of Node IDs of users for this issue. - """ - assigneeIds: [ID!] @possibleTypes(concreteTypes: ["User"]) - - """ - The body for the issue description. - """ - body: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the Issue to modify. - """ - id: ID! @possibleTypes(concreteTypes: ["Issue"]) - - """ - An array of Node IDs of labels for this issue. - """ - labelIds: [ID!] @possibleTypes(concreteTypes: ["Label"]) - - """ - The Node ID of the milestone for this issue. - """ - milestoneId: ID @possibleTypes(concreteTypes: ["Milestone"]) - - """ - An array of Node IDs for projects associated with this issue. - """ - projectIds: [ID!] - - """ - The desired issue state. - """ - state: IssueState - - """ - The title for the issue. - """ - title: String -} - -""" -Autogenerated return type of UpdateIssue -""" -type UpdateIssuePayload { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The issue. - """ - issue: Issue -} - -""" -Autogenerated input type of UpdateLabel -""" -input UpdateLabelInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - A 6 character hex code, without the leading #, identifying the updated color of the label. - """ - color: String - - """ - A brief description of the label, such as its purpose. - """ - description: String - - """ - The Node ID of the label to be updated. - """ - id: ID! @possibleTypes(concreteTypes: ["Label"]) - - """ - The updated name of the label. - """ - name: String -} - -""" -Autogenerated return type of UpdateLabel -""" -type UpdateLabelPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated label. - """ - label: Label -} - -""" -Autogenerated input type of UpdateNotificationRestrictionSetting -""" -input UpdateNotificationRestrictionSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the owner on which to set the restrict notifications setting. - """ - ownerId: ID! @possibleTypes(concreteTypes: ["Enterprise", "Organization"], abstractType: "VerifiableDomainOwner") - - """ - The value for the restrict notifications setting. - """ - settingValue: NotificationRestrictionSettingValue! -} - -""" -Autogenerated return type of UpdateNotificationRestrictionSetting -""" -type UpdateNotificationRestrictionSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The owner on which the setting was updated. - """ - owner: VerifiableDomainOwner -} - -""" -Autogenerated input type of UpdateOrganizationAllowPrivateRepositoryForkingSetting -""" -input UpdateOrganizationAllowPrivateRepositoryForkingSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Enable forking of private repositories in the organization? - """ - forkingEnabled: Boolean! - - """ - The ID of the organization on which to set the allow private repository forking setting. - """ - organizationId: ID! @possibleTypes(concreteTypes: ["Organization"]) -} - -""" -Autogenerated return type of UpdateOrganizationAllowPrivateRepositoryForkingSetting -""" -type UpdateOrganizationAllowPrivateRepositoryForkingSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - A message confirming the result of updating the allow private repository forking setting. - """ - message: String - - """ - The organization with the updated allow private repository forking setting. - """ - organization: Organization -} - -""" -Autogenerated input type of UpdateOrganizationWebCommitSignoffSetting -""" -input UpdateOrganizationWebCommitSignoffSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the organization on which to set the web commit signoff setting. - """ - organizationId: ID! @possibleTypes(concreteTypes: ["Organization"]) - - """ - Enable signoff on web-based commits for repositories in the organization? - """ - webCommitSignoffRequired: Boolean! -} - -""" -Autogenerated return type of UpdateOrganizationWebCommitSignoffSetting -""" -type UpdateOrganizationWebCommitSignoffSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - A message confirming the result of updating the web commit signoff setting. - """ - message: String - - """ - The organization with the updated web commit signoff setting. - """ - organization: Organization -} - -""" -Only allow users with bypass permission to update matching refs. -""" -type UpdateParameters { - """ - Branch can pull changes from its upstream repository - """ - updateAllowsFetchAndMerge: Boolean! -} - -""" -Only allow users with bypass permission to update matching refs. -""" -input UpdateParametersInput { - """ - Branch can pull changes from its upstream repository - """ - updateAllowsFetchAndMerge: Boolean! -} - -""" -Autogenerated input type of UpdateProjectCard -""" -input UpdateProjectCardInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Whether or not the ProjectCard should be archived - """ - isArchived: Boolean - - """ - The note of ProjectCard. - """ - note: String - - """ - The ProjectCard ID to update. - """ - projectCardId: ID! @possibleTypes(concreteTypes: ["ProjectCard"]) -} - -""" -Autogenerated return type of UpdateProjectCard -""" -type UpdateProjectCardPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated ProjectCard. - """ - projectCard: ProjectCard -} - -""" -Autogenerated input type of UpdateProjectColumn -""" -input UpdateProjectColumnInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The name of project column. - """ - name: String! - - """ - The ProjectColumn ID to update. - """ - projectColumnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"]) -} - -""" -Autogenerated return type of UpdateProjectColumn -""" -type UpdateProjectColumnPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated project column. - """ - projectColumn: ProjectColumn -} - -""" -Autogenerated input type of UpdateProject -""" -input UpdateProjectInput { - """ - The description of project. - """ - body: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The name of project. - """ - name: String - - """ - The Project ID to update. - """ - projectId: ID! @possibleTypes(concreteTypes: ["Project"]) - - """ - Whether the project is public or not. - """ - public: Boolean - - """ - Whether the project is open or closed. - """ - state: ProjectState -} - -""" -Autogenerated return type of UpdateProject -""" -type UpdateProjectPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated project. - """ - project: Project -} - -""" -Autogenerated input type of UpdateProjectV2Collaborators -""" -input UpdateProjectV2CollaboratorsInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The collaborators to update. - """ - collaborators: [ProjectV2Collaborator!]! - - """ - The ID of the project to update the collaborators for. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) -} - -""" -Autogenerated return type of UpdateProjectV2Collaborators -""" -type UpdateProjectV2CollaboratorsPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The collaborators granted a role - """ - collaborators( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ProjectV2ActorConnection -} - -""" -Autogenerated input type of UpdateProjectV2DraftIssue -""" -input UpdateProjectV2DraftIssueInput { - """ - The IDs of the assignees of the draft issue. - """ - assigneeIds: [ID!] @possibleTypes(concreteTypes: ["User"]) - - """ - The body of the draft issue. - """ - body: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the draft issue to update. - """ - draftIssueId: ID! @possibleTypes(concreteTypes: ["DraftIssue"]) - - """ - The title of the draft issue. - """ - title: String -} - -""" -Autogenerated return type of UpdateProjectV2DraftIssue -""" -type UpdateProjectV2DraftIssuePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The draft issue updated in the project. - """ - draftIssue: DraftIssue -} - -""" -Autogenerated input type of UpdateProjectV2 -""" -input UpdateProjectV2Input { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Set the project to closed or open. - """ - closed: Boolean - - """ - The ID of the Project to update. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) - - """ - Set the project to public or private. - """ - public: Boolean - - """ - Set the readme description of the project. - """ - readme: String - - """ - Set the short description of the project. - """ - shortDescription: String - - """ - Set the title of the project. - """ - title: String -} - -""" -Autogenerated input type of UpdateProjectV2ItemFieldValue -""" -input UpdateProjectV2ItemFieldValueInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the field to be updated. - """ - fieldId: ID! - @possibleTypes( - concreteTypes: ["ProjectV2Field", "ProjectV2IterationField", "ProjectV2SingleSelectField"] - abstractType: "ProjectV2FieldConfiguration" - ) - - """ - The ID of the item to be updated. - """ - itemId: ID! @possibleTypes(concreteTypes: ["ProjectV2Item"]) - - """ - The ID of the Project. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) - - """ - The value which will be set on the field. - """ - value: ProjectV2FieldValue! -} - -""" -Autogenerated return type of UpdateProjectV2ItemFieldValue -""" -type UpdateProjectV2ItemFieldValuePayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated item. - """ - projectV2Item: ProjectV2Item -} - -""" -Autogenerated input type of UpdateProjectV2ItemPosition -""" -input UpdateProjectV2ItemPositionInput { - """ - The ID of the item to position this item after. If omitted or set to null the item will be moved to top. - """ - afterId: ID @possibleTypes(concreteTypes: ["ProjectV2Item"]) - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the item to be moved. - """ - itemId: ID! @possibleTypes(concreteTypes: ["ProjectV2Item"]) - - """ - The ID of the Project. - """ - projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"]) -} - -""" -Autogenerated return type of UpdateProjectV2ItemPosition -""" -type UpdateProjectV2ItemPositionPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The items in the new order - """ - items( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ProjectV2ItemConnection -} - -""" -Autogenerated return type of UpdateProjectV2 -""" -type UpdateProjectV2Payload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated Project. - """ - projectV2: ProjectV2 -} - -""" -Autogenerated input type of UpdatePullRequestBranch -""" -input UpdatePullRequestBranchInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The head ref oid for the upstream branch. - """ - expectedHeadOid: GitObjectID - - """ - The Node ID of the pull request. - """ - pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"]) - - """ - The update branch method to use. If omitted, defaults to 'MERGE' - """ - updateMethod: PullRequestBranchUpdateMethod -} - -""" -Autogenerated return type of UpdatePullRequestBranch -""" -type UpdatePullRequestBranchPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated pull request. - """ - pullRequest: PullRequest -} - -""" -Autogenerated input type of UpdatePullRequest -""" -input UpdatePullRequestInput { - """ - An array of Node IDs of users for this pull request. - """ - assigneeIds: [ID!] @possibleTypes(concreteTypes: ["User"]) - - """ - The name of the branch you want your changes pulled into. This should be an existing branch - on the current repository. - """ - baseRefName: String - - """ - The contents of the pull request. - """ - body: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - An array of Node IDs of labels for this pull request. - """ - labelIds: [ID!] @possibleTypes(concreteTypes: ["Label"]) - - """ - Indicates whether maintainers can modify the pull request. - """ - maintainerCanModify: Boolean - - """ - The Node ID of the milestone for this pull request. - """ - milestoneId: ID @possibleTypes(concreteTypes: ["Milestone"]) - - """ - An array of Node IDs for projects associated with this pull request. - """ - projectIds: [ID!] - - """ - The Node ID of the pull request. - """ - pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"]) - - """ - The target state of the pull request. - """ - state: PullRequestUpdateState - - """ - The title of the pull request. - """ - title: String -} - -""" -Autogenerated return type of UpdatePullRequest -""" -type UpdatePullRequestPayload { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated pull request. - """ - pullRequest: PullRequest -} - -""" -Autogenerated input type of UpdatePullRequestReviewComment -""" -input UpdatePullRequestReviewCommentInput { - """ - The text of the comment. - """ - body: String! - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the comment to modify. - """ - pullRequestReviewCommentId: ID! @possibleTypes(concreteTypes: ["PullRequestReviewComment"]) -} - -""" -Autogenerated return type of UpdatePullRequestReviewComment -""" -type UpdatePullRequestReviewCommentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated comment. - """ - pullRequestReviewComment: PullRequestReviewComment -} - -""" -Autogenerated input type of UpdatePullRequestReview -""" -input UpdatePullRequestReviewInput { - """ - The contents of the pull request review body. - """ - body: String! - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the pull request review to modify. - """ - pullRequestReviewId: ID! @possibleTypes(concreteTypes: ["PullRequestReview"]) -} - -""" -Autogenerated return type of UpdatePullRequestReview -""" -type UpdatePullRequestReviewPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated pull request review. - """ - pullRequestReview: PullRequestReview -} - -""" -Autogenerated input type of UpdateRef -""" -input UpdateRefInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Permit updates of branch Refs that are not fast-forwards? - """ - force: Boolean = false - - """ - The GitObjectID that the Ref shall be updated to target. - """ - oid: GitObjectID! - - """ - The Node ID of the Ref to be updated. - """ - refId: ID! @possibleTypes(concreteTypes: ["Ref"]) -} - -""" -Autogenerated return type of UpdateRef -""" -type UpdateRefPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated Ref. - """ - ref: Ref -} - -""" -Autogenerated input type of UpdateRefs -""" -input UpdateRefsInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - A list of ref updates. - """ - refUpdates: [RefUpdate!]! - - """ - The Node ID of the repository. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) -} - -""" -Autogenerated return type of UpdateRefs -""" -type UpdateRefsPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String -} - -""" -Autogenerated input type of UpdateRepository -""" -input UpdateRepositoryInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - A new description for the repository. Pass an empty string to erase the existing description. - """ - description: String - - """ - Indicates if the repository should have the discussions feature enabled. - """ - hasDiscussionsEnabled: Boolean - - """ - Indicates if the repository should have the issues feature enabled. - """ - hasIssuesEnabled: Boolean - - """ - Indicates if the repository should have the project boards feature enabled. - """ - hasProjectsEnabled: Boolean - - """ - Indicates if the repository should have the wiki feature enabled. - """ - hasWikiEnabled: Boolean - - """ - The URL for a web page about this repository. Pass an empty string to erase the existing URL. - """ - homepageUrl: URI - - """ - The new name of the repository. - """ - name: String - - """ - The ID of the repository to update. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) - - """ - Whether this repository should be marked as a template such that anyone who - can access it can create new repositories with the same files and directory structure. - """ - template: Boolean -} - -""" -Autogenerated return type of UpdateRepository -""" -type UpdateRepositoryPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated repository. - """ - repository: Repository -} - -""" -Autogenerated input type of UpdateRepositoryRuleset -""" -input UpdateRepositoryRulesetInput { - """ - A list of actors that are allowed to bypass rules in this ruleset. - """ - bypassActors: [RepositoryRulesetBypassActorInput!] - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The list of conditions for this ruleset - """ - conditions: RepositoryRuleConditionsInput - - """ - The enforcement level for this ruleset - """ - enforcement: RuleEnforcement - - """ - The name of the ruleset. - """ - name: String - - """ - The global relay id of the repository ruleset to be updated. - """ - repositoryRulesetId: ID! @possibleTypes(concreteTypes: ["RepositoryRuleset"]) - - """ - The list of rules for this ruleset - """ - rules: [RepositoryRuleInput!] - - """ - The target of the ruleset. - """ - target: RepositoryRulesetTarget -} - -""" -Autogenerated return type of UpdateRepositoryRuleset -""" -type UpdateRepositoryRulesetPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The newly created Ruleset. - """ - ruleset: RepositoryRuleset -} - -""" -Autogenerated input type of UpdateRepositoryWebCommitSignoffSetting -""" -input UpdateRepositoryWebCommitSignoffSettingInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the repository to update. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) - - """ - Indicates if the repository should require signoff on web-based commits. - """ - webCommitSignoffRequired: Boolean! -} - -""" -Autogenerated return type of UpdateRepositoryWebCommitSignoffSetting -""" -type UpdateRepositoryWebCommitSignoffSettingPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - A message confirming the result of updating the web commit signoff setting. - """ - message: String - - """ - The updated repository. - """ - repository: Repository -} - -""" -Autogenerated input type of UpdateSubscription -""" -input UpdateSubscriptionInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The new state of the subscription. - """ - state: SubscriptionState! - - """ - The Node ID of the subscribable object to modify. - """ - subscribableId: ID! - @possibleTypes( - concreteTypes: ["Commit", "Discussion", "Issue", "PullRequest", "Repository", "Team", "TeamDiscussion"] - abstractType: "Subscribable" - ) -} - -""" -Autogenerated return type of UpdateSubscription -""" -type UpdateSubscriptionPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The input subscribable entity. - """ - subscribable: Subscribable -} - -""" -Autogenerated input type of UpdateTeamDiscussionComment -""" -input UpdateTeamDiscussionCommentInput { - """ - The updated text of the comment. - """ - body: String! - - """ - The current version of the body content. - """ - bodyVersion: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the comment to modify. - """ - id: ID! @possibleTypes(concreteTypes: ["TeamDiscussionComment"]) -} - -""" -Autogenerated return type of UpdateTeamDiscussionComment -""" -type UpdateTeamDiscussionCommentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated comment. - """ - teamDiscussionComment: TeamDiscussionComment -} - -""" -Autogenerated input type of UpdateTeamDiscussion -""" -input UpdateTeamDiscussionInput { - """ - The updated text of the discussion. - """ - body: String - - """ - 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. - """ - bodyVersion: String - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the discussion to modify. - """ - id: ID! @possibleTypes(concreteTypes: ["TeamDiscussion"]) - - """ - If provided, sets the pinned state of the updated discussion. - """ - pinned: Boolean - - """ - The updated title of the discussion. - """ - title: String -} - -""" -Autogenerated return type of UpdateTeamDiscussion -""" -type UpdateTeamDiscussionPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The updated discussion. - """ - teamDiscussion: TeamDiscussion -} - -""" -Autogenerated input type of UpdateTeamReviewAssignment -""" -input UpdateTeamReviewAssignmentInput { - """ - The algorithm to use for review assignment - """ - algorithm: TeamReviewAssignmentAlgorithm = ROUND_ROBIN - - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Count any members whose review has already been requested against the required number of members assigned to review - """ - countMembersAlreadyRequested: Boolean = true - - """ - Turn on or off review assignment - """ - enabled: Boolean! - - """ - An array of team member IDs to exclude - """ - excludedTeamMemberIds: [ID!] @possibleTypes(concreteTypes: ["User"]) - - """ - The Node ID of the team to update review assignments of - """ - id: ID! @possibleTypes(concreteTypes: ["Team"]) - - """ - Include the members of any child teams when assigning - """ - includeChildTeamMembers: Boolean = true - - """ - Notify the entire team of the PR if it is delegated - """ - notifyTeam: Boolean = true - - """ - Remove the team review request when assigning - """ - removeTeamRequest: Boolean = true - - """ - The number of team members to assign - """ - teamMemberCount: Int = 1 -} - -""" -Autogenerated return type of UpdateTeamReviewAssignment -""" -type UpdateTeamReviewAssignmentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The team that was modified - """ - team: Team -} - -""" -Autogenerated input type of UpdateTeamsRepository -""" -input UpdateTeamsRepositoryInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Permission that should be granted to the teams. - """ - permission: RepositoryPermission! - - """ - Repository ID being granted access to. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) - - """ - A list of teams being granted access. Limit: 10 - """ - teamIds: [ID!]! @possibleTypes(concreteTypes: ["Team"]) -} - -""" -Autogenerated return type of UpdateTeamsRepository -""" -type UpdateTeamsRepositoryPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The repository that was updated. - """ - repository: Repository - - """ - The teams granted permission on the repository. - """ - teams: [Team!] -} - -""" -Autogenerated input type of UpdateTopics -""" -input UpdateTopicsInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The Node ID of the repository. - """ - repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) - - """ - An array of topic names. - """ - topicNames: [String!]! -} - -""" -Autogenerated return type of UpdateTopics -""" -type UpdateTopicsPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Names of the provided topics that are not valid. - """ - invalidTopicNames: [String!] - - """ - The updated repository. - """ - repository: Repository -} - -""" -Autogenerated input type of UpdateUserList -""" -input UpdateUserListInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - A description of the list - """ - description: String - - """ - Whether or not the list is private - """ - isPrivate: Boolean - - """ - The ID of the list to update. - """ - listId: ID! @possibleTypes(concreteTypes: ["UserList"]) - - """ - The name of the list - """ - name: String -} - -""" -Autogenerated return type of UpdateUserList -""" -type UpdateUserListPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The list that was just updated - """ - list: UserList -} - -""" -Autogenerated input type of UpdateUserListsForItem -""" -input UpdateUserListsForItemInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The item to add to the list - """ - itemId: ID! @possibleTypes(concreteTypes: ["Repository"], abstractType: "UserListItems") - - """ - The lists to which this item should belong - """ - listIds: [ID!]! @possibleTypes(concreteTypes: ["UserList"]) - - """ - The suggested lists to create and add this item to - """ - suggestedListIds: [ID!] @possibleTypes(concreteTypes: ["UserListSuggestion"]) -} - -""" -Autogenerated return type of UpdateUserListsForItem -""" -type UpdateUserListsForItemPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The item that was added - """ - item: UserListItems - - """ - The lists to which this item belongs - """ - lists: [UserList!] - - """ - The user who owns the lists - """ - user: User -} - -""" -A user is an individual's account on GitHub that owns repositories and can make new content. -""" -type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner & ProjectV2Owner & ProjectV2Recent & RepositoryDiscussionAuthor & RepositoryDiscussionCommentAuthor & RepositoryOwner & UniformResourceLocatable { - """ - Determine if this repository owner has any items that can be pinned to their profile. - """ - anyPinnableItems( - """ - Filter to only a particular kind of pinnable item. - """ - type: PinnableItemType - ): Boolean! - - """ - A URL pointing to the user's public avatar. - """ - avatarUrl( - """ - The size of the resulting square image. - """ - size: Int - ): URI! - - """ - The user's public profile bio. - """ - bio: String - - """ - The user's public profile bio as HTML. - """ - bioHTML: HTML! - - """ - Could this user receive email notifications, if the organization had notification restrictions enabled? - """ - canReceiveOrganizationEmailsWhenNotificationsRestricted( - """ - The login of the organization to check. - """ - login: String! - ): Boolean! - - """ - A list of commit comments made by this user. - """ - commitComments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): CommitCommentConnection! - - """ - The user's public profile company. - """ - company: String - - """ - The user's public profile company as HTML. - """ - companyHTML: HTML! - - """ - The collection of contributions this user has made to different repositories. - """ - contributionsCollection( - """ - Only contributions made at this time or later will be counted. If omitted, defaults to a year ago. - """ - from: DateTime - - """ - The ID of the organization used to filter contributions. - """ - organizationID: ID - - """ - Only contributions made before and up to (including) this time will be - counted. If omitted, defaults to the current time or one year from the - provided from argument. - """ - to: DateTime - ): ContributionsCollection! - - """ - The user's Copilot endpoint information - """ - copilotEndpoints: CopilotEndpoints - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The user's publicly visible profile email. - """ - email: String! - - """ - A list of enterprises that the user belongs to. - """ - enterprises( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filter enterprises returned based on the user's membership type. - """ - membershipType: EnterpriseMembershipType = ALL - - """ - Ordering options for the User's enterprises. - """ - orderBy: EnterpriseOrder = {field: NAME, direction: ASC} - ): EnterpriseConnection - - """ - A list of users the given user is followed by. - """ - followers( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): FollowerConnection! - - """ - A list of users the given user is following. - """ - following( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): FollowingConnection! - - """ - Find gist by repo name. - """ - gist( - """ - The gist name to find. - """ - name: String! - ): Gist - - """ - A list of gist comments made by this user. - """ - gistComments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): GistCommentConnection! - - """ - A list of the Gists the user has created. - """ - gists( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for gists returned from the connection - """ - orderBy: GistOrder - - """ - Filters Gists according to privacy. - """ - privacy: GistPrivacy - ): GistConnection! - - """ - The hovercard information for this user in a given context - """ - hovercard( - """ - The ID of the subject to get the hovercard in the context of - """ - primarySubjectId: ID - ): Hovercard! - - """ - The Node ID of the User object - """ - id: ID! - - """ - Whether or not this user is a participant in the GitHub Security Bug Bounty. - """ - isBountyHunter: Boolean! - - """ - Whether or not this user is a participant in the GitHub Campus Experts Program. - """ - isCampusExpert: Boolean! - - """ - Whether or not this user is a GitHub Developer Program member. - """ - isDeveloperProgramMember: Boolean! - - """ - Whether or not this user is a GitHub employee. - """ - isEmployee: Boolean! - - """ - Whether or not this user is following the viewer. Inverse of viewerIsFollowing - """ - isFollowingViewer: 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. - """ - isHireable: Boolean! - - """ - Whether or not this user is a site administrator. - """ - isSiteAdmin: Boolean! - - """ - Whether or not this user is the viewing user. - """ - isViewer: Boolean! - - """ - A list of issue comments made by this user. - """ - issueComments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for issue comments returned from the connection. - """ - orderBy: IssueCommentOrder - ): IssueCommentConnection! - - """ - A list of issues associated with this user. - """ - issues( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Filtering options for issues returned from the connection. - """ - filterBy: IssueFilters - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - A list of label names to filter the pull requests by. - """ - labels: [String!] - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for issues returned from the connection. - """ - orderBy: IssueOrder - - """ - A list of states to filter the issues by. - """ - states: [IssueState!] - ): IssueConnection! - - """ - Showcases a selection of repositories and gists that the profile owner has - either curated or that have been selected automatically based on popularity. - """ - itemShowcase: ProfileItemShowcase! - - """ - A user-curated list of repositories - """ - lists( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserListConnection! - - """ - The user's public profile location. - """ - location: String - - """ - The username used to login. - """ - login: String! - - """ - The user's public profile name. - """ - name: String - - """ - Find an organization by its login that the user belongs to. - """ - organization( - """ - The login of the organization to find. - """ - login: String! - ): Organization - - """ - Verified email addresses that match verified domains for a specified organization the user is a member of. - """ - organizationVerifiedDomainEmails( - """ - The login of the organization to match verified domains from. - """ - login: String! - ): [String!]! - - """ - A list of organizations the user belongs to. - """ - organizations( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for the User's organizations. - """ - orderBy: OrganizationOrder = null - ): OrganizationConnection! - - """ - A list of packages under the owner. - """ - packages( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Find packages by their names. - """ - names: [String] - - """ - Ordering of the returned packages. - """ - orderBy: PackageOrder = {field: CREATED_AT, direction: DESC} - - """ - Filter registry package by type. - """ - packageType: PackageType - - """ - Find packages in a repository by ID. - """ - repositoryId: ID - ): PackageConnection! - - """ - A list of repositories and gists this profile owner can pin to their profile. - """ - pinnableItems( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filter the types of pinnable items that are returned. - """ - types: [PinnableItemType!] - ): PinnableItemConnection! - - """ - A list of repositories and gists this profile owner has pinned to their profile - """ - pinnedItems( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filter the types of pinned items that are returned. - """ - types: [PinnableItemType!] - ): PinnableItemConnection! - - """ - Returns how many more items this profile owner can pin to their profile. - """ - pinnedItemsRemaining: Int! - - """ - Find project by number. - """ - project( - """ - The project number to find. - """ - number: Int! - ): Project - - """ - Find a project by number. - """ - projectV2( - """ - The project number. - """ - number: Int! - ): ProjectV2 - - """ - A list of projects under the owner. - """ - projects( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for projects returned from the connection - """ - orderBy: ProjectOrder - - """ - Query to search projects by, currently only searching by name. - """ - search: String - - """ - A list of states to filter the projects by. - """ - states: [ProjectState!] - ): ProjectConnection! - - """ - The HTTP path listing user's projects - """ - projectsResourcePath: URI! - - """ - The HTTP URL listing user's projects - """ - projectsUrl: URI! - - """ - A list of projects under the owner. - """ - projectsV2( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - How to order the returned projects. - """ - orderBy: ProjectV2Order = {field: NUMBER, direction: DESC} - - """ - A project to search for under the the owner. - """ - query: String - ): ProjectV2Connection! - - """ - The user's profile pronouns - """ - pronouns: String - - """ - A list of public keys associated with this user. - """ - publicKeys( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): PublicKeyConnection! - - """ - A list of pull requests associated with this user. - """ - pullRequests( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - The base ref name to filter the pull requests by. - """ - baseRefName: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - The head ref name to filter the pull requests by. - """ - headRefName: String - - """ - A list of label names to filter the pull requests by. - """ - labels: [String!] - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for pull requests returned from the connection. - """ - orderBy: IssueOrder - - """ - A list of states to filter the pull requests by. - """ - states: [PullRequestState!] - ): PullRequestConnection! - - """ - Recent projects that this user has modified in the context of the owner. - """ - recentProjects( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): ProjectV2Connection! - - """ - A list of repositories that the user owns. - """ - repositories( - """ - Array of viewer's affiliation options for repositories returned from the - connection. For example, OWNER will include only repositories that the - current viewer owns. - """ - affiliations: [RepositoryAffiliation] - - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - If non-null, filters repositories according to whether they have issues enabled - """ - hasIssuesEnabled: Boolean - - """ - If non-null, filters repositories according to whether they are archived and not maintained - """ - isArchived: Boolean - - """ - If non-null, filters repositories according to whether they are forks of another repository - """ - isFork: Boolean - - """ - If non-null, filters repositories according to whether they have been locked - """ - isLocked: Boolean - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for repositories returned from the connection - """ - orderBy: RepositoryOrder - - """ - Array of owner's affiliation options for repositories returned from the - connection. For example, OWNER will include only repositories that the - organization or user being viewed owns. - """ - ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR] - - """ - If non-null, filters repositories according to privacy. Internal - repositories are considered private; consider using the visibility argument - if only internal repositories are needed. Cannot be combined with the - visibility argument. - """ - privacy: RepositoryPrivacy - - """ - If non-null, filters repositories according to visibility. Cannot be combined with the privacy argument. - """ - visibility: RepositoryVisibility - ): RepositoryConnection! - - """ - A list of repositories that the user recently contributed to. - """ - repositoriesContributedTo( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - If non-null, include only the specified types of contributions. The - GitHub.com UI uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY] - """ - contributionTypes: [RepositoryContributionType] - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - If non-null, filters repositories according to whether they have issues enabled - """ - hasIssues: Boolean - - """ - If true, include user repositories - """ - includeUserRepositories: Boolean - - """ - If non-null, filters repositories according to whether they have been locked - """ - isLocked: Boolean - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for repositories returned from the connection - """ - orderBy: RepositoryOrder - - """ - If non-null, filters repositories according to privacy - """ - privacy: RepositoryPrivacy - ): RepositoryConnection! - - """ - Find Repository. - """ - repository( - """ - Follow repository renames. If disabled, a repository referenced by its old name will return an error. - """ - followRenames: Boolean = true - - """ - Name of Repository to find. - """ - name: String! - ): Repository - - """ - Discussion comments this user has authored. - """ - repositoryDiscussionComments( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Filter discussion comments to only those that were marked as the answer - """ - onlyAnswers: Boolean = false - - """ - Filter discussion comments to only those in a specific repository. - """ - repositoryId: ID - ): DiscussionCommentConnection! - - """ - Discussions this user has started. - """ - repositoryDiscussions( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Filter discussions to only those that have been answered or not. Defaults to - including both answered and unanswered discussions. - """ - answered: Boolean = null - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for discussions returned from the connection. - """ - orderBy: DiscussionOrder = {field: CREATED_AT, direction: DESC} - - """ - Filter discussions to only those in a specific repository. - """ - repositoryId: ID - - """ - A list of states to filter the discussions by. - """ - states: [DiscussionState!] = [] - ): DiscussionConnection! - - """ - The HTTP path for this user - """ - resourcePath: URI! - - """ - Replies this user has saved - """ - savedReplies( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - The field to order saved replies by. - """ - orderBy: SavedReplyOrder = {field: UPDATED_AT, direction: DESC} - ): SavedReplyConnection - - """ - The user's social media accounts, ordered as they appear on the user's profile. - """ - socialAccounts( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): SocialAccountConnection! - - """ - Repositories the user has starred. - """ - starredRepositories( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Order for connection - """ - orderBy: StarOrder - - """ - Filters starred repositories to only return repositories owned by the viewer. - """ - ownedByViewer: Boolean - ): StarredRepositoryConnection! - - """ - The user's description of what they're currently doing. - """ - status: UserStatus - - """ - Suggested names for user lists - """ - suggestedListNames: [UserListSuggestion!]! - - """ - Identifies the date and time when the user was suspended. - """ - suspendedAt: DateTime - - """ - Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created - """ - topRepositories( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for repositories returned from the connection - """ - orderBy: RepositoryOrder! - - """ - How far back in time to fetch contributed repositories - """ - since: DateTime - ): RepositoryConnection! - - """ - The user's Twitter username. - """ - twitterUsername: String - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this user - """ - url: URI! - - """ - Can the viewer pin repositories and gists to the profile? - """ - viewerCanChangePinnedItems: Boolean! - - """ - Can the current viewer create new projects on this owner. - """ - viewerCanCreateProjects: Boolean! - - """ - Whether or not the viewer is able to follow the user. - """ - viewerCanFollow: Boolean! - - """ - Whether or not this user is followed by the viewer. Inverse of isFollowingViewer. - """ - viewerIsFollowing: Boolean! - - """ - A list of repositories the given user is watching. - """ - watching( - """ - Affiliation options for repositories returned from the connection. If none - specified, the results will include repositories for which the current - viewer is an owner or collaborator, or member. - """ - affiliations: [RepositoryAffiliation] - - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - If non-null, filters repositories according to whether they have issues enabled - """ - hasIssuesEnabled: Boolean - - """ - If non-null, filters repositories according to whether they have been locked - """ - isLocked: Boolean - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for repositories returned from the connection - """ - orderBy: RepositoryOrder - - """ - Array of owner's affiliation options for repositories returned from the - connection. For example, OWNER will include only repositories that the - organization or user being viewed owns. - """ - ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR] - - """ - If non-null, filters repositories according to privacy. Internal - repositories are considered private; consider using the visibility argument - if only internal repositories are needed. Cannot be combined with the - visibility argument. - """ - privacy: RepositoryPrivacy - - """ - If non-null, filters repositories according to visibility. Cannot be combined with the privacy argument. - """ - visibility: RepositoryVisibility - ): RepositoryConnection! - - """ - A URL pointing to the user's public website/blog. - """ - websiteUrl: URI -} - -""" -The possible durations that a user can be blocked for. -""" -enum UserBlockDuration { - """ - The user was blocked for 1 day - """ - ONE_DAY - - """ - The user was blocked for 30 days - """ - ONE_MONTH - - """ - The user was blocked for 7 days - """ - ONE_WEEK - - """ - The user was blocked permanently - """ - PERMANENT - - """ - The user was blocked for 3 days - """ - THREE_DAYS -} - -""" -Represents a 'user_blocked' event on a given user. -""" -type UserBlockedEvent implements Node { - """ - Identifies the actor who performed the event. - """ - actor: Actor - - """ - Number of days that the user was blocked for. - """ - blockDuration: UserBlockDuration! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The Node ID of the UserBlockedEvent object - """ - id: ID! - - """ - The user who was blocked. - """ - subject: User -} - -""" -A list of users. -""" -type UserConnection { - """ - A list of edges. - """ - edges: [UserEdge] - - """ - A list of nodes. - """ - nodes: [User] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edit on user content -""" -type UserContentEdit implements Node { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the date and time when the object was deleted. - """ - deletedAt: DateTime - - """ - The actor who deleted this content - """ - deletedBy: Actor - - """ - A summary of the changes for this edit - """ - diff: String - - """ - When this content was edited - """ - editedAt: DateTime! - - """ - The actor who edited this content - """ - editor: Actor - - """ - The Node ID of the UserContentEdit object - """ - id: ID! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! -} - -""" -A list of edits to content. -""" -type UserContentEditConnection { - """ - A list of edges. - """ - edges: [UserContentEditEdge] - - """ - A list of nodes. - """ - nodes: [UserContentEdit] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type UserContentEditEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: UserContentEdit -} - -""" -Represents a user. -""" -type UserEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: User -} - -""" -Email attributes from External Identity -""" -type UserEmailMetadata { - """ - Boolean to identify primary emails - """ - primary: Boolean - - """ - Type of email - """ - type: String - - """ - Email id - """ - value: String! -} - -""" -A user-curated list of repositories -""" -type UserList implements Node { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - The description of this list - """ - description: String - - """ - The Node ID of the UserList object - """ - id: ID! - - """ - Whether or not this list is private - """ - isPrivate: Boolean! - - """ - The items associated with this list - """ - items( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): UserListItemsConnection! - - """ - The date and time at which this list was created or last had items added to it - """ - lastAddedAt: DateTime! - - """ - The name of this list - """ - name: String! - - """ - The slug of this list - """ - slug: String! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The user to which this list belongs - """ - user: User! -} - -""" -The connection type for UserList. -""" -type UserListConnection { - """ - A list of edges. - """ - edges: [UserListEdge] - - """ - A list of nodes. - """ - nodes: [UserList] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type UserListEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: UserList -} - -""" -Types that can be added to a user list. -""" -union UserListItems = Repository - -""" -The connection type for UserListItems. -""" -type UserListItemsConnection { - """ - A list of edges. - """ - edges: [UserListItemsEdge] - - """ - A list of nodes. - """ - nodes: [UserListItems] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type UserListItemsEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: UserListItems -} - -""" -Represents a suggested user list. -""" -type UserListSuggestion { - """ - The ID of the suggested user list - """ - id: ID - - """ - The name of the suggested user list - """ - name: String -} - -""" -The user's description of what they're currently doing. -""" -type UserStatus implements Node { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - An emoji summarizing the user's status. - """ - emoji: String - - """ - The status emoji as HTML. - """ - emojiHTML: HTML - - """ - If set, the status will not be shown after this date. - """ - expiresAt: DateTime - - """ - The Node ID of the UserStatus object - """ - id: ID! - - """ - Whether this status indicates the user is not fully available on GitHub. - """ - indicatesLimitedAvailability: Boolean! - - """ - A brief message describing what the user is doing. - """ - message: String - - """ - The organization whose members can see this status. If null, this status is publicly visible. - """ - organization: Organization - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The user who has this status. - """ - user: User! -} - -""" -The connection type for UserStatus. -""" -type UserStatusConnection { - """ - A list of edges. - """ - edges: [UserStatusEdge] - - """ - A list of nodes. - """ - nodes: [UserStatus] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type UserStatusEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: UserStatus -} - -""" -Ordering options for user status connections. -""" -input UserStatusOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order user statuses by. - """ - field: UserStatusOrderField! -} - -""" -Properties by which user status connections can be ordered. -""" -enum UserStatusOrderField { - """ - Order user statuses by when they were updated. - """ - UPDATED_AT -} - -""" -A domain that can be verified or approved 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. - """ - databaseId: Int - - """ - The DNS host name that should be used for verification. - """ - dnsHostName: URI - - """ - The unicode encoded domain. - """ - domain: URI! - - """ - Whether a TXT record for verification with the expected host name was found. - """ - hasFoundHostName: Boolean! - - """ - Whether a TXT record for verification with the expected verification token was found. - """ - hasFoundVerificationToken: Boolean! - - """ - The Node ID of the VerifiableDomain object - """ - id: ID! - - """ - Whether or not the domain is approved. - """ - isApproved: Boolean! - - """ - Whether this domain is required to exist for an organization or enterprise policy to be enforced. - """ - isRequiredForPolicyEnforcement: Boolean! - - """ - Whether or not the domain is verified. - """ - isVerified: Boolean! - - """ - The owner of the domain. - """ - owner: VerifiableDomainOwner! - - """ - The punycode encoded domain. - """ - punycodeEncodedDomain: URI! - - """ - The time that the current verification token will expire. - """ - tokenExpirationTime: DateTime - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The current verification token for the domain. - """ - verificationToken: String -} - -""" -The connection type for VerifiableDomain. -""" -type VerifiableDomainConnection { - """ - A list of edges. - """ - edges: [VerifiableDomainEdge] - - """ - A list of nodes. - """ - nodes: [VerifiableDomain] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type VerifiableDomainEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: VerifiableDomain -} - -""" -Ordering options for verifiable domain connections. -""" -input VerifiableDomainOrder { - """ - The ordering direction. - """ - direction: OrderDirection! - - """ - The field to order verifiable domains by. - """ - field: VerifiableDomainOrderField! -} - -""" -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. - """ - DOMAIN -} - -""" -Types that can own a verifiable domain. -""" -union VerifiableDomainOwner = Enterprise | Organization - -""" -Autogenerated input type of VerifyVerifiableDomain -""" -input VerifyVerifiableDomainInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The ID of the verifiable domain to verify. - """ - id: ID! @possibleTypes(concreteTypes: ["VerifiableDomain"]) -} - -""" -Autogenerated return type of VerifyVerifiableDomain -""" -type VerifyVerifiableDomainPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The verifiable domain that was verified. - """ - domain: VerifiableDomain -} - -""" -A hovercard context with a message describing how the viewer is related. -""" -type ViewerHovercardContext implements HovercardContext { - """ - A string describing this context - """ - message: String! - - """ - An octicon to accompany this context - """ - octicon: String! - - """ - Identifies the user who is related to this context. - """ - viewer: User! -} - -""" -A subject that may be upvoted. -""" -interface Votable { - """ - Number of upvotes that this subject has received. - """ - upvoteCount: Int! - - """ - Whether or not the current user can add or remove an upvote on this subject. - """ - viewerCanUpvote: Boolean! - - """ - Whether or not the current user has already upvoted this subject. - """ - viewerHasUpvoted: Boolean! -} - -""" -A workflow contains meta information about an Actions workflow file. -""" -type Workflow implements Node & UniformResourceLocatable { - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The Node ID of the Workflow object - """ - id: ID! - - """ - The name of the workflow. - """ - name: String! - - """ - The HTTP path for this workflow - """ - resourcePath: URI! - - """ - The runs of the workflow. - """ - runs( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - - """ - Ordering options for the connection - """ - orderBy: WorkflowRunOrder = {field: CREATED_AT, direction: DESC} - ): WorkflowRunConnection! - - """ - The state of the workflow. - """ - state: WorkflowState! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this workflow - """ - url: URI! -} - -""" -A workflow that must run for this rule to pass -""" -type WorkflowFileReference { - """ - The path to the workflow file - """ - path: String! - - """ - The ref (branch or tag) of the workflow file to use - """ - ref: String - - """ - The ID of the repository where the workflow is defined - """ - repositoryId: Int! - - """ - The commit SHA of the workflow file to use - """ - sha: String -} - -""" -A workflow that must run for this rule to pass -""" -input WorkflowFileReferenceInput { - """ - The path to the workflow file - """ - path: String! - - """ - The ref (branch or tag) of the workflow file to use - """ - ref: String - - """ - The ID of the repository where the workflow is defined - """ - repositoryId: Int! - - """ - The commit SHA of the workflow file to use - """ - sha: String -} - -""" -A workflow run. -""" -type WorkflowRun implements Node & UniformResourceLocatable { - """ - The check suite this workflow run belongs to. - """ - checkSuite: CheckSuite! - - """ - Identifies the date and time when the object was created. - """ - createdAt: DateTime! - - """ - Identifies the primary key from the database. - """ - databaseId: Int - - """ - The log of deployment reviews - """ - deploymentReviews( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): DeploymentReviewConnection! - - """ - The event that triggered the workflow run - """ - event: String! - - """ - The workflow file - """ - file: WorkflowRunFile - - """ - The Node ID of the WorkflowRun object - """ - id: ID! - - """ - The pending deployment requests of all check runs in this workflow run - """ - pendingDeploymentRequests( - """ - Returns the elements in the list that come after the specified cursor. - """ - after: String - - """ - Returns the elements in the list that come before the specified cursor. - """ - before: String - - """ - Returns the first _n_ elements from the list. - """ - first: Int - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): DeploymentRequestConnection! - - """ - The HTTP path for this workflow run - """ - resourcePath: URI! - - """ - A number that uniquely identifies this workflow run in its parent workflow. - """ - runNumber: Int! - - """ - Identifies the date and time when the object was last updated. - """ - updatedAt: DateTime! - - """ - The HTTP URL for this workflow run - """ - url: URI! - - """ - The workflow executed in this workflow run. - """ - workflow: Workflow! -} - -""" -The connection type for WorkflowRun. -""" -type WorkflowRunConnection { - """ - A list of edges. - """ - edges: [WorkflowRunEdge] - - """ - A list of nodes. - """ - nodes: [WorkflowRun] - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! - - """ - Identifies the total count of items in the connection. - """ - totalCount: Int! -} - -""" -An edge in a connection. -""" -type WorkflowRunEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of the edge. - """ - node: WorkflowRun -} - -""" -An executed workflow file for a workflow run. -""" -type WorkflowRunFile implements Node & UniformResourceLocatable { - """ - The Node ID of the WorkflowRunFile object - """ - id: ID! - - """ - The path of the workflow file relative to its repository. - """ - path: String! - - """ - The direct link to the file in the repository which stores the workflow file. - """ - repositoryFileUrl: URI! - - """ - The repository name and owner which stores the workflow file. - """ - repositoryName: URI! - - """ - The HTTP path for this workflow run file - """ - resourcePath: URI! - - """ - The parent workflow run execution for this file. - """ - run: WorkflowRun! - - """ - The HTTP URL for this workflow run file - """ - url: URI! - - """ - If the viewer has permissions to push to the repository which stores the workflow. - """ - viewerCanPushRepository: Boolean! - - """ - If the viewer has permissions to read the repository which stores the workflow. - """ - viewerCanReadRepository: Boolean! -} - -""" -Ways in which lists of workflow runs can be ordered upon return. -""" -input WorkflowRunOrder { - """ - The direction in which to order workflow runs by the specified field. - """ - direction: OrderDirection! - - """ - The field by which to order workflows. - """ - field: WorkflowRunOrderField! -} - -""" -Properties by which workflow run connections can be ordered. -""" -enum WorkflowRunOrderField { - """ - Order workflow runs by most recently created - """ - CREATED_AT -} - -""" -The possible states for a workflow. -""" -enum WorkflowState { - """ - The workflow is active. - """ - ACTIVE - - """ - The workflow was deleted from the git repository. - """ - DELETED - - """ - The workflow was disabled by default on a fork. - """ - DISABLED_FORK - - """ - The workflow was disabled for inactivity in the repository. - """ - DISABLED_INACTIVITY - - """ - The workflow was disabled manually. - """ - DISABLED_MANUALLY -} - -""" -Require all changes made to a targeted branch to pass the specified workflows before they can be merged. -""" -type WorkflowsParameters { - """ - Workflows that must pass for this rule to pass. - """ - workflows: [WorkflowFileReference!]! -} - -""" -Require all changes made to a targeted branch to pass the specified workflows before they can be merged. -""" -input WorkflowsParametersInput { - """ - Workflows that must pass for this rule to pass. - """ - workflows: [WorkflowFileReferenceInput!]! -} - -""" -A valid x509 certificate string -""" -scalar X509Certificate diff --git a/src/graphql/data/ghes-3.14/schema.json b/src/graphql/data/ghes-3.14/schema.json deleted file mode 100644 index 78672426d71e..000000000000 --- a/src/graphql/data/ghes-3.14/schema.json +++ /dev/null @@ -1,84718 +0,0 @@ -{ - "queries": [ - { - "name": "codeOfConduct", - "type": "CodeOfConduct", - "id": "codeofconduct", - "href": "/graphql/reference/objects#codeofconduct", - "description": "

Look up a code of conduct by its key.

", - "args": [ - { - "name": "key", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

The code of conduct's key.

" - } - ] - }, - { - "name": "codesOfConduct", - "type": "[CodeOfConduct]", - "id": "codeofconduct", - "href": "/graphql/reference/objects#codeofconduct", - "description": "

Look up a code of conduct by its key.

", - "args": [] - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

Look up an enterprise by URL slug.

", - "args": [ - { - "name": "invitationToken", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

The enterprise invitation token.

" - }, - { - "name": "slug", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

The enterprise URL slug.

" - } - ] - }, - { - "name": "license", - "type": "License", - "id": "license", - "href": "/graphql/reference/objects#license", - "description": "

Look up an open source license by its key.

", - "args": [ - { - "name": "key", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

The license's downcased SPDX ID.

" - } - ] - }, - { - "name": "licenses", - "type": "[License]!", - "id": "license", - "href": "/graphql/reference/objects#license", - "description": "

Return a list of known open source licenses.

", - "args": [] - }, - { - "name": "meta", - "type": "GitHubMetadata!", - "id": "githubmetadata", - "href": "/graphql/reference/objects#githubmetadata", - "description": "

Return information about the GitHub instance.

", - "args": [] - }, - { - "name": "node", - "type": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node", - "description": "

Fetches an object given its ID.

", - "args": [ - { - "name": "id", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "description": "

ID of the object.

" - } - ] - }, - { - "name": "nodes", - "type": "[Node]!", - "id": "node", - "href": "/graphql/reference/interfaces#node", - "description": "

Lookup nodes by a list of IDs.

", - "args": [ - { - "name": "ids", - "type": "[ID!]!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "description": "

The list of node IDs.

" - } - ] - }, - { - "name": "organization", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization", - "description": "

Lookup a organization by login.

", - "args": [ - { - "name": "login", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

The organization's login.

" - } - ] - }, - { - "name": "organizations", - "type": "OrganizationConnection!", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "description": "

A list of organizations.

", - "args": [ - { - "name": "after", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

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

" - }, - { - "name": "before", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

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

" - }, - { - "name": "first", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int", - "description": "

Returns the first n elements from the list.

" - }, - { - "name": "last", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int", - "description": "

Returns the last n elements from the list.

" - }, - { - "name": "orderBy", - "type": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder", - "description": "

Ordering options for the User's organizations.

" - } - ] - }, - { - "name": "rateLimit", - "type": "RateLimit", - "id": "ratelimit", - "href": "/graphql/reference/objects#ratelimit", - "description": "

The client's rate limit information.

", - "args": [ - { - "name": "dryRun", - "defaultValue": false, - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "description": "

If true, calculate the cost for the query without evaluating it.

" - } - ] - }, - { - "name": "relay", - "type": "Query!", - "id": "query", - "href": "/graphql/reference/objects#query", - "description": "

Workaround for re-exposing the root query object. (Refer to\nhttps://github.com/facebook/relay/issues/112 for more information.).

", - "args": [] - }, - { - "name": "repository", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "description": "

Lookup a given repository by the owner and repository name.

", - "args": [ - { - "name": "followRenames", - "defaultValue": true, - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "description": "

Follow repository renames. If disabled, a repository referenced by its old name will return an error.

" - }, - { - "name": "name", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

The name of the repository.

" - }, - { - "name": "owner", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

The login field of a user or organization.

" - } - ] - }, - { - "name": "repositoryOwner", - "type": "RepositoryOwner", - "id": "repositoryowner", - "href": "/graphql/reference/interfaces#repositoryowner", - "description": "

Lookup a repository owner (ie. either a User or an Organization) by login.

", - "args": [ - { - "name": "login", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

The username to lookup the owner by.

" - } - ] - }, - { - "name": "resource", - "type": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable", - "description": "

Lookup resource by a URL.

", - "args": [ - { - "name": "url", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "description": "

The URL.

" - } - ] - }, - { - "name": "search", - "type": "SearchResultItemConnection!", - "id": "searchresultitemconnection", - "href": "/graphql/reference/objects#searchresultitemconnection", - "description": "

Perform a search across resources, returning a maximum of 1,000 results.

", - "args": [ - { - "name": "after", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

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

" - }, - { - "name": "before", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

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

" - }, - { - "name": "first", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int", - "description": "

Returns the first n elements from the list.

" - }, - { - "name": "last", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int", - "description": "

Returns the last n elements from the list.

" - }, - { - "name": "query", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

The search string to look for. GitHub search syntax is supported. For more\ninformation, see \"Searching on\nGitHub,\"\n\"Understanding the search syntax,\"\nand \"Sorting search results.\".

" - }, - { - "name": "type", - "type": "SearchType!", - "id": "searchtype", - "href": "/graphql/reference/enums#searchtype", - "description": "

The types of search items to search within.

" - } - ] - }, - { - "name": "securityAdvisories", - "type": "SecurityAdvisoryConnection!", - "id": "securityadvisoryconnection", - "href": "/graphql/reference/objects#securityadvisoryconnection", - "description": "

GitHub Security Advisories.

", - "args": [ - { - "name": "after", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

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

" - }, - { - "name": "before", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

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

" - }, - { - "name": "classifications", - "type": "[SecurityAdvisoryClassification!]", - "id": "securityadvisoryclassification", - "href": "/graphql/reference/enums#securityadvisoryclassification", - "description": "

A list of classifications to filter advisories by.

" - }, - { - "name": "first", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int", - "description": "

Returns the first n elements from the list.

" - }, - { - "name": "last", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int", - "description": "

Returns the last n elements from the list.

" - }, - { - "name": "publishedSince", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime", - "description": "

Filter advisories to those published since a time in the past.

" - }, - { - "name": "updatedSince", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime", - "description": "

Filter advisories to those updated since a time in the past.

" - } - ] - }, - { - "name": "securityAdvisory", - "type": "SecurityAdvisory", - "id": "securityadvisory", - "href": "/graphql/reference/objects#securityadvisory", - "description": "

Fetch a Security Advisory by its GHSA ID.

", - "args": [ - { - "name": "ghsaId", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

GitHub Security Advisory ID.

" - } - ] - }, - { - "name": "securityVulnerabilities", - "type": "SecurityVulnerabilityConnection!", - "id": "securityvulnerabilityconnection", - "href": "/graphql/reference/objects#securityvulnerabilityconnection", - "description": "

Software Vulnerabilities documented by GitHub Security Advisories.

", - "args": [ - { - "name": "after", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

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

" - }, - { - "name": "before", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

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

" - }, - { - "name": "classifications", - "type": "[SecurityAdvisoryClassification!]", - "id": "securityadvisoryclassification", - "href": "/graphql/reference/enums#securityadvisoryclassification", - "description": "

A list of advisory classifications to filter vulnerabilities by.

" - }, - { - "name": "ecosystem", - "type": "SecurityAdvisoryEcosystem", - "id": "securityadvisoryecosystem", - "href": "/graphql/reference/enums#securityadvisoryecosystem", - "description": "

An ecosystem to filter vulnerabilities by.

" - }, - { - "name": "first", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int", - "description": "

Returns the first n elements from the list.

" - }, - { - "name": "last", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int", - "description": "

Returns the last n elements from the list.

" - }, - { - "name": "package", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A package name to filter vulnerabilities by.

" - }, - { - "name": "severities", - "type": "[SecurityAdvisorySeverity!]", - "id": "securityadvisoryseverity", - "href": "/graphql/reference/enums#securityadvisoryseverity", - "description": "

A list of severities to filter vulnerabilities by.

" - } - ] - }, - { - "name": "topic", - "type": "Topic", - "id": "topic", - "href": "/graphql/reference/objects#topic", - "description": "

Look up a topic by name.

", - "args": [ - { - "name": "name", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

The topic's name.

" - } - ] - }, - { - "name": "user", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user", - "description": "

Lookup a user by login.

", - "args": [ - { - "name": "login", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

The user's login.

" - } - ] - }, - { - "name": "users", - "type": "UserConnection!", - "id": "userconnection", - "href": "/graphql/reference/objects#userconnection", - "description": "

A list of users.

", - "args": [ - { - "name": "after", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

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

" - }, - { - "name": "before", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

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

" - }, - { - "name": "first", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int", - "description": "

Returns the first n elements from the list.

" - }, - { - "name": "last", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int", - "description": "

Returns the last n elements from the list.

" - } - ] - }, - { - "name": "viewer", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user", - "description": "

The currently authenticated user.

", - "args": [] - } - ], - "mutations": [ - { - "name": "abortQueuedMigrations", - "id": "abortqueuedmigrations", - "href": "/graphql/reference/mutations#abortqueuedmigrations", - "description": "

Clear all of a customer's queued migrations.

", - "inputFields": [ - { - "name": "input", - "type": "AbortQueuedMigrationsInput!", - "id": "abortqueuedmigrationsinput", - "href": "/graphql/reference/input-objects#abortqueuedmigrationsinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "success", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "description": "

Did the operation succeed?.

" - } - ] - }, - { - "name": "abortRepositoryMigration", - "id": "abortrepositorymigration", - "href": "/graphql/reference/mutations#abortrepositorymigration", - "description": "

Abort a repository migration queued or in progress.

", - "inputFields": [ - { - "name": "input", - "type": "AbortRepositoryMigrationInput!", - "id": "abortrepositorymigrationinput", - "href": "/graphql/reference/input-objects#abortrepositorymigrationinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "success", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "description": "

Did the operation succeed?.

" - } - ] - }, - { - "name": "addAssigneesToAssignable", - "id": "addassigneestoassignable", - "href": "/graphql/reference/mutations#addassigneestoassignable", - "description": "

Adds assignees to an assignable object.

", - "inputFields": [ - { - "name": "input", - "type": "AddAssigneesToAssignableInput!", - "id": "addassigneestoassignableinput", - "href": "/graphql/reference/input-objects#addassigneestoassignableinput" - } - ], - "returnFields": [ - { - "name": "assignable", - "type": "Assignable", - "id": "assignable", - "href": "/graphql/reference/interfaces#assignable", - "description": "

The item that was assigned.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "addComment", - "id": "addcomment", - "href": "/graphql/reference/mutations#addcomment", - "description": "

Adds a comment to an Issue or Pull Request.

", - "inputFields": [ - { - "name": "input", - "type": "AddCommentInput!", - "id": "addcommentinput", - "href": "/graphql/reference/input-objects#addcommentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "commentEdge", - "type": "IssueCommentEdge", - "id": "issuecommentedge", - "href": "/graphql/reference/objects#issuecommentedge", - "description": "

The edge from the subject's comment connection.

" - }, - { - "name": "subject", - "type": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node", - "description": "

The subject.

" - }, - { - "name": "timelineEdge", - "type": "IssueTimelineItemEdge", - "id": "issuetimelineitemedge", - "href": "/graphql/reference/objects#issuetimelineitemedge", - "description": "

The edge from the subject's timeline connection.

" - } - ] - }, - { - "name": "addDiscussionComment", - "id": "adddiscussioncomment", - "href": "/graphql/reference/mutations#adddiscussioncomment", - "description": "

Adds a comment to a Discussion, possibly as a reply to another comment.

", - "inputFields": [ - { - "name": "input", - "type": "AddDiscussionCommentInput!", - "id": "adddiscussioncommentinput", - "href": "/graphql/reference/input-objects#adddiscussioncommentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "comment", - "type": "DiscussionComment", - "id": "discussioncomment", - "href": "/graphql/reference/objects#discussioncomment", - "description": "

The newly created discussion comment.

" - } - ] - }, - { - "name": "addDiscussionPollVote", - "id": "adddiscussionpollvote", - "href": "/graphql/reference/mutations#adddiscussionpollvote", - "description": "

Vote for an option in a discussion poll.

", - "inputFields": [ - { - "name": "input", - "type": "AddDiscussionPollVoteInput!", - "id": "adddiscussionpollvoteinput", - "href": "/graphql/reference/input-objects#adddiscussionpollvoteinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pollOption", - "type": "DiscussionPollOption", - "id": "discussionpolloption", - "href": "/graphql/reference/objects#discussionpolloption", - "description": "

The poll option that a vote was added to.

" - } - ] - }, - { - "name": "addEnterpriseAdmin", - "id": "addenterpriseadmin", - "href": "/graphql/reference/mutations#addenterpriseadmin", - "description": "

Adds an administrator to the global enterprise account.

", - "inputFields": [ - { - "name": "input", - "type": "AddEnterpriseAdminInput!", - "id": "addenterpriseadmininput", - "href": "/graphql/reference/input-objects#addenterpriseadmininput" - } - ], - "returnFields": [ - { - "name": "admin", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user", - "description": "

The user who was added as an administrator.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

The updated enterprise.

" - }, - { - "name": "role", - "type": "EnterpriseAdministratorRole", - "id": "enterpriseadministratorrole", - "href": "/graphql/reference/enums#enterpriseadministratorrole", - "description": "

The role of the administrator.

" - }, - { - "name": "viewer", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user", - "description": "

The viewer performing the mutation.

" - } - ] - }, - { - "name": "addEnterpriseOrganizationMember", - "id": "addenterpriseorganizationmember", - "href": "/graphql/reference/mutations#addenterpriseorganizationmember", - "description": "

Adds enterprise members to an organization within the enterprise.

", - "inputFields": [ - { - "name": "input", - "type": "AddEnterpriseOrganizationMemberInput!", - "id": "addenterpriseorganizationmemberinput", - "href": "/graphql/reference/input-objects#addenterpriseorganizationmemberinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "users", - "type": "[User!]", - "id": "user", - "href": "/graphql/reference/objects#user", - "description": "

The users who were added to the organization.

" - } - ] - }, - { - "name": "addLabelsToLabelable", - "id": "addlabelstolabelable", - "href": "/graphql/reference/mutations#addlabelstolabelable", - "description": "

Adds labels to a labelable object.

", - "inputFields": [ - { - "name": "input", - "type": "AddLabelsToLabelableInput!", - "id": "addlabelstolabelableinput", - "href": "/graphql/reference/input-objects#addlabelstolabelableinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "labelable", - "type": "Labelable", - "id": "labelable", - "href": "/graphql/reference/interfaces#labelable", - "description": "

The item that was labeled.

" - } - ] - }, - { - "name": "addProjectCard", - "id": "addprojectcard", - "href": "/graphql/reference/mutations#addprojectcard", - "description": "

Adds a card to a ProjectColumn. Either contentId or note must be provided but not both.

", - "inputFields": [ - { - "name": "input", - "type": "AddProjectCardInput!", - "id": "addprojectcardinput", - "href": "/graphql/reference/input-objects#addprojectcardinput" - } - ], - "returnFields": [ - { - "name": "cardEdge", - "type": "ProjectCardEdge", - "id": "projectcardedge", - "href": "/graphql/reference/objects#projectcardedge", - "description": "

The edge from the ProjectColumn's card connection.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "projectColumn", - "type": "ProjectColumn", - "id": "projectcolumn", - "href": "/graphql/reference/objects#projectcolumn", - "description": "

The ProjectColumn.

" - } - ] - }, - { - "name": "addProjectColumn", - "id": "addprojectcolumn", - "href": "/graphql/reference/mutations#addprojectcolumn", - "description": "

Adds a column to a Project.

", - "inputFields": [ - { - "name": "input", - "type": "AddProjectColumnInput!", - "id": "addprojectcolumninput", - "href": "/graphql/reference/input-objects#addprojectcolumninput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "columnEdge", - "type": "ProjectColumnEdge", - "id": "projectcolumnedge", - "href": "/graphql/reference/objects#projectcolumnedge", - "description": "

The edge from the project's column connection.

" - }, - { - "name": "project", - "type": "Project", - "id": "project", - "href": "/graphql/reference/objects#project", - "description": "

The project.

" - } - ] - }, - { - "name": "addProjectV2DraftIssue", - "id": "addprojectv2draftissue", - "href": "/graphql/reference/mutations#addprojectv2draftissue", - "description": "

Creates a new draft issue and add it to a Project.

", - "inputFields": [ - { - "name": "input", - "type": "AddProjectV2DraftIssueInput!", - "id": "addprojectv2draftissueinput", - "href": "/graphql/reference/input-objects#addprojectv2draftissueinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "projectItem", - "type": "ProjectV2Item", - "id": "projectv2item", - "href": "/graphql/reference/objects#projectv2item", - "description": "

The draft issue added to the project.

" - } - ] - }, - { - "name": "addProjectV2ItemById", - "id": "addprojectv2itembyid", - "href": "/graphql/reference/mutations#addprojectv2itembyid", - "description": "

Links an existing content instance to a Project.

", - "inputFields": [ - { - "name": "input", - "type": "AddProjectV2ItemByIdInput!", - "id": "addprojectv2itembyidinput", - "href": "/graphql/reference/input-objects#addprojectv2itembyidinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "item", - "type": "ProjectV2Item", - "id": "projectv2item", - "href": "/graphql/reference/objects#projectv2item", - "description": "

The item added to the project.

" - } - ] - }, - { - "name": "addPullRequestReview", - "id": "addpullrequestreview", - "href": "/graphql/reference/mutations#addpullrequestreview", - "description": "

Adds a review to a Pull Request.

", - "inputFields": [ - { - "name": "input", - "type": "AddPullRequestReviewInput!", - "id": "addpullrequestreviewinput", - "href": "/graphql/reference/input-objects#addpullrequestreviewinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequestReview", - "type": "PullRequestReview", - "id": "pullrequestreview", - "href": "/graphql/reference/objects#pullrequestreview", - "description": "

The newly created pull request review.

" - }, - { - "name": "reviewEdge", - "type": "PullRequestReviewEdge", - "id": "pullrequestreviewedge", - "href": "/graphql/reference/objects#pullrequestreviewedge", - "description": "

The edge from the pull request's review connection.

" - } - ] - }, - { - "name": "addPullRequestReviewComment", - "id": "addpullrequestreviewcomment", - "href": "/graphql/reference/mutations#addpullrequestreviewcomment", - "description": "

Adds a comment to a review.

", - "inputFields": [ - { - "name": "input", - "type": "AddPullRequestReviewCommentInput!", - "id": "addpullrequestreviewcommentinput", - "href": "/graphql/reference/input-objects#addpullrequestreviewcommentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "comment", - "type": "PullRequestReviewComment", - "id": "pullrequestreviewcomment", - "href": "/graphql/reference/objects#pullrequestreviewcomment", - "description": "

The newly created comment.

" - }, - { - "name": "commentEdge", - "type": "PullRequestReviewCommentEdge", - "id": "pullrequestreviewcommentedge", - "href": "/graphql/reference/objects#pullrequestreviewcommentedge", - "description": "

The edge from the review's comment connection.

" - } - ] - }, - { - "name": "addPullRequestReviewThread", - "id": "addpullrequestreviewthread", - "href": "/graphql/reference/mutations#addpullrequestreviewthread", - "description": "

Adds a new thread to a pending Pull Request Review.

", - "inputFields": [ - { - "name": "input", - "type": "AddPullRequestReviewThreadInput!", - "id": "addpullrequestreviewthreadinput", - "href": "/graphql/reference/input-objects#addpullrequestreviewthreadinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "thread", - "type": "PullRequestReviewThread", - "id": "pullrequestreviewthread", - "href": "/graphql/reference/objects#pullrequestreviewthread", - "description": "

The newly created thread.

" - } - ] - }, - { - "name": "addPullRequestReviewThreadReply", - "id": "addpullrequestreviewthreadreply", - "href": "/graphql/reference/mutations#addpullrequestreviewthreadreply", - "description": "

Adds a reply to an existing Pull Request Review Thread.

", - "inputFields": [ - { - "name": "input", - "type": "AddPullRequestReviewThreadReplyInput!", - "id": "addpullrequestreviewthreadreplyinput", - "href": "/graphql/reference/input-objects#addpullrequestreviewthreadreplyinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "comment", - "type": "PullRequestReviewComment", - "id": "pullrequestreviewcomment", - "href": "/graphql/reference/objects#pullrequestreviewcomment", - "description": "

The newly created reply.

" - } - ] - }, - { - "name": "addReaction", - "id": "addreaction", - "href": "/graphql/reference/mutations#addreaction", - "description": "

Adds a reaction to a subject.

", - "inputFields": [ - { - "name": "input", - "type": "AddReactionInput!", - "id": "addreactioninput", - "href": "/graphql/reference/input-objects#addreactioninput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "reaction", - "type": "Reaction", - "id": "reaction", - "href": "/graphql/reference/objects#reaction", - "description": "

The reaction object.

" - }, - { - "name": "reactionGroups", - "type": "[ReactionGroup!]", - "id": "reactiongroup", - "href": "/graphql/reference/objects#reactiongroup", - "description": "

The reaction groups for the subject.

" - }, - { - "name": "subject", - "type": "Reactable", - "id": "reactable", - "href": "/graphql/reference/interfaces#reactable", - "description": "

The reactable subject.

" - } - ] - }, - { - "name": "addStar", - "id": "addstar", - "href": "/graphql/reference/mutations#addstar", - "description": "

Adds a star to a Starrable.

", - "inputFields": [ - { - "name": "input", - "type": "AddStarInput!", - "id": "addstarinput", - "href": "/graphql/reference/input-objects#addstarinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "starrable", - "type": "Starrable", - "id": "starrable", - "href": "/graphql/reference/interfaces#starrable", - "description": "

The starrable.

" - } - ] - }, - { - "name": "addUpvote", - "id": "addupvote", - "href": "/graphql/reference/mutations#addupvote", - "description": "

Add an upvote to a discussion or discussion comment.

", - "inputFields": [ - { - "name": "input", - "type": "AddUpvoteInput!", - "id": "addupvoteinput", - "href": "/graphql/reference/input-objects#addupvoteinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "subject", - "type": "Votable", - "id": "votable", - "href": "/graphql/reference/interfaces#votable", - "description": "

The votable subject.

" - } - ] - }, - { - "name": "addVerifiableDomain", - "id": "addverifiabledomain", - "href": "/graphql/reference/mutations#addverifiabledomain", - "description": "

Adds a verifiable domain to an owning account.

", - "inputFields": [ - { - "name": "input", - "type": "AddVerifiableDomainInput!", - "id": "addverifiabledomaininput", - "href": "/graphql/reference/input-objects#addverifiabledomaininput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "domain", - "type": "VerifiableDomain", - "id": "verifiabledomain", - "href": "/graphql/reference/objects#verifiabledomain", - "description": "

The verifiable domain that was added.

" - } - ] - }, - { - "name": "approveDeployments", - "id": "approvedeployments", - "href": "/graphql/reference/mutations#approvedeployments", - "description": "

Approve all pending deployments under one or more environments.

", - "inputFields": [ - { - "name": "input", - "type": "ApproveDeploymentsInput!", - "id": "approvedeploymentsinput", - "href": "/graphql/reference/input-objects#approvedeploymentsinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "deployments", - "type": "[Deployment!]", - "id": "deployment", - "href": "/graphql/reference/objects#deployment", - "description": "

The affected deployments.

" - } - ] - }, - { - "name": "approveVerifiableDomain", - "id": "approveverifiabledomain", - "href": "/graphql/reference/mutations#approveverifiabledomain", - "description": "

Approve a verifiable domain for notification delivery.

", - "inputFields": [ - { - "name": "input", - "type": "ApproveVerifiableDomainInput!", - "id": "approveverifiabledomaininput", - "href": "/graphql/reference/input-objects#approveverifiabledomaininput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "domain", - "type": "VerifiableDomain", - "id": "verifiabledomain", - "href": "/graphql/reference/objects#verifiabledomain", - "description": "

The verifiable domain that was approved.

" - } - ] - }, - { - "name": "archiveProjectV2Item", - "id": "archiveprojectv2item", - "href": "/graphql/reference/mutations#archiveprojectv2item", - "description": "

Archives a ProjectV2Item.

", - "inputFields": [ - { - "name": "input", - "type": "ArchiveProjectV2ItemInput!", - "id": "archiveprojectv2iteminput", - "href": "/graphql/reference/input-objects#archiveprojectv2iteminput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "item", - "type": "ProjectV2Item", - "id": "projectv2item", - "href": "/graphql/reference/objects#projectv2item", - "description": "

The item archived from the project.

" - } - ] - }, - { - "name": "archiveRepository", - "id": "archiverepository", - "href": "/graphql/reference/mutations#archiverepository", - "description": "

Marks a repository as archived.

", - "inputFields": [ - { - "name": "input", - "type": "ArchiveRepositoryInput!", - "id": "archiverepositoryinput", - "href": "/graphql/reference/input-objects#archiverepositoryinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "repository", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "description": "

The repository that was marked as archived.

" - } - ] - }, - { - "name": "changeUserStatus", - "id": "changeuserstatus", - "href": "/graphql/reference/mutations#changeuserstatus", - "description": "

Update your status on GitHub.

", - "inputFields": [ - { - "name": "input", - "type": "ChangeUserStatusInput!", - "id": "changeuserstatusinput", - "href": "/graphql/reference/input-objects#changeuserstatusinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "status", - "type": "UserStatus", - "id": "userstatus", - "href": "/graphql/reference/objects#userstatus", - "description": "

Your updated status.

" - } - ] - }, - { - "name": "clearLabelsFromLabelable", - "id": "clearlabelsfromlabelable", - "href": "/graphql/reference/mutations#clearlabelsfromlabelable", - "description": "

Clears all labels from a labelable object.

", - "inputFields": [ - { - "name": "input", - "type": "ClearLabelsFromLabelableInput!", - "id": "clearlabelsfromlabelableinput", - "href": "/graphql/reference/input-objects#clearlabelsfromlabelableinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "labelable", - "type": "Labelable", - "id": "labelable", - "href": "/graphql/reference/interfaces#labelable", - "description": "

The item that was unlabeled.

" - } - ] - }, - { - "name": "clearProjectV2ItemFieldValue", - "id": "clearprojectv2itemfieldvalue", - "href": "/graphql/reference/mutations#clearprojectv2itemfieldvalue", - "description": "

This mutation clears the value of a field for an item in a Project. Currently\nonly text, number, date, assignees, labels, single-select, iteration and\nmilestone fields are supported.

", - "inputFields": [ - { - "name": "input", - "type": "ClearProjectV2ItemFieldValueInput!", - "id": "clearprojectv2itemfieldvalueinput", - "href": "/graphql/reference/input-objects#clearprojectv2itemfieldvalueinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "projectV2Item", - "type": "ProjectV2Item", - "id": "projectv2item", - "href": "/graphql/reference/objects#projectv2item", - "description": "

The updated item.

" - } - ] - }, - { - "name": "cloneProject", - "id": "cloneproject", - "href": "/graphql/reference/mutations#cloneproject", - "description": "

Creates a new project by cloning configuration from an existing project.

", - "inputFields": [ - { - "name": "input", - "type": "CloneProjectInput!", - "id": "cloneprojectinput", - "href": "/graphql/reference/input-objects#cloneprojectinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "jobStatusId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

The id of the JobStatus for populating cloned fields.

" - }, - { - "name": "project", - "type": "Project", - "id": "project", - "href": "/graphql/reference/objects#project", - "description": "

The new cloned project.

" - } - ] - }, - { - "name": "cloneTemplateRepository", - "id": "clonetemplaterepository", - "href": "/graphql/reference/mutations#clonetemplaterepository", - "description": "

Create a new repository with the same files and directory structure as a template repository.

", - "inputFields": [ - { - "name": "input", - "type": "CloneTemplateRepositoryInput!", - "id": "clonetemplaterepositoryinput", - "href": "/graphql/reference/input-objects#clonetemplaterepositoryinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "repository", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "description": "

The new repository.

" - } - ] - }, - { - "name": "closeDiscussion", - "id": "closediscussion", - "href": "/graphql/reference/mutations#closediscussion", - "description": "

Close a discussion.

", - "inputFields": [ - { - "name": "input", - "type": "CloseDiscussionInput!", - "id": "closediscussioninput", - "href": "/graphql/reference/input-objects#closediscussioninput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "discussion", - "type": "Discussion", - "id": "discussion", - "href": "/graphql/reference/objects#discussion", - "description": "

The discussion that was closed.

" - } - ] - }, - { - "name": "closeIssue", - "id": "closeissue", - "href": "/graphql/reference/mutations#closeissue", - "description": "

Close an issue.

", - "inputFields": [ - { - "name": "input", - "type": "CloseIssueInput!", - "id": "closeissueinput", - "href": "/graphql/reference/input-objects#closeissueinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "issue", - "type": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue", - "description": "

The issue that was closed.

" - } - ] - }, - { - "name": "closePullRequest", - "id": "closepullrequest", - "href": "/graphql/reference/mutations#closepullrequest", - "description": "

Close a pull request.

", - "inputFields": [ - { - "name": "input", - "type": "ClosePullRequestInput!", - "id": "closepullrequestinput", - "href": "/graphql/reference/input-objects#closepullrequestinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequest", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest", - "description": "

The pull request that was closed.

" - } - ] - }, - { - "name": "convertProjectCardNoteToIssue", - "id": "convertprojectcardnotetoissue", - "href": "/graphql/reference/mutations#convertprojectcardnotetoissue", - "description": "

Convert a project note card to one associated with a newly created issue.

", - "inputFields": [ - { - "name": "input", - "type": "ConvertProjectCardNoteToIssueInput!", - "id": "convertprojectcardnotetoissueinput", - "href": "/graphql/reference/input-objects#convertprojectcardnotetoissueinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "projectCard", - "type": "ProjectCard", - "id": "projectcard", - "href": "/graphql/reference/objects#projectcard", - "description": "

The updated ProjectCard.

" - } - ] - }, - { - "name": "convertPullRequestToDraft", - "id": "convertpullrequesttodraft", - "href": "/graphql/reference/mutations#convertpullrequesttodraft", - "description": "

Converts a pull request to draft.

", - "inputFields": [ - { - "name": "input", - "type": "ConvertPullRequestToDraftInput!", - "id": "convertpullrequesttodraftinput", - "href": "/graphql/reference/input-objects#convertpullrequesttodraftinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequest", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest", - "description": "

The pull request that is now a draft.

" - } - ] - }, - { - "name": "copyProjectV2", - "id": "copyprojectv2", - "href": "/graphql/reference/mutations#copyprojectv2", - "description": "

Copy a project.

", - "inputFields": [ - { - "name": "input", - "type": "CopyProjectV2Input!", - "id": "copyprojectv2input", - "href": "/graphql/reference/input-objects#copyprojectv2input" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "projectV2", - "type": "ProjectV2", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2", - "description": "

The copied project.

" - } - ] - }, - { - "name": "createAttributionInvitation", - "id": "createattributioninvitation", - "href": "/graphql/reference/mutations#createattributioninvitation", - "description": "

Invites a user to claim reattributable data.

", - "inputFields": [ - { - "name": "input", - "type": "CreateAttributionInvitationInput!", - "id": "createattributioninvitationinput", - "href": "/graphql/reference/input-objects#createattributioninvitationinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "owner", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization", - "description": "

The owner scoping the reattributable data.

" - }, - { - "name": "source", - "type": "Claimable", - "id": "claimable", - "href": "/graphql/reference/unions#claimable", - "description": "

The account owning the data to reattribute.

" - }, - { - "name": "target", - "type": "Claimable", - "id": "claimable", - "href": "/graphql/reference/unions#claimable", - "description": "

The account which may claim the data.

" - } - ] - }, - { - "name": "createBranchProtectionRule", - "id": "createbranchprotectionrule", - "href": "/graphql/reference/mutations#createbranchprotectionrule", - "description": "

Create a new branch protection rule.

", - "inputFields": [ - { - "name": "input", - "type": "CreateBranchProtectionRuleInput!", - "id": "createbranchprotectionruleinput", - "href": "/graphql/reference/input-objects#createbranchprotectionruleinput" - } - ], - "returnFields": [ - { - "name": "branchProtectionRule", - "type": "BranchProtectionRule", - "id": "branchprotectionrule", - "href": "/graphql/reference/objects#branchprotectionrule", - "description": "

The newly created BranchProtectionRule.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "createCheckRun", - "id": "createcheckrun", - "href": "/graphql/reference/mutations#createcheckrun", - "description": "

Create a check run.

", - "inputFields": [ - { - "name": "input", - "type": "CreateCheckRunInput!", - "id": "createcheckruninput", - "href": "/graphql/reference/input-objects#createcheckruninput" - } - ], - "returnFields": [ - { - "name": "checkRun", - "type": "CheckRun", - "id": "checkrun", - "href": "/graphql/reference/objects#checkrun", - "description": "

The newly created check run.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "createCheckSuite", - "id": "createchecksuite", - "href": "/graphql/reference/mutations#createchecksuite", - "description": "

Create a check suite.

", - "inputFields": [ - { - "name": "input", - "type": "CreateCheckSuiteInput!", - "id": "createchecksuiteinput", - "href": "/graphql/reference/input-objects#createchecksuiteinput" - } - ], - "returnFields": [ - { - "name": "checkSuite", - "type": "CheckSuite", - "id": "checksuite", - "href": "/graphql/reference/objects#checksuite", - "description": "

The newly created check suite.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "createCommitOnBranch", - "id": "createcommitonbranch", - "href": "/graphql/reference/mutations#createcommitonbranch", - "description": "

Appends a commit to the given branch as the authenticated user.

\n

This mutation creates a commit whose parent is the HEAD of the provided\nbranch and also updates that branch to point to the new commit.\nIt can be thought of as similar to git commit.

\n

Locating a Branch

\n

Commits are appended to a branch of type Ref.\nThis must refer to a git branch (i.e. the fully qualified path must\nbegin with refs/heads/, although including this prefix is optional.

\n

Callers may specify the branch to commit to either by its global node\nID or by passing both of repositoryNameWithOwner and refName. For\nmore details see the documentation for CommittableBranch.

\n

Describing Changes

\n

fileChanges are specified as a FilesChanges object describing\nFileAdditions and FileDeletions.

\n

Please see the documentation for FileChanges for more information on\nhow to use this argument to describe any set of file changes.

\n

Authorship

\n

Similar to the web commit interface, this mutation does not support\nspecifying the author or committer of the commit and will not add\nsupport for this in the future.

\n

A commit created by a successful execution of this mutation will be\nauthored by the owner of the credential which authenticates the API\nrequest. The committer will be identical to that of commits authored\nusing the web interface.

\n

If you need full control over author and committer information, please\nuse the Git Database REST API instead.

\n

Commit Signing

\n

Commits made using this mutation are automatically signed by GitHub if\nsupported and will be marked as verified in the user interface.

", - "inputFields": [ - { - "name": "input", - "type": "CreateCommitOnBranchInput!", - "id": "createcommitonbranchinput", - "href": "/graphql/reference/input-objects#createcommitonbranchinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "commit", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit", - "description": "

The new commit.

" - }, - { - "name": "ref", - "type": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref", - "description": "

The ref which has been updated to point to the new commit.

" - } - ] - }, - { - "name": "createDeployment", - "id": "createdeployment", - "href": "/graphql/reference/mutations#createdeployment", - "description": "

Creates a new deployment event.

", - "inputFields": [ - { - "name": "input", - "type": "CreateDeploymentInput!", - "id": "createdeploymentinput", - "href": "/graphql/reference/input-objects#createdeploymentinput" - } - ], - "returnFields": [ - { - "name": "autoMerged", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "description": "

True if the default branch has been auto-merged into the deployment ref.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "deployment", - "type": "Deployment", - "id": "deployment", - "href": "/graphql/reference/objects#deployment", - "description": "

The new deployment.

" - } - ] - }, - { - "name": "createDeploymentStatus", - "id": "createdeploymentstatus", - "href": "/graphql/reference/mutations#createdeploymentstatus", - "description": "

Create a deployment status.

", - "inputFields": [ - { - "name": "input", - "type": "CreateDeploymentStatusInput!", - "id": "createdeploymentstatusinput", - "href": "/graphql/reference/input-objects#createdeploymentstatusinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "deploymentStatus", - "type": "DeploymentStatus", - "id": "deploymentstatus", - "href": "/graphql/reference/objects#deploymentstatus", - "description": "

The new deployment status.

" - } - ] - }, - { - "name": "createDiscussion", - "id": "creatediscussion", - "href": "/graphql/reference/mutations#creatediscussion", - "description": "

Create a discussion.

", - "inputFields": [ - { - "name": "input", - "type": "CreateDiscussionInput!", - "id": "creatediscussioninput", - "href": "/graphql/reference/input-objects#creatediscussioninput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "discussion", - "type": "Discussion", - "id": "discussion", - "href": "/graphql/reference/objects#discussion", - "description": "

The discussion that was just created.

" - } - ] - }, - { - "name": "createEnterpriseOrganization", - "id": "createenterpriseorganization", - "href": "/graphql/reference/mutations#createenterpriseorganization", - "description": "

Creates an organization as part of an enterprise account. A personal access\ntoken used to create an organization is implicitly permitted to update the\norganization it created, if the organization is part of an enterprise that has\nSAML enabled or uses Enterprise Managed Users. If the organization is not part\nof such an enterprise, and instead has SAML enabled for it individually, the\ntoken will then require SAML authorization to continue working against that organization.

", - "inputFields": [ - { - "name": "input", - "type": "CreateEnterpriseOrganizationInput!", - "id": "createenterpriseorganizationinput", - "href": "/graphql/reference/input-objects#createenterpriseorganizationinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

The enterprise that owns the created organization.

" - }, - { - "name": "organization", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization", - "description": "

The organization that was created.

" - } - ] - }, - { - "name": "createEnvironment", - "id": "createenvironment", - "href": "/graphql/reference/mutations#createenvironment", - "description": "

Creates an environment or simply returns it if already exists.

", - "inputFields": [ - { - "name": "input", - "type": "CreateEnvironmentInput!", - "id": "createenvironmentinput", - "href": "/graphql/reference/input-objects#createenvironmentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "environment", - "type": "Environment", - "id": "environment", - "href": "/graphql/reference/objects#environment", - "description": "

The new or existing environment.

" - } - ] - }, - { - "name": "createIpAllowListEntry", - "id": "createipallowlistentry", - "href": "/graphql/reference/mutations#createipallowlistentry", - "description": "

Creates a new IP allow list entry.

", - "inputFields": [ - { - "name": "input", - "type": "CreateIpAllowListEntryInput!", - "id": "createipallowlistentryinput", - "href": "/graphql/reference/input-objects#createipallowlistentryinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "ipAllowListEntry", - "type": "IpAllowListEntry", - "id": "ipallowlistentry", - "href": "/graphql/reference/objects#ipallowlistentry", - "description": "

The IP allow list entry that was created.

" - } - ] - }, - { - "name": "createIssue", - "id": "createissue", - "href": "/graphql/reference/mutations#createissue", - "description": "

Creates a new issue.

", - "inputFields": [ - { - "name": "input", - "type": "CreateIssueInput!", - "id": "createissueinput", - "href": "/graphql/reference/input-objects#createissueinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "issue", - "type": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue", - "description": "

The new issue.

" - } - ] - }, - { - "name": "createLabel", - "id": "createlabel", - "href": "/graphql/reference/mutations#createlabel", - "description": "

Creates a new label.

", - "inputFields": [ - { - "name": "input", - "type": "CreateLabelInput!", - "id": "createlabelinput", - "href": "/graphql/reference/input-objects#createlabelinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "label", - "type": "Label", - "id": "label", - "href": "/graphql/reference/objects#label", - "description": "

The new label.

" - } - ] - }, - { - "name": "createLinkedBranch", - "id": "createlinkedbranch", - "href": "/graphql/reference/mutations#createlinkedbranch", - "description": "

Create a branch linked to an issue.

", - "inputFields": [ - { - "name": "input", - "type": "CreateLinkedBranchInput!", - "id": "createlinkedbranchinput", - "href": "/graphql/reference/input-objects#createlinkedbranchinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "issue", - "type": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue", - "description": "

The issue that was linked to.

" - }, - { - "name": "linkedBranch", - "type": "LinkedBranch", - "id": "linkedbranch", - "href": "/graphql/reference/objects#linkedbranch", - "description": "

The new branch issue reference.

" - } - ] - }, - { - "name": "createMigrationSource", - "id": "createmigrationsource", - "href": "/graphql/reference/mutations#createmigrationsource", - "description": "

Creates a GitHub Enterprise Importer (GEI) migration source.

", - "inputFields": [ - { - "name": "input", - "type": "CreateMigrationSourceInput!", - "id": "createmigrationsourceinput", - "href": "/graphql/reference/input-objects#createmigrationsourceinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "migrationSource", - "type": "MigrationSource", - "id": "migrationsource", - "href": "/graphql/reference/objects#migrationsource", - "description": "

The created migration source.

" - } - ] - }, - { - "name": "createProject", - "id": "createproject", - "href": "/graphql/reference/mutations#createproject", - "description": "

Creates a new project.

", - "inputFields": [ - { - "name": "input", - "type": "CreateProjectInput!", - "id": "createprojectinput", - "href": "/graphql/reference/input-objects#createprojectinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "project", - "type": "Project", - "id": "project", - "href": "/graphql/reference/objects#project", - "description": "

The new project.

" - } - ] - }, - { - "name": "createProjectV2", - "id": "createprojectv2", - "href": "/graphql/reference/mutations#createprojectv2", - "description": "

Creates a new project.

", - "inputFields": [ - { - "name": "input", - "type": "CreateProjectV2Input!", - "id": "createprojectv2input", - "href": "/graphql/reference/input-objects#createprojectv2input" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "projectV2", - "type": "ProjectV2", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2", - "description": "

The new project.

" - } - ] - }, - { - "name": "createProjectV2Field", - "id": "createprojectv2field", - "href": "/graphql/reference/mutations#createprojectv2field", - "description": "

Create a new project field.

", - "inputFields": [ - { - "name": "input", - "type": "CreateProjectV2FieldInput!", - "id": "createprojectv2fieldinput", - "href": "/graphql/reference/input-objects#createprojectv2fieldinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "projectV2Field", - "type": "ProjectV2FieldConfiguration", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration", - "description": "

The new field.

" - } - ] - }, - { - "name": "createPullRequest", - "id": "createpullrequest", - "href": "/graphql/reference/mutations#createpullrequest", - "description": "

Create a new pull request.

", - "inputFields": [ - { - "name": "input", - "type": "CreatePullRequestInput!", - "id": "createpullrequestinput", - "href": "/graphql/reference/input-objects#createpullrequestinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequest", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest", - "description": "

The new pull request.

" - } - ] - }, - { - "name": "createRef", - "id": "createref", - "href": "/graphql/reference/mutations#createref", - "description": "

Create a new Git Ref.

", - "inputFields": [ - { - "name": "input", - "type": "CreateRefInput!", - "id": "createrefinput", - "href": "/graphql/reference/input-objects#createrefinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "ref", - "type": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref", - "description": "

The newly created ref.

" - } - ] - }, - { - "name": "createRepository", - "id": "createrepository", - "href": "/graphql/reference/mutations#createrepository", - "description": "

Create a new repository.

", - "inputFields": [ - { - "name": "input", - "type": "CreateRepositoryInput!", - "id": "createrepositoryinput", - "href": "/graphql/reference/input-objects#createrepositoryinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "repository", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "description": "

The new repository.

" - } - ] - }, - { - "name": "createRepositoryRuleset", - "id": "createrepositoryruleset", - "href": "/graphql/reference/mutations#createrepositoryruleset", - "description": "

Create a repository ruleset.

", - "inputFields": [ - { - "name": "input", - "type": "CreateRepositoryRulesetInput!", - "id": "createrepositoryrulesetinput", - "href": "/graphql/reference/input-objects#createrepositoryrulesetinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "ruleset", - "type": "RepositoryRuleset", - "id": "repositoryruleset", - "href": "/graphql/reference/objects#repositoryruleset", - "description": "

The newly created Ruleset.

" - } - ] - }, - { - "name": "createTeamDiscussion", - "id": "createteamdiscussion", - "href": "/graphql/reference/mutations#createteamdiscussion", - "description": "

Creates a new team discussion.

", - "inputFields": [ - { - "name": "input", - "type": "CreateTeamDiscussionInput!", - "id": "createteamdiscussioninput", - "href": "/graphql/reference/input-objects#createteamdiscussioninput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "teamDiscussion", - "type": "TeamDiscussion", - "id": "teamdiscussion", - "href": "/graphql/reference/objects#teamdiscussion", - "description": "

The new discussion.

", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - } - ] - }, - { - "name": "createTeamDiscussionComment", - "id": "createteamdiscussioncomment", - "href": "/graphql/reference/mutations#createteamdiscussioncomment", - "description": "

Creates a new team discussion comment.

", - "inputFields": [ - { - "name": "input", - "type": "CreateTeamDiscussionCommentInput!", - "id": "createteamdiscussioncommentinput", - "href": "/graphql/reference/input-objects#createteamdiscussioncommentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "teamDiscussionComment", - "type": "TeamDiscussionComment", - "id": "teamdiscussioncomment", - "href": "/graphql/reference/objects#teamdiscussioncomment", - "description": "

The new comment.

", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - } - ] - }, - { - "name": "createUserList", - "id": "createuserlist", - "href": "/graphql/reference/mutations#createuserlist", - "description": "

Creates a new user list.

", - "inputFields": [ - { - "name": "input", - "type": "CreateUserListInput!", - "id": "createuserlistinput", - "href": "/graphql/reference/input-objects#createuserlistinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "list", - "type": "UserList", - "id": "userlist", - "href": "/graphql/reference/objects#userlist", - "description": "

The list that was just created.

" - }, - { - "name": "viewer", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user", - "description": "

The user who created the list.

" - } - ] - }, - { - "name": "deleteBranchProtectionRule", - "id": "deletebranchprotectionrule", - "href": "/graphql/reference/mutations#deletebranchprotectionrule", - "description": "

Delete a branch protection rule.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteBranchProtectionRuleInput!", - "id": "deletebranchprotectionruleinput", - "href": "/graphql/reference/input-objects#deletebranchprotectionruleinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "deleteDeployment", - "id": "deletedeployment", - "href": "/graphql/reference/mutations#deletedeployment", - "description": "

Deletes a deployment.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteDeploymentInput!", - "id": "deletedeploymentinput", - "href": "/graphql/reference/input-objects#deletedeploymentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "deleteDiscussion", - "id": "deletediscussion", - "href": "/graphql/reference/mutations#deletediscussion", - "description": "

Delete a discussion and all of its replies.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteDiscussionInput!", - "id": "deletediscussioninput", - "href": "/graphql/reference/input-objects#deletediscussioninput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "discussion", - "type": "Discussion", - "id": "discussion", - "href": "/graphql/reference/objects#discussion", - "description": "

The discussion that was just deleted.

" - } - ] - }, - { - "name": "deleteDiscussionComment", - "id": "deletediscussioncomment", - "href": "/graphql/reference/mutations#deletediscussioncomment", - "description": "

Delete a discussion comment. If it has replies, wipe it instead.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteDiscussionCommentInput!", - "id": "deletediscussioncommentinput", - "href": "/graphql/reference/input-objects#deletediscussioncommentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "comment", - "type": "DiscussionComment", - "id": "discussioncomment", - "href": "/graphql/reference/objects#discussioncomment", - "description": "

The discussion comment that was just deleted.

" - } - ] - }, - { - "name": "deleteEnvironment", - "id": "deleteenvironment", - "href": "/graphql/reference/mutations#deleteenvironment", - "description": "

Deletes an environment.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteEnvironmentInput!", - "id": "deleteenvironmentinput", - "href": "/graphql/reference/input-objects#deleteenvironmentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "deleteIpAllowListEntry", - "id": "deleteipallowlistentry", - "href": "/graphql/reference/mutations#deleteipallowlistentry", - "description": "

Deletes an IP allow list entry.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteIpAllowListEntryInput!", - "id": "deleteipallowlistentryinput", - "href": "/graphql/reference/input-objects#deleteipallowlistentryinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "ipAllowListEntry", - "type": "IpAllowListEntry", - "id": "ipallowlistentry", - "href": "/graphql/reference/objects#ipallowlistentry", - "description": "

The IP allow list entry that was deleted.

" - } - ] - }, - { - "name": "deleteIssue", - "id": "deleteissue", - "href": "/graphql/reference/mutations#deleteissue", - "description": "

Deletes an Issue object.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteIssueInput!", - "id": "deleteissueinput", - "href": "/graphql/reference/input-objects#deleteissueinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "repository", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "description": "

The repository the issue belonged to.

" - } - ] - }, - { - "name": "deleteIssueComment", - "id": "deleteissuecomment", - "href": "/graphql/reference/mutations#deleteissuecomment", - "description": "

Deletes an IssueComment object.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteIssueCommentInput!", - "id": "deleteissuecommentinput", - "href": "/graphql/reference/input-objects#deleteissuecommentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "deleteLabel", - "id": "deletelabel", - "href": "/graphql/reference/mutations#deletelabel", - "description": "

Deletes a label.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteLabelInput!", - "id": "deletelabelinput", - "href": "/graphql/reference/input-objects#deletelabelinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "deleteLinkedBranch", - "id": "deletelinkedbranch", - "href": "/graphql/reference/mutations#deletelinkedbranch", - "description": "

Unlink a branch from an issue.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteLinkedBranchInput!", - "id": "deletelinkedbranchinput", - "href": "/graphql/reference/input-objects#deletelinkedbranchinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "issue", - "type": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue", - "description": "

The issue the linked branch was unlinked from.

" - } - ] - }, - { - "name": "deletePackageVersion", - "id": "deletepackageversion", - "href": "/graphql/reference/mutations#deletepackageversion", - "description": "

Delete a package version.

", - "inputFields": [ - { - "name": "input", - "type": "DeletePackageVersionInput!", - "id": "deletepackageversioninput", - "href": "/graphql/reference/input-objects#deletepackageversioninput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "success", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "description": "

Whether or not the operation succeeded.

" - } - ] - }, - { - "name": "deleteProject", - "id": "deleteproject", - "href": "/graphql/reference/mutations#deleteproject", - "description": "

Deletes a project.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteProjectInput!", - "id": "deleteprojectinput", - "href": "/graphql/reference/input-objects#deleteprojectinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "owner", - "type": "ProjectOwner", - "id": "projectowner", - "href": "/graphql/reference/interfaces#projectowner", - "description": "

The repository or organization the project was removed from.

" - } - ] - }, - { - "name": "deleteProjectCard", - "id": "deleteprojectcard", - "href": "/graphql/reference/mutations#deleteprojectcard", - "description": "

Deletes a project card.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteProjectCardInput!", - "id": "deleteprojectcardinput", - "href": "/graphql/reference/input-objects#deleteprojectcardinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "column", - "type": "ProjectColumn", - "id": "projectcolumn", - "href": "/graphql/reference/objects#projectcolumn", - "description": "

The column the deleted card was in.

" - }, - { - "name": "deletedCardId", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "description": "

The deleted card ID.

" - } - ] - }, - { - "name": "deleteProjectColumn", - "id": "deleteprojectcolumn", - "href": "/graphql/reference/mutations#deleteprojectcolumn", - "description": "

Deletes a project column.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteProjectColumnInput!", - "id": "deleteprojectcolumninput", - "href": "/graphql/reference/input-objects#deleteprojectcolumninput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "deletedColumnId", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "description": "

The deleted column ID.

" - }, - { - "name": "project", - "type": "Project", - "id": "project", - "href": "/graphql/reference/objects#project", - "description": "

The project the deleted column was in.

" - } - ] - }, - { - "name": "deleteProjectV2", - "id": "deleteprojectv2", - "href": "/graphql/reference/mutations#deleteprojectv2", - "description": "

Delete a project.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteProjectV2Input!", - "id": "deleteprojectv2input", - "href": "/graphql/reference/input-objects#deleteprojectv2input" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "projectV2", - "type": "ProjectV2", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2", - "description": "

The deleted Project.

" - } - ] - }, - { - "name": "deleteProjectV2Field", - "id": "deleteprojectv2field", - "href": "/graphql/reference/mutations#deleteprojectv2field", - "description": "

Delete a project field.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteProjectV2FieldInput!", - "id": "deleteprojectv2fieldinput", - "href": "/graphql/reference/input-objects#deleteprojectv2fieldinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "projectV2Field", - "type": "ProjectV2FieldConfiguration", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration", - "description": "

The deleted field.

" - } - ] - }, - { - "name": "deleteProjectV2Item", - "id": "deleteprojectv2item", - "href": "/graphql/reference/mutations#deleteprojectv2item", - "description": "

Deletes an item from a Project.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteProjectV2ItemInput!", - "id": "deleteprojectv2iteminput", - "href": "/graphql/reference/input-objects#deleteprojectv2iteminput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "deletedItemId", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "description": "

The ID of the deleted item.

" - } - ] - }, - { - "name": "deleteProjectV2Workflow", - "id": "deleteprojectv2workflow", - "href": "/graphql/reference/mutations#deleteprojectv2workflow", - "description": "

Deletes a project workflow.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteProjectV2WorkflowInput!", - "id": "deleteprojectv2workflowinput", - "href": "/graphql/reference/input-objects#deleteprojectv2workflowinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "deletedWorkflowId", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "description": "

The ID of the deleted workflow.

" - }, - { - "name": "projectV2", - "type": "ProjectV2", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2", - "description": "

The project the deleted workflow was in.

" - } - ] - }, - { - "name": "deletePullRequestReview", - "id": "deletepullrequestreview", - "href": "/graphql/reference/mutations#deletepullrequestreview", - "description": "

Deletes a pull request review.

", - "inputFields": [ - { - "name": "input", - "type": "DeletePullRequestReviewInput!", - "id": "deletepullrequestreviewinput", - "href": "/graphql/reference/input-objects#deletepullrequestreviewinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequestReview", - "type": "PullRequestReview", - "id": "pullrequestreview", - "href": "/graphql/reference/objects#pullrequestreview", - "description": "

The deleted pull request review.

" - } - ] - }, - { - "name": "deletePullRequestReviewComment", - "id": "deletepullrequestreviewcomment", - "href": "/graphql/reference/mutations#deletepullrequestreviewcomment", - "description": "

Deletes a pull request review comment.

", - "inputFields": [ - { - "name": "input", - "type": "DeletePullRequestReviewCommentInput!", - "id": "deletepullrequestreviewcommentinput", - "href": "/graphql/reference/input-objects#deletepullrequestreviewcommentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequestReview", - "type": "PullRequestReview", - "id": "pullrequestreview", - "href": "/graphql/reference/objects#pullrequestreview", - "description": "

The pull request review the deleted comment belonged to.

" - }, - { - "name": "pullRequestReviewComment", - "type": "PullRequestReviewComment", - "id": "pullrequestreviewcomment", - "href": "/graphql/reference/objects#pullrequestreviewcomment", - "description": "

The deleted pull request review comment.

" - } - ] - }, - { - "name": "deleteRef", - "id": "deleteref", - "href": "/graphql/reference/mutations#deleteref", - "description": "

Delete a Git Ref.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteRefInput!", - "id": "deleterefinput", - "href": "/graphql/reference/input-objects#deleterefinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "deleteRepositoryRuleset", - "id": "deleterepositoryruleset", - "href": "/graphql/reference/mutations#deleterepositoryruleset", - "description": "

Delete a repository ruleset.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteRepositoryRulesetInput!", - "id": "deleterepositoryrulesetinput", - "href": "/graphql/reference/input-objects#deleterepositoryrulesetinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "deleteTeamDiscussion", - "id": "deleteteamdiscussion", - "href": "/graphql/reference/mutations#deleteteamdiscussion", - "description": "

Deletes a team discussion.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteTeamDiscussionInput!", - "id": "deleteteamdiscussioninput", - "href": "/graphql/reference/input-objects#deleteteamdiscussioninput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "deleteTeamDiscussionComment", - "id": "deleteteamdiscussioncomment", - "href": "/graphql/reference/mutations#deleteteamdiscussioncomment", - "description": "

Deletes a team discussion comment.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteTeamDiscussionCommentInput!", - "id": "deleteteamdiscussioncommentinput", - "href": "/graphql/reference/input-objects#deleteteamdiscussioncommentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "deleteUserList", - "id": "deleteuserlist", - "href": "/graphql/reference/mutations#deleteuserlist", - "description": "

Deletes a user list.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteUserListInput!", - "id": "deleteuserlistinput", - "href": "/graphql/reference/input-objects#deleteuserlistinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "user", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user", - "description": "

The owner of the list that will be deleted.

" - } - ] - }, - { - "name": "deleteVerifiableDomain", - "id": "deleteverifiabledomain", - "href": "/graphql/reference/mutations#deleteverifiabledomain", - "description": "

Deletes a verifiable domain.

", - "inputFields": [ - { - "name": "input", - "type": "DeleteVerifiableDomainInput!", - "id": "deleteverifiabledomaininput", - "href": "/graphql/reference/input-objects#deleteverifiabledomaininput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "owner", - "type": "VerifiableDomainOwner", - "id": "verifiabledomainowner", - "href": "/graphql/reference/unions#verifiabledomainowner", - "description": "

The owning account from which the domain was deleted.

" - } - ] - }, - { - "name": "dequeuePullRequest", - "id": "dequeuepullrequest", - "href": "/graphql/reference/mutations#dequeuepullrequest", - "description": "

Remove a pull request from the merge queue.

", - "inputFields": [ - { - "name": "input", - "type": "DequeuePullRequestInput!", - "id": "dequeuepullrequestinput", - "href": "/graphql/reference/input-objects#dequeuepullrequestinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "mergeQueueEntry", - "type": "MergeQueueEntry", - "id": "mergequeueentry", - "href": "/graphql/reference/objects#mergequeueentry", - "description": "

The merge queue entry of the dequeued pull request.

" - } - ] - }, - { - "name": "disablePullRequestAutoMerge", - "id": "disablepullrequestautomerge", - "href": "/graphql/reference/mutations#disablepullrequestautomerge", - "description": "

Disable auto merge on the given pull request.

", - "inputFields": [ - { - "name": "input", - "type": "DisablePullRequestAutoMergeInput!", - "id": "disablepullrequestautomergeinput", - "href": "/graphql/reference/input-objects#disablepullrequestautomergeinput" - } - ], - "returnFields": [ - { - "name": "actor", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor", - "description": "

Identifies the actor who performed the event.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequest", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest", - "description": "

The pull request auto merge was disabled on.

" - } - ] - }, - { - "name": "dismissPullRequestReview", - "id": "dismisspullrequestreview", - "href": "/graphql/reference/mutations#dismisspullrequestreview", - "description": "

Dismisses an approved or rejected pull request review.

", - "inputFields": [ - { - "name": "input", - "type": "DismissPullRequestReviewInput!", - "id": "dismisspullrequestreviewinput", - "href": "/graphql/reference/input-objects#dismisspullrequestreviewinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequestReview", - "type": "PullRequestReview", - "id": "pullrequestreview", - "href": "/graphql/reference/objects#pullrequestreview", - "description": "

The dismissed pull request review.

" - } - ] - }, - { - "name": "dismissRepositoryVulnerabilityAlert", - "id": "dismissrepositoryvulnerabilityalert", - "href": "/graphql/reference/mutations#dismissrepositoryvulnerabilityalert", - "description": "

Dismisses the Dependabot alert.

", - "inputFields": [ - { - "name": "input", - "type": "DismissRepositoryVulnerabilityAlertInput!", - "id": "dismissrepositoryvulnerabilityalertinput", - "href": "/graphql/reference/input-objects#dismissrepositoryvulnerabilityalertinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "repositoryVulnerabilityAlert", - "type": "RepositoryVulnerabilityAlert", - "id": "repositoryvulnerabilityalert", - "href": "/graphql/reference/objects#repositoryvulnerabilityalert", - "description": "

The Dependabot alert that was dismissed.

" - } - ] - }, - { - "name": "enablePullRequestAutoMerge", - "id": "enablepullrequestautomerge", - "href": "/graphql/reference/mutations#enablepullrequestautomerge", - "description": "

Enable the default auto-merge on a pull request.

", - "inputFields": [ - { - "name": "input", - "type": "EnablePullRequestAutoMergeInput!", - "id": "enablepullrequestautomergeinput", - "href": "/graphql/reference/input-objects#enablepullrequestautomergeinput" - } - ], - "returnFields": [ - { - "name": "actor", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor", - "description": "

Identifies the actor who performed the event.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequest", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest", - "description": "

The pull request auto-merge was enabled on.

" - } - ] - }, - { - "name": "enqueuePullRequest", - "id": "enqueuepullrequest", - "href": "/graphql/reference/mutations#enqueuepullrequest", - "description": "

Add a pull request to the merge queue.

", - "inputFields": [ - { - "name": "input", - "type": "EnqueuePullRequestInput!", - "id": "enqueuepullrequestinput", - "href": "/graphql/reference/input-objects#enqueuepullrequestinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "mergeQueueEntry", - "type": "MergeQueueEntry", - "id": "mergequeueentry", - "href": "/graphql/reference/objects#mergequeueentry", - "description": "

The merge queue entry for the enqueued pull request.

" - } - ] - }, - { - "name": "followOrganization", - "id": "followorganization", - "href": "/graphql/reference/mutations#followorganization", - "description": "

Follow an organization.

", - "inputFields": [ - { - "name": "input", - "type": "FollowOrganizationInput!", - "id": "followorganizationinput", - "href": "/graphql/reference/input-objects#followorganizationinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "organization", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization", - "description": "

The organization that was followed.

" - } - ] - }, - { - "name": "followUser", - "id": "followuser", - "href": "/graphql/reference/mutations#followuser", - "description": "

Follow a user.

", - "inputFields": [ - { - "name": "input", - "type": "FollowUserInput!", - "id": "followuserinput", - "href": "/graphql/reference/input-objects#followuserinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "user", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user", - "description": "

The user that was followed.

" - } - ] - }, - { - "name": "grantEnterpriseOrganizationsMigratorRole", - "id": "grantenterpriseorganizationsmigratorrole", - "href": "/graphql/reference/mutations#grantenterpriseorganizationsmigratorrole", - "description": "

Grant the migrator role to a user for all organizations under an enterprise account.

", - "inputFields": [ - { - "name": "input", - "type": "GrantEnterpriseOrganizationsMigratorRoleInput!", - "id": "grantenterpriseorganizationsmigratorroleinput", - "href": "/graphql/reference/input-objects#grantenterpriseorganizationsmigratorroleinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "organizations", - "type": "OrganizationConnection", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "description": "

The organizations that had the migrator role applied to for the given user.

" - } - ] - }, - { - "name": "grantMigratorRole", - "id": "grantmigratorrole", - "href": "/graphql/reference/mutations#grantmigratorrole", - "description": "

Grant the migrator role to a user or a team.

", - "inputFields": [ - { - "name": "input", - "type": "GrantMigratorRoleInput!", - "id": "grantmigratorroleinput", - "href": "/graphql/reference/input-objects#grantmigratorroleinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "success", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "description": "

Did the operation succeed?.

" - } - ] - }, - { - "name": "importProject", - "id": "importproject", - "href": "/graphql/reference/mutations#importproject", - "description": "

Creates a new project by importing columns and a list of issues/PRs.

", - "inputFields": [ - { - "name": "input", - "type": "ImportProjectInput!", - "id": "importprojectinput", - "href": "/graphql/reference/input-objects#importprojectinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "project", - "type": "Project", - "id": "project", - "href": "/graphql/reference/objects#project", - "description": "

The new Project!.

" - } - ] - }, - { - "name": "linkProjectV2ToRepository", - "id": "linkprojectv2torepository", - "href": "/graphql/reference/mutations#linkprojectv2torepository", - "description": "

Links a project to a repository.

", - "inputFields": [ - { - "name": "input", - "type": "LinkProjectV2ToRepositoryInput!", - "id": "linkprojectv2torepositoryinput", - "href": "/graphql/reference/input-objects#linkprojectv2torepositoryinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "repository", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "description": "

The repository the project is linked to.

" - } - ] - }, - { - "name": "linkProjectV2ToTeam", - "id": "linkprojectv2toteam", - "href": "/graphql/reference/mutations#linkprojectv2toteam", - "description": "

Links a project to a team.

", - "inputFields": [ - { - "name": "input", - "type": "LinkProjectV2ToTeamInput!", - "id": "linkprojectv2toteaminput", - "href": "/graphql/reference/input-objects#linkprojectv2toteaminput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "team", - "type": "Team", - "id": "team", - "href": "/graphql/reference/objects#team", - "description": "

The team the project is linked to.

" - } - ] - }, - { - "name": "linkRepositoryToProject", - "id": "linkrepositorytoproject", - "href": "/graphql/reference/mutations#linkrepositorytoproject", - "description": "

Creates a repository link for a project.

", - "inputFields": [ - { - "name": "input", - "type": "LinkRepositoryToProjectInput!", - "id": "linkrepositorytoprojectinput", - "href": "/graphql/reference/input-objects#linkrepositorytoprojectinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "project", - "type": "Project", - "id": "project", - "href": "/graphql/reference/objects#project", - "description": "

The linked Project.

" - }, - { - "name": "repository", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "description": "

The linked Repository.

" - } - ] - }, - { - "name": "lockLockable", - "id": "locklockable", - "href": "/graphql/reference/mutations#locklockable", - "description": "

Lock a lockable object.

", - "inputFields": [ - { - "name": "input", - "type": "LockLockableInput!", - "id": "locklockableinput", - "href": "/graphql/reference/input-objects#locklockableinput" - } - ], - "returnFields": [ - { - "name": "actor", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor", - "description": "

Identifies the actor who performed the event.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "lockedRecord", - "type": "Lockable", - "id": "lockable", - "href": "/graphql/reference/interfaces#lockable", - "description": "

The item that was locked.

" - } - ] - }, - { - "name": "markDiscussionCommentAsAnswer", - "id": "markdiscussioncommentasanswer", - "href": "/graphql/reference/mutations#markdiscussioncommentasanswer", - "description": "

Mark a discussion comment as the chosen answer for discussions in an answerable category.

", - "inputFields": [ - { - "name": "input", - "type": "MarkDiscussionCommentAsAnswerInput!", - "id": "markdiscussioncommentasanswerinput", - "href": "/graphql/reference/input-objects#markdiscussioncommentasanswerinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "discussion", - "type": "Discussion", - "id": "discussion", - "href": "/graphql/reference/objects#discussion", - "description": "

The discussion that includes the chosen comment.

" - } - ] - }, - { - "name": "markFileAsViewed", - "id": "markfileasviewed", - "href": "/graphql/reference/mutations#markfileasviewed", - "description": "

Mark a pull request file as viewed.

", - "inputFields": [ - { - "name": "input", - "type": "MarkFileAsViewedInput!", - "id": "markfileasviewedinput", - "href": "/graphql/reference/input-objects#markfileasviewedinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequest", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest", - "description": "

The updated pull request.

" - } - ] - }, - { - "name": "markNotificationAsDone", - "id": "marknotificationasdone", - "href": "/graphql/reference/mutations#marknotificationasdone", - "description": "

Marks a notification as done.

", - "inputFields": [ - { - "name": "input", - "type": "MarkNotificationAsDoneInput!", - "id": "marknotificationasdoneinput", - "href": "/graphql/reference/input-objects#marknotificationasdoneinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "success", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "description": "

Did the operation succeed?.

" - }, - { - "name": "viewer", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user", - "description": "

The user that the notification belongs to.

" - } - ] - }, - { - "name": "markProjectV2AsTemplate", - "id": "markprojectv2astemplate", - "href": "/graphql/reference/mutations#markprojectv2astemplate", - "description": "

Mark a project as a template. Note that only projects which are owned by an Organization can be marked as a template.

", - "inputFields": [ - { - "name": "input", - "type": "MarkProjectV2AsTemplateInput!", - "id": "markprojectv2astemplateinput", - "href": "/graphql/reference/input-objects#markprojectv2astemplateinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "projectV2", - "type": "ProjectV2", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2", - "description": "

The project.

" - } - ] - }, - { - "name": "markPullRequestReadyForReview", - "id": "markpullrequestreadyforreview", - "href": "/graphql/reference/mutations#markpullrequestreadyforreview", - "description": "

Marks a pull request ready for review.

", - "inputFields": [ - { - "name": "input", - "type": "MarkPullRequestReadyForReviewInput!", - "id": "markpullrequestreadyforreviewinput", - "href": "/graphql/reference/input-objects#markpullrequestreadyforreviewinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequest", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest", - "description": "

The pull request that is ready for review.

" - } - ] - }, - { - "name": "mergeBranch", - "id": "mergebranch", - "href": "/graphql/reference/mutations#mergebranch", - "description": "

Merge a head into a branch.

", - "inputFields": [ - { - "name": "input", - "type": "MergeBranchInput!", - "id": "mergebranchinput", - "href": "/graphql/reference/input-objects#mergebranchinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "mergeCommit", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit", - "description": "

The resulting merge Commit.

" - } - ] - }, - { - "name": "mergePullRequest", - "id": "mergepullrequest", - "href": "/graphql/reference/mutations#mergepullrequest", - "description": "

Merge a pull request.

", - "inputFields": [ - { - "name": "input", - "type": "MergePullRequestInput!", - "id": "mergepullrequestinput", - "href": "/graphql/reference/input-objects#mergepullrequestinput" - } - ], - "returnFields": [ - { - "name": "actor", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor", - "description": "

Identifies the actor who performed the event.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequest", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest", - "description": "

The pull request that was merged.

" - } - ] - }, - { - "name": "minimizeComment", - "id": "minimizecomment", - "href": "/graphql/reference/mutations#minimizecomment", - "description": "

Minimizes a comment on an Issue, Commit, Pull Request, or Gist.

", - "inputFields": [ - { - "name": "input", - "type": "MinimizeCommentInput!", - "id": "minimizecommentinput", - "href": "/graphql/reference/input-objects#minimizecommentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "minimizedComment", - "type": "Minimizable", - "id": "minimizable", - "href": "/graphql/reference/interfaces#minimizable", - "description": "

The comment that was minimized.

" - } - ] - }, - { - "name": "moveProjectCard", - "id": "moveprojectcard", - "href": "/graphql/reference/mutations#moveprojectcard", - "description": "

Moves a project card to another place.

", - "inputFields": [ - { - "name": "input", - "type": "MoveProjectCardInput!", - "id": "moveprojectcardinput", - "href": "/graphql/reference/input-objects#moveprojectcardinput" - } - ], - "returnFields": [ - { - "name": "cardEdge", - "type": "ProjectCardEdge", - "id": "projectcardedge", - "href": "/graphql/reference/objects#projectcardedge", - "description": "

The new edge of the moved card.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "moveProjectColumn", - "id": "moveprojectcolumn", - "href": "/graphql/reference/mutations#moveprojectcolumn", - "description": "

Moves a project column to another place.

", - "inputFields": [ - { - "name": "input", - "type": "MoveProjectColumnInput!", - "id": "moveprojectcolumninput", - "href": "/graphql/reference/input-objects#moveprojectcolumninput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "columnEdge", - "type": "ProjectColumnEdge", - "id": "projectcolumnedge", - "href": "/graphql/reference/objects#projectcolumnedge", - "description": "

The new edge of the moved column.

" - } - ] - }, - { - "name": "pinEnvironment", - "id": "pinenvironment", - "href": "/graphql/reference/mutations#pinenvironment", - "description": "

Pin an environment to a repository.

", - "inputFields": [ - { - "name": "input", - "type": "PinEnvironmentInput!", - "id": "pinenvironmentinput", - "href": "/graphql/reference/input-objects#pinenvironmentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "environment", - "type": "Environment", - "id": "environment", - "href": "/graphql/reference/objects#environment", - "description": "

The environment that was pinned.

" - }, - { - "name": "pinnedEnvironment", - "type": "PinnedEnvironment", - "id": "pinnedenvironment", - "href": "/graphql/reference/objects#pinnedenvironment", - "description": "

The pinned environment if we pinned.

" - } - ] - }, - { - "name": "pinIssue", - "id": "pinissue", - "href": "/graphql/reference/mutations#pinissue", - "description": "

Pin an issue to a repository.

", - "inputFields": [ - { - "name": "input", - "type": "PinIssueInput!", - "id": "pinissueinput", - "href": "/graphql/reference/input-objects#pinissueinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "issue", - "type": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue", - "description": "

The issue that was pinned.

" - } - ] - }, - { - "name": "regenerateVerifiableDomainToken", - "id": "regenerateverifiabledomaintoken", - "href": "/graphql/reference/mutations#regenerateverifiabledomaintoken", - "description": "

Regenerates a verifiable domain's verification token.

", - "inputFields": [ - { - "name": "input", - "type": "RegenerateVerifiableDomainTokenInput!", - "id": "regenerateverifiabledomaintokeninput", - "href": "/graphql/reference/input-objects#regenerateverifiabledomaintokeninput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "verificationToken", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

The verification token that was generated.

" - } - ] - }, - { - "name": "rejectDeployments", - "id": "rejectdeployments", - "href": "/graphql/reference/mutations#rejectdeployments", - "description": "

Reject all pending deployments under one or more environments.

", - "inputFields": [ - { - "name": "input", - "type": "RejectDeploymentsInput!", - "id": "rejectdeploymentsinput", - "href": "/graphql/reference/input-objects#rejectdeploymentsinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "deployments", - "type": "[Deployment!]", - "id": "deployment", - "href": "/graphql/reference/objects#deployment", - "description": "

The affected deployments.

" - } - ] - }, - { - "name": "removeAssigneesFromAssignable", - "id": "removeassigneesfromassignable", - "href": "/graphql/reference/mutations#removeassigneesfromassignable", - "description": "

Removes assignees from an assignable object.

", - "inputFields": [ - { - "name": "input", - "type": "RemoveAssigneesFromAssignableInput!", - "id": "removeassigneesfromassignableinput", - "href": "/graphql/reference/input-objects#removeassigneesfromassignableinput" - } - ], - "returnFields": [ - { - "name": "assignable", - "type": "Assignable", - "id": "assignable", - "href": "/graphql/reference/interfaces#assignable", - "description": "

The item that was unassigned.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "removeEnterpriseAdmin", - "id": "removeenterpriseadmin", - "href": "/graphql/reference/mutations#removeenterpriseadmin", - "description": "

Removes an administrator from the enterprise.

", - "inputFields": [ - { - "name": "input", - "type": "RemoveEnterpriseAdminInput!", - "id": "removeenterpriseadmininput", - "href": "/graphql/reference/input-objects#removeenterpriseadmininput" - } - ], - "returnFields": [ - { - "name": "admin", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user", - "description": "

The user who was removed as an administrator.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

The updated enterprise.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of removing an administrator.

" - }, - { - "name": "viewer", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user", - "description": "

The viewer performing the mutation.

" - } - ] - }, - { - "name": "removeLabelsFromLabelable", - "id": "removelabelsfromlabelable", - "href": "/graphql/reference/mutations#removelabelsfromlabelable", - "description": "

Removes labels from a Labelable object.

", - "inputFields": [ - { - "name": "input", - "type": "RemoveLabelsFromLabelableInput!", - "id": "removelabelsfromlabelableinput", - "href": "/graphql/reference/input-objects#removelabelsfromlabelableinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "labelable", - "type": "Labelable", - "id": "labelable", - "href": "/graphql/reference/interfaces#labelable", - "description": "

The Labelable the labels were removed from.

" - } - ] - }, - { - "name": "removeOutsideCollaborator", - "id": "removeoutsidecollaborator", - "href": "/graphql/reference/mutations#removeoutsidecollaborator", - "description": "

Removes outside collaborator from all repositories in an organization.

", - "inputFields": [ - { - "name": "input", - "type": "RemoveOutsideCollaboratorInput!", - "id": "removeoutsidecollaboratorinput", - "href": "/graphql/reference/input-objects#removeoutsidecollaboratorinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "removedUser", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user", - "description": "

The user that was removed as an outside collaborator.

" - } - ] - }, - { - "name": "removeReaction", - "id": "removereaction", - "href": "/graphql/reference/mutations#removereaction", - "description": "

Removes a reaction from a subject.

", - "inputFields": [ - { - "name": "input", - "type": "RemoveReactionInput!", - "id": "removereactioninput", - "href": "/graphql/reference/input-objects#removereactioninput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "reaction", - "type": "Reaction", - "id": "reaction", - "href": "/graphql/reference/objects#reaction", - "description": "

The reaction object.

" - }, - { - "name": "reactionGroups", - "type": "[ReactionGroup!]", - "id": "reactiongroup", - "href": "/graphql/reference/objects#reactiongroup", - "description": "

The reaction groups for the subject.

" - }, - { - "name": "subject", - "type": "Reactable", - "id": "reactable", - "href": "/graphql/reference/interfaces#reactable", - "description": "

The reactable subject.

" - } - ] - }, - { - "name": "removeStar", - "id": "removestar", - "href": "/graphql/reference/mutations#removestar", - "description": "

Removes a star from a Starrable.

", - "inputFields": [ - { - "name": "input", - "type": "RemoveStarInput!", - "id": "removestarinput", - "href": "/graphql/reference/input-objects#removestarinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "starrable", - "type": "Starrable", - "id": "starrable", - "href": "/graphql/reference/interfaces#starrable", - "description": "

The starrable.

" - } - ] - }, - { - "name": "removeUpvote", - "id": "removeupvote", - "href": "/graphql/reference/mutations#removeupvote", - "description": "

Remove an upvote to a discussion or discussion comment.

", - "inputFields": [ - { - "name": "input", - "type": "RemoveUpvoteInput!", - "id": "removeupvoteinput", - "href": "/graphql/reference/input-objects#removeupvoteinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "subject", - "type": "Votable", - "id": "votable", - "href": "/graphql/reference/interfaces#votable", - "description": "

The votable subject.

" - } - ] - }, - { - "name": "reopenDiscussion", - "id": "reopendiscussion", - "href": "/graphql/reference/mutations#reopendiscussion", - "description": "

Reopen a discussion.

", - "inputFields": [ - { - "name": "input", - "type": "ReopenDiscussionInput!", - "id": "reopendiscussioninput", - "href": "/graphql/reference/input-objects#reopendiscussioninput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "discussion", - "type": "Discussion", - "id": "discussion", - "href": "/graphql/reference/objects#discussion", - "description": "

The discussion that was reopened.

" - } - ] - }, - { - "name": "reopenIssue", - "id": "reopenissue", - "href": "/graphql/reference/mutations#reopenissue", - "description": "

Reopen a issue.

", - "inputFields": [ - { - "name": "input", - "type": "ReopenIssueInput!", - "id": "reopenissueinput", - "href": "/graphql/reference/input-objects#reopenissueinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "issue", - "type": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue", - "description": "

The issue that was opened.

" - } - ] - }, - { - "name": "reopenPullRequest", - "id": "reopenpullrequest", - "href": "/graphql/reference/mutations#reopenpullrequest", - "description": "

Reopen a pull request.

", - "inputFields": [ - { - "name": "input", - "type": "ReopenPullRequestInput!", - "id": "reopenpullrequestinput", - "href": "/graphql/reference/input-objects#reopenpullrequestinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequest", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest", - "description": "

The pull request that was reopened.

" - } - ] - }, - { - "name": "reorderEnvironment", - "id": "reorderenvironment", - "href": "/graphql/reference/mutations#reorderenvironment", - "description": "

Reorder a pinned repository environment.

", - "inputFields": [ - { - "name": "input", - "type": "ReorderEnvironmentInput!", - "id": "reorderenvironmentinput", - "href": "/graphql/reference/input-objects#reorderenvironmentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "environment", - "type": "Environment", - "id": "environment", - "href": "/graphql/reference/objects#environment", - "description": "

The environment that was reordered.

" - } - ] - }, - { - "name": "requestReviews", - "id": "requestreviews", - "href": "/graphql/reference/mutations#requestreviews", - "description": "

Set review requests on a pull request.

", - "inputFields": [ - { - "name": "input", - "type": "RequestReviewsInput!", - "id": "requestreviewsinput", - "href": "/graphql/reference/input-objects#requestreviewsinput" - } - ], - "returnFields": [ - { - "name": "actor", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor", - "description": "

Identifies the actor who performed the event.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequest", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest", - "description": "

The pull request that is getting requests.

" - }, - { - "name": "requestedReviewersEdge", - "type": "UserEdge", - "id": "useredge", - "href": "/graphql/reference/objects#useredge", - "description": "

The edge from the pull request to the requested reviewers.

" - } - ] - }, - { - "name": "rerequestCheckSuite", - "id": "rerequestchecksuite", - "href": "/graphql/reference/mutations#rerequestchecksuite", - "description": "

Rerequests an existing check suite.

", - "inputFields": [ - { - "name": "input", - "type": "RerequestCheckSuiteInput!", - "id": "rerequestchecksuiteinput", - "href": "/graphql/reference/input-objects#rerequestchecksuiteinput" - } - ], - "returnFields": [ - { - "name": "checkSuite", - "type": "CheckSuite", - "id": "checksuite", - "href": "/graphql/reference/objects#checksuite", - "description": "

The requested check suite.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "resolveReviewThread", - "id": "resolvereviewthread", - "href": "/graphql/reference/mutations#resolvereviewthread", - "description": "

Marks a review thread as resolved.

", - "inputFields": [ - { - "name": "input", - "type": "ResolveReviewThreadInput!", - "id": "resolvereviewthreadinput", - "href": "/graphql/reference/input-objects#resolvereviewthreadinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "thread", - "type": "PullRequestReviewThread", - "id": "pullrequestreviewthread", - "href": "/graphql/reference/objects#pullrequestreviewthread", - "description": "

The thread to resolve.

" - } - ] - }, - { - "name": "revertPullRequest", - "id": "revertpullrequest", - "href": "/graphql/reference/mutations#revertpullrequest", - "description": "

Create a pull request that reverts the changes from a merged pull request.

", - "inputFields": [ - { - "name": "input", - "type": "RevertPullRequestInput!", - "id": "revertpullrequestinput", - "href": "/graphql/reference/input-objects#revertpullrequestinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequest", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest", - "description": "

The pull request that was reverted.

" - }, - { - "name": "revertPullRequest", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest", - "description": "

The new pull request that reverts the input pull request.

" - } - ] - }, - { - "name": "revokeEnterpriseOrganizationsMigratorRole", - "id": "revokeenterpriseorganizationsmigratorrole", - "href": "/graphql/reference/mutations#revokeenterpriseorganizationsmigratorrole", - "description": "

Revoke the migrator role to a user for all organizations under an enterprise account.

", - "inputFields": [ - { - "name": "input", - "type": "RevokeEnterpriseOrganizationsMigratorRoleInput!", - "id": "revokeenterpriseorganizationsmigratorroleinput", - "href": "/graphql/reference/input-objects#revokeenterpriseorganizationsmigratorroleinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "organizations", - "type": "OrganizationConnection", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "description": "

The organizations that had the migrator role revoked for the given user.

" - } - ] - }, - { - "name": "revokeMigratorRole", - "id": "revokemigratorrole", - "href": "/graphql/reference/mutations#revokemigratorrole", - "description": "

Revoke the migrator role from a user or a team.

", - "inputFields": [ - { - "name": "input", - "type": "RevokeMigratorRoleInput!", - "id": "revokemigratorroleinput", - "href": "/graphql/reference/input-objects#revokemigratorroleinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "success", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "description": "

Did the operation succeed?.

" - } - ] - }, - { - "name": "startOrganizationMigration", - "id": "startorganizationmigration", - "href": "/graphql/reference/mutations#startorganizationmigration", - "description": "

Starts a GitHub Enterprise Importer organization migration.

", - "inputFields": [ - { - "name": "input", - "type": "StartOrganizationMigrationInput!", - "id": "startorganizationmigrationinput", - "href": "/graphql/reference/input-objects#startorganizationmigrationinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "orgMigration", - "type": "OrganizationMigration", - "id": "organizationmigration", - "href": "/graphql/reference/objects#organizationmigration", - "description": "

The new organization migration.

" - } - ] - }, - { - "name": "startRepositoryMigration", - "id": "startrepositorymigration", - "href": "/graphql/reference/mutations#startrepositorymigration", - "description": "

Starts a GitHub Enterprise Importer (GEI) repository migration.

", - "inputFields": [ - { - "name": "input", - "type": "StartRepositoryMigrationInput!", - "id": "startrepositorymigrationinput", - "href": "/graphql/reference/input-objects#startrepositorymigrationinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "repositoryMigration", - "type": "RepositoryMigration", - "id": "repositorymigration", - "href": "/graphql/reference/objects#repositorymigration", - "description": "

The new repository migration.

" - } - ] - }, - { - "name": "submitPullRequestReview", - "id": "submitpullrequestreview", - "href": "/graphql/reference/mutations#submitpullrequestreview", - "description": "

Submits a pending pull request review.

", - "inputFields": [ - { - "name": "input", - "type": "SubmitPullRequestReviewInput!", - "id": "submitpullrequestreviewinput", - "href": "/graphql/reference/input-objects#submitpullrequestreviewinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequestReview", - "type": "PullRequestReview", - "id": "pullrequestreview", - "href": "/graphql/reference/objects#pullrequestreview", - "description": "

The submitted pull request review.

" - } - ] - }, - { - "name": "transferIssue", - "id": "transferissue", - "href": "/graphql/reference/mutations#transferissue", - "description": "

Transfer an issue to a different repository.

", - "inputFields": [ - { - "name": "input", - "type": "TransferIssueInput!", - "id": "transferissueinput", - "href": "/graphql/reference/input-objects#transferissueinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "issue", - "type": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue", - "description": "

The issue that was transferred.

" - } - ] - }, - { - "name": "unarchiveProjectV2Item", - "id": "unarchiveprojectv2item", - "href": "/graphql/reference/mutations#unarchiveprojectv2item", - "description": "

Unarchives a ProjectV2Item.

", - "inputFields": [ - { - "name": "input", - "type": "UnarchiveProjectV2ItemInput!", - "id": "unarchiveprojectv2iteminput", - "href": "/graphql/reference/input-objects#unarchiveprojectv2iteminput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "item", - "type": "ProjectV2Item", - "id": "projectv2item", - "href": "/graphql/reference/objects#projectv2item", - "description": "

The item unarchived from the project.

" - } - ] - }, - { - "name": "unarchiveRepository", - "id": "unarchiverepository", - "href": "/graphql/reference/mutations#unarchiverepository", - "description": "

Unarchives a repository.

", - "inputFields": [ - { - "name": "input", - "type": "UnarchiveRepositoryInput!", - "id": "unarchiverepositoryinput", - "href": "/graphql/reference/input-objects#unarchiverepositoryinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "repository", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "description": "

The repository that was unarchived.

" - } - ] - }, - { - "name": "unfollowOrganization", - "id": "unfolloworganization", - "href": "/graphql/reference/mutations#unfolloworganization", - "description": "

Unfollow an organization.

", - "inputFields": [ - { - "name": "input", - "type": "UnfollowOrganizationInput!", - "id": "unfolloworganizationinput", - "href": "/graphql/reference/input-objects#unfolloworganizationinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "organization", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization", - "description": "

The organization that was unfollowed.

" - } - ] - }, - { - "name": "unfollowUser", - "id": "unfollowuser", - "href": "/graphql/reference/mutations#unfollowuser", - "description": "

Unfollow a user.

", - "inputFields": [ - { - "name": "input", - "type": "UnfollowUserInput!", - "id": "unfollowuserinput", - "href": "/graphql/reference/input-objects#unfollowuserinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "user", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user", - "description": "

The user that was unfollowed.

" - } - ] - }, - { - "name": "unlinkProjectV2FromRepository", - "id": "unlinkprojectv2fromrepository", - "href": "/graphql/reference/mutations#unlinkprojectv2fromrepository", - "description": "

Unlinks a project from a repository.

", - "inputFields": [ - { - "name": "input", - "type": "UnlinkProjectV2FromRepositoryInput!", - "id": "unlinkprojectv2fromrepositoryinput", - "href": "/graphql/reference/input-objects#unlinkprojectv2fromrepositoryinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "repository", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "description": "

The repository the project is no longer linked to.

" - } - ] - }, - { - "name": "unlinkProjectV2FromTeam", - "id": "unlinkprojectv2fromteam", - "href": "/graphql/reference/mutations#unlinkprojectv2fromteam", - "description": "

Unlinks a project to a team.

", - "inputFields": [ - { - "name": "input", - "type": "UnlinkProjectV2FromTeamInput!", - "id": "unlinkprojectv2fromteaminput", - "href": "/graphql/reference/input-objects#unlinkprojectv2fromteaminput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "team", - "type": "Team", - "id": "team", - "href": "/graphql/reference/objects#team", - "description": "

The team the project is unlinked from.

" - } - ] - }, - { - "name": "unlinkRepositoryFromProject", - "id": "unlinkrepositoryfromproject", - "href": "/graphql/reference/mutations#unlinkrepositoryfromproject", - "description": "

Deletes a repository link from a project.

", - "inputFields": [ - { - "name": "input", - "type": "UnlinkRepositoryFromProjectInput!", - "id": "unlinkrepositoryfromprojectinput", - "href": "/graphql/reference/input-objects#unlinkrepositoryfromprojectinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "project", - "type": "Project", - "id": "project", - "href": "/graphql/reference/objects#project", - "description": "

The linked Project.

" - }, - { - "name": "repository", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "description": "

The linked Repository.

" - } - ] - }, - { - "name": "unlockLockable", - "id": "unlocklockable", - "href": "/graphql/reference/mutations#unlocklockable", - "description": "

Unlock a lockable object.

", - "inputFields": [ - { - "name": "input", - "type": "UnlockLockableInput!", - "id": "unlocklockableinput", - "href": "/graphql/reference/input-objects#unlocklockableinput" - } - ], - "returnFields": [ - { - "name": "actor", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor", - "description": "

Identifies the actor who performed the event.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "unlockedRecord", - "type": "Lockable", - "id": "lockable", - "href": "/graphql/reference/interfaces#lockable", - "description": "

The item that was unlocked.

" - } - ] - }, - { - "name": "unmarkDiscussionCommentAsAnswer", - "id": "unmarkdiscussioncommentasanswer", - "href": "/graphql/reference/mutations#unmarkdiscussioncommentasanswer", - "description": "

Unmark a discussion comment as the chosen answer for discussions in an answerable category.

", - "inputFields": [ - { - "name": "input", - "type": "UnmarkDiscussionCommentAsAnswerInput!", - "id": "unmarkdiscussioncommentasanswerinput", - "href": "/graphql/reference/input-objects#unmarkdiscussioncommentasanswerinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "discussion", - "type": "Discussion", - "id": "discussion", - "href": "/graphql/reference/objects#discussion", - "description": "

The discussion that includes the comment.

" - } - ] - }, - { - "name": "unmarkFileAsViewed", - "id": "unmarkfileasviewed", - "href": "/graphql/reference/mutations#unmarkfileasviewed", - "description": "

Unmark a pull request file as viewed.

", - "inputFields": [ - { - "name": "input", - "type": "UnmarkFileAsViewedInput!", - "id": "unmarkfileasviewedinput", - "href": "/graphql/reference/input-objects#unmarkfileasviewedinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequest", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest", - "description": "

The updated pull request.

" - } - ] - }, - { - "name": "unmarkIssueAsDuplicate", - "id": "unmarkissueasduplicate", - "href": "/graphql/reference/mutations#unmarkissueasduplicate", - "description": "

Unmark an issue as a duplicate of another issue.

", - "inputFields": [ - { - "name": "input", - "type": "UnmarkIssueAsDuplicateInput!", - "id": "unmarkissueasduplicateinput", - "href": "/graphql/reference/input-objects#unmarkissueasduplicateinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "duplicate", - "type": "IssueOrPullRequest", - "id": "issueorpullrequest", - "href": "/graphql/reference/unions#issueorpullrequest", - "description": "

The issue or pull request that was marked as a duplicate.

" - } - ] - }, - { - "name": "unmarkProjectV2AsTemplate", - "id": "unmarkprojectv2astemplate", - "href": "/graphql/reference/mutations#unmarkprojectv2astemplate", - "description": "

Unmark a project as a template.

", - "inputFields": [ - { - "name": "input", - "type": "UnmarkProjectV2AsTemplateInput!", - "id": "unmarkprojectv2astemplateinput", - "href": "/graphql/reference/input-objects#unmarkprojectv2astemplateinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "projectV2", - "type": "ProjectV2", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2", - "description": "

The project.

" - } - ] - }, - { - "name": "unminimizeComment", - "id": "unminimizecomment", - "href": "/graphql/reference/mutations#unminimizecomment", - "description": "

Unminimizes a comment on an Issue, Commit, Pull Request, or Gist.

", - "inputFields": [ - { - "name": "input", - "type": "UnminimizeCommentInput!", - "id": "unminimizecommentinput", - "href": "/graphql/reference/input-objects#unminimizecommentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "unminimizedComment", - "type": "Minimizable", - "id": "minimizable", - "href": "/graphql/reference/interfaces#minimizable", - "description": "

The comment that was unminimized.

" - } - ] - }, - { - "name": "unpinIssue", - "id": "unpinissue", - "href": "/graphql/reference/mutations#unpinissue", - "description": "

Unpin a pinned issue from a repository.

", - "inputFields": [ - { - "name": "input", - "type": "UnpinIssueInput!", - "id": "unpinissueinput", - "href": "/graphql/reference/input-objects#unpinissueinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "id", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "description": "

The id of the pinned issue that was unpinned.

" - }, - { - "name": "issue", - "type": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue", - "description": "

The issue that was unpinned.

" - } - ] - }, - { - "name": "unresolveReviewThread", - "id": "unresolvereviewthread", - "href": "/graphql/reference/mutations#unresolvereviewthread", - "description": "

Marks a review thread as unresolved.

", - "inputFields": [ - { - "name": "input", - "type": "UnresolveReviewThreadInput!", - "id": "unresolvereviewthreadinput", - "href": "/graphql/reference/input-objects#unresolvereviewthreadinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "thread", - "type": "PullRequestReviewThread", - "id": "pullrequestreviewthread", - "href": "/graphql/reference/objects#pullrequestreviewthread", - "description": "

The thread to resolve.

" - } - ] - }, - { - "name": "unsubscribeFromNotifications", - "id": "unsubscribefromnotifications", - "href": "/graphql/reference/mutations#unsubscribefromnotifications", - "description": "

Unsubscribes from notifications.

", - "inputFields": [ - { - "name": "input", - "type": "UnsubscribeFromNotificationsInput!", - "id": "unsubscribefromnotificationsinput", - "href": "/graphql/reference/input-objects#unsubscribefromnotificationsinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "success", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "description": "

Did the operation succeed?.

" - } - ] - }, - { - "name": "updateBranchProtectionRule", - "id": "updatebranchprotectionrule", - "href": "/graphql/reference/mutations#updatebranchprotectionrule", - "description": "

Update a branch protection rule.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateBranchProtectionRuleInput!", - "id": "updatebranchprotectionruleinput", - "href": "/graphql/reference/input-objects#updatebranchprotectionruleinput" - } - ], - "returnFields": [ - { - "name": "branchProtectionRule", - "type": "BranchProtectionRule", - "id": "branchprotectionrule", - "href": "/graphql/reference/objects#branchprotectionrule", - "description": "

The newly created BranchProtectionRule.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "updateCheckRun", - "id": "updatecheckrun", - "href": "/graphql/reference/mutations#updatecheckrun", - "description": "

Update a check run.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateCheckRunInput!", - "id": "updatecheckruninput", - "href": "/graphql/reference/input-objects#updatecheckruninput" - } - ], - "returnFields": [ - { - "name": "checkRun", - "type": "CheckRun", - "id": "checkrun", - "href": "/graphql/reference/objects#checkrun", - "description": "

The updated check run.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "updateCheckSuitePreferences", - "id": "updatechecksuitepreferences", - "href": "/graphql/reference/mutations#updatechecksuitepreferences", - "description": "

Modifies the settings of an existing check suite.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateCheckSuitePreferencesInput!", - "id": "updatechecksuitepreferencesinput", - "href": "/graphql/reference/input-objects#updatechecksuitepreferencesinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "repository", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "description": "

The updated repository.

" - } - ] - }, - { - "name": "updateDiscussion", - "id": "updatediscussion", - "href": "/graphql/reference/mutations#updatediscussion", - "description": "

Update a discussion.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateDiscussionInput!", - "id": "updatediscussioninput", - "href": "/graphql/reference/input-objects#updatediscussioninput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "discussion", - "type": "Discussion", - "id": "discussion", - "href": "/graphql/reference/objects#discussion", - "description": "

The modified discussion.

" - } - ] - }, - { - "name": "updateDiscussionComment", - "id": "updatediscussioncomment", - "href": "/graphql/reference/mutations#updatediscussioncomment", - "description": "

Update the contents of a comment on a Discussion.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateDiscussionCommentInput!", - "id": "updatediscussioncommentinput", - "href": "/graphql/reference/input-objects#updatediscussioncommentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "comment", - "type": "DiscussionComment", - "id": "discussioncomment", - "href": "/graphql/reference/objects#discussioncomment", - "description": "

The modified discussion comment.

" - } - ] - }, - { - "name": "updateEnterpriseAllowPrivateRepositoryForkingSetting", - "id": "updateenterpriseallowprivaterepositoryforkingsetting", - "href": "/graphql/reference/mutations#updateenterpriseallowprivaterepositoryforkingsetting", - "description": "

Sets whether private repository forks are enabled for an enterprise.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput!", - "id": "updateenterpriseallowprivaterepositoryforkingsettinginput", - "href": "/graphql/reference/input-objects#updateenterpriseallowprivaterepositoryforkingsettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

The enterprise with the updated allow private repository forking setting.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of updating the allow private repository forking setting.

" - } - ] - }, - { - "name": "updateEnterpriseDefaultRepositoryPermissionSetting", - "id": "updateenterprisedefaultrepositorypermissionsetting", - "href": "/graphql/reference/mutations#updateenterprisedefaultrepositorypermissionsetting", - "description": "

Sets the base repository permission for organizations in an enterprise.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateEnterpriseDefaultRepositoryPermissionSettingInput!", - "id": "updateenterprisedefaultrepositorypermissionsettinginput", - "href": "/graphql/reference/input-objects#updateenterprisedefaultrepositorypermissionsettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

The enterprise with the updated base repository permission setting.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of updating the base repository permission setting.

" - } - ] - }, - { - "name": "updateEnterpriseMembersCanChangeRepositoryVisibilitySetting", - "id": "updateenterprisememberscanchangerepositoryvisibilitysetting", - "href": "/graphql/reference/mutations#updateenterprisememberscanchangerepositoryvisibilitysetting", - "description": "

Sets whether organization members with admin permissions on a repository can change repository visibility.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput!", - "id": "updateenterprisememberscanchangerepositoryvisibilitysettinginput", - "href": "/graphql/reference/input-objects#updateenterprisememberscanchangerepositoryvisibilitysettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

The enterprise with the updated members can change repository visibility setting.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of updating the members can change repository visibility setting.

" - } - ] - }, - { - "name": "updateEnterpriseMembersCanCreateRepositoriesSetting", - "id": "updateenterprisememberscancreaterepositoriessetting", - "href": "/graphql/reference/mutations#updateenterprisememberscancreaterepositoriessetting", - "description": "

Sets the members can create repositories setting for an enterprise.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateEnterpriseMembersCanCreateRepositoriesSettingInput!", - "id": "updateenterprisememberscancreaterepositoriessettinginput", - "href": "/graphql/reference/input-objects#updateenterprisememberscancreaterepositoriessettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

The enterprise with the updated members can create repositories setting.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of updating the members can create repositories setting.

" - } - ] - }, - { - "name": "updateEnterpriseMembersCanDeleteIssuesSetting", - "id": "updateenterprisememberscandeleteissuessetting", - "href": "/graphql/reference/mutations#updateenterprisememberscandeleteissuessetting", - "description": "

Sets the members can delete issues setting for an enterprise.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateEnterpriseMembersCanDeleteIssuesSettingInput!", - "id": "updateenterprisememberscandeleteissuessettinginput", - "href": "/graphql/reference/input-objects#updateenterprisememberscandeleteissuessettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

The enterprise with the updated members can delete issues setting.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of updating the members can delete issues setting.

" - } - ] - }, - { - "name": "updateEnterpriseMembersCanDeleteRepositoriesSetting", - "id": "updateenterprisememberscandeleterepositoriessetting", - "href": "/graphql/reference/mutations#updateenterprisememberscandeleterepositoriessetting", - "description": "

Sets the members can delete repositories setting for an enterprise.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput!", - "id": "updateenterprisememberscandeleterepositoriessettinginput", - "href": "/graphql/reference/input-objects#updateenterprisememberscandeleterepositoriessettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

The enterprise with the updated members can delete repositories setting.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of updating the members can delete repositories setting.

" - } - ] - }, - { - "name": "updateEnterpriseMembersCanInviteCollaboratorsSetting", - "id": "updateenterprisememberscaninvitecollaboratorssetting", - "href": "/graphql/reference/mutations#updateenterprisememberscaninvitecollaboratorssetting", - "description": "

Sets whether members can invite collaborators are enabled for an enterprise.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput!", - "id": "updateenterprisememberscaninvitecollaboratorssettinginput", - "href": "/graphql/reference/input-objects#updateenterprisememberscaninvitecollaboratorssettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

The enterprise with the updated members can invite collaborators setting.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of updating the members can invite collaborators setting.

" - } - ] - }, - { - "name": "updateEnterpriseMembersCanMakePurchasesSetting", - "id": "updateenterprisememberscanmakepurchasessetting", - "href": "/graphql/reference/mutations#updateenterprisememberscanmakepurchasessetting", - "description": "

Sets whether or not an organization owner can make purchases.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateEnterpriseMembersCanMakePurchasesSettingInput!", - "id": "updateenterprisememberscanmakepurchasessettinginput", - "href": "/graphql/reference/input-objects#updateenterprisememberscanmakepurchasessettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

The enterprise with the updated members can make purchases setting.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of updating the members can make purchases setting.

" - } - ] - }, - { - "name": "updateEnterpriseMembersCanUpdateProtectedBranchesSetting", - "id": "updateenterprisememberscanupdateprotectedbranchessetting", - "href": "/graphql/reference/mutations#updateenterprisememberscanupdateprotectedbranchessetting", - "description": "

Sets the members can update protected branches setting for an enterprise.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput!", - "id": "updateenterprisememberscanupdateprotectedbranchessettinginput", - "href": "/graphql/reference/input-objects#updateenterprisememberscanupdateprotectedbranchessettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

The enterprise with the updated members can update protected branches setting.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of updating the members can update protected branches setting.

" - } - ] - }, - { - "name": "updateEnterpriseMembersCanViewDependencyInsightsSetting", - "id": "updateenterprisememberscanviewdependencyinsightssetting", - "href": "/graphql/reference/mutations#updateenterprisememberscanviewdependencyinsightssetting", - "description": "

Sets the members can view dependency insights for an enterprise.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput!", - "id": "updateenterprisememberscanviewdependencyinsightssettinginput", - "href": "/graphql/reference/input-objects#updateenterprisememberscanviewdependencyinsightssettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

The enterprise with the updated members can view dependency insights setting.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of updating the members can view dependency insights setting.

" - } - ] - }, - { - "name": "updateEnterpriseOrganizationProjectsSetting", - "id": "updateenterpriseorganizationprojectssetting", - "href": "/graphql/reference/mutations#updateenterpriseorganizationprojectssetting", - "description": "

Sets whether organization projects are enabled for an enterprise.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateEnterpriseOrganizationProjectsSettingInput!", - "id": "updateenterpriseorganizationprojectssettinginput", - "href": "/graphql/reference/input-objects#updateenterpriseorganizationprojectssettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

The enterprise with the updated organization projects setting.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of updating the organization projects setting.

" - } - ] - }, - { - "name": "updateEnterpriseOwnerOrganizationRole", - "id": "updateenterpriseownerorganizationrole", - "href": "/graphql/reference/mutations#updateenterpriseownerorganizationrole", - "description": "

Updates the role of an enterprise owner with an organization.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateEnterpriseOwnerOrganizationRoleInput!", - "id": "updateenterpriseownerorganizationroleinput", - "href": "/graphql/reference/input-objects#updateenterpriseownerorganizationroleinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of changing the owner's organization role.

" - } - ] - }, - { - "name": "updateEnterpriseProfile", - "id": "updateenterpriseprofile", - "href": "/graphql/reference/mutations#updateenterpriseprofile", - "description": "

Updates an enterprise's profile.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateEnterpriseProfileInput!", - "id": "updateenterpriseprofileinput", - "href": "/graphql/reference/input-objects#updateenterpriseprofileinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

The updated enterprise.

" - } - ] - }, - { - "name": "updateEnterpriseRepositoryProjectsSetting", - "id": "updateenterpriserepositoryprojectssetting", - "href": "/graphql/reference/mutations#updateenterpriserepositoryprojectssetting", - "description": "

Sets whether repository projects are enabled for a enterprise.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateEnterpriseRepositoryProjectsSettingInput!", - "id": "updateenterpriserepositoryprojectssettinginput", - "href": "/graphql/reference/input-objects#updateenterpriserepositoryprojectssettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

The enterprise with the updated repository projects setting.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of updating the repository projects setting.

" - } - ] - }, - { - "name": "updateEnterpriseTeamDiscussionsSetting", - "id": "updateenterpriseteamdiscussionssetting", - "href": "/graphql/reference/mutations#updateenterpriseteamdiscussionssetting", - "description": "

Sets whether team discussions are enabled for an enterprise.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateEnterpriseTeamDiscussionsSettingInput!", - "id": "updateenterpriseteamdiscussionssettinginput", - "href": "/graphql/reference/input-objects#updateenterpriseteamdiscussionssettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

The enterprise with the updated team discussions setting.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of updating the team discussions setting.

" - } - ] - }, - { - "name": "updateEnterpriseTwoFactorAuthenticationRequiredSetting", - "id": "updateenterprisetwofactorauthenticationrequiredsetting", - "href": "/graphql/reference/mutations#updateenterprisetwofactorauthenticationrequiredsetting", - "description": "

Sets whether two factor authentication is required for all users in an enterprise.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput!", - "id": "updateenterprisetwofactorauthenticationrequiredsettinginput", - "href": "/graphql/reference/input-objects#updateenterprisetwofactorauthenticationrequiredsettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "enterprise", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

The enterprise with the updated two factor authentication required setting.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of updating the two factor authentication required setting.

" - } - ] - }, - { - "name": "updateEnvironment", - "id": "updateenvironment", - "href": "/graphql/reference/mutations#updateenvironment", - "description": "

Updates an environment.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateEnvironmentInput!", - "id": "updateenvironmentinput", - "href": "/graphql/reference/input-objects#updateenvironmentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "environment", - "type": "Environment", - "id": "environment", - "href": "/graphql/reference/objects#environment", - "description": "

The updated environment.

" - } - ] - }, - { - "name": "updateIpAllowListEnabledSetting", - "id": "updateipallowlistenabledsetting", - "href": "/graphql/reference/mutations#updateipallowlistenabledsetting", - "description": "

Sets whether an IP allow list is enabled on an owner.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateIpAllowListEnabledSettingInput!", - "id": "updateipallowlistenabledsettinginput", - "href": "/graphql/reference/input-objects#updateipallowlistenabledsettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "owner", - "type": "IpAllowListOwner", - "id": "ipallowlistowner", - "href": "/graphql/reference/unions#ipallowlistowner", - "description": "

The IP allow list owner on which the setting was updated.

" - } - ] - }, - { - "name": "updateIpAllowListEntry", - "id": "updateipallowlistentry", - "href": "/graphql/reference/mutations#updateipallowlistentry", - "description": "

Updates an IP allow list entry.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateIpAllowListEntryInput!", - "id": "updateipallowlistentryinput", - "href": "/graphql/reference/input-objects#updateipallowlistentryinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "ipAllowListEntry", - "type": "IpAllowListEntry", - "id": "ipallowlistentry", - "href": "/graphql/reference/objects#ipallowlistentry", - "description": "

The IP allow list entry that was updated.

" - } - ] - }, - { - "name": "updateIpAllowListForInstalledAppsEnabledSetting", - "id": "updateipallowlistforinstalledappsenabledsetting", - "href": "/graphql/reference/mutations#updateipallowlistforinstalledappsenabledsetting", - "description": "

Sets whether IP allow list configuration for installed GitHub Apps is enabled on an owner.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateIpAllowListForInstalledAppsEnabledSettingInput!", - "id": "updateipallowlistforinstalledappsenabledsettinginput", - "href": "/graphql/reference/input-objects#updateipallowlistforinstalledappsenabledsettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "owner", - "type": "IpAllowListOwner", - "id": "ipallowlistowner", - "href": "/graphql/reference/unions#ipallowlistowner", - "description": "

The IP allow list owner on which the setting was updated.

" - } - ] - }, - { - "name": "updateIssue", - "id": "updateissue", - "href": "/graphql/reference/mutations#updateissue", - "description": "

Updates an Issue.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateIssueInput!", - "id": "updateissueinput", - "href": "/graphql/reference/input-objects#updateissueinput" - } - ], - "returnFields": [ - { - "name": "actor", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor", - "description": "

Identifies the actor who performed the event.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "issue", - "type": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue", - "description": "

The issue.

" - } - ] - }, - { - "name": "updateIssueComment", - "id": "updateissuecomment", - "href": "/graphql/reference/mutations#updateissuecomment", - "description": "

Updates an IssueComment object.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateIssueCommentInput!", - "id": "updateissuecommentinput", - "href": "/graphql/reference/input-objects#updateissuecommentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "issueComment", - "type": "IssueComment", - "id": "issuecomment", - "href": "/graphql/reference/objects#issuecomment", - "description": "

The updated comment.

" - } - ] - }, - { - "name": "updateLabel", - "id": "updatelabel", - "href": "/graphql/reference/mutations#updatelabel", - "description": "

Updates an existing label.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateLabelInput!", - "id": "updatelabelinput", - "href": "/graphql/reference/input-objects#updatelabelinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "label", - "type": "Label", - "id": "label", - "href": "/graphql/reference/objects#label", - "description": "

The updated label.

" - } - ] - }, - { - "name": "updateNotificationRestrictionSetting", - "id": "updatenotificationrestrictionsetting", - "href": "/graphql/reference/mutations#updatenotificationrestrictionsetting", - "description": "

Update the setting to restrict notifications to only verified or approved domains available to an owner.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateNotificationRestrictionSettingInput!", - "id": "updatenotificationrestrictionsettinginput", - "href": "/graphql/reference/input-objects#updatenotificationrestrictionsettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "owner", - "type": "VerifiableDomainOwner", - "id": "verifiabledomainowner", - "href": "/graphql/reference/unions#verifiabledomainowner", - "description": "

The owner on which the setting was updated.

" - } - ] - }, - { - "name": "updateOrganizationAllowPrivateRepositoryForkingSetting", - "id": "updateorganizationallowprivaterepositoryforkingsetting", - "href": "/graphql/reference/mutations#updateorganizationallowprivaterepositoryforkingsetting", - "description": "

Sets whether private repository forks are enabled for an organization.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateOrganizationAllowPrivateRepositoryForkingSettingInput!", - "id": "updateorganizationallowprivaterepositoryforkingsettinginput", - "href": "/graphql/reference/input-objects#updateorganizationallowprivaterepositoryforkingsettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of updating the allow private repository forking setting.

" - }, - { - "name": "organization", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization", - "description": "

The organization with the updated allow private repository forking setting.

" - } - ] - }, - { - "name": "updateOrganizationWebCommitSignoffSetting", - "id": "updateorganizationwebcommitsignoffsetting", - "href": "/graphql/reference/mutations#updateorganizationwebcommitsignoffsetting", - "description": "

Sets whether contributors are required to sign off on web-based commits for repositories in an organization.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateOrganizationWebCommitSignoffSettingInput!", - "id": "updateorganizationwebcommitsignoffsettinginput", - "href": "/graphql/reference/input-objects#updateorganizationwebcommitsignoffsettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of updating the web commit signoff setting.

" - }, - { - "name": "organization", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization", - "description": "

The organization with the updated web commit signoff setting.

" - } - ] - }, - { - "name": "updateProject", - "id": "updateproject", - "href": "/graphql/reference/mutations#updateproject", - "description": "

Updates an existing project.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateProjectInput!", - "id": "updateprojectinput", - "href": "/graphql/reference/input-objects#updateprojectinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "project", - "type": "Project", - "id": "project", - "href": "/graphql/reference/objects#project", - "description": "

The updated project.

" - } - ] - }, - { - "name": "updateProjectCard", - "id": "updateprojectcard", - "href": "/graphql/reference/mutations#updateprojectcard", - "description": "

Updates an existing project card.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateProjectCardInput!", - "id": "updateprojectcardinput", - "href": "/graphql/reference/input-objects#updateprojectcardinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "projectCard", - "type": "ProjectCard", - "id": "projectcard", - "href": "/graphql/reference/objects#projectcard", - "description": "

The updated ProjectCard.

" - } - ] - }, - { - "name": "updateProjectColumn", - "id": "updateprojectcolumn", - "href": "/graphql/reference/mutations#updateprojectcolumn", - "description": "

Updates an existing project column.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateProjectColumnInput!", - "id": "updateprojectcolumninput", - "href": "/graphql/reference/input-objects#updateprojectcolumninput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "projectColumn", - "type": "ProjectColumn", - "id": "projectcolumn", - "href": "/graphql/reference/objects#projectcolumn", - "description": "

The updated project column.

" - } - ] - }, - { - "name": "updateProjectV2", - "id": "updateprojectv2", - "href": "/graphql/reference/mutations#updateprojectv2", - "description": "

Updates an existing project.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateProjectV2Input!", - "id": "updateprojectv2input", - "href": "/graphql/reference/input-objects#updateprojectv2input" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "projectV2", - "type": "ProjectV2", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2", - "description": "

The updated Project.

" - } - ] - }, - { - "name": "updateProjectV2Collaborators", - "id": "updateprojectv2collaborators", - "href": "/graphql/reference/mutations#updateprojectv2collaborators", - "description": "

Update the collaborators on a team or a project.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateProjectV2CollaboratorsInput!", - "id": "updateprojectv2collaboratorsinput", - "href": "/graphql/reference/input-objects#updateprojectv2collaboratorsinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "collaborators", - "type": "ProjectV2ActorConnection", - "id": "projectv2actorconnection", - "href": "/graphql/reference/objects#projectv2actorconnection", - "description": "

The collaborators granted a role.

" - } - ] - }, - { - "name": "updateProjectV2DraftIssue", - "id": "updateprojectv2draftissue", - "href": "/graphql/reference/mutations#updateprojectv2draftissue", - "description": "

Updates a draft issue within a Project.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateProjectV2DraftIssueInput!", - "id": "updateprojectv2draftissueinput", - "href": "/graphql/reference/input-objects#updateprojectv2draftissueinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "draftIssue", - "type": "DraftIssue", - "id": "draftissue", - "href": "/graphql/reference/objects#draftissue", - "description": "

The draft issue updated in the project.

" - } - ] - }, - { - "name": "updateProjectV2ItemFieldValue", - "id": "updateprojectv2itemfieldvalue", - "href": "/graphql/reference/mutations#updateprojectv2itemfieldvalue", - "description": "

This mutation updates the value of a field for an item in a Project. Currently\nonly single-select, text, number, date, and iteration fields are supported.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateProjectV2ItemFieldValueInput!", - "id": "updateprojectv2itemfieldvalueinput", - "href": "/graphql/reference/input-objects#updateprojectv2itemfieldvalueinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "projectV2Item", - "type": "ProjectV2Item", - "id": "projectv2item", - "href": "/graphql/reference/objects#projectv2item", - "description": "

The updated item.

" - } - ] - }, - { - "name": "updateProjectV2ItemPosition", - "id": "updateprojectv2itemposition", - "href": "/graphql/reference/mutations#updateprojectv2itemposition", - "description": "

This mutation updates the position of the item in the project, where the position represents the priority of an item.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateProjectV2ItemPositionInput!", - "id": "updateprojectv2itempositioninput", - "href": "/graphql/reference/input-objects#updateprojectv2itempositioninput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "items", - "type": "ProjectV2ItemConnection", - "id": "projectv2itemconnection", - "href": "/graphql/reference/objects#projectv2itemconnection", - "description": "

The items in the new order.

" - } - ] - }, - { - "name": "updatePullRequest", - "id": "updatepullrequest", - "href": "/graphql/reference/mutations#updatepullrequest", - "description": "

Update a pull request.

", - "inputFields": [ - { - "name": "input", - "type": "UpdatePullRequestInput!", - "id": "updatepullrequestinput", - "href": "/graphql/reference/input-objects#updatepullrequestinput" - } - ], - "returnFields": [ - { - "name": "actor", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor", - "description": "

Identifies the actor who performed the event.

" - }, - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequest", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest", - "description": "

The updated pull request.

" - } - ] - }, - { - "name": "updatePullRequestBranch", - "id": "updatepullrequestbranch", - "href": "/graphql/reference/mutations#updatepullrequestbranch", - "description": "

Merge or Rebase HEAD from upstream branch into pull request branch.

", - "inputFields": [ - { - "name": "input", - "type": "UpdatePullRequestBranchInput!", - "id": "updatepullrequestbranchinput", - "href": "/graphql/reference/input-objects#updatepullrequestbranchinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequest", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest", - "description": "

The updated pull request.

" - } - ] - }, - { - "name": "updatePullRequestReview", - "id": "updatepullrequestreview", - "href": "/graphql/reference/mutations#updatepullrequestreview", - "description": "

Updates the body of a pull request review.

", - "inputFields": [ - { - "name": "input", - "type": "UpdatePullRequestReviewInput!", - "id": "updatepullrequestreviewinput", - "href": "/graphql/reference/input-objects#updatepullrequestreviewinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequestReview", - "type": "PullRequestReview", - "id": "pullrequestreview", - "href": "/graphql/reference/objects#pullrequestreview", - "description": "

The updated pull request review.

" - } - ] - }, - { - "name": "updatePullRequestReviewComment", - "id": "updatepullrequestreviewcomment", - "href": "/graphql/reference/mutations#updatepullrequestreviewcomment", - "description": "

Updates a pull request review comment.

", - "inputFields": [ - { - "name": "input", - "type": "UpdatePullRequestReviewCommentInput!", - "id": "updatepullrequestreviewcommentinput", - "href": "/graphql/reference/input-objects#updatepullrequestreviewcommentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "pullRequestReviewComment", - "type": "PullRequestReviewComment", - "id": "pullrequestreviewcomment", - "href": "/graphql/reference/objects#pullrequestreviewcomment", - "description": "

The updated comment.

" - } - ] - }, - { - "name": "updateRef", - "id": "updateref", - "href": "/graphql/reference/mutations#updateref", - "description": "

Update a Git Ref.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateRefInput!", - "id": "updaterefinput", - "href": "/graphql/reference/input-objects#updaterefinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "ref", - "type": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref", - "description": "

The updated Ref.

" - } - ] - }, - { - "name": "updateRefs", - "id": "updaterefs", - "href": "/graphql/reference/mutations#updaterefs", - "description": "

Creates, updates and/or deletes multiple refs in a repository.

\n

This mutation takes a list of RefUpdates and performs these updates\non the repository. All updates are performed atomically, meaning that\nif one of them is rejected, no other ref will be modified.

\n

RefUpdate.beforeOid specifies that the given reference needs to point\nto the given value before performing any updates. A value of\n0000000000000000000000000000000000000000 can be used to verify that\nthe references should not exist.

\n

RefUpdate.afterOid specifies the value that the given reference\nwill point to after performing all updates. A value of\n0000000000000000000000000000000000000000 can be used to delete a\nreference.

\n

If RefUpdate.force is set to true, a non-fast-forward updates\nfor the given reference will be allowed.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateRefsInput!", - "id": "updaterefsinput", - "href": "/graphql/reference/input-objects#updaterefsinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - } - ] - }, - { - "name": "updateRepository", - "id": "updaterepository", - "href": "/graphql/reference/mutations#updaterepository", - "description": "

Update information about a repository.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateRepositoryInput!", - "id": "updaterepositoryinput", - "href": "/graphql/reference/input-objects#updaterepositoryinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "repository", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "description": "

The updated repository.

" - } - ] - }, - { - "name": "updateRepositoryRuleset", - "id": "updaterepositoryruleset", - "href": "/graphql/reference/mutations#updaterepositoryruleset", - "description": "

Update a repository ruleset.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateRepositoryRulesetInput!", - "id": "updaterepositoryrulesetinput", - "href": "/graphql/reference/input-objects#updaterepositoryrulesetinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "ruleset", - "type": "RepositoryRuleset", - "id": "repositoryruleset", - "href": "/graphql/reference/objects#repositoryruleset", - "description": "

The newly created Ruleset.

" - } - ] - }, - { - "name": "updateRepositoryWebCommitSignoffSetting", - "id": "updaterepositorywebcommitsignoffsetting", - "href": "/graphql/reference/mutations#updaterepositorywebcommitsignoffsetting", - "description": "

Sets whether contributors are required to sign off on web-based commits for a repository.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateRepositoryWebCommitSignoffSettingInput!", - "id": "updaterepositorywebcommitsignoffsettinginput", - "href": "/graphql/reference/input-objects#updaterepositorywebcommitsignoffsettinginput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "message", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of updating the web commit signoff setting.

" - }, - { - "name": "repository", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "description": "

The updated repository.

" - } - ] - }, - { - "name": "updateSubscription", - "id": "updatesubscription", - "href": "/graphql/reference/mutations#updatesubscription", - "description": "

Updates the state for subscribable subjects.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateSubscriptionInput!", - "id": "updatesubscriptioninput", - "href": "/graphql/reference/input-objects#updatesubscriptioninput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "subscribable", - "type": "Subscribable", - "id": "subscribable", - "href": "/graphql/reference/interfaces#subscribable", - "description": "

The input subscribable entity.

" - } - ] - }, - { - "name": "updateTeamDiscussion", - "id": "updateteamdiscussion", - "href": "/graphql/reference/mutations#updateteamdiscussion", - "description": "

Updates a team discussion.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateTeamDiscussionInput!", - "id": "updateteamdiscussioninput", - "href": "/graphql/reference/input-objects#updateteamdiscussioninput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "teamDiscussion", - "type": "TeamDiscussion", - "id": "teamdiscussion", - "href": "/graphql/reference/objects#teamdiscussion", - "description": "

The updated discussion.

" - } - ] - }, - { - "name": "updateTeamDiscussionComment", - "id": "updateteamdiscussioncomment", - "href": "/graphql/reference/mutations#updateteamdiscussioncomment", - "description": "

Updates a discussion comment.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateTeamDiscussionCommentInput!", - "id": "updateteamdiscussioncommentinput", - "href": "/graphql/reference/input-objects#updateteamdiscussioncommentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "teamDiscussionComment", - "type": "TeamDiscussionComment", - "id": "teamdiscussioncomment", - "href": "/graphql/reference/objects#teamdiscussioncomment", - "description": "

The updated comment.

" - } - ] - }, - { - "name": "updateTeamReviewAssignment", - "id": "updateteamreviewassignment", - "href": "/graphql/reference/mutations#updateteamreviewassignment", - "description": "

Updates team review assignment.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateTeamReviewAssignmentInput!", - "id": "updateteamreviewassignmentinput", - "href": "/graphql/reference/input-objects#updateteamreviewassignmentinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "team", - "type": "Team", - "id": "team", - "href": "/graphql/reference/objects#team", - "description": "

The team that was modified.

" - } - ] - }, - { - "name": "updateTeamsRepository", - "id": "updateteamsrepository", - "href": "/graphql/reference/mutations#updateteamsrepository", - "description": "

Update team repository.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateTeamsRepositoryInput!", - "id": "updateteamsrepositoryinput", - "href": "/graphql/reference/input-objects#updateteamsrepositoryinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "repository", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "description": "

The repository that was updated.

" - }, - { - "name": "teams", - "type": "[Team!]", - "id": "team", - "href": "/graphql/reference/objects#team", - "description": "

The teams granted permission on the repository.

" - } - ] - }, - { - "name": "updateTopics", - "id": "updatetopics", - "href": "/graphql/reference/mutations#updatetopics", - "description": "

Replaces the repository's topics with the given topics.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateTopicsInput!", - "id": "updatetopicsinput", - "href": "/graphql/reference/input-objects#updatetopicsinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "invalidTopicNames", - "type": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

Names of the provided topics that are not valid.

" - }, - { - "name": "repository", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "description": "

The updated repository.

" - } - ] - }, - { - "name": "updateUserList", - "id": "updateuserlist", - "href": "/graphql/reference/mutations#updateuserlist", - "description": "

Updates an existing user list.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateUserListInput!", - "id": "updateuserlistinput", - "href": "/graphql/reference/input-objects#updateuserlistinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "list", - "type": "UserList", - "id": "userlist", - "href": "/graphql/reference/objects#userlist", - "description": "

The list that was just updated.

" - } - ] - }, - { - "name": "updateUserListsForItem", - "id": "updateuserlistsforitem", - "href": "/graphql/reference/mutations#updateuserlistsforitem", - "description": "

Updates which of the viewer's lists an item belongs to.

", - "inputFields": [ - { - "name": "input", - "type": "UpdateUserListsForItemInput!", - "id": "updateuserlistsforiteminput", - "href": "/graphql/reference/input-objects#updateuserlistsforiteminput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "item", - "type": "UserListItems", - "id": "userlistitems", - "href": "/graphql/reference/unions#userlistitems", - "description": "

The item that was added.

" - }, - { - "name": "lists", - "type": "[UserList!]", - "id": "userlist", - "href": "/graphql/reference/objects#userlist", - "description": "

The lists to which this item belongs.

" - }, - { - "name": "user", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user", - "description": "

The user who owns the lists.

" - } - ] - }, - { - "name": "verifyVerifiableDomain", - "id": "verifyverifiabledomain", - "href": "/graphql/reference/mutations#verifyverifiabledomain", - "description": "

Verify that a verifiable domain has the expected DNS record.

", - "inputFields": [ - { - "name": "input", - "type": "VerifyVerifiableDomainInput!", - "id": "verifyverifiabledomaininput", - "href": "/graphql/reference/input-objects#verifyverifiabledomaininput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "description": "

A unique identifier for the client performing the mutation.

" - }, - { - "name": "domain", - "type": "VerifiableDomain", - "id": "verifiabledomain", - "href": "/graphql/reference/objects#verifiabledomain", - "description": "

The verifiable domain that was verified.

" - } - ] - } - ], - "objects": [ - { - "name": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation", - "description": "

Location information for an actor.

", - "fields": [ - { - "name": "city", - "description": "

City.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "country", - "description": "

Country name.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "countryCode", - "description": "

Country code.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "region", - "description": "

Region name.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "regionCode", - "description": "

Region or state code.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "AddedToMergeQueueEvent", - "id": "addedtomergequeueevent", - "href": "/graphql/reference/objects#addedtomergequeueevent", - "description": "

Represents anadded_to_merge_queueevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "enqueuer", - "description": "

The user who added this Pull Request to the merge queue.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "id", - "description": "

The Node ID of the AddedToMergeQueueEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "mergeQueue", - "description": "

The merge queue where this pull request was added to.

", - "type": "MergeQueue", - "id": "mergequeue", - "href": "/graphql/reference/objects#mergequeue" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "AddedToProjectEvent", - "id": "addedtoprojectevent", - "href": "/graphql/reference/objects#addedtoprojectevent", - "description": "

Represents aadded_to_projectevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the AddedToProjectEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "project", - "description": "

Project referenced by event.

", - "type": "Project", - "id": "project", - "href": "/graphql/reference/objects#project" - }, - { - "name": "projectCard", - "description": "

Project card referenced by this project event.

", - "type": "ProjectCard", - "id": "projectcard", - "href": "/graphql/reference/objects#projectcard" - }, - { - "name": "projectColumnName", - "description": "

Column name referenced by this project event.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "App", - "id": "app", - "href": "/graphql/reference/objects#app", - "description": "

A GitHub App.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "description", - "description": "

The description of the app.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the App object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "ipAllowListEntries", - "description": "

The IP addresses of the app.

", - "type": "IpAllowListEntryConnection!", - "id": "ipallowlistentryconnection", - "href": "/graphql/reference/objects#ipallowlistentryconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for IP allow list entries returned.

", - "type": { - "name": "IpAllowListEntryOrder", - "id": "ipallowlistentryorder", - "href": "/graphql/reference/input-objects#ipallowlistentryorder" - } - } - ] - }, - { - "name": "logoBackgroundColor", - "description": "

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

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "logoUrl", - "description": "

A URL pointing to the app's logo.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "arguments": [ - { - "name": "size", - "description": "

The size of the resulting image.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "name", - "description": "

The name of the app.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "slug", - "description": "

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

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The URL to the app's homepage.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "AssignedEvent", - "id": "assignedevent", - "href": "/graphql/reference/objects#assignedevent", - "description": "

Represents anassignedevent on any assignable object.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "assignable", - "description": "

Identifies the assignable associated with the event.

", - "type": "Assignable!", - "id": "assignable", - "href": "/graphql/reference/interfaces#assignable" - }, - { - "name": "assignee", - "description": "

Identifies the user or mannequin that was assigned.

", - "type": "Assignee", - "id": "assignee", - "href": "/graphql/reference/unions#assignee" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the AssignedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "user", - "description": "

Identifies the user who was assigned.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user", - "isDeprecated": true, - "deprecationReason": "

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

" - } - ] - }, - { - "name": "AutoMergeDisabledEvent", - "id": "automergedisabledevent", - "href": "/graphql/reference/objects#automergedisabledevent", - "description": "

Represents aauto_merge_disabledevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "disabler", - "description": "

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

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "id", - "description": "

The Node ID of the AutoMergeDisabledEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "reason", - "description": "

The reason auto-merge was disabled.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "reasonCode", - "description": "

The reason_code relating to why auto-merge was disabled.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "AutoMergeEnabledEvent", - "id": "automergeenabledevent", - "href": "/graphql/reference/objects#automergeenabledevent", - "description": "

Represents aauto_merge_enabledevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "enabler", - "description": "

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

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "id", - "description": "

The Node ID of the AutoMergeEnabledEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "AutoMergeRequest", - "id": "automergerequest", - "href": "/graphql/reference/objects#automergerequest", - "description": "

Represents an auto-merge request for a pull request.

", - "fields": [ - { - "name": "authorEmail", - "description": "

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

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "commitBody", - "description": "

The commit message of the auto-merge request. If a merge queue is required by\nthe base branch, this value will be set by the merge queue when merging.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "commitHeadline", - "description": "

The commit title of the auto-merge request. If a merge queue is required by\nthe base branch, this value will be set by the merge queue when merging.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enabledAt", - "description": "

When was this auto-merge request was enabled.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "enabledBy", - "description": "

The actor who created the auto-merge request.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "mergeMethod", - "description": "

The merge method of the auto-merge request. If a merge queue is required by\nthe base branch, this value will be set by the merge queue when merging.

", - "type": "PullRequestMergeMethod!", - "id": "pullrequestmergemethod", - "href": "/graphql/reference/enums#pullrequestmergemethod" - }, - { - "name": "pullRequest", - "description": "

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

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "AutoRebaseEnabledEvent", - "id": "autorebaseenabledevent", - "href": "/graphql/reference/objects#autorebaseenabledevent", - "description": "

Represents aauto_rebase_enabledevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "enabler", - "description": "

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

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "id", - "description": "

The Node ID of the AutoRebaseEnabledEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "AutoSquashEnabledEvent", - "id": "autosquashenabledevent", - "href": "/graphql/reference/objects#autosquashenabledevent", - "description": "

Represents aauto_squash_enabledevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "enabler", - "description": "

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

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "id", - "description": "

The Node ID of the AutoSquashEnabledEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "AutomaticBaseChangeFailedEvent", - "id": "automaticbasechangefailedevent", - "href": "/graphql/reference/objects#automaticbasechangefailedevent", - "description": "

Represents aautomatic_base_change_failedevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the AutomaticBaseChangeFailedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "newBase", - "description": "

The new base for this PR.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "oldBase", - "description": "

The old base for this PR.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "AutomaticBaseChangeSucceededEvent", - "id": "automaticbasechangesucceededevent", - "href": "/graphql/reference/objects#automaticbasechangesucceededevent", - "description": "

Represents aautomatic_base_change_succeededevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the AutomaticBaseChangeSucceededEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "newBase", - "description": "

The new base for this PR.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "oldBase", - "description": "

The old base for this PR.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "BaseRefChangedEvent", - "id": "baserefchangedevent", - "href": "/graphql/reference/objects#baserefchangedevent", - "description": "

Represents abase_ref_changedevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "currentRefName", - "description": "

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

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the BaseRefChangedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "previousRefName", - "description": "

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

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "BaseRefDeletedEvent", - "id": "baserefdeletedevent", - "href": "/graphql/reference/objects#baserefdeletedevent", - "description": "

Represents abase_ref_deletedevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "baseRefName", - "description": "

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

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the BaseRefDeletedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "BaseRefForcePushedEvent", - "id": "baserefforcepushedevent", - "href": "/graphql/reference/objects#baserefforcepushedevent", - "description": "

Represents abase_ref_force_pushedevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "afterCommit", - "description": "

Identifies the after commit SHA for thebase_ref_force_pushedevent.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "beforeCommit", - "description": "

Identifies the before commit SHA for thebase_ref_force_pushedevent.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the BaseRefForcePushedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "ref", - "description": "

Identifies the fully qualified ref name for thebase_ref_force_pushedevent.

", - "type": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref" - } - ] - }, - { - "name": "Blame", - "id": "blame", - "href": "/graphql/reference/objects#blame", - "description": "

Represents a Git blame.

", - "fields": [ - { - "name": "ranges", - "description": "

The list of ranges from a Git blame.

", - "type": "[BlameRange!]!", - "id": "blamerange", - "href": "/graphql/reference/objects#blamerange" - } - ] - }, - { - "name": "BlameRange", - "id": "blamerange", - "href": "/graphql/reference/objects#blamerange", - "description": "

Represents a range of information from a Git blame.

", - "fields": [ - { - "name": "age", - "description": "

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.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "commit", - "description": "

Identifies the line author.

", - "type": "Commit!", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "endingLine", - "description": "

The ending line for the range.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "startingLine", - "description": "

The starting line for the range.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "Blob", - "id": "blob", - "href": "/graphql/reference/objects#blob", - "description": "

Represents a Git blob.

", - "implements": [ - { - "name": "GitObject", - "id": "gitobject", - "href": "/graphql/reference/interfaces#gitobject" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "abbreviatedOid", - "description": "

An abbreviated version of the Git object ID.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "byteSize", - "description": "

Byte size of Blob object.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "commitResourcePath", - "description": "

The HTTP path for this Git object.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "commitUrl", - "description": "

The HTTP URL for this Git object.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "id", - "description": "

The Node ID of the Blob object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isBinary", - "description": "

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

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isTruncated", - "description": "

Indicates whether the contents is truncated.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "oid", - "description": "

The Git object ID.

", - "type": "GitObjectID!", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "repository", - "description": "

The Repository the Git object belongs to.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "text", - "description": "

UTF8 text data or null if the Blob is binary.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "Bot", - "id": "bot", - "href": "/graphql/reference/objects#bot", - "description": "

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

", - "implements": [ - { - "name": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "avatarUrl", - "description": "

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

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "arguments": [ - { - "name": "size", - "description": "

The size of the resulting square image.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the Bot object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "login", - "description": "

The username of the actor.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this bot.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this bot.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "BranchNamePatternParameters", - "id": "branchnamepatternparameters", - "href": "/graphql/reference/objects#branchnamepatternparameters", - "description": "

Parameters to be used for the branch_name_pattern rule.

", - "fields": [ - { - "name": "name", - "description": "

How this rule will appear to users.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "operator", - "description": "

The operator to use for matching.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pattern", - "description": "

The pattern to match with.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "BranchProtectionRule", - "id": "branchprotectionrule", - "href": "/graphql/reference/objects#branchprotectionrule", - "description": "

A branch protection rule.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "allowsDeletions", - "description": "

Can this branch be deleted.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "allowsForcePushes", - "description": "

Are force pushes allowed on this branch.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "blocksCreations", - "description": "

Is branch creation a protected operation.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "branchProtectionRuleConflicts", - "description": "

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

", - "type": "BranchProtectionRuleConflictConnection!", - "id": "branchprotectionruleconflictconnection", - "href": "/graphql/reference/objects#branchprotectionruleconflictconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "bypassForcePushAllowances", - "description": "

A list of actors able to force push for this branch protection rule.

", - "type": "BypassForcePushAllowanceConnection!", - "id": "bypassforcepushallowanceconnection", - "href": "/graphql/reference/objects#bypassforcepushallowanceconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "bypassPullRequestAllowances", - "description": "

A list of actors able to bypass PRs for this branch protection rule.

", - "type": "BypassPullRequestAllowanceConnection!", - "id": "bypasspullrequestallowanceconnection", - "href": "/graphql/reference/objects#bypasspullrequestallowanceconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "creator", - "description": "

The actor who created this branch protection rule.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "dismissesStaleReviews", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "id", - "description": "

The Node ID of the BranchProtectionRule object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isAdminEnforced", - "description": "

Can admins override branch protection.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "lockAllowsFetchAndMerge", - "description": "

Whether users can pull changes from upstream when the branch is locked. Set to\ntrue to allow fork syncing. Set to false to prevent fork syncing.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "lockBranch", - "description": "

Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "matchingRefs", - "description": "

Repository refs that are protected by this rule.

", - "type": "RefConnection!", - "id": "refconnection", - "href": "/graphql/reference/objects#refconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "query", - "description": "

Filters refs with query on name.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "pattern", - "description": "

Identifies the protection rule pattern.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pushAllowances", - "description": "

A list push allowances for this branch protection rule.

", - "type": "PushAllowanceConnection!", - "id": "pushallowanceconnection", - "href": "/graphql/reference/objects#pushallowanceconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "repository", - "description": "

The repository associated with this branch protection rule.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "requireLastPushApproval", - "description": "

Whether the most recent push must be approved by someone other than the person who pushed it.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiredApprovingReviewCount", - "description": "

Number of approving reviews required to update matching branches.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "requiredDeploymentEnvironments", - "description": "

List of required deployment environments that must be deployed successfully to update matching branches.

", - "type": "[String]", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "requiredStatusCheckContexts", - "description": "

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

", - "type": "[String]", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "requiredStatusChecks", - "description": "

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

", - "type": "[RequiredStatusCheckDescription!]", - "id": "requiredstatuscheckdescription", - "href": "/graphql/reference/objects#requiredstatuscheckdescription" - }, - { - "name": "requiresApprovingReviews", - "description": "

Are approving reviews required to update matching branches.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresCodeOwnerReviews", - "description": "

Are reviews from code owners required to update matching branches.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresCommitSignatures", - "description": "

Are commits required to be signed.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresConversationResolution", - "description": "

Are conversations required to be resolved before merging.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresDeployments", - "description": "

Does this branch require deployment to specific environments before merging.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresLinearHistory", - "description": "

Are merge commits prohibited from being pushed to this branch.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresStatusChecks", - "description": "

Are status checks required to update matching branches.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresStrictStatusChecks", - "description": "

Are branches required to be up to date before merging.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "restrictsPushes", - "description": "

Is pushing to matching branches restricted.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "restrictsReviewDismissals", - "description": "

Is dismissal of pull request reviews restricted.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "reviewDismissalAllowances", - "description": "

A list review dismissal allowances for this branch protection rule.

", - "type": "ReviewDismissalAllowanceConnection!", - "id": "reviewdismissalallowanceconnection", - "href": "/graphql/reference/objects#reviewdismissalallowanceconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - } - ] - }, - { - "name": "BranchProtectionRuleConflict", - "id": "branchprotectionruleconflict", - "href": "/graphql/reference/objects#branchprotectionruleconflict", - "description": "

A conflict between two branch protection rules.

", - "fields": [ - { - "name": "branchProtectionRule", - "description": "

Identifies the branch protection rule.

", - "type": "BranchProtectionRule", - "id": "branchprotectionrule", - "href": "/graphql/reference/objects#branchprotectionrule" - }, - { - "name": "conflictingBranchProtectionRule", - "description": "

Identifies the conflicting branch protection rule.

", - "type": "BranchProtectionRule", - "id": "branchprotectionrule", - "href": "/graphql/reference/objects#branchprotectionrule" - }, - { - "name": "ref", - "description": "

Identifies the branch ref that has conflicting rules.

", - "type": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref" - } - ] - }, - { - "name": "BranchProtectionRuleConflictConnection", - "id": "branchprotectionruleconflictconnection", - "href": "/graphql/reference/objects#branchprotectionruleconflictconnection", - "description": "

The connection type for BranchProtectionRuleConflict.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[BranchProtectionRuleConflictEdge]", - "id": "branchprotectionruleconflictedge", - "href": "/graphql/reference/objects#branchprotectionruleconflictedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[BranchProtectionRuleConflict]", - "id": "branchprotectionruleconflict", - "href": "/graphql/reference/objects#branchprotectionruleconflict" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "BranchProtectionRuleConflictEdge", - "id": "branchprotectionruleconflictedge", - "href": "/graphql/reference/objects#branchprotectionruleconflictedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "BranchProtectionRuleConflict", - "id": "branchprotectionruleconflict", - "href": "/graphql/reference/objects#branchprotectionruleconflict" - } - ] - }, - { - "name": "BranchProtectionRuleConnection", - "id": "branchprotectionruleconnection", - "href": "/graphql/reference/objects#branchprotectionruleconnection", - "description": "

The connection type for BranchProtectionRule.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[BranchProtectionRuleEdge]", - "id": "branchprotectionruleedge", - "href": "/graphql/reference/objects#branchprotectionruleedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[BranchProtectionRule]", - "id": "branchprotectionrule", - "href": "/graphql/reference/objects#branchprotectionrule" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "BranchProtectionRuleEdge", - "id": "branchprotectionruleedge", - "href": "/graphql/reference/objects#branchprotectionruleedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "BranchProtectionRule", - "id": "branchprotectionrule", - "href": "/graphql/reference/objects#branchprotectionrule" - } - ] - }, - { - "name": "BypassForcePushAllowance", - "id": "bypassforcepushallowance", - "href": "/graphql/reference/objects#bypassforcepushallowance", - "description": "

A user, team, or app who has the ability to bypass a force push requirement on a protected branch.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

The actor that can force push.

", - "type": "BranchActorAllowanceActor", - "id": "branchactorallowanceactor", - "href": "/graphql/reference/unions#branchactorallowanceactor" - }, - { - "name": "branchProtectionRule", - "description": "

Identifies the branch protection rule associated with the allowed user, team, or app.

", - "type": "BranchProtectionRule", - "id": "branchprotectionrule", - "href": "/graphql/reference/objects#branchprotectionrule" - }, - { - "name": "id", - "description": "

The Node ID of the BypassForcePushAllowance object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - ] - }, - { - "name": "BypassForcePushAllowanceConnection", - "id": "bypassforcepushallowanceconnection", - "href": "/graphql/reference/objects#bypassforcepushallowanceconnection", - "description": "

The connection type for BypassForcePushAllowance.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[BypassForcePushAllowanceEdge]", - "id": "bypassforcepushallowanceedge", - "href": "/graphql/reference/objects#bypassforcepushallowanceedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[BypassForcePushAllowance]", - "id": "bypassforcepushallowance", - "href": "/graphql/reference/objects#bypassforcepushallowance" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "BypassForcePushAllowanceEdge", - "id": "bypassforcepushallowanceedge", - "href": "/graphql/reference/objects#bypassforcepushallowanceedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "BypassForcePushAllowance", - "id": "bypassforcepushallowance", - "href": "/graphql/reference/objects#bypassforcepushallowance" - } - ] - }, - { - "name": "BypassPullRequestAllowance", - "id": "bypasspullrequestallowance", - "href": "/graphql/reference/objects#bypasspullrequestallowance", - "description": "

A user, team, or app who has the ability to bypass a pull request requirement on a protected branch.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

The actor that can bypass.

", - "type": "BranchActorAllowanceActor", - "id": "branchactorallowanceactor", - "href": "/graphql/reference/unions#branchactorallowanceactor" - }, - { - "name": "branchProtectionRule", - "description": "

Identifies the branch protection rule associated with the allowed user, team, or app.

", - "type": "BranchProtectionRule", - "id": "branchprotectionrule", - "href": "/graphql/reference/objects#branchprotectionrule" - }, - { - "name": "id", - "description": "

The Node ID of the BypassPullRequestAllowance object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - ] - }, - { - "name": "BypassPullRequestAllowanceConnection", - "id": "bypasspullrequestallowanceconnection", - "href": "/graphql/reference/objects#bypasspullrequestallowanceconnection", - "description": "

The connection type for BypassPullRequestAllowance.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[BypassPullRequestAllowanceEdge]", - "id": "bypasspullrequestallowanceedge", - "href": "/graphql/reference/objects#bypasspullrequestallowanceedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[BypassPullRequestAllowance]", - "id": "bypasspullrequestallowance", - "href": "/graphql/reference/objects#bypasspullrequestallowance" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "BypassPullRequestAllowanceEdge", - "id": "bypasspullrequestallowanceedge", - "href": "/graphql/reference/objects#bypasspullrequestallowanceedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "BypassPullRequestAllowance", - "id": "bypasspullrequestallowance", - "href": "/graphql/reference/objects#bypasspullrequestallowance" - } - ] - }, - { - "name": "CVSS", - "id": "cvss", - "href": "/graphql/reference/objects#cvss", - "description": "

The Common Vulnerability Scoring System.

", - "fields": [ - { - "name": "score", - "description": "

The CVSS score associated with this advisory.

", - "type": "Float!", - "id": "float", - "href": "/graphql/reference/scalars#float" - }, - { - "name": "vectorString", - "description": "

The CVSS vector string associated with this advisory.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CWE", - "id": "cwe", - "href": "/graphql/reference/objects#cwe", - "description": "

A common weakness enumeration.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "cweId", - "description": "

The id of the CWE.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "description", - "description": "

A detailed description of this CWE.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the CWE object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "name", - "description": "

The name of this CWE.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CWEConnection", - "id": "cweconnection", - "href": "/graphql/reference/objects#cweconnection", - "description": "

The connection type for CWE.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[CWEEdge]", - "id": "cweedge", - "href": "/graphql/reference/objects#cweedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[CWE]", - "id": "cwe", - "href": "/graphql/reference/objects#cwe" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "CWEEdge", - "id": "cweedge", - "href": "/graphql/reference/objects#cweedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "CWE", - "id": "cwe", - "href": "/graphql/reference/objects#cwe" - } - ] - }, - { - "name": "CheckAnnotation", - "id": "checkannotation", - "href": "/graphql/reference/objects#checkannotation", - "description": "

A single check annotation.

", - "fields": [ - { - "name": "annotationLevel", - "description": "

The annotation's severity level.

", - "type": "CheckAnnotationLevel", - "id": "checkannotationlevel", - "href": "/graphql/reference/enums#checkannotationlevel" - }, - { - "name": "blobUrl", - "description": "

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

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "location", - "description": "

The position of this annotation.

", - "type": "CheckAnnotationSpan!", - "id": "checkannotationspan", - "href": "/graphql/reference/objects#checkannotationspan" - }, - { - "name": "message", - "description": "

The annotation's message.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "path", - "description": "

The path that this annotation was made on.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "rawDetails", - "description": "

Additional information about the annotation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "title", - "description": "

The annotation's title.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CheckAnnotationConnection", - "id": "checkannotationconnection", - "href": "/graphql/reference/objects#checkannotationconnection", - "description": "

The connection type for CheckAnnotation.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[CheckAnnotationEdge]", - "id": "checkannotationedge", - "href": "/graphql/reference/objects#checkannotationedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[CheckAnnotation]", - "id": "checkannotation", - "href": "/graphql/reference/objects#checkannotation" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "CheckAnnotationEdge", - "id": "checkannotationedge", - "href": "/graphql/reference/objects#checkannotationedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "CheckAnnotation", - "id": "checkannotation", - "href": "/graphql/reference/objects#checkannotation" - } - ] - }, - { - "name": "CheckAnnotationPosition", - "id": "checkannotationposition", - "href": "/graphql/reference/objects#checkannotationposition", - "description": "

A character position in a check annotation.

", - "fields": [ - { - "name": "column", - "description": "

Column number (1 indexed).

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "line", - "description": "

Line number (1 indexed).

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "CheckAnnotationSpan", - "id": "checkannotationspan", - "href": "/graphql/reference/objects#checkannotationspan", - "description": "

An inclusive pair of positions for a check annotation.

", - "fields": [ - { - "name": "end", - "description": "

End position (inclusive).

", - "type": "CheckAnnotationPosition!", - "id": "checkannotationposition", - "href": "/graphql/reference/objects#checkannotationposition" - }, - { - "name": "start", - "description": "

Start position (inclusive).

", - "type": "CheckAnnotationPosition!", - "id": "checkannotationposition", - "href": "/graphql/reference/objects#checkannotationposition" - } - ] - }, - { - "name": "CheckRun", - "id": "checkrun", - "href": "/graphql/reference/objects#checkrun", - "description": "

A check run.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "RequirableByPullRequest", - "id": "requirablebypullrequest", - "href": "/graphql/reference/interfaces#requirablebypullrequest" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "annotations", - "description": "

The check run's annotations.

", - "type": "CheckAnnotationConnection", - "id": "checkannotationconnection", - "href": "/graphql/reference/objects#checkannotationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "checkSuite", - "description": "

The check suite that this run is a part of.

", - "type": "CheckSuite!", - "id": "checksuite", - "href": "/graphql/reference/objects#checksuite" - }, - { - "name": "completedAt", - "description": "

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

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "conclusion", - "description": "

The conclusion of the check run.

", - "type": "CheckConclusionState", - "id": "checkconclusionstate", - "href": "/graphql/reference/enums#checkconclusionstate" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "deployment", - "description": "

The corresponding deployment for this job, if any.

", - "type": "Deployment", - "id": "deployment", - "href": "/graphql/reference/objects#deployment" - }, - { - "name": "detailsUrl", - "description": "

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

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "externalId", - "description": "

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

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the CheckRun object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isRequired", - "description": "

Whether this is required to pass before merging for a specific pull request.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "arguments": [ - { - "name": "pullRequestId", - "description": "

The id of the pull request this is required for.

", - "type": { - "name": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - }, - { - "name": "pullRequestNumber", - "description": "

The number of the pull request this is required for.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "name", - "description": "

The name of the check for this check run.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pendingDeploymentRequest", - "description": "

Information about a pending deployment, if any, in this check run.

", - "type": "DeploymentRequest", - "id": "deploymentrequest", - "href": "/graphql/reference/objects#deploymentrequest" - }, - { - "name": "permalink", - "description": "

The permalink to the check run summary.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with this check run.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this check run.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "startedAt", - "description": "

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

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "status", - "description": "

The current status of the check run.

", - "type": "CheckStatusState!", - "id": "checkstatusstate", - "href": "/graphql/reference/enums#checkstatusstate" - }, - { - "name": "steps", - "description": "

The check run's steps.

", - "type": "CheckStepConnection", - "id": "checkstepconnection", - "href": "/graphql/reference/objects#checkstepconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "number", - "description": "

Step number.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "summary", - "description": "

A string representing the check run's summary.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "text", - "description": "

A string representing the check run's text.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "title", - "description": "

A string representing the check run.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "url", - "description": "

The HTTP URL for this check run.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "CheckRunConnection", - "id": "checkrunconnection", - "href": "/graphql/reference/objects#checkrunconnection", - "description": "

The connection type for CheckRun.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[CheckRunEdge]", - "id": "checkrunedge", - "href": "/graphql/reference/objects#checkrunedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[CheckRun]", - "id": "checkrun", - "href": "/graphql/reference/objects#checkrun" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "CheckRunEdge", - "id": "checkrunedge", - "href": "/graphql/reference/objects#checkrunedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "CheckRun", - "id": "checkrun", - "href": "/graphql/reference/objects#checkrun" - } - ] - }, - { - "name": "CheckRunStateCount", - "id": "checkrunstatecount", - "href": "/graphql/reference/objects#checkrunstatecount", - "description": "

Represents a count of the state of a check run.

", - "fields": [ - { - "name": "count", - "description": "

The number of check runs with this state.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "state", - "description": "

The state of a check run.

", - "type": "CheckRunState!", - "id": "checkrunstate", - "href": "/graphql/reference/enums#checkrunstate" - } - ] - }, - { - "name": "CheckStep", - "id": "checkstep", - "href": "/graphql/reference/objects#checkstep", - "description": "

A single check step.

", - "fields": [ - { - "name": "completedAt", - "description": "

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

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "conclusion", - "description": "

The conclusion of the check step.

", - "type": "CheckConclusionState", - "id": "checkconclusionstate", - "href": "/graphql/reference/enums#checkconclusionstate" - }, - { - "name": "externalId", - "description": "

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

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The step's name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "number", - "description": "

The index of the step in the list of steps of the parent check run.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "secondsToCompletion", - "description": "

Number of seconds to completion.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "startedAt", - "description": "

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

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "status", - "description": "

The current status of the check step.

", - "type": "CheckStatusState!", - "id": "checkstatusstate", - "href": "/graphql/reference/enums#checkstatusstate" - } - ] - }, - { - "name": "CheckStepConnection", - "id": "checkstepconnection", - "href": "/graphql/reference/objects#checkstepconnection", - "description": "

The connection type for CheckStep.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[CheckStepEdge]", - "id": "checkstepedge", - "href": "/graphql/reference/objects#checkstepedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[CheckStep]", - "id": "checkstep", - "href": "/graphql/reference/objects#checkstep" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "CheckStepEdge", - "id": "checkstepedge", - "href": "/graphql/reference/objects#checkstepedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "CheckStep", - "id": "checkstep", - "href": "/graphql/reference/objects#checkstep" - } - ] - }, - { - "name": "CheckSuite", - "id": "checksuite", - "href": "/graphql/reference/objects#checksuite", - "description": "

A check suite.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "app", - "description": "

The GitHub App which created this check suite.

", - "type": "App", - "id": "app", - "href": "/graphql/reference/objects#app" - }, - { - "name": "branch", - "description": "

The name of the branch for this check suite.

", - "type": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref" - }, - { - "name": "checkRuns", - "description": "

The check runs associated with a check suite.

", - "type": "CheckRunConnection", - "id": "checkrunconnection", - "href": "/graphql/reference/objects#checkrunconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "filterBy", - "description": "

Filters the check runs by this type.

", - "type": { - "name": "CheckRunFilter", - "id": "checkrunfilter", - "href": "/graphql/reference/input-objects#checkrunfilter" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "commit", - "description": "

The commit for this check suite.

", - "type": "Commit!", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "conclusion", - "description": "

The conclusion of this check suite.

", - "type": "CheckConclusionState", - "id": "checkconclusionstate", - "href": "/graphql/reference/enums#checkconclusionstate" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "creator", - "description": "

The user who triggered the check suite.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the CheckSuite object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "matchingPullRequests", - "description": "

A list of open pull requests matching the check suite.

", - "type": "PullRequestConnection", - "id": "pullrequestconnection", - "href": "/graphql/reference/objects#pullrequestconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "baseRefName", - "description": "

The base ref name to filter the pull requests by.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "headRefName", - "description": "

The head ref name to filter the pull requests by.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "labels", - "description": "

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

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for pull requests returned from the connection.

", - "type": { - "name": "IssueOrder", - "id": "issueorder", - "href": "/graphql/reference/input-objects#issueorder" - } - }, - { - "name": "states", - "description": "

A list of states to filter the pull requests by.

", - "type": { - "name": "[PullRequestState!]", - "id": "pullrequeststate", - "href": "/graphql/reference/enums#pullrequeststate" - } - } - ] - }, - { - "name": "push", - "description": "

The push that triggered this check suite.

", - "type": "Push", - "id": "push", - "href": "/graphql/reference/objects#push" - }, - { - "name": "repository", - "description": "

The repository associated with this check suite.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this check suite.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "status", - "description": "

The status of this check suite.

", - "type": "CheckStatusState!", - "id": "checkstatusstate", - "href": "/graphql/reference/enums#checkstatusstate" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this check suite.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "workflowRun", - "description": "

The workflow run associated with this check suite.

", - "type": "WorkflowRun", - "id": "workflowrun", - "href": "/graphql/reference/objects#workflowrun" - } - ] - }, - { - "name": "CheckSuiteConnection", - "id": "checksuiteconnection", - "href": "/graphql/reference/objects#checksuiteconnection", - "description": "

The connection type for CheckSuite.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[CheckSuiteEdge]", - "id": "checksuiteedge", - "href": "/graphql/reference/objects#checksuiteedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[CheckSuite]", - "id": "checksuite", - "href": "/graphql/reference/objects#checksuite" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "CheckSuiteEdge", - "id": "checksuiteedge", - "href": "/graphql/reference/objects#checksuiteedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "CheckSuite", - "id": "checksuite", - "href": "/graphql/reference/objects#checksuite" - } - ] - }, - { - "name": "ClosedEvent", - "id": "closedevent", - "href": "/graphql/reference/objects#closedevent", - "description": "

Represents aclosedevent on any Closable.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "closable", - "description": "

Object that was closed.

", - "type": "Closable!", - "id": "closable", - "href": "/graphql/reference/interfaces#closable" - }, - { - "name": "closer", - "description": "

Object which triggered the creation of this event.

", - "type": "Closer", - "id": "closer", - "href": "/graphql/reference/unions#closer" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the ClosedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this closed event.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "stateReason", - "description": "

The reason the issue state was changed to closed.

", - "type": "IssueStateReason", - "id": "issuestatereason", - "href": "/graphql/reference/enums#issuestatereason" - }, - { - "name": "url", - "description": "

The HTTP URL for this closed event.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "CodeOfConduct", - "id": "codeofconduct", - "href": "/graphql/reference/objects#codeofconduct", - "description": "

The Code of Conduct for a repository.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "body", - "description": "

The body of the Code of Conduct.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the CodeOfConduct object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "key", - "description": "

The key for the Code of Conduct.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The formal name of the Code of Conduct.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this Code of Conduct.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The HTTP URL for this Code of Conduct.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "CodeScanningParameters", - "id": "codescanningparameters", - "href": "/graphql/reference/objects#codescanningparameters", - "description": "

Choose which tools must provide code scanning results before the reference is\nupdated. When configured, code scanning must be enabled and have results for\nboth the commit and the reference being updated.

", - "fields": [ - { - "name": "codeScanningTools", - "description": "

Tools that must provide code scanning results for this rule to pass.

", - "type": "[CodeScanningTool!]!", - "id": "codescanningtool", - "href": "/graphql/reference/objects#codescanningtool" - } - ] - }, - { - "name": "CodeScanningTool", - "id": "codescanningtool", - "href": "/graphql/reference/objects#codescanningtool", - "description": "

A tool that must provide code scanning results for this rule to pass.

", - "fields": [ - { - "name": "alertsThreshold", - "description": "

The severity level at which code scanning results that raise alerts block a\nreference update. For more information on alert severity levels, see \"About code scanning alerts.\".

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "securityAlertsThreshold", - "description": "

The severity level at which code scanning results that raise security alerts\nblock a reference update. For more information on security severity levels,\nsee \"About code scanning alerts.\".

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "tool", - "description": "

The name of a code scanning tool.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CommentDeletedEvent", - "id": "commentdeletedevent", - "href": "/graphql/reference/objects#commentdeletedevent", - "description": "

Represents acomment_deletedevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "deletedCommentAuthor", - "description": "

The user who authored the deleted comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "id", - "description": "

The Node ID of the CommentDeletedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - ] - }, - { - "name": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit", - "description": "

Represents a Git commit.

", - "implements": [ - { - "name": "GitObject", - "id": "gitobject", - "href": "/graphql/reference/interfaces#gitobject" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "Subscribable", - "id": "subscribable", - "href": "/graphql/reference/interfaces#subscribable" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "abbreviatedOid", - "description": "

An abbreviated version of the Git object ID.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "additions", - "description": "

The number of additions in this commit.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "associatedPullRequests", - "description": "

The merged Pull Request that introduced the commit to the repository. If the\ncommit is not present in the default branch, additionally returns open Pull\nRequests associated with the commit.

", - "type": "PullRequestConnection", - "id": "pullrequestconnection", - "href": "/graphql/reference/objects#pullrequestconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for pull requests.

", - "type": { - "name": "PullRequestOrder", - "id": "pullrequestorder", - "href": "/graphql/reference/input-objects#pullrequestorder" - } - } - ] - }, - { - "name": "author", - "description": "

Authorship details of the commit.

", - "type": "GitActor", - "id": "gitactor", - "href": "/graphql/reference/objects#gitactor" - }, - { - "name": "authoredByCommitter", - "description": "

Check if the committer and the author match.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "authoredDate", - "description": "

The datetime when this commit was authored.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "authors", - "description": "

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.

", - "type": "GitActorConnection!", - "id": "gitactorconnection", - "href": "/graphql/reference/objects#gitactorconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "blame", - "description": "

Fetches git blame information.

", - "type": "Blame!", - "id": "blame", - "href": "/graphql/reference/objects#blame", - "arguments": [ - { - "name": "path", - "description": "

The file whose Git blame information you want.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "changedFiles", - "description": "

We recommend using the changedFilesIfAvailable field instead of\nchangedFiles, as changedFiles will cause your request to return an error\nif GitHub is unable to calculate the number of changed files.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int", - "isDeprecated": true, - "deprecationReason": "

changedFiles will be removed. Use changedFilesIfAvailable instead. Removal on 2023-01-01 UTC.

" - }, - { - "name": "changedFilesIfAvailable", - "description": "

The number of changed files in this commit. If GitHub is unable to calculate\nthe number of changed files (for example due to a timeout), this will return\nnull. We recommend using this field instead of changedFiles.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "checkSuites", - "description": "

The check suites associated with a commit.

", - "type": "CheckSuiteConnection", - "id": "checksuiteconnection", - "href": "/graphql/reference/objects#checksuiteconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "filterBy", - "description": "

Filters the check suites by this type.

", - "type": { - "name": "CheckSuiteFilter", - "id": "checksuitefilter", - "href": "/graphql/reference/input-objects#checksuitefilter" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "comments", - "description": "

Comments made on the commit.

", - "type": "CommitCommentConnection!", - "id": "commitcommentconnection", - "href": "/graphql/reference/objects#commitcommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "commitResourcePath", - "description": "

The HTTP path for this Git object.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "commitUrl", - "description": "

The HTTP URL for this Git object.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "committedDate", - "description": "

The datetime when this commit was committed.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "committedViaWeb", - "description": "

Check if committed via GitHub web UI.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "committer", - "description": "

Committer details of the commit.

", - "type": "GitActor", - "id": "gitactor", - "href": "/graphql/reference/objects#gitactor" - }, - { - "name": "deletions", - "description": "

The number of deletions in this commit.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "deployments", - "description": "

The deployments associated with a commit.

", - "type": "DeploymentConnection", - "id": "deploymentconnection", - "href": "/graphql/reference/objects#deploymentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "environments", - "description": "

Environments to list deployments for.

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for deployments returned from the connection.

", - "type": { - "name": "DeploymentOrder", - "id": "deploymentorder", - "href": "/graphql/reference/input-objects#deploymentorder" - } - } - ] - }, - { - "name": "file", - "description": "

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

", - "type": "TreeEntry", - "id": "treeentry", - "href": "/graphql/reference/objects#treeentry", - "arguments": [ - { - "name": "path", - "description": "

The path for the file.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "history", - "description": "

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

", - "type": "CommitHistoryConnection!", - "id": "commithistoryconnection", - "href": "/graphql/reference/objects#commithistoryconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "author", - "description": "

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

", - "type": { - "name": "CommitAuthor", - "id": "commitauthor", - "href": "/graphql/reference/input-objects#commitauthor" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "path", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "since", - "description": "

Allows specifying a beginning time or date for fetching commits.

", - "type": { - "name": "GitTimestamp", - "id": "gittimestamp", - "href": "/graphql/reference/scalars#gittimestamp" - } - }, - { - "name": "until", - "description": "

Allows specifying an ending time or date for fetching commits.

", - "type": { - "name": "GitTimestamp", - "id": "gittimestamp", - "href": "/graphql/reference/scalars#gittimestamp" - } - } - ] - }, - { - "name": "id", - "description": "

The Node ID of the Commit object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "message", - "description": "

The Git commit message.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "messageBody", - "description": "

The Git commit message body.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "messageBodyHTML", - "description": "

The commit message body rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "messageHeadline", - "description": "

The Git commit message headline.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "messageHeadlineHTML", - "description": "

The commit message headline rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "oid", - "description": "

The Git object ID.

", - "type": "GitObjectID!", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "onBehalfOf", - "description": "

The organization this commit was made on behalf of.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "parents", - "description": "

The parents of a commit.

", - "type": "CommitConnection!", - "id": "commitconnection", - "href": "/graphql/reference/objects#commitconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "pushedDate", - "description": "

The datetime when this commit was pushed.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime", - "isDeprecated": true, - "deprecationReason": "

pushedDate is no longer supported. Removal on 2023-07-01 UTC.

" - }, - { - "name": "repository", - "description": "

The Repository this commit belongs to.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this commit.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "signature", - "description": "

Commit signing information, if present.

", - "type": "GitSignature", - "id": "gitsignature", - "href": "/graphql/reference/interfaces#gitsignature" - }, - { - "name": "status", - "description": "

Status information for this commit.

", - "type": "Status", - "id": "status", - "href": "/graphql/reference/objects#status" - }, - { - "name": "statusCheckRollup", - "description": "

Check and Status rollup information for this commit.

", - "type": "StatusCheckRollup", - "id": "statuscheckrollup", - "href": "/graphql/reference/objects#statuscheckrollup" - }, - { - "name": "submodules", - "description": "

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

", - "type": "SubmoduleConnection!", - "id": "submoduleconnection", - "href": "/graphql/reference/objects#submoduleconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "tarballUrl", - "description": "

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

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "tree", - "description": "

Commit's root Tree.

", - "type": "Tree!", - "id": "tree", - "href": "/graphql/reference/objects#tree" - }, - { - "name": "treeResourcePath", - "description": "

The HTTP path for the tree of this commit.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "treeUrl", - "description": "

The HTTP URL for the tree of this commit.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The HTTP URL for this commit.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "viewerCanSubscribe", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerSubscription", - "description": "

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

", - "type": "SubscriptionState", - "id": "subscriptionstate", - "href": "/graphql/reference/enums#subscriptionstate" - }, - { - "name": "zipballUrl", - "description": "

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

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "CommitAuthorEmailPatternParameters", - "id": "commitauthoremailpatternparameters", - "href": "/graphql/reference/objects#commitauthoremailpatternparameters", - "description": "

Parameters to be used for the commit_author_email_pattern rule.

", - "fields": [ - { - "name": "name", - "description": "

How this rule will appear to users.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "operator", - "description": "

The operator to use for matching.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pattern", - "description": "

The pattern to match with.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CommitComment", - "id": "commitcomment", - "href": "/graphql/reference/objects#commitcomment", - "description": "

Represents a comment on a given Commit.

", - "implements": [ - { - "name": "Comment", - "id": "comment", - "href": "/graphql/reference/interfaces#comment" - }, - { - "name": "Deletable", - "id": "deletable", - "href": "/graphql/reference/interfaces#deletable" - }, - { - "name": "Minimizable", - "id": "minimizable", - "href": "/graphql/reference/interfaces#minimizable" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "Reactable", - "id": "reactable", - "href": "/graphql/reference/interfaces#reactable" - }, - { - "name": "RepositoryNode", - "id": "repositorynode", - "href": "/graphql/reference/interfaces#repositorynode" - }, - { - "name": "Updatable", - "id": "updatable", - "href": "/graphql/reference/interfaces#updatable" - }, - { - "name": "UpdatableComment", - "id": "updatablecomment", - "href": "/graphql/reference/interfaces#updatablecomment" - } - ], - "fields": [ - { - "name": "author", - "description": "

The actor who authored the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "authorAssociation", - "description": "

Author's association with the subject of the comment.

", - "type": "CommentAuthorAssociation!", - "id": "commentauthorassociation", - "href": "/graphql/reference/enums#commentauthorassociation" - }, - { - "name": "body", - "description": "

Identifies the comment body.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyHTML", - "description": "

The body rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "bodyText", - "description": "

The body rendered to text.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "commit", - "description": "

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

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "createdViaEmail", - "description": "

Check if this comment was created via an email reply.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "editor", - "description": "

The actor who edited the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "id", - "description": "

The Node ID of the CommitComment object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "includesCreatedEdit", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isMinimized", - "description": "

Returns whether or not a comment has been minimized.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "lastEditedAt", - "description": "

The moment the editor made the last edit.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "minimizedReason", - "description": "

Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "path", - "description": "

Identifies the file path associated with the comment.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "position", - "description": "

Identifies the line position associated with the comment.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "publishedAt", - "description": "

Identifies when the comment was published at.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "reactionGroups", - "description": "

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

", - "type": "[ReactionGroup!]", - "id": "reactiongroup", - "href": "/graphql/reference/objects#reactiongroup" - }, - { - "name": "reactions", - "description": "

A list of Reactions left on the Issue.

", - "type": "ReactionConnection!", - "id": "reactionconnection", - "href": "/graphql/reference/objects#reactionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "content", - "description": "

Allows filtering Reactions by emoji.

", - "type": { - "name": "ReactionContent", - "id": "reactioncontent", - "href": "/graphql/reference/enums#reactioncontent" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Allows specifying the order in which reactions are returned.

", - "type": { - "name": "ReactionOrder", - "id": "reactionorder", - "href": "/graphql/reference/input-objects#reactionorder" - } - } - ] - }, - { - "name": "repository", - "description": "

The repository associated with this node.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resourcePath", - "description": "

The HTTP path permalink for this commit comment.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL permalink for this commit comment.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userContentEdits", - "description": "

A list of edits to this content.

", - "type": "UserContentEditConnection", - "id": "usercontenteditconnection", - "href": "/graphql/reference/objects#usercontenteditconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "viewerCanDelete", - "description": "

Check if the current viewer can delete this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanMinimize", - "description": "

Check if the current viewer can minimize this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanReact", - "description": "

Can user react to this subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUpdate", - "description": "

Check if the current viewer can update this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCannotUpdateReasons", - "description": "

Reasons why the current viewer can not update this comment.

", - "type": "[CommentCannotUpdateReason!]!", - "id": "commentcannotupdatereason", - "href": "/graphql/reference/enums#commentcannotupdatereason" - }, - { - "name": "viewerDidAuthor", - "description": "

Did the viewer author this comment.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "CommitCommentConnection", - "id": "commitcommentconnection", - "href": "/graphql/reference/objects#commitcommentconnection", - "description": "

The connection type for CommitComment.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[CommitCommentEdge]", - "id": "commitcommentedge", - "href": "/graphql/reference/objects#commitcommentedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[CommitComment]", - "id": "commitcomment", - "href": "/graphql/reference/objects#commitcomment" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "CommitCommentEdge", - "id": "commitcommentedge", - "href": "/graphql/reference/objects#commitcommentedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "CommitComment", - "id": "commitcomment", - "href": "/graphql/reference/objects#commitcomment" - } - ] - }, - { - "name": "CommitCommentThread", - "id": "commitcommentthread", - "href": "/graphql/reference/objects#commitcommentthread", - "description": "

A thread of comments on a commit.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "RepositoryNode", - "id": "repositorynode", - "href": "/graphql/reference/interfaces#repositorynode" - } - ], - "fields": [ - { - "name": "comments", - "description": "

The comments that exist in this thread.

", - "type": "CommitCommentConnection!", - "id": "commitcommentconnection", - "href": "/graphql/reference/objects#commitcommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "commit", - "description": "

The commit the comments were made on.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "id", - "description": "

The Node ID of the CommitCommentThread object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "path", - "description": "

The file the comments were made on.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "position", - "description": "

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

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "repository", - "description": "

The repository associated with this node.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "CommitConnection", - "id": "commitconnection", - "href": "/graphql/reference/objects#commitconnection", - "description": "

The connection type for Commit.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[CommitEdge]", - "id": "commitedge", - "href": "/graphql/reference/objects#commitedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Commit]", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "CommitContributionsByRepository", - "id": "commitcontributionsbyrepository", - "href": "/graphql/reference/objects#commitcontributionsbyrepository", - "description": "

This aggregates commits made by a user within one repository.

", - "fields": [ - { - "name": "contributions", - "description": "

The commit contributions, each representing a day.

", - "type": "CreatedCommitContributionConnection!", - "id": "createdcommitcontributionconnection", - "href": "/graphql/reference/objects#createdcommitcontributionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for commit contributions returned from the connection.

", - "type": { - "name": "CommitContributionOrder", - "id": "commitcontributionorder", - "href": "/graphql/reference/input-objects#commitcontributionorder" - } - } - ] - }, - { - "name": "repository", - "description": "

The repository in which the commits were made.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resourcePath", - "description": "

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

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

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

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "CommitEdge", - "id": "commitedge", - "href": "/graphql/reference/objects#commitedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - } - ] - }, - { - "name": "CommitHistoryConnection", - "id": "commithistoryconnection", - "href": "/graphql/reference/objects#commithistoryconnection", - "description": "

The connection type for Commit.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[CommitEdge]", - "id": "commitedge", - "href": "/graphql/reference/objects#commitedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Commit]", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "CommitMessagePatternParameters", - "id": "commitmessagepatternparameters", - "href": "/graphql/reference/objects#commitmessagepatternparameters", - "description": "

Parameters to be used for the commit_message_pattern rule.

", - "fields": [ - { - "name": "name", - "description": "

How this rule will appear to users.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "operator", - "description": "

The operator to use for matching.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pattern", - "description": "

The pattern to match with.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CommitterEmailPatternParameters", - "id": "committeremailpatternparameters", - "href": "/graphql/reference/objects#committeremailpatternparameters", - "description": "

Parameters to be used for the committer_email_pattern rule.

", - "fields": [ - { - "name": "name", - "description": "

How this rule will appear to users.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "operator", - "description": "

The operator to use for matching.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pattern", - "description": "

The pattern to match with.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "Comparison", - "id": "comparison", - "href": "/graphql/reference/objects#comparison", - "description": "

Represents a comparison between two commit revisions.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "aheadBy", - "description": "

The number of commits ahead of the base branch.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "baseTarget", - "description": "

The base revision of this comparison.

", - "type": "GitObject!", - "id": "gitobject", - "href": "/graphql/reference/interfaces#gitobject" - }, - { - "name": "behindBy", - "description": "

The number of commits behind the base branch.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "commits", - "description": "

The commits which compose this comparison.

", - "type": "ComparisonCommitConnection!", - "id": "comparisoncommitconnection", - "href": "/graphql/reference/objects#comparisoncommitconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "headTarget", - "description": "

The head revision of this comparison.

", - "type": "GitObject!", - "id": "gitobject", - "href": "/graphql/reference/interfaces#gitobject" - }, - { - "name": "id", - "description": "

The Node ID of the Comparison object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "status", - "description": "

The status of this comparison.

", - "type": "ComparisonStatus!", - "id": "comparisonstatus", - "href": "/graphql/reference/enums#comparisonstatus" - } - ] - }, - { - "name": "ComparisonCommitConnection", - "id": "comparisoncommitconnection", - "href": "/graphql/reference/objects#comparisoncommitconnection", - "description": "

The connection type for Commit.

", - "fields": [ - { - "name": "authorCount", - "description": "

The total count of authors and co-authors across all commits.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[CommitEdge]", - "id": "commitedge", - "href": "/graphql/reference/objects#commitedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Commit]", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ConnectedEvent", - "id": "connectedevent", - "href": "/graphql/reference/objects#connectedevent", - "description": "

Represents aconnectedevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the ConnectedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isCrossRepository", - "description": "

Reference originated in a different repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "source", - "description": "

Issue or pull request that made the reference.

", - "type": "ReferencedSubject!", - "id": "referencedsubject", - "href": "/graphql/reference/unions#referencedsubject" - }, - { - "name": "subject", - "description": "

Issue or pull request which was connected.

", - "type": "ReferencedSubject!", - "id": "referencedsubject", - "href": "/graphql/reference/unions#referencedsubject" - } - ] - }, - { - "name": "ContributingGuidelines", - "id": "contributingguidelines", - "href": "/graphql/reference/objects#contributingguidelines", - "description": "

The Contributing Guidelines for a repository.

", - "fields": [ - { - "name": "body", - "description": "

The body of the Contributing Guidelines.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for the Contributing Guidelines.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The HTTP URL for the Contributing Guidelines.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "ContributionCalendar", - "id": "contributioncalendar", - "href": "/graphql/reference/objects#contributioncalendar", - "description": "

A calendar of contributions made on GitHub by a user.

", - "fields": [ - { - "name": "colors", - "description": "

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

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "isHalloween", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "months", - "description": "

A list of the months of contributions in this calendar.

", - "type": "[ContributionCalendarMonth!]!", - "id": "contributioncalendarmonth", - "href": "/graphql/reference/objects#contributioncalendarmonth" - }, - { - "name": "totalContributions", - "description": "

The count of total contributions in the calendar.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "weeks", - "description": "

A list of the weeks of contributions in this calendar.

", - "type": "[ContributionCalendarWeek!]!", - "id": "contributioncalendarweek", - "href": "/graphql/reference/objects#contributioncalendarweek" - } - ] - }, - { - "name": "ContributionCalendarDay", - "id": "contributioncalendarday", - "href": "/graphql/reference/objects#contributioncalendarday", - "description": "

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

", - "fields": [ - { - "name": "color", - "description": "

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

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "contributionCount", - "description": "

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

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "contributionLevel", - "description": "

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

", - "type": "ContributionLevel!", - "id": "contributionlevel", - "href": "/graphql/reference/enums#contributionlevel" - }, - { - "name": "date", - "description": "

The day this square represents.

", - "type": "Date!", - "id": "date", - "href": "/graphql/reference/scalars#date" - }, - { - "name": "weekday", - "description": "

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

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ContributionCalendarMonth", - "id": "contributioncalendarmonth", - "href": "/graphql/reference/objects#contributioncalendarmonth", - "description": "

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

", - "fields": [ - { - "name": "firstDay", - "description": "

The date of the first day of this month.

", - "type": "Date!", - "id": "date", - "href": "/graphql/reference/scalars#date" - }, - { - "name": "name", - "description": "

The name of the month.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "totalWeeks", - "description": "

How many weeks started in this month.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "year", - "description": "

The year the month occurred in.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ContributionCalendarWeek", - "id": "contributioncalendarweek", - "href": "/graphql/reference/objects#contributioncalendarweek", - "description": "

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

", - "fields": [ - { - "name": "contributionDays", - "description": "

The days of contributions in this week.

", - "type": "[ContributionCalendarDay!]!", - "id": "contributioncalendarday", - "href": "/graphql/reference/objects#contributioncalendarday" - }, - { - "name": "firstDay", - "description": "

The date of the earliest square in this week.

", - "type": "Date!", - "id": "date", - "href": "/graphql/reference/scalars#date" - } - ] - }, - { - "name": "ContributionsCollection", - "id": "contributionscollection", - "href": "/graphql/reference/objects#contributionscollection", - "description": "

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

", - "fields": [ - { - "name": "commitContributionsByRepository", - "description": "

Commit contributions made by the user, grouped by repository.

", - "type": "[CommitContributionsByRepository!]!", - "id": "commitcontributionsbyrepository", - "href": "/graphql/reference/objects#commitcontributionsbyrepository", - "arguments": [ - { - "name": "maxRepositories", - "defaultValue": "25", - "description": "

How many repositories should be included.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "contributionCalendar", - "description": "

A calendar of this user's contributions on GitHub.

", - "type": "ContributionCalendar!", - "id": "contributioncalendar", - "href": "/graphql/reference/objects#contributioncalendar" - }, - { - "name": "contributionYears", - "description": "

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

", - "type": "[Int!]!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "doesEndInCurrentMonth", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "earliestRestrictedContributionDate", - "description": "

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.

", - "type": "Date", - "id": "date", - "href": "/graphql/reference/scalars#date" - }, - { - "name": "endedAt", - "description": "

The ending date and time of this collection.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "firstIssueContribution", - "description": "

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.

", - "type": "CreatedIssueOrRestrictedContribution", - "id": "createdissueorrestrictedcontribution", - "href": "/graphql/reference/unions#createdissueorrestrictedcontribution" - }, - { - "name": "firstPullRequestContribution", - "description": "

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.

", - "type": "CreatedPullRequestOrRestrictedContribution", - "id": "createdpullrequestorrestrictedcontribution", - "href": "/graphql/reference/unions#createdpullrequestorrestrictedcontribution" - }, - { - "name": "firstRepositoryContribution", - "description": "

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.

", - "type": "CreatedRepositoryOrRestrictedContribution", - "id": "createdrepositoryorrestrictedcontribution", - "href": "/graphql/reference/unions#createdrepositoryorrestrictedcontribution" - }, - { - "name": "hasActivityInThePast", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "hasAnyContributions", - "description": "

Determine if there are any contributions in this collection.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "hasAnyRestrictedContributions", - "description": "

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.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isSingleDay", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "issueContributions", - "description": "

A list of issues the user opened.

", - "type": "CreatedIssueContributionConnection!", - "id": "createdissuecontributionconnection", - "href": "/graphql/reference/objects#createdissuecontributionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "excludeFirst", - "defaultValue": false, - "description": "

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

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "excludePopular", - "defaultValue": false, - "description": "

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

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for contributions returned from the connection.

", - "type": { - "name": "ContributionOrder", - "id": "contributionorder", - "href": "/graphql/reference/input-objects#contributionorder" - } - } - ] - }, - { - "name": "issueContributionsByRepository", - "description": "

Issue contributions made by the user, grouped by repository.

", - "type": "[IssueContributionsByRepository!]!", - "id": "issuecontributionsbyrepository", - "href": "/graphql/reference/objects#issuecontributionsbyrepository", - "arguments": [ - { - "name": "excludeFirst", - "defaultValue": false, - "description": "

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

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "excludePopular", - "defaultValue": false, - "description": "

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

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "maxRepositories", - "defaultValue": "25", - "description": "

How many repositories should be included.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "joinedGitHubContribution", - "description": "

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.

", - "type": "JoinedGitHubContribution", - "id": "joinedgithubcontribution", - "href": "/graphql/reference/objects#joinedgithubcontribution" - }, - { - "name": "latestRestrictedContributionDate", - "description": "

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.

", - "type": "Date", - "id": "date", - "href": "/graphql/reference/scalars#date" - }, - { - "name": "mostRecentCollectionWithActivity", - "description": "

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.

", - "type": "ContributionsCollection", - "id": "contributionscollection", - "href": "/graphql/reference/objects#contributionscollection" - }, - { - "name": "mostRecentCollectionWithoutActivity", - "description": "

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

", - "type": "ContributionsCollection", - "id": "contributionscollection", - "href": "/graphql/reference/objects#contributionscollection" - }, - { - "name": "popularIssueContribution", - "description": "

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

", - "type": "CreatedIssueContribution", - "id": "createdissuecontribution", - "href": "/graphql/reference/objects#createdissuecontribution" - }, - { - "name": "popularPullRequestContribution", - "description": "

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

", - "type": "CreatedPullRequestContribution", - "id": "createdpullrequestcontribution", - "href": "/graphql/reference/objects#createdpullrequestcontribution" - }, - { - "name": "pullRequestContributions", - "description": "

Pull request contributions made by the user.

", - "type": "CreatedPullRequestContributionConnection!", - "id": "createdpullrequestcontributionconnection", - "href": "/graphql/reference/objects#createdpullrequestcontributionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "excludeFirst", - "defaultValue": false, - "description": "

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

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "excludePopular", - "defaultValue": false, - "description": "

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

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for contributions returned from the connection.

", - "type": { - "name": "ContributionOrder", - "id": "contributionorder", - "href": "/graphql/reference/input-objects#contributionorder" - } - } - ] - }, - { - "name": "pullRequestContributionsByRepository", - "description": "

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

", - "type": "[PullRequestContributionsByRepository!]!", - "id": "pullrequestcontributionsbyrepository", - "href": "/graphql/reference/objects#pullrequestcontributionsbyrepository", - "arguments": [ - { - "name": "excludeFirst", - "defaultValue": false, - "description": "

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

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "excludePopular", - "defaultValue": false, - "description": "

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

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "maxRepositories", - "defaultValue": "25", - "description": "

How many repositories should be included.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "pullRequestReviewContributions", - "description": "

Pull request review contributions made by the user. Returns the most recently\nsubmitted review for each PR reviewed by the user.

", - "type": "CreatedPullRequestReviewContributionConnection!", - "id": "createdpullrequestreviewcontributionconnection", - "href": "/graphql/reference/objects#createdpullrequestreviewcontributionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for contributions returned from the connection.

", - "type": { - "name": "ContributionOrder", - "id": "contributionorder", - "href": "/graphql/reference/input-objects#contributionorder" - } - } - ] - }, - { - "name": "pullRequestReviewContributionsByRepository", - "description": "

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

", - "type": "[PullRequestReviewContributionsByRepository!]!", - "id": "pullrequestreviewcontributionsbyrepository", - "href": "/graphql/reference/objects#pullrequestreviewcontributionsbyrepository", - "arguments": [ - { - "name": "maxRepositories", - "defaultValue": "25", - "description": "

How many repositories should be included.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "repositoryContributions", - "description": "

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

", - "type": "CreatedRepositoryContributionConnection!", - "id": "createdrepositorycontributionconnection", - "href": "/graphql/reference/objects#createdrepositorycontributionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "excludeFirst", - "defaultValue": false, - "description": "

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

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for contributions returned from the connection.

", - "type": { - "name": "ContributionOrder", - "id": "contributionorder", - "href": "/graphql/reference/input-objects#contributionorder" - } - } - ] - }, - { - "name": "restrictedContributionsCount", - "description": "

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.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "startedAt", - "description": "

The beginning date and time of this collection.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "totalCommitContributions", - "description": "

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

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "totalIssueContributions", - "description": "

How many issues the user opened.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int", - "arguments": [ - { - "name": "excludeFirst", - "defaultValue": false, - "description": "

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

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "excludePopular", - "defaultValue": false, - "description": "

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

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "totalPullRequestContributions", - "description": "

How many pull requests the user opened.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int", - "arguments": [ - { - "name": "excludeFirst", - "defaultValue": false, - "description": "

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

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "excludePopular", - "defaultValue": false, - "description": "

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

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "totalPullRequestReviewContributions", - "description": "

How many pull request reviews the user left.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "totalRepositoriesWithContributedCommits", - "description": "

How many different repositories the user committed to.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "totalRepositoriesWithContributedIssues", - "description": "

How many different repositories the user opened issues in.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int", - "arguments": [ - { - "name": "excludeFirst", - "defaultValue": false, - "description": "

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

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "excludePopular", - "defaultValue": false, - "description": "

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

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "totalRepositoriesWithContributedPullRequestReviews", - "description": "

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

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "totalRepositoriesWithContributedPullRequests", - "description": "

How many different repositories the user opened pull requests in.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int", - "arguments": [ - { - "name": "excludeFirst", - "defaultValue": false, - "description": "

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

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "excludePopular", - "defaultValue": false, - "description": "

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

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "totalRepositoryContributions", - "description": "

How many repositories the user created.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int", - "arguments": [ - { - "name": "excludeFirst", - "defaultValue": false, - "description": "

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

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "user", - "description": "

The user who made the contributions in this collection.

", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "ConvertToDraftEvent", - "id": "converttodraftevent", - "href": "/graphql/reference/objects#converttodraftevent", - "description": "

Represents aconvert_to_draftevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the ConvertToDraftEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this convert to draft event.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The HTTP URL for this convert to draft event.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "ConvertedNoteToIssueEvent", - "id": "convertednotetoissueevent", - "href": "/graphql/reference/objects#convertednotetoissueevent", - "description": "

Represents aconverted_note_to_issueevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the ConvertedNoteToIssueEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "project", - "description": "

Project referenced by event.

", - "type": "Project", - "id": "project", - "href": "/graphql/reference/objects#project" - }, - { - "name": "projectCard", - "description": "

Project card referenced by this project event.

", - "type": "ProjectCard", - "id": "projectcard", - "href": "/graphql/reference/objects#projectcard" - }, - { - "name": "projectColumnName", - "description": "

Column name referenced by this project event.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "ConvertedToDiscussionEvent", - "id": "convertedtodiscussionevent", - "href": "/graphql/reference/objects#convertedtodiscussionevent", - "description": "

Represents aconverted_to_discussionevent on a given issue.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "discussion", - "description": "

The discussion that the issue was converted into.

", - "type": "Discussion", - "id": "discussion", - "href": "/graphql/reference/objects#discussion" - }, - { - "name": "id", - "description": "

The Node ID of the ConvertedToDiscussionEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - ] - }, - { - "name": "CopilotEndpoints", - "id": "copilotendpoints", - "href": "/graphql/reference/objects#copilotendpoints", - "description": "

Copilot endpoint information.

", - "fields": [ - { - "name": "api", - "description": "

Copilot API endpoint.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "originTracker", - "description": "

Copilot origin tracker endpoint.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "proxy", - "description": "

Copilot proxy endpoint.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "telemetry", - "description": "

Copilot telemetry endpoint.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CreatedCommitContribution", - "id": "createdcommitcontribution", - "href": "/graphql/reference/objects#createdcommitcontribution", - "description": "

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

", - "implements": [ - { - "name": "Contribution", - "id": "contribution", - "href": "/graphql/reference/interfaces#contribution" - } - ], - "fields": [ - { - "name": "commitCount", - "description": "

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

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "isRestricted", - "description": "

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.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "occurredAt", - "description": "

When this contribution was made.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "repository", - "description": "

The repository the user made a commit in.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this contribution.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The HTTP URL for this contribution.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user who made this contribution.

", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "CreatedCommitContributionConnection", - "id": "createdcommitcontributionconnection", - "href": "/graphql/reference/objects#createdcommitcontributionconnection", - "description": "

The connection type for CreatedCommitContribution.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[CreatedCommitContributionEdge]", - "id": "createdcommitcontributionedge", - "href": "/graphql/reference/objects#createdcommitcontributionedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[CreatedCommitContribution]", - "id": "createdcommitcontribution", - "href": "/graphql/reference/objects#createdcommitcontribution" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

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

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "CreatedCommitContributionEdge", - "id": "createdcommitcontributionedge", - "href": "/graphql/reference/objects#createdcommitcontributionedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "CreatedCommitContribution", - "id": "createdcommitcontribution", - "href": "/graphql/reference/objects#createdcommitcontribution" - } - ] - }, - { - "name": "CreatedIssueContribution", - "id": "createdissuecontribution", - "href": "/graphql/reference/objects#createdissuecontribution", - "description": "

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

", - "implements": [ - { - "name": "Contribution", - "id": "contribution", - "href": "/graphql/reference/interfaces#contribution" - } - ], - "fields": [ - { - "name": "isRestricted", - "description": "

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.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "issue", - "description": "

The issue that was opened.

", - "type": "Issue!", - "id": "issue", - "href": "/graphql/reference/objects#issue" - }, - { - "name": "occurredAt", - "description": "

When this contribution was made.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this contribution.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The HTTP URL for this contribution.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user who made this contribution.

", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "CreatedIssueContributionConnection", - "id": "createdissuecontributionconnection", - "href": "/graphql/reference/objects#createdissuecontributionconnection", - "description": "

The connection type for CreatedIssueContribution.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[CreatedIssueContributionEdge]", - "id": "createdissuecontributionedge", - "href": "/graphql/reference/objects#createdissuecontributionedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[CreatedIssueContribution]", - "id": "createdissuecontribution", - "href": "/graphql/reference/objects#createdissuecontribution" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "CreatedIssueContributionEdge", - "id": "createdissuecontributionedge", - "href": "/graphql/reference/objects#createdissuecontributionedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "CreatedIssueContribution", - "id": "createdissuecontribution", - "href": "/graphql/reference/objects#createdissuecontribution" - } - ] - }, - { - "name": "CreatedPullRequestContribution", - "id": "createdpullrequestcontribution", - "href": "/graphql/reference/objects#createdpullrequestcontribution", - "description": "

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

", - "implements": [ - { - "name": "Contribution", - "id": "contribution", - "href": "/graphql/reference/interfaces#contribution" - } - ], - "fields": [ - { - "name": "isRestricted", - "description": "

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.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "occurredAt", - "description": "

When this contribution was made.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "pullRequest", - "description": "

The pull request that was opened.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this contribution.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The HTTP URL for this contribution.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user who made this contribution.

", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "CreatedPullRequestContributionConnection", - "id": "createdpullrequestcontributionconnection", - "href": "/graphql/reference/objects#createdpullrequestcontributionconnection", - "description": "

The connection type for CreatedPullRequestContribution.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[CreatedPullRequestContributionEdge]", - "id": "createdpullrequestcontributionedge", - "href": "/graphql/reference/objects#createdpullrequestcontributionedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[CreatedPullRequestContribution]", - "id": "createdpullrequestcontribution", - "href": "/graphql/reference/objects#createdpullrequestcontribution" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "CreatedPullRequestContributionEdge", - "id": "createdpullrequestcontributionedge", - "href": "/graphql/reference/objects#createdpullrequestcontributionedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "CreatedPullRequestContribution", - "id": "createdpullrequestcontribution", - "href": "/graphql/reference/objects#createdpullrequestcontribution" - } - ] - }, - { - "name": "CreatedPullRequestReviewContribution", - "id": "createdpullrequestreviewcontribution", - "href": "/graphql/reference/objects#createdpullrequestreviewcontribution", - "description": "

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

", - "implements": [ - { - "name": "Contribution", - "id": "contribution", - "href": "/graphql/reference/interfaces#contribution" - } - ], - "fields": [ - { - "name": "isRestricted", - "description": "

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.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "occurredAt", - "description": "

When this contribution was made.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "pullRequest", - "description": "

The pull request the user reviewed.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "pullRequestReview", - "description": "

The review the user left on the pull request.

", - "type": "PullRequestReview!", - "id": "pullrequestreview", - "href": "/graphql/reference/objects#pullrequestreview" - }, - { - "name": "repository", - "description": "

The repository containing the pull request that the user reviewed.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this contribution.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The HTTP URL for this contribution.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user who made this contribution.

", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "CreatedPullRequestReviewContributionConnection", - "id": "createdpullrequestreviewcontributionconnection", - "href": "/graphql/reference/objects#createdpullrequestreviewcontributionconnection", - "description": "

The connection type for CreatedPullRequestReviewContribution.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[CreatedPullRequestReviewContributionEdge]", - "id": "createdpullrequestreviewcontributionedge", - "href": "/graphql/reference/objects#createdpullrequestreviewcontributionedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[CreatedPullRequestReviewContribution]", - "id": "createdpullrequestreviewcontribution", - "href": "/graphql/reference/objects#createdpullrequestreviewcontribution" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "CreatedPullRequestReviewContributionEdge", - "id": "createdpullrequestreviewcontributionedge", - "href": "/graphql/reference/objects#createdpullrequestreviewcontributionedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "CreatedPullRequestReviewContribution", - "id": "createdpullrequestreviewcontribution", - "href": "/graphql/reference/objects#createdpullrequestreviewcontribution" - } - ] - }, - { - "name": "CreatedRepositoryContribution", - "id": "createdrepositorycontribution", - "href": "/graphql/reference/objects#createdrepositorycontribution", - "description": "

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

", - "implements": [ - { - "name": "Contribution", - "id": "contribution", - "href": "/graphql/reference/interfaces#contribution" - } - ], - "fields": [ - { - "name": "isRestricted", - "description": "

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.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "occurredAt", - "description": "

When this contribution was made.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "repository", - "description": "

The repository that was created.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this contribution.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The HTTP URL for this contribution.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user who made this contribution.

", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "CreatedRepositoryContributionConnection", - "id": "createdrepositorycontributionconnection", - "href": "/graphql/reference/objects#createdrepositorycontributionconnection", - "description": "

The connection type for CreatedRepositoryContribution.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[CreatedRepositoryContributionEdge]", - "id": "createdrepositorycontributionedge", - "href": "/graphql/reference/objects#createdrepositorycontributionedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[CreatedRepositoryContribution]", - "id": "createdrepositorycontribution", - "href": "/graphql/reference/objects#createdrepositorycontribution" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "CreatedRepositoryContributionEdge", - "id": "createdrepositorycontributionedge", - "href": "/graphql/reference/objects#createdrepositorycontributionedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "CreatedRepositoryContribution", - "id": "createdrepositorycontribution", - "href": "/graphql/reference/objects#createdrepositorycontribution" - } - ] - }, - { - "name": "CrossReferencedEvent", - "id": "crossreferencedevent", - "href": "/graphql/reference/objects#crossreferencedevent", - "description": "

Represents a mention made by one issue or pull request to another.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the CrossReferencedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isCrossRepository", - "description": "

Reference originated in a different repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "referencedAt", - "description": "

Identifies when the reference was made.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this pull request.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "source", - "description": "

Issue or pull request that made the reference.

", - "type": "ReferencedSubject!", - "id": "referencedsubject", - "href": "/graphql/reference/unions#referencedsubject" - }, - { - "name": "target", - "description": "

Issue or pull request to which the reference was made.

", - "type": "ReferencedSubject!", - "id": "referencedsubject", - "href": "/graphql/reference/unions#referencedsubject" - }, - { - "name": "url", - "description": "

The HTTP URL for this pull request.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "willCloseTarget", - "description": "

Checks if the target will be closed when the source is merged.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "DemilestonedEvent", - "id": "demilestonedevent", - "href": "/graphql/reference/objects#demilestonedevent", - "description": "

Represents ademilestonedevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the DemilestonedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "milestoneTitle", - "description": "

Identifies the milestone title associated with thedemilestonedevent.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "subject", - "description": "

Object referenced by event.

", - "type": "MilestoneItem!", - "id": "milestoneitem", - "href": "/graphql/reference/unions#milestoneitem" - } - ] - }, - { - "name": "DependabotUpdate", - "id": "dependabotupdate", - "href": "/graphql/reference/objects#dependabotupdate", - "description": "

A Dependabot Update for a dependency in a repository.

", - "implements": [ - { - "name": "RepositoryNode", - "id": "repositorynode", - "href": "/graphql/reference/interfaces#repositorynode" - } - ], - "fields": [ - { - "name": "error", - "description": "

The error from a dependency update.

", - "type": "DependabotUpdateError", - "id": "dependabotupdateerror", - "href": "/graphql/reference/objects#dependabotupdateerror" - }, - { - "name": "pullRequest", - "description": "

The associated pull request.

", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "repository", - "description": "

The repository associated with this node.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "DependabotUpdateError", - "id": "dependabotupdateerror", - "href": "/graphql/reference/objects#dependabotupdateerror", - "description": "

An error produced from a Dependabot Update.

", - "fields": [ - { - "name": "body", - "description": "

The body of the error.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "errorType", - "description": "

The error code.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "title", - "description": "

The title of the error.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "DependencyGraphDependency", - "id": "dependencygraphdependency", - "href": "/graphql/reference/objects#dependencygraphdependency", - "description": "

A dependency manifest entry.

", - "fields": [ - { - "name": "hasDependencies", - "description": "

Does the dependency itself have dependencies?.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "packageLabel", - "description": "

The original name of the package, as it appears in the manifest.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string", - "isDeprecated": true, - "deprecationReason": "

packageLabel will be removed. Use normalized packageName field instead. Removal on 2022-10-01 UTC.

" - }, - { - "name": "packageManager", - "description": "

The dependency package manager.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "packageName", - "description": "

The name of the package in the canonical form used by the package manager.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repository", - "description": "

The repository containing the package.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "requirements", - "description": "

The dependency version requirements.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "DependencyGraphDependencyConnection", - "id": "dependencygraphdependencyconnection", - "href": "/graphql/reference/objects#dependencygraphdependencyconnection", - "description": "

The connection type for DependencyGraphDependency.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[DependencyGraphDependencyEdge]", - "id": "dependencygraphdependencyedge", - "href": "/graphql/reference/objects#dependencygraphdependencyedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[DependencyGraphDependency]", - "id": "dependencygraphdependency", - "href": "/graphql/reference/objects#dependencygraphdependency" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "DependencyGraphDependencyEdge", - "id": "dependencygraphdependencyedge", - "href": "/graphql/reference/objects#dependencygraphdependencyedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "DependencyGraphDependency", - "id": "dependencygraphdependency", - "href": "/graphql/reference/objects#dependencygraphdependency" - } - ] - }, - { - "name": "DependencyGraphManifest", - "id": "dependencygraphmanifest", - "href": "/graphql/reference/objects#dependencygraphmanifest", - "description": "

Dependency manifest for a repository.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "blobPath", - "description": "

Path to view the manifest file blob.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "dependencies", - "description": "

A list of manifest dependencies.

", - "type": "DependencyGraphDependencyConnection", - "id": "dependencygraphdependencyconnection", - "href": "/graphql/reference/objects#dependencygraphdependencyconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "dependenciesCount", - "description": "

The number of dependencies listed in the manifest.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "exceedsMaxSize", - "description": "

Is the manifest too big to parse?.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "filename", - "description": "

Fully qualified manifest filename.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the DependencyGraphManifest object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "parseable", - "description": "

Were we able to parse the manifest?.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "repository", - "description": "

The repository containing the manifest.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "DependencyGraphManifestConnection", - "id": "dependencygraphmanifestconnection", - "href": "/graphql/reference/objects#dependencygraphmanifestconnection", - "description": "

The connection type for DependencyGraphManifest.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[DependencyGraphManifestEdge]", - "id": "dependencygraphmanifestedge", - "href": "/graphql/reference/objects#dependencygraphmanifestedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[DependencyGraphManifest]", - "id": "dependencygraphmanifest", - "href": "/graphql/reference/objects#dependencygraphmanifest" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "DependencyGraphManifestEdge", - "id": "dependencygraphmanifestedge", - "href": "/graphql/reference/objects#dependencygraphmanifestedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "DependencyGraphManifest", - "id": "dependencygraphmanifest", - "href": "/graphql/reference/objects#dependencygraphmanifest" - } - ] - }, - { - "name": "DeployKey", - "id": "deploykey", - "href": "/graphql/reference/objects#deploykey", - "description": "

A repository deploy key.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the DeployKey object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "key", - "description": "

The deploy key.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "readOnly", - "description": "

Whether or not the deploy key is read only.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "title", - "description": "

The deploy key title.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "verified", - "description": "

Whether or not the deploy key has been verified.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "DeployKeyConnection", - "id": "deploykeyconnection", - "href": "/graphql/reference/objects#deploykeyconnection", - "description": "

The connection type for DeployKey.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[DeployKeyEdge]", - "id": "deploykeyedge", - "href": "/graphql/reference/objects#deploykeyedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[DeployKey]", - "id": "deploykey", - "href": "/graphql/reference/objects#deploykey" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "DeployKeyEdge", - "id": "deploykeyedge", - "href": "/graphql/reference/objects#deploykeyedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "DeployKey", - "id": "deploykey", - "href": "/graphql/reference/objects#deploykey" - } - ] - }, - { - "name": "DeployedEvent", - "id": "deployedevent", - "href": "/graphql/reference/objects#deployedevent", - "description": "

Represents adeployedevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "deployment", - "description": "

The deployment associated with thedeployedevent.

", - "type": "Deployment!", - "id": "deployment", - "href": "/graphql/reference/objects#deployment" - }, - { - "name": "id", - "description": "

The Node ID of the DeployedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "ref", - "description": "

The ref associated with thedeployedevent.

", - "type": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref" - } - ] - }, - { - "name": "Deployment", - "id": "deployment", - "href": "/graphql/reference/objects#deployment", - "description": "

Represents triggered deployment instance.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "commit", - "description": "

Identifies the commit sha of the deployment.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "commitOid", - "description": "

Identifies the oid of the deployment commit, even if the commit has been deleted.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "creator", - "description": "

Identifies the actor who triggered the deployment.

", - "type": "Actor!", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "description", - "description": "

The deployment description.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "environment", - "description": "

The latest environment to which this deployment was made.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the Deployment object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "latestEnvironment", - "description": "

The latest environment to which this deployment was made.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "latestStatus", - "description": "

The latest status of this deployment.

", - "type": "DeploymentStatus", - "id": "deploymentstatus", - "href": "/graphql/reference/objects#deploymentstatus" - }, - { - "name": "originalEnvironment", - "description": "

The original environment to which this deployment was made.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "payload", - "description": "

Extra information that a deployment system might need.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ref", - "description": "

Identifies the Ref of the deployment, if the deployment was created by ref.

", - "type": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref" - }, - { - "name": "repository", - "description": "

Identifies the repository associated with the deployment.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "state", - "description": "

The current state of the deployment.

", - "type": "DeploymentState", - "id": "deploymentstate", - "href": "/graphql/reference/enums#deploymentstate" - }, - { - "name": "statuses", - "description": "

A list of statuses associated with the deployment.

", - "type": "DeploymentStatusConnection", - "id": "deploymentstatusconnection", - "href": "/graphql/reference/objects#deploymentstatusconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "task", - "description": "

The deployment task.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "DeploymentConnection", - "id": "deploymentconnection", - "href": "/graphql/reference/objects#deploymentconnection", - "description": "

The connection type for Deployment.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[DeploymentEdge]", - "id": "deploymentedge", - "href": "/graphql/reference/objects#deploymentedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Deployment]", - "id": "deployment", - "href": "/graphql/reference/objects#deployment" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "DeploymentEdge", - "id": "deploymentedge", - "href": "/graphql/reference/objects#deploymentedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Deployment", - "id": "deployment", - "href": "/graphql/reference/objects#deployment" - } - ] - }, - { - "name": "DeploymentEnvironmentChangedEvent", - "id": "deploymentenvironmentchangedevent", - "href": "/graphql/reference/objects#deploymentenvironmentchangedevent", - "description": "

Represents adeployment_environment_changedevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "deploymentStatus", - "description": "

The deployment status that updated the deployment environment.

", - "type": "DeploymentStatus!", - "id": "deploymentstatus", - "href": "/graphql/reference/objects#deploymentstatus" - }, - { - "name": "id", - "description": "

The Node ID of the DeploymentEnvironmentChangedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "DeploymentProtectionRule", - "id": "deploymentprotectionrule", - "href": "/graphql/reference/objects#deploymentprotectionrule", - "description": "

A protection rule.

", - "fields": [ - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "preventSelfReview", - "description": "

Whether deployments to this environment can be approved by the user who created the deployment.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "reviewers", - "description": "

The teams or users that can review the deployment.

", - "type": "DeploymentReviewerConnection!", - "id": "deploymentreviewerconnection", - "href": "/graphql/reference/objects#deploymentreviewerconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "timeout", - "description": "

The timeout in minutes for this protection rule.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "type", - "description": "

The type of protection rule.

", - "type": "DeploymentProtectionRuleType!", - "id": "deploymentprotectionruletype", - "href": "/graphql/reference/enums#deploymentprotectionruletype" - } - ] - }, - { - "name": "DeploymentProtectionRuleConnection", - "id": "deploymentprotectionruleconnection", - "href": "/graphql/reference/objects#deploymentprotectionruleconnection", - "description": "

The connection type for DeploymentProtectionRule.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[DeploymentProtectionRuleEdge]", - "id": "deploymentprotectionruleedge", - "href": "/graphql/reference/objects#deploymentprotectionruleedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[DeploymentProtectionRule]", - "id": "deploymentprotectionrule", - "href": "/graphql/reference/objects#deploymentprotectionrule" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "DeploymentProtectionRuleEdge", - "id": "deploymentprotectionruleedge", - "href": "/graphql/reference/objects#deploymentprotectionruleedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "DeploymentProtectionRule", - "id": "deploymentprotectionrule", - "href": "/graphql/reference/objects#deploymentprotectionrule" - } - ] - }, - { - "name": "DeploymentRequest", - "id": "deploymentrequest", - "href": "/graphql/reference/objects#deploymentrequest", - "description": "

A request to deploy a workflow run to an environment.

", - "fields": [ - { - "name": "currentUserCanApprove", - "description": "

Whether or not the current user can approve the deployment.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "environment", - "description": "

The target environment of the deployment.

", - "type": "Environment!", - "id": "environment", - "href": "/graphql/reference/objects#environment" - }, - { - "name": "reviewers", - "description": "

The teams or users that can review the deployment.

", - "type": "DeploymentReviewerConnection!", - "id": "deploymentreviewerconnection", - "href": "/graphql/reference/objects#deploymentreviewerconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "waitTimer", - "description": "

The wait timer in minutes configured in the environment.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "waitTimerStartedAt", - "description": "

The wait timer in minutes configured in the environment.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "DeploymentRequestConnection", - "id": "deploymentrequestconnection", - "href": "/graphql/reference/objects#deploymentrequestconnection", - "description": "

The connection type for DeploymentRequest.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[DeploymentRequestEdge]", - "id": "deploymentrequestedge", - "href": "/graphql/reference/objects#deploymentrequestedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[DeploymentRequest]", - "id": "deploymentrequest", - "href": "/graphql/reference/objects#deploymentrequest" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "DeploymentRequestEdge", - "id": "deploymentrequestedge", - "href": "/graphql/reference/objects#deploymentrequestedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "DeploymentRequest", - "id": "deploymentrequest", - "href": "/graphql/reference/objects#deploymentrequest" - } - ] - }, - { - "name": "DeploymentReview", - "id": "deploymentreview", - "href": "/graphql/reference/objects#deploymentreview", - "description": "

A deployment review.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "comment", - "description": "

The comment the user left.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "environments", - "description": "

The environments approved or rejected.

", - "type": "EnvironmentConnection!", - "id": "environmentconnection", - "href": "/graphql/reference/objects#environmentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "id", - "description": "

The Node ID of the DeploymentReview object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "state", - "description": "

The decision of the user.

", - "type": "DeploymentReviewState!", - "id": "deploymentreviewstate", - "href": "/graphql/reference/enums#deploymentreviewstate" - }, - { - "name": "user", - "description": "

The user that reviewed the deployment.

", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "DeploymentReviewConnection", - "id": "deploymentreviewconnection", - "href": "/graphql/reference/objects#deploymentreviewconnection", - "description": "

The connection type for DeploymentReview.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[DeploymentReviewEdge]", - "id": "deploymentreviewedge", - "href": "/graphql/reference/objects#deploymentreviewedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[DeploymentReview]", - "id": "deploymentreview", - "href": "/graphql/reference/objects#deploymentreview" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "DeploymentReviewEdge", - "id": "deploymentreviewedge", - "href": "/graphql/reference/objects#deploymentreviewedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "DeploymentReview", - "id": "deploymentreview", - "href": "/graphql/reference/objects#deploymentreview" - } - ] - }, - { - "name": "DeploymentReviewerConnection", - "id": "deploymentreviewerconnection", - "href": "/graphql/reference/objects#deploymentreviewerconnection", - "description": "

The connection type for DeploymentReviewer.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[DeploymentReviewerEdge]", - "id": "deploymentrevieweredge", - "href": "/graphql/reference/objects#deploymentrevieweredge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[DeploymentReviewer]", - "id": "deploymentreviewer", - "href": "/graphql/reference/unions#deploymentreviewer" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "DeploymentReviewerEdge", - "id": "deploymentrevieweredge", - "href": "/graphql/reference/objects#deploymentrevieweredge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "DeploymentReviewer", - "id": "deploymentreviewer", - "href": "/graphql/reference/unions#deploymentreviewer" - } - ] - }, - { - "name": "DeploymentStatus", - "id": "deploymentstatus", - "href": "/graphql/reference/objects#deploymentstatus", - "description": "

Describes the status of a given deployment attempt.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "creator", - "description": "

Identifies the actor who triggered the deployment.

", - "type": "Actor!", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "deployment", - "description": "

Identifies the deployment associated with status.

", - "type": "Deployment!", - "id": "deployment", - "href": "/graphql/reference/objects#deployment" - }, - { - "name": "description", - "description": "

Identifies the description of the deployment.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "environment", - "description": "

Identifies the environment of the deployment at the time of this deployment status.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "environmentUrl", - "description": "

Identifies the environment URL of the deployment.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "id", - "description": "

The Node ID of the DeploymentStatus object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "logUrl", - "description": "

Identifies the log URL of the deployment.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "state", - "description": "

Identifies the current state of the deployment.

", - "type": "DeploymentStatusState!", - "id": "deploymentstatusstate", - "href": "/graphql/reference/enums#deploymentstatusstate" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "DeploymentStatusConnection", - "id": "deploymentstatusconnection", - "href": "/graphql/reference/objects#deploymentstatusconnection", - "description": "

The connection type for DeploymentStatus.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[DeploymentStatusEdge]", - "id": "deploymentstatusedge", - "href": "/graphql/reference/objects#deploymentstatusedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[DeploymentStatus]", - "id": "deploymentstatus", - "href": "/graphql/reference/objects#deploymentstatus" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "DeploymentStatusEdge", - "id": "deploymentstatusedge", - "href": "/graphql/reference/objects#deploymentstatusedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "DeploymentStatus", - "id": "deploymentstatus", - "href": "/graphql/reference/objects#deploymentstatus" - } - ] - }, - { - "name": "DisconnectedEvent", - "id": "disconnectedevent", - "href": "/graphql/reference/objects#disconnectedevent", - "description": "

Represents adisconnectedevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the DisconnectedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isCrossRepository", - "description": "

Reference originated in a different repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "source", - "description": "

Issue or pull request from which the issue was disconnected.

", - "type": "ReferencedSubject!", - "id": "referencedsubject", - "href": "/graphql/reference/unions#referencedsubject" - }, - { - "name": "subject", - "description": "

Issue or pull request which was disconnected.

", - "type": "ReferencedSubject!", - "id": "referencedsubject", - "href": "/graphql/reference/unions#referencedsubject" - } - ] - }, - { - "name": "Discussion", - "id": "discussion", - "href": "/graphql/reference/objects#discussion", - "description": "

A discussion in a repository.

", - "implements": [ - { - "name": "Closable", - "id": "closable", - "href": "/graphql/reference/interfaces#closable" - }, - { - "name": "Comment", - "id": "comment", - "href": "/graphql/reference/interfaces#comment" - }, - { - "name": "Deletable", - "id": "deletable", - "href": "/graphql/reference/interfaces#deletable" - }, - { - "name": "Labelable", - "id": "labelable", - "href": "/graphql/reference/interfaces#labelable" - }, - { - "name": "Lockable", - "id": "lockable", - "href": "/graphql/reference/interfaces#lockable" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "Reactable", - "id": "reactable", - "href": "/graphql/reference/interfaces#reactable" - }, - { - "name": "RepositoryNode", - "id": "repositorynode", - "href": "/graphql/reference/interfaces#repositorynode" - }, - { - "name": "Subscribable", - "id": "subscribable", - "href": "/graphql/reference/interfaces#subscribable" - }, - { - "name": "Updatable", - "id": "updatable", - "href": "/graphql/reference/interfaces#updatable" - }, - { - "name": "Votable", - "id": "votable", - "href": "/graphql/reference/interfaces#votable" - } - ], - "fields": [ - { - "name": "activeLockReason", - "description": "

Reason that the conversation was locked.

", - "type": "LockReason", - "id": "lockreason", - "href": "/graphql/reference/enums#lockreason" - }, - { - "name": "answer", - "description": "

The comment chosen as this discussion's answer, if any.

", - "type": "DiscussionComment", - "id": "discussioncomment", - "href": "/graphql/reference/objects#discussioncomment" - }, - { - "name": "answerChosenAt", - "description": "

The time when a user chose this discussion's answer, if answered.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "answerChosenBy", - "description": "

The user who chose this discussion's answer, if answered.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "author", - "description": "

The actor who authored the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "authorAssociation", - "description": "

Author's association with the subject of the comment.

", - "type": "CommentAuthorAssociation!", - "id": "commentauthorassociation", - "href": "/graphql/reference/enums#commentauthorassociation" - }, - { - "name": "body", - "description": "

The main text of the discussion post.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyHTML", - "description": "

The body rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "bodyText", - "description": "

The body rendered to text.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "category", - "description": "

The category for this discussion.

", - "type": "DiscussionCategory!", - "id": "discussioncategory", - "href": "/graphql/reference/objects#discussioncategory" - }, - { - "name": "closed", - "description": "

Indicates if the object is closed (definition of closed may depend on type).

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "closedAt", - "description": "

Identifies the date and time when the object was closed.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "comments", - "description": "

The replies to the discussion.

", - "type": "DiscussionCommentConnection!", - "id": "discussioncommentconnection", - "href": "/graphql/reference/objects#discussioncommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "createdViaEmail", - "description": "

Check if this comment was created via an email reply.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "editor", - "description": "

The actor who edited the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "id", - "description": "

The Node ID of the Discussion object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "includesCreatedEdit", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isAnswered", - "description": "

Only return answered/unanswered discussions.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "labels", - "description": "

A list of labels associated with the object.

", - "type": "LabelConnection", - "id": "labelconnection", - "href": "/graphql/reference/objects#labelconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for labels returned from the connection.

", - "type": { - "name": "LabelOrder", - "id": "labelorder", - "href": "/graphql/reference/input-objects#labelorder" - } - } - ] - }, - { - "name": "lastEditedAt", - "description": "

The moment the editor made the last edit.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "locked", - "description": "

true if the object is locked.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "number", - "description": "

The number identifying this discussion within the repository.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "poll", - "description": "

The poll associated with this discussion, if one exists.

", - "type": "DiscussionPoll", - "id": "discussionpoll", - "href": "/graphql/reference/objects#discussionpoll" - }, - { - "name": "publishedAt", - "description": "

Identifies when the comment was published at.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "reactionGroups", - "description": "

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

", - "type": "[ReactionGroup!]", - "id": "reactiongroup", - "href": "/graphql/reference/objects#reactiongroup" - }, - { - "name": "reactions", - "description": "

A list of Reactions left on the Issue.

", - "type": "ReactionConnection!", - "id": "reactionconnection", - "href": "/graphql/reference/objects#reactionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "content", - "description": "

Allows filtering Reactions by emoji.

", - "type": { - "name": "ReactionContent", - "id": "reactioncontent", - "href": "/graphql/reference/enums#reactioncontent" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Allows specifying the order in which reactions are returned.

", - "type": { - "name": "ReactionOrder", - "id": "reactionorder", - "href": "/graphql/reference/input-objects#reactionorder" - } - } - ] - }, - { - "name": "repository", - "description": "

The repository associated with this node.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resourcePath", - "description": "

The path for this discussion.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "stateReason", - "description": "

Identifies the reason for the discussion's state.

", - "type": "DiscussionStateReason", - "id": "discussionstatereason", - "href": "/graphql/reference/enums#discussionstatereason" - }, - { - "name": "title", - "description": "

The title of this discussion.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "upvoteCount", - "description": "

Number of upvotes that this subject has received.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "url", - "description": "

The URL for this discussion.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userContentEdits", - "description": "

A list of edits to this content.

", - "type": "UserContentEditConnection", - "id": "usercontenteditconnection", - "href": "/graphql/reference/objects#usercontenteditconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "viewerCanClose", - "description": "

Indicates if the object can be closed by the viewer.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanDelete", - "description": "

Check if the current viewer can delete this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanReact", - "description": "

Can user react to this subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanReopen", - "description": "

Indicates if the object can be reopened by the viewer.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanSubscribe", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUpdate", - "description": "

Check if the current viewer can update this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUpvote", - "description": "

Whether or not the current user can add or remove an upvote on this subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerDidAuthor", - "description": "

Did the viewer author this comment.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerHasUpvoted", - "description": "

Whether or not the current user has already upvoted this subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerSubscription", - "description": "

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

", - "type": "SubscriptionState", - "id": "subscriptionstate", - "href": "/graphql/reference/enums#subscriptionstate" - } - ] - }, - { - "name": "DiscussionCategory", - "id": "discussioncategory", - "href": "/graphql/reference/objects#discussioncategory", - "description": "

A category for discussions in a repository.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "RepositoryNode", - "id": "repositorynode", - "href": "/graphql/reference/interfaces#repositorynode" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "description", - "description": "

A description of this category.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "emoji", - "description": "

An emoji representing this category.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "emojiHTML", - "description": "

This category's emoji rendered as HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "id", - "description": "

The Node ID of the DiscussionCategory object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isAnswerable", - "description": "

Whether or not discussions in this category support choosing an answer with the markDiscussionCommentAsAnswer mutation.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "name", - "description": "

The name of this category.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repository", - "description": "

The repository associated with this node.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "slug", - "description": "

The slug of this category.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "DiscussionCategoryConnection", - "id": "discussioncategoryconnection", - "href": "/graphql/reference/objects#discussioncategoryconnection", - "description": "

The connection type for DiscussionCategory.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[DiscussionCategoryEdge]", - "id": "discussioncategoryedge", - "href": "/graphql/reference/objects#discussioncategoryedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[DiscussionCategory]", - "id": "discussioncategory", - "href": "/graphql/reference/objects#discussioncategory" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "DiscussionCategoryEdge", - "id": "discussioncategoryedge", - "href": "/graphql/reference/objects#discussioncategoryedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "DiscussionCategory", - "id": "discussioncategory", - "href": "/graphql/reference/objects#discussioncategory" - } - ] - }, - { - "name": "DiscussionComment", - "id": "discussioncomment", - "href": "/graphql/reference/objects#discussioncomment", - "description": "

A comment on a discussion.

", - "implements": [ - { - "name": "Comment", - "id": "comment", - "href": "/graphql/reference/interfaces#comment" - }, - { - "name": "Deletable", - "id": "deletable", - "href": "/graphql/reference/interfaces#deletable" - }, - { - "name": "Minimizable", - "id": "minimizable", - "href": "/graphql/reference/interfaces#minimizable" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "Reactable", - "id": "reactable", - "href": "/graphql/reference/interfaces#reactable" - }, - { - "name": "Updatable", - "id": "updatable", - "href": "/graphql/reference/interfaces#updatable" - }, - { - "name": "UpdatableComment", - "id": "updatablecomment", - "href": "/graphql/reference/interfaces#updatablecomment" - }, - { - "name": "Votable", - "id": "votable", - "href": "/graphql/reference/interfaces#votable" - } - ], - "fields": [ - { - "name": "author", - "description": "

The actor who authored the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "authorAssociation", - "description": "

Author's association with the subject of the comment.

", - "type": "CommentAuthorAssociation!", - "id": "commentauthorassociation", - "href": "/graphql/reference/enums#commentauthorassociation" - }, - { - "name": "body", - "description": "

The body as Markdown.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyHTML", - "description": "

The body rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "bodyText", - "description": "

The body rendered to text.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "createdViaEmail", - "description": "

Check if this comment was created via an email reply.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "deletedAt", - "description": "

The time when this replied-to comment was deleted.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "discussion", - "description": "

The discussion this comment was created in.

", - "type": "Discussion", - "id": "discussion", - "href": "/graphql/reference/objects#discussion" - }, - { - "name": "editor", - "description": "

The actor who edited the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "id", - "description": "

The Node ID of the DiscussionComment object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "includesCreatedEdit", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isAnswer", - "description": "

Has this comment been chosen as the answer of its discussion?.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isMinimized", - "description": "

Returns whether or not a comment has been minimized.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "lastEditedAt", - "description": "

The moment the editor made the last edit.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "minimizedReason", - "description": "

Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "publishedAt", - "description": "

Identifies when the comment was published at.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "reactionGroups", - "description": "

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

", - "type": "[ReactionGroup!]", - "id": "reactiongroup", - "href": "/graphql/reference/objects#reactiongroup" - }, - { - "name": "reactions", - "description": "

A list of Reactions left on the Issue.

", - "type": "ReactionConnection!", - "id": "reactionconnection", - "href": "/graphql/reference/objects#reactionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "content", - "description": "

Allows filtering Reactions by emoji.

", - "type": { - "name": "ReactionContent", - "id": "reactioncontent", - "href": "/graphql/reference/enums#reactioncontent" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Allows specifying the order in which reactions are returned.

", - "type": { - "name": "ReactionOrder", - "id": "reactionorder", - "href": "/graphql/reference/input-objects#reactionorder" - } - } - ] - }, - { - "name": "replies", - "description": "

The threaded replies to this comment.

", - "type": "DiscussionCommentConnection!", - "id": "discussioncommentconnection", - "href": "/graphql/reference/objects#discussioncommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "replyTo", - "description": "

The discussion comment this comment is a reply to.

", - "type": "DiscussionComment", - "id": "discussioncomment", - "href": "/graphql/reference/objects#discussioncomment" - }, - { - "name": "resourcePath", - "description": "

The path for this discussion comment.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "upvoteCount", - "description": "

Number of upvotes that this subject has received.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "url", - "description": "

The URL for this discussion comment.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userContentEdits", - "description": "

A list of edits to this content.

", - "type": "UserContentEditConnection", - "id": "usercontenteditconnection", - "href": "/graphql/reference/objects#usercontenteditconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "viewerCanDelete", - "description": "

Check if the current viewer can delete this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanMarkAsAnswer", - "description": "

Can the current user mark this comment as an answer?.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanMinimize", - "description": "

Check if the current viewer can minimize this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanReact", - "description": "

Can user react to this subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUnmarkAsAnswer", - "description": "

Can the current user unmark this comment as an answer?.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUpdate", - "description": "

Check if the current viewer can update this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUpvote", - "description": "

Whether or not the current user can add or remove an upvote on this subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCannotUpdateReasons", - "description": "

Reasons why the current viewer can not update this comment.

", - "type": "[CommentCannotUpdateReason!]!", - "id": "commentcannotupdatereason", - "href": "/graphql/reference/enums#commentcannotupdatereason" - }, - { - "name": "viewerDidAuthor", - "description": "

Did the viewer author this comment.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerHasUpvoted", - "description": "

Whether or not the current user has already upvoted this subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "DiscussionCommentConnection", - "id": "discussioncommentconnection", - "href": "/graphql/reference/objects#discussioncommentconnection", - "description": "

The connection type for DiscussionComment.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[DiscussionCommentEdge]", - "id": "discussioncommentedge", - "href": "/graphql/reference/objects#discussioncommentedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[DiscussionComment]", - "id": "discussioncomment", - "href": "/graphql/reference/objects#discussioncomment" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "DiscussionCommentEdge", - "id": "discussioncommentedge", - "href": "/graphql/reference/objects#discussioncommentedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "DiscussionComment", - "id": "discussioncomment", - "href": "/graphql/reference/objects#discussioncomment" - } - ] - }, - { - "name": "DiscussionConnection", - "id": "discussionconnection", - "href": "/graphql/reference/objects#discussionconnection", - "description": "

The connection type for Discussion.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[DiscussionEdge]", - "id": "discussionedge", - "href": "/graphql/reference/objects#discussionedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Discussion]", - "id": "discussion", - "href": "/graphql/reference/objects#discussion" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "DiscussionEdge", - "id": "discussionedge", - "href": "/graphql/reference/objects#discussionedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Discussion", - "id": "discussion", - "href": "/graphql/reference/objects#discussion" - } - ] - }, - { - "name": "DiscussionPoll", - "id": "discussionpoll", - "href": "/graphql/reference/objects#discussionpoll", - "description": "

A poll for a discussion.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "discussion", - "description": "

The discussion that this poll belongs to.

", - "type": "Discussion", - "id": "discussion", - "href": "/graphql/reference/objects#discussion" - }, - { - "name": "id", - "description": "

The Node ID of the DiscussionPoll object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "options", - "description": "

The options for this poll.

", - "type": "DiscussionPollOptionConnection", - "id": "discussionpolloptionconnection", - "href": "/graphql/reference/objects#discussionpolloptionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

How to order the options for the discussion poll.

", - "type": { - "name": "DiscussionPollOptionOrder", - "id": "discussionpolloptionorder", - "href": "/graphql/reference/input-objects#discussionpolloptionorder" - } - } - ] - }, - { - "name": "question", - "description": "

The question that is being asked by this poll.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "totalVoteCount", - "description": "

The total number of votes that have been cast for this poll.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "viewerCanVote", - "description": "

Indicates if the viewer has permission to vote in this poll.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerHasVoted", - "description": "

Indicates if the viewer has voted for any option in this poll.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "DiscussionPollOption", - "id": "discussionpolloption", - "href": "/graphql/reference/objects#discussionpolloption", - "description": "

An option for a discussion poll.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "id", - "description": "

The Node ID of the DiscussionPollOption object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "option", - "description": "

The text for this option.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "poll", - "description": "

The discussion poll that this option belongs to.

", - "type": "DiscussionPoll", - "id": "discussionpoll", - "href": "/graphql/reference/objects#discussionpoll" - }, - { - "name": "totalVoteCount", - "description": "

The total number of votes that have been cast for this option.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "viewerHasVoted", - "description": "

Indicates if the viewer has voted for this option in the poll.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "DiscussionPollOptionConnection", - "id": "discussionpolloptionconnection", - "href": "/graphql/reference/objects#discussionpolloptionconnection", - "description": "

The connection type for DiscussionPollOption.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[DiscussionPollOptionEdge]", - "id": "discussionpolloptionedge", - "href": "/graphql/reference/objects#discussionpolloptionedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[DiscussionPollOption]", - "id": "discussionpolloption", - "href": "/graphql/reference/objects#discussionpolloption" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "DiscussionPollOptionEdge", - "id": "discussionpolloptionedge", - "href": "/graphql/reference/objects#discussionpolloptionedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "DiscussionPollOption", - "id": "discussionpolloption", - "href": "/graphql/reference/objects#discussionpolloption" - } - ] - }, - { - "name": "DraftIssue", - "id": "draftissue", - "href": "/graphql/reference/objects#draftissue", - "description": "

A draft issue within a project.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "assignees", - "description": "

A list of users to assigned to this draft issue.

", - "type": "UserConnection!", - "id": "userconnection", - "href": "/graphql/reference/objects#userconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "body", - "description": "

The body of the draft issue.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyHTML", - "description": "

The body of the draft issue rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "bodyText", - "description": "

The body of the draft issue rendered to text.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "creator", - "description": "

The actor who created this draft issue.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "id", - "description": "

The Node ID of the DraftIssue object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "projectV2Items", - "description": "

List of items linked with the draft issue (currently draft issue can be linked to only one item).

", - "type": "ProjectV2ItemConnection!", - "id": "projectv2itemconnection", - "href": "/graphql/reference/objects#projectv2itemconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "projectsV2", - "description": "

Projects that link to this draft issue (currently draft issue can be linked to only one project).

", - "type": "ProjectV2Connection!", - "id": "projectv2connection", - "href": "/graphql/reference/objects#projectv2connection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "title", - "description": "

The title of the draft issue.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise", - "description": "

An account to manage multiple organizations with consolidated policy and billing.

", - "implements": [ - { - "name": "AnnouncementBanner", - "id": "announcementbanner", - "href": "/graphql/reference/interfaces#announcementbanner" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "announcement", - "description": "

The text of the announcement.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "announcementCreatedAt", - "description": "

The date the announcement was created.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "announcementExpiresAt", - "description": "

The expiration date of the announcement, if any.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "announcementUserDismissible", - "description": "

Whether the announcement can be dismissed by the user.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "avatarUrl", - "description": "

A URL pointing to the enterprise's public avatar.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "arguments": [ - { - "name": "size", - "description": "

The size of the resulting square image.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "billingEmail", - "description": "

The enterprise's billing email.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "billingInfo", - "description": "

Enterprise billing information visible to enterprise billing managers.

", - "type": "EnterpriseBillingInfo", - "id": "enterprisebillinginfo", - "href": "/graphql/reference/objects#enterprisebillinginfo" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "description", - "description": "

The description of the enterprise.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "descriptionHTML", - "description": "

The description of the enterprise as HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "id", - "description": "

The Node ID of the Enterprise object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "location", - "description": "

The location of the enterprise.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "members", - "description": "

A list of users who are members of this enterprise.

", - "type": "EnterpriseMemberConnection!", - "id": "enterprisememberconnection", - "href": "/graphql/reference/objects#enterprisememberconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "deployment", - "description": "

Only return members within the selected GitHub Enterprise deployment.

", - "type": { - "name": "EnterpriseUserDeployment", - "id": "enterpriseuserdeployment", - "href": "/graphql/reference/enums#enterpriseuserdeployment" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "hasTwoFactorEnabled", - "description": "

Only return members with this two-factor authentication status. Does not\ninclude members who only have an account on a GitHub Enterprise Server instance.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for members returned from the connection.

", - "type": { - "name": "EnterpriseMemberOrder", - "id": "enterprisememberorder", - "href": "/graphql/reference/input-objects#enterprisememberorder" - } - }, - { - "name": "organizationLogins", - "description": "

Only return members within the organizations with these logins.

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "query", - "description": "

The search string to look for.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "role", - "description": "

The role of the user in the enterprise organization or server.

", - "type": { - "name": "EnterpriseUserAccountMembershipRole", - "id": "enterpriseuseraccountmembershiprole", - "href": "/graphql/reference/enums#enterpriseuseraccountmembershiprole" - } - } - ] - }, - { - "name": "name", - "description": "

The name of the enterprise.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizations", - "description": "

A list of organizations that belong to this enterprise.

", - "type": "OrganizationConnection!", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for organizations returned from the connection.

", - "type": { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder" - } - }, - { - "name": "query", - "description": "

The search string to look for.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "viewerOrganizationRole", - "description": "

The viewer's role in an organization.

", - "type": { - "name": "RoleInOrganization", - "id": "roleinorganization", - "href": "/graphql/reference/enums#roleinorganization" - } - } - ] - }, - { - "name": "ownerInfo", - "description": "

Enterprise information visible to enterprise owners or enterprise owners'\npersonal access tokens (classic) with read:enterprise or admin:enterprise scope.

", - "type": "EnterpriseOwnerInfo", - "id": "enterpriseownerinfo", - "href": "/graphql/reference/objects#enterpriseownerinfo" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this enterprise.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "slug", - "description": "

The URL-friendly identifier for the enterprise.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "url", - "description": "

The HTTP URL for this enterprise.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "viewerIsAdmin", - "description": "

Is the current viewer an admin of this enterprise?.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "websiteUrl", - "description": "

The URL of the enterprise website.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "EnterpriseAdministratorConnection", - "id": "enterpriseadministratorconnection", - "href": "/graphql/reference/objects#enterpriseadministratorconnection", - "description": "

The connection type for User.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[EnterpriseAdministratorEdge]", - "id": "enterpriseadministratoredge", - "href": "/graphql/reference/objects#enterpriseadministratoredge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[User]", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "EnterpriseAdministratorEdge", - "id": "enterpriseadministratoredge", - "href": "/graphql/reference/objects#enterpriseadministratoredge", - "description": "

A User who is an administrator of an enterprise.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "role", - "description": "

The role of the administrator.

", - "type": "EnterpriseAdministratorRole!", - "id": "enterpriseadministratorrole", - "href": "/graphql/reference/enums#enterpriseadministratorrole" - } - ] - }, - { - "name": "EnterpriseAdministratorInvitation", - "id": "enterpriseadministratorinvitation", - "href": "/graphql/reference/objects#enterpriseadministratorinvitation", - "description": "

An invitation for a user to become an owner or billing manager of an enterprise.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "email", - "description": "

The email of the person who was invited to the enterprise.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterprise", - "description": "

The enterprise the invitation is for.

", - "type": "Enterprise!", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise" - }, - { - "name": "id", - "description": "

The Node ID of the EnterpriseAdministratorInvitation object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "invitee", - "description": "

The user who was invited to the enterprise.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "inviter", - "description": "

The user who created the invitation.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "role", - "description": "

The invitee's pending role in the enterprise (owner or billing_manager).

", - "type": "EnterpriseAdministratorRole!", - "id": "enterpriseadministratorrole", - "href": "/graphql/reference/enums#enterpriseadministratorrole" - } - ] - }, - { - "name": "EnterpriseAdministratorInvitationConnection", - "id": "enterpriseadministratorinvitationconnection", - "href": "/graphql/reference/objects#enterpriseadministratorinvitationconnection", - "description": "

The connection type for EnterpriseAdministratorInvitation.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[EnterpriseAdministratorInvitationEdge]", - "id": "enterpriseadministratorinvitationedge", - "href": "/graphql/reference/objects#enterpriseadministratorinvitationedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[EnterpriseAdministratorInvitation]", - "id": "enterpriseadministratorinvitation", - "href": "/graphql/reference/objects#enterpriseadministratorinvitation" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "EnterpriseAdministratorInvitationEdge", - "id": "enterpriseadministratorinvitationedge", - "href": "/graphql/reference/objects#enterpriseadministratorinvitationedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "EnterpriseAdministratorInvitation", - "id": "enterpriseadministratorinvitation", - "href": "/graphql/reference/objects#enterpriseadministratorinvitation" - } - ] - }, - { - "name": "EnterpriseBillingInfo", - "id": "enterprisebillinginfo", - "href": "/graphql/reference/objects#enterprisebillinginfo", - "description": "

Enterprise billing information visible to enterprise billing managers and owners.

", - "fields": [ - { - "name": "allLicensableUsersCount", - "description": "

The number of licenseable users/emails across the enterprise.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "assetPacks", - "description": "

The number of data packs used by all organizations owned by the enterprise.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "bandwidthQuota", - "description": "

The bandwidth quota in GB for all organizations owned by the enterprise.

", - "type": "Float!", - "id": "float", - "href": "/graphql/reference/scalars#float" - }, - { - "name": "bandwidthUsage", - "description": "

The bandwidth usage in GB for all organizations owned by the enterprise.

", - "type": "Float!", - "id": "float", - "href": "/graphql/reference/scalars#float" - }, - { - "name": "bandwidthUsagePercentage", - "description": "

The bandwidth usage as a percentage of the bandwidth quota.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "storageQuota", - "description": "

The storage quota in GB for all organizations owned by the enterprise.

", - "type": "Float!", - "id": "float", - "href": "/graphql/reference/scalars#float" - }, - { - "name": "storageUsage", - "description": "

The storage usage in GB for all organizations owned by the enterprise.

", - "type": "Float!", - "id": "float", - "href": "/graphql/reference/scalars#float" - }, - { - "name": "storageUsagePercentage", - "description": "

The storage usage as a percentage of the storage quota.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "totalAvailableLicenses", - "description": "

The number of available licenses across all owned organizations based on the unique number of billable users.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "totalLicenses", - "description": "

The total number of licenses allocated.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "EnterpriseConnection", - "id": "enterpriseconnection", - "href": "/graphql/reference/objects#enterpriseconnection", - "description": "

The connection type for Enterprise.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[EnterpriseEdge]", - "id": "enterpriseedge", - "href": "/graphql/reference/objects#enterpriseedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Enterprise]", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "EnterpriseEdge", - "id": "enterpriseedge", - "href": "/graphql/reference/objects#enterpriseedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise" - } - ] - }, - { - "name": "EnterpriseFailedInvitationConnection", - "id": "enterprisefailedinvitationconnection", - "href": "/graphql/reference/objects#enterprisefailedinvitationconnection", - "description": "

The connection type for OrganizationInvitation.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[EnterpriseFailedInvitationEdge]", - "id": "enterprisefailedinvitationedge", - "href": "/graphql/reference/objects#enterprisefailedinvitationedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[OrganizationInvitation]", - "id": "organizationinvitation", - "href": "/graphql/reference/objects#organizationinvitation" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "totalUniqueUserCount", - "description": "

Identifies the total count of unique users in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "EnterpriseFailedInvitationEdge", - "id": "enterprisefailedinvitationedge", - "href": "/graphql/reference/objects#enterprisefailedinvitationedge", - "description": "

A failed invitation to be a member in an enterprise organization.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "OrganizationInvitation", - "id": "organizationinvitation", - "href": "/graphql/reference/objects#organizationinvitation" - } - ] - }, - { - "name": "EnterpriseIdentityProvider", - "id": "enterpriseidentityprovider", - "href": "/graphql/reference/objects#enterpriseidentityprovider", - "description": "

An identity provider configured to provision identities for an enterprise.\nVisible to enterprise owners or enterprise owners' personal access tokens\n(classic) with read:enterprise or admin:enterprise scope.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "digestMethod", - "description": "

The digest algorithm used to sign SAML requests for the identity provider.

", - "type": "SamlDigestAlgorithm", - "id": "samldigestalgorithm", - "href": "/graphql/reference/enums#samldigestalgorithm" - }, - { - "name": "enterprise", - "description": "

The enterprise this identity provider belongs to.

", - "type": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise" - }, - { - "name": "externalIdentities", - "description": "

ExternalIdentities provisioned by this identity provider.

", - "type": "ExternalIdentityConnection!", - "id": "externalidentityconnection", - "href": "/graphql/reference/objects#externalidentityconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "login", - "description": "

Filter to external identities with the users login.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "membersOnly", - "description": "

Filter to external identities with valid org membership only.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "userName", - "description": "

Filter to external identities with the users userName/NameID attribute.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "id", - "description": "

The Node ID of the EnterpriseIdentityProvider object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "idpCertificate", - "description": "

The x509 certificate used by the identity provider to sign assertions and responses.

", - "type": "X509Certificate", - "id": "x509certificate", - "href": "/graphql/reference/scalars#x509certificate" - }, - { - "name": "issuer", - "description": "

The Issuer Entity ID for the SAML identity provider.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "recoveryCodes", - "description": "

Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable.

", - "type": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "signatureMethod", - "description": "

The signature algorithm used to sign SAML requests for the identity provider.

", - "type": "SamlSignatureAlgorithm", - "id": "samlsignaturealgorithm", - "href": "/graphql/reference/enums#samlsignaturealgorithm" - }, - { - "name": "ssoUrl", - "description": "

The URL endpoint for the identity provider's SAML SSO.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "EnterpriseMemberConnection", - "id": "enterprisememberconnection", - "href": "/graphql/reference/objects#enterprisememberconnection", - "description": "

The connection type for EnterpriseMember.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[EnterpriseMemberEdge]", - "id": "enterprisememberedge", - "href": "/graphql/reference/objects#enterprisememberedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[EnterpriseMember]", - "id": "enterprisemember", - "href": "/graphql/reference/unions#enterprisemember" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "EnterpriseMemberEdge", - "id": "enterprisememberedge", - "href": "/graphql/reference/objects#enterprisememberedge", - "description": "

A User who is a member of an enterprise through one or more organizations.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "EnterpriseMember", - "id": "enterprisemember", - "href": "/graphql/reference/unions#enterprisemember" - } - ] - }, - { - "name": "EnterpriseOrganizationMembershipConnection", - "id": "enterpriseorganizationmembershipconnection", - "href": "/graphql/reference/objects#enterpriseorganizationmembershipconnection", - "description": "

The connection type for Organization.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[EnterpriseOrganizationMembershipEdge]", - "id": "enterpriseorganizationmembershipedge", - "href": "/graphql/reference/objects#enterpriseorganizationmembershipedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Organization]", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "EnterpriseOrganizationMembershipEdge", - "id": "enterpriseorganizationmembershipedge", - "href": "/graphql/reference/objects#enterpriseorganizationmembershipedge", - "description": "

An enterprise organization that a user is a member of.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "role", - "description": "

The role of the user in the enterprise membership.

", - "type": "EnterpriseUserAccountMembershipRole!", - "id": "enterpriseuseraccountmembershiprole", - "href": "/graphql/reference/enums#enterpriseuseraccountmembershiprole" - } - ] - }, - { - "name": "EnterpriseOutsideCollaboratorConnection", - "id": "enterpriseoutsidecollaboratorconnection", - "href": "/graphql/reference/objects#enterpriseoutsidecollaboratorconnection", - "description": "

The connection type for User.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[EnterpriseOutsideCollaboratorEdge]", - "id": "enterpriseoutsidecollaboratoredge", - "href": "/graphql/reference/objects#enterpriseoutsidecollaboratoredge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[User]", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "EnterpriseOutsideCollaboratorEdge", - "id": "enterpriseoutsidecollaboratoredge", - "href": "/graphql/reference/objects#enterpriseoutsidecollaboratoredge", - "description": "

A User who is an outside collaborator of an enterprise through one or more organizations.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "repositories", - "description": "

The enterprise organization repositories this user is a member of.

", - "type": "EnterpriseRepositoryInfoConnection!", - "id": "enterpriserepositoryinfoconnection", - "href": "/graphql/reference/objects#enterpriserepositoryinfoconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for repositories.

", - "type": { - "name": "RepositoryOrder", - "id": "repositoryorder", - "href": "/graphql/reference/input-objects#repositoryorder" - } - } - ] - } - ] - }, - { - "name": "EnterpriseOwnerInfo", - "id": "enterpriseownerinfo", - "href": "/graphql/reference/objects#enterpriseownerinfo", - "description": "

Enterprise information visible to enterprise owners or enterprise owners'\npersonal access tokens (classic) with read:enterprise or admin:enterprise scope.

", - "fields": [ - { - "name": "admins", - "description": "

A list of all of the administrators for this enterprise.

", - "type": "EnterpriseAdministratorConnection!", - "id": "enterpriseadministratorconnection", - "href": "/graphql/reference/objects#enterpriseadministratorconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "hasTwoFactorEnabled", - "description": "

Only return administrators with this two-factor authentication status.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for administrators returned from the connection.

", - "type": { - "name": "EnterpriseMemberOrder", - "id": "enterprisememberorder", - "href": "/graphql/reference/input-objects#enterprisememberorder" - } - }, - { - "name": "organizationLogins", - "description": "

Only return members within the organizations with these logins.

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "query", - "description": "

The search string to look for.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "role", - "description": "

The role to filter by.

", - "type": { - "name": "EnterpriseAdministratorRole", - "id": "enterpriseadministratorrole", - "href": "/graphql/reference/enums#enterpriseadministratorrole" - } - } - ] - }, - { - "name": "affiliatedUsersWithTwoFactorDisabled", - "description": "

A list of users in the enterprise who currently have two-factor authentication disabled.

", - "type": "UserConnection!", - "id": "userconnection", - "href": "/graphql/reference/objects#userconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "affiliatedUsersWithTwoFactorDisabledExist", - "description": "

Whether or not affiliated users with two-factor authentication disabled exist in the enterprise.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "allowPrivateRepositoryForkingSetting", - "description": "

The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - }, - { - "name": "allowPrivateRepositoryForkingSettingOrganizations", - "description": "

A list of enterprise organizations configured with the provided private repository forking setting value.

", - "type": "OrganizationConnection!", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for organizations with this setting.

", - "type": { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder" - } - }, - { - "name": "value", - "description": "

The setting value to find organizations for.

", - "type": { - "name": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "allowPrivateRepositoryForkingSettingPolicyValue", - "description": "

The value for the allow private repository forking policy on the enterprise.

", - "type": "EnterpriseAllowPrivateRepositoryForkingPolicyValue", - "id": "enterpriseallowprivaterepositoryforkingpolicyvalue", - "href": "/graphql/reference/enums#enterpriseallowprivaterepositoryforkingpolicyvalue" - }, - { - "name": "defaultRepositoryPermissionSetting", - "description": "

The setting value for base repository permissions for organizations in this enterprise.

", - "type": "EnterpriseDefaultRepositoryPermissionSettingValue!", - "id": "enterprisedefaultrepositorypermissionsettingvalue", - "href": "/graphql/reference/enums#enterprisedefaultrepositorypermissionsettingvalue" - }, - { - "name": "defaultRepositoryPermissionSettingOrganizations", - "description": "

A list of enterprise organizations configured with the provided base repository permission.

", - "type": "OrganizationConnection!", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for organizations with this setting.

", - "type": { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder" - } - }, - { - "name": "value", - "description": "

The permission to find organizations for.

", - "type": { - "name": "DefaultRepositoryPermissionField!", - "id": "defaultrepositorypermissionfield", - "href": "/graphql/reference/enums#defaultrepositorypermissionfield" - } - } - ] - }, - { - "name": "domains", - "description": "

A list of domains owned by the enterprise. Visible to enterprise owners or\nenterprise owners' personal access tokens (classic) with admin:enterprise scope.

", - "type": "VerifiableDomainConnection!", - "id": "verifiabledomainconnection", - "href": "/graphql/reference/objects#verifiabledomainconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "isApproved", - "description": "

Filter whether or not the domain is approved.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "isVerified", - "description": "

Filter whether or not the domain is verified.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for verifiable domains returned.

", - "type": { - "name": "VerifiableDomainOrder", - "id": "verifiabledomainorder", - "href": "/graphql/reference/input-objects#verifiabledomainorder" - } - } - ] - }, - { - "name": "failedInvitations", - "description": "

A list of failed invitations in the enterprise.

", - "type": "EnterpriseFailedInvitationConnection!", - "id": "enterprisefailedinvitationconnection", - "href": "/graphql/reference/objects#enterprisefailedinvitationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "query", - "description": "

The search string to look for.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "ipAllowListEnabledSetting", - "description": "

The setting value for whether the enterprise has an IP allow list enabled.

", - "type": "IpAllowListEnabledSettingValue!", - "id": "ipallowlistenabledsettingvalue", - "href": "/graphql/reference/enums#ipallowlistenabledsettingvalue" - }, - { - "name": "ipAllowListEntries", - "description": "

The IP addresses that are allowed to access resources owned by the enterprise.\nVisible to enterprise owners or enterprise owners' personal access tokens\n(classic) with admin:enterprise scope.

", - "type": "IpAllowListEntryConnection!", - "id": "ipallowlistentryconnection", - "href": "/graphql/reference/objects#ipallowlistentryconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for IP allow list entries returned.

", - "type": { - "name": "IpAllowListEntryOrder", - "id": "ipallowlistentryorder", - "href": "/graphql/reference/input-objects#ipallowlistentryorder" - } - } - ] - }, - { - "name": "ipAllowListForInstalledAppsEnabledSetting", - "description": "

The setting value for whether the enterprise has IP allow list configuration for installed GitHub Apps enabled.

", - "type": "IpAllowListForInstalledAppsEnabledSettingValue!", - "id": "ipallowlistforinstalledappsenabledsettingvalue", - "href": "/graphql/reference/enums#ipallowlistforinstalledappsenabledsettingvalue" - }, - { - "name": "isUpdatingDefaultRepositoryPermission", - "description": "

Whether or not the base repository permission is currently being updated.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isUpdatingTwoFactorRequirement", - "description": "

Whether the two-factor authentication requirement is currently being enforced.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "membersCanChangeRepositoryVisibilitySetting", - "description": "

The setting value for whether organization members with admin permissions on a\nrepository can change repository visibility.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - }, - { - "name": "membersCanChangeRepositoryVisibilitySettingOrganizations", - "description": "

A list of enterprise organizations configured with the provided can change repository visibility setting value.

", - "type": "OrganizationConnection!", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for organizations with this setting.

", - "type": { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder" - } - }, - { - "name": "value", - "description": "

The setting value to find organizations for.

", - "type": { - "name": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "membersCanCreateInternalRepositoriesSetting", - "description": "

The setting value for whether members of organizations in the enterprise can create internal repositories.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "membersCanCreatePrivateRepositoriesSetting", - "description": "

The setting value for whether members of organizations in the enterprise can create private repositories.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "membersCanCreatePublicRepositoriesSetting", - "description": "

The setting value for whether members of organizations in the enterprise can create public repositories.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "membersCanCreateRepositoriesSetting", - "description": "

The setting value for whether members of organizations in the enterprise can create repositories.

", - "type": "EnterpriseMembersCanCreateRepositoriesSettingValue", - "id": "enterprisememberscancreaterepositoriessettingvalue", - "href": "/graphql/reference/enums#enterprisememberscancreaterepositoriessettingvalue" - }, - { - "name": "membersCanCreateRepositoriesSettingOrganizations", - "description": "

A list of enterprise organizations configured with the provided repository creation setting value.

", - "type": "OrganizationConnection!", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for organizations with this setting.

", - "type": { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder" - } - }, - { - "name": "value", - "description": "

The setting to find organizations for.

", - "type": { - "name": "OrganizationMembersCanCreateRepositoriesSettingValue!", - "id": "organizationmemberscancreaterepositoriessettingvalue", - "href": "/graphql/reference/enums#organizationmemberscancreaterepositoriessettingvalue" - } - } - ] - }, - { - "name": "membersCanDeleteIssuesSetting", - "description": "

The setting value for whether members with admin permissions for repositories can delete issues.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - }, - { - "name": "membersCanDeleteIssuesSettingOrganizations", - "description": "

A list of enterprise organizations configured with the provided members can delete issues setting value.

", - "type": "OrganizationConnection!", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for organizations with this setting.

", - "type": { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder" - } - }, - { - "name": "value", - "description": "

The setting value to find organizations for.

", - "type": { - "name": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "membersCanDeleteRepositoriesSetting", - "description": "

The setting value for whether members with admin permissions for repositories can delete or transfer repositories.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - }, - { - "name": "membersCanDeleteRepositoriesSettingOrganizations", - "description": "

A list of enterprise organizations configured with the provided members can delete repositories setting value.

", - "type": "OrganizationConnection!", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for organizations with this setting.

", - "type": { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder" - } - }, - { - "name": "value", - "description": "

The setting value to find organizations for.

", - "type": { - "name": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "membersCanInviteCollaboratorsSetting", - "description": "

The setting value for whether members of organizations in the enterprise can invite outside collaborators.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - }, - { - "name": "membersCanInviteCollaboratorsSettingOrganizations", - "description": "

A list of enterprise organizations configured with the provided members can invite collaborators setting value.

", - "type": "OrganizationConnection!", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for organizations with this setting.

", - "type": { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder" - } - }, - { - "name": "value", - "description": "

The setting value to find organizations for.

", - "type": { - "name": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "membersCanMakePurchasesSetting", - "description": "

Indicates whether members of this enterprise's organizations can purchase additional services for those organizations.

", - "type": "EnterpriseMembersCanMakePurchasesSettingValue!", - "id": "enterprisememberscanmakepurchasessettingvalue", - "href": "/graphql/reference/enums#enterprisememberscanmakepurchasessettingvalue" - }, - { - "name": "membersCanUpdateProtectedBranchesSetting", - "description": "

The setting value for whether members with admin permissions for repositories can update protected branches.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - }, - { - "name": "membersCanUpdateProtectedBranchesSettingOrganizations", - "description": "

A list of enterprise organizations configured with the provided members can update protected branches setting value.

", - "type": "OrganizationConnection!", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for organizations with this setting.

", - "type": { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder" - } - }, - { - "name": "value", - "description": "

The setting value to find organizations for.

", - "type": { - "name": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "membersCanViewDependencyInsightsSetting", - "description": "

The setting value for whether members can view dependency insights.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - }, - { - "name": "membersCanViewDependencyInsightsSettingOrganizations", - "description": "

A list of enterprise organizations configured with the provided members can view dependency insights setting value.

", - "type": "OrganizationConnection!", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for organizations with this setting.

", - "type": { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder" - } - }, - { - "name": "value", - "description": "

The setting value to find organizations for.

", - "type": { - "name": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "notificationDeliveryRestrictionEnabledSetting", - "description": "

Indicates if email notification delivery for this enterprise is restricted to verified or approved domains.

", - "type": "NotificationRestrictionSettingValue!", - "id": "notificationrestrictionsettingvalue", - "href": "/graphql/reference/enums#notificationrestrictionsettingvalue" - }, - { - "name": "organizationProjectsSetting", - "description": "

The setting value for whether organization projects are enabled for organizations in this enterprise.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - }, - { - "name": "organizationProjectsSettingOrganizations", - "description": "

A list of enterprise organizations configured with the provided organization projects setting value.

", - "type": "OrganizationConnection!", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for organizations with this setting.

", - "type": { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder" - } - }, - { - "name": "value", - "description": "

The setting value to find organizations for.

", - "type": { - "name": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "outsideCollaborators", - "description": "

A list of outside collaborators across the repositories in the enterprise.

", - "type": "EnterpriseOutsideCollaboratorConnection!", - "id": "enterpriseoutsidecollaboratorconnection", - "href": "/graphql/reference/objects#enterpriseoutsidecollaboratorconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "hasTwoFactorEnabled", - "description": "

Only return outside collaborators with this two-factor authentication status.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "login", - "description": "

The login of one specific outside collaborator.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for outside collaborators returned from the connection.

", - "type": { - "name": "EnterpriseMemberOrder", - "id": "enterprisememberorder", - "href": "/graphql/reference/input-objects#enterprisememberorder" - } - }, - { - "name": "organizationLogins", - "description": "

Only return outside collaborators within the organizations with these logins.

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "query", - "description": "

The search string to look for.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "visibility", - "description": "

Only return outside collaborators on repositories with this visibility.

", - "type": { - "name": "RepositoryVisibility", - "id": "repositoryvisibility", - "href": "/graphql/reference/enums#repositoryvisibility" - } - } - ] - }, - { - "name": "pendingAdminInvitations", - "description": "

A list of pending administrator invitations for the enterprise.

", - "type": "EnterpriseAdministratorInvitationConnection!", - "id": "enterpriseadministratorinvitationconnection", - "href": "/graphql/reference/objects#enterpriseadministratorinvitationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for pending enterprise administrator invitations returned from the connection.

", - "type": { - "name": "EnterpriseAdministratorInvitationOrder", - "id": "enterpriseadministratorinvitationorder", - "href": "/graphql/reference/input-objects#enterpriseadministratorinvitationorder" - } - }, - { - "name": "query", - "description": "

The search string to look for.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "role", - "description": "

The role to filter by.

", - "type": { - "name": "EnterpriseAdministratorRole", - "id": "enterpriseadministratorrole", - "href": "/graphql/reference/enums#enterpriseadministratorrole" - } - } - ] - }, - { - "name": "pendingCollaboratorInvitations", - "description": "

A list of pending collaborator invitations across the repositories in the enterprise.

", - "type": "RepositoryInvitationConnection!", - "id": "repositoryinvitationconnection", - "href": "/graphql/reference/objects#repositoryinvitationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for pending repository collaborator invitations returned from the connection.

", - "type": { - "name": "RepositoryInvitationOrder", - "id": "repositoryinvitationorder", - "href": "/graphql/reference/input-objects#repositoryinvitationorder" - } - }, - { - "name": "query", - "description": "

The search string to look for.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "pendingMemberInvitations", - "description": "

A list of pending member invitations for organizations in the enterprise.

", - "type": "EnterprisePendingMemberInvitationConnection!", - "id": "enterprisependingmemberinvitationconnection", - "href": "/graphql/reference/objects#enterprisependingmemberinvitationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "invitationSource", - "description": "

Only return invitations matching this invitation source.

", - "type": { - "name": "OrganizationInvitationSource", - "id": "organizationinvitationsource", - "href": "/graphql/reference/enums#organizationinvitationsource" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "organizationLogins", - "description": "

Only return invitations within the organizations with these logins.

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "query", - "description": "

The search string to look for.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "repositoryProjectsSetting", - "description": "

The setting value for whether repository projects are enabled in this enterprise.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - }, - { - "name": "repositoryProjectsSettingOrganizations", - "description": "

A list of enterprise organizations configured with the provided repository projects setting value.

", - "type": "OrganizationConnection!", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for organizations with this setting.

", - "type": { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder" - } - }, - { - "name": "value", - "description": "

The setting value to find organizations for.

", - "type": { - "name": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "samlIdentityProvider", - "description": "

The SAML Identity Provider for the enterprise.

", - "type": "EnterpriseIdentityProvider", - "id": "enterpriseidentityprovider", - "href": "/graphql/reference/objects#enterpriseidentityprovider" - }, - { - "name": "samlIdentityProviderSettingOrganizations", - "description": "

A list of enterprise organizations configured with the SAML single sign-on setting value.

", - "type": "OrganizationConnection!", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for organizations with this setting.

", - "type": { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder" - } - }, - { - "name": "value", - "description": "

The setting value to find organizations for.

", - "type": { - "name": "IdentityProviderConfigurationState!", - "id": "identityproviderconfigurationstate", - "href": "/graphql/reference/enums#identityproviderconfigurationstate" - } - } - ] - }, - { - "name": "teamDiscussionsSetting", - "description": "

The setting value for whether team discussions are enabled for organizations in this enterprise.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - }, - { - "name": "teamDiscussionsSettingOrganizations", - "description": "

A list of enterprise organizations configured with the provided team discussions setting value.

", - "type": "OrganizationConnection!", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for organizations with this setting.

", - "type": { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder" - } - }, - { - "name": "value", - "description": "

The setting value to find organizations for.

", - "type": { - "name": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "twoFactorRequiredSetting", - "description": "

The setting value for whether the enterprise requires two-factor authentication for its organizations and users.

", - "type": "EnterpriseEnabledSettingValue!", - "id": "enterpriseenabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenabledsettingvalue" - }, - { - "name": "twoFactorRequiredSettingOrganizations", - "description": "

A list of enterprise organizations configured with the two-factor authentication setting value.

", - "type": "OrganizationConnection!", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for organizations with this setting.

", - "type": { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder" - } - }, - { - "name": "value", - "description": "

The setting value to find organizations for.

", - "type": { - "name": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - } - ] - }, - { - "name": "EnterprisePendingMemberInvitationConnection", - "id": "enterprisependingmemberinvitationconnection", - "href": "/graphql/reference/objects#enterprisependingmemberinvitationconnection", - "description": "

The connection type for OrganizationInvitation.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[EnterprisePendingMemberInvitationEdge]", - "id": "enterprisependingmemberinvitationedge", - "href": "/graphql/reference/objects#enterprisependingmemberinvitationedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[OrganizationInvitation]", - "id": "organizationinvitation", - "href": "/graphql/reference/objects#organizationinvitation" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "totalUniqueUserCount", - "description": "

Identifies the total count of unique users in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "EnterprisePendingMemberInvitationEdge", - "id": "enterprisependingmemberinvitationedge", - "href": "/graphql/reference/objects#enterprisependingmemberinvitationedge", - "description": "

An invitation to be a member in an enterprise organization.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "OrganizationInvitation", - "id": "organizationinvitation", - "href": "/graphql/reference/objects#organizationinvitation" - } - ] - }, - { - "name": "EnterpriseRepositoryInfo", - "id": "enterpriserepositoryinfo", - "href": "/graphql/reference/objects#enterpriserepositoryinfo", - "description": "

A subset of repository information queryable from an enterprise.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "id", - "description": "

The Node ID of the EnterpriseRepositoryInfo object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isPrivate", - "description": "

Identifies if the repository is private or internal.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "name", - "description": "

The repository's name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "nameWithOwner", - "description": "

The repository's name with owner.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "EnterpriseRepositoryInfoConnection", - "id": "enterpriserepositoryinfoconnection", - "href": "/graphql/reference/objects#enterpriserepositoryinfoconnection", - "description": "

The connection type for EnterpriseRepositoryInfo.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[EnterpriseRepositoryInfoEdge]", - "id": "enterpriserepositoryinfoedge", - "href": "/graphql/reference/objects#enterpriserepositoryinfoedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[EnterpriseRepositoryInfo]", - "id": "enterpriserepositoryinfo", - "href": "/graphql/reference/objects#enterpriserepositoryinfo" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "EnterpriseRepositoryInfoEdge", - "id": "enterpriserepositoryinfoedge", - "href": "/graphql/reference/objects#enterpriserepositoryinfoedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "EnterpriseRepositoryInfo", - "id": "enterpriserepositoryinfo", - "href": "/graphql/reference/objects#enterpriserepositoryinfo" - } - ] - }, - { - "name": "EnterpriseServerInstallation", - "id": "enterpriseserverinstallation", - "href": "/graphql/reference/objects#enterpriseserverinstallation", - "description": "

An Enterprise Server installation.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "customerName", - "description": "

The customer name to which the Enterprise Server installation belongs.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "hostName", - "description": "

The host name of the Enterprise Server installation.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the EnterpriseServerInstallation object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isConnected", - "description": "

Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "userAccounts", - "description": "

User accounts on this Enterprise Server installation.

", - "type": "EnterpriseServerUserAccountConnection!", - "id": "enterpriseserveruseraccountconnection", - "href": "/graphql/reference/objects#enterpriseserveruseraccountconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for Enterprise Server user accounts returned from the connection.

", - "type": { - "name": "EnterpriseServerUserAccountOrder", - "id": "enterpriseserveruseraccountorder", - "href": "/graphql/reference/input-objects#enterpriseserveruseraccountorder" - } - } - ] - }, - { - "name": "userAccountsUploads", - "description": "

User accounts uploads for the Enterprise Server installation.

", - "type": "EnterpriseServerUserAccountsUploadConnection!", - "id": "enterpriseserveruseraccountsuploadconnection", - "href": "/graphql/reference/objects#enterpriseserveruseraccountsuploadconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for Enterprise Server user accounts uploads returned from the connection.

", - "type": { - "name": "EnterpriseServerUserAccountsUploadOrder", - "id": "enterpriseserveruseraccountsuploadorder", - "href": "/graphql/reference/input-objects#enterpriseserveruseraccountsuploadorder" - } - } - ] - } - ] - }, - { - "name": "EnterpriseServerInstallationMembershipConnection", - "id": "enterpriseserverinstallationmembershipconnection", - "href": "/graphql/reference/objects#enterpriseserverinstallationmembershipconnection", - "description": "

The connection type for EnterpriseServerInstallation.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[EnterpriseServerInstallationMembershipEdge]", - "id": "enterpriseserverinstallationmembershipedge", - "href": "/graphql/reference/objects#enterpriseserverinstallationmembershipedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[EnterpriseServerInstallation]", - "id": "enterpriseserverinstallation", - "href": "/graphql/reference/objects#enterpriseserverinstallation" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "EnterpriseServerInstallationMembershipEdge", - "id": "enterpriseserverinstallationmembershipedge", - "href": "/graphql/reference/objects#enterpriseserverinstallationmembershipedge", - "description": "

An Enterprise Server installation that a user is a member of.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "EnterpriseServerInstallation", - "id": "enterpriseserverinstallation", - "href": "/graphql/reference/objects#enterpriseserverinstallation" - }, - { - "name": "role", - "description": "

The role of the user in the enterprise membership.

", - "type": "EnterpriseUserAccountMembershipRole!", - "id": "enterpriseuseraccountmembershiprole", - "href": "/graphql/reference/enums#enterpriseuseraccountmembershiprole" - } - ] - }, - { - "name": "EnterpriseServerUserAccount", - "id": "enterpriseserveruseraccount", - "href": "/graphql/reference/objects#enterpriseserveruseraccount", - "description": "

A user account on an Enterprise Server installation.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "emails", - "description": "

User emails belonging to this user account.

", - "type": "EnterpriseServerUserAccountEmailConnection!", - "id": "enterpriseserveruseraccountemailconnection", - "href": "/graphql/reference/objects#enterpriseserveruseraccountemailconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for Enterprise Server user account emails returned from the connection.

", - "type": { - "name": "EnterpriseServerUserAccountEmailOrder", - "id": "enterpriseserveruseraccountemailorder", - "href": "/graphql/reference/input-objects#enterpriseserveruseraccountemailorder" - } - } - ] - }, - { - "name": "enterpriseServerInstallation", - "description": "

The Enterprise Server installation on which this user account exists.

", - "type": "EnterpriseServerInstallation!", - "id": "enterpriseserverinstallation", - "href": "/graphql/reference/objects#enterpriseserverinstallation" - }, - { - "name": "id", - "description": "

The Node ID of the EnterpriseServerUserAccount object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isSiteAdmin", - "description": "

Whether the user account is a site administrator on the Enterprise Server installation.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "login", - "description": "

The login of the user account on the Enterprise Server installation.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "profileName", - "description": "

The profile name of the user account on the Enterprise Server installation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "remoteCreatedAt", - "description": "

The date and time when the user account was created on the Enterprise Server installation.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "remoteUserId", - "description": "

The ID of the user account on the Enterprise Server installation.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "EnterpriseServerUserAccountConnection", - "id": "enterpriseserveruseraccountconnection", - "href": "/graphql/reference/objects#enterpriseserveruseraccountconnection", - "description": "

The connection type for EnterpriseServerUserAccount.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[EnterpriseServerUserAccountEdge]", - "id": "enterpriseserveruseraccountedge", - "href": "/graphql/reference/objects#enterpriseserveruseraccountedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[EnterpriseServerUserAccount]", - "id": "enterpriseserveruseraccount", - "href": "/graphql/reference/objects#enterpriseserveruseraccount" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "EnterpriseServerUserAccountEdge", - "id": "enterpriseserveruseraccountedge", - "href": "/graphql/reference/objects#enterpriseserveruseraccountedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "EnterpriseServerUserAccount", - "id": "enterpriseserveruseraccount", - "href": "/graphql/reference/objects#enterpriseserveruseraccount" - } - ] - }, - { - "name": "EnterpriseServerUserAccountEmail", - "id": "enterpriseserveruseraccountemail", - "href": "/graphql/reference/objects#enterpriseserveruseraccountemail", - "description": "

An email belonging to a user account on an Enterprise Server installation.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "email", - "description": "

The email address.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the EnterpriseServerUserAccountEmail object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isPrimary", - "description": "

Indicates whether this is the primary email of the associated user account.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "userAccount", - "description": "

The user account to which the email belongs.

", - "type": "EnterpriseServerUserAccount!", - "id": "enterpriseserveruseraccount", - "href": "/graphql/reference/objects#enterpriseserveruseraccount" - } - ] - }, - { - "name": "EnterpriseServerUserAccountEmailConnection", - "id": "enterpriseserveruseraccountemailconnection", - "href": "/graphql/reference/objects#enterpriseserveruseraccountemailconnection", - "description": "

The connection type for EnterpriseServerUserAccountEmail.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[EnterpriseServerUserAccountEmailEdge]", - "id": "enterpriseserveruseraccountemailedge", - "href": "/graphql/reference/objects#enterpriseserveruseraccountemailedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[EnterpriseServerUserAccountEmail]", - "id": "enterpriseserveruseraccountemail", - "href": "/graphql/reference/objects#enterpriseserveruseraccountemail" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "EnterpriseServerUserAccountEmailEdge", - "id": "enterpriseserveruseraccountemailedge", - "href": "/graphql/reference/objects#enterpriseserveruseraccountemailedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "EnterpriseServerUserAccountEmail", - "id": "enterpriseserveruseraccountemail", - "href": "/graphql/reference/objects#enterpriseserveruseraccountemail" - } - ] - }, - { - "name": "EnterpriseServerUserAccountsUpload", - "id": "enterpriseserveruseraccountsupload", - "href": "/graphql/reference/objects#enterpriseserveruseraccountsupload", - "description": "

A user accounts upload from an Enterprise Server installation.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "enterprise", - "description": "

The enterprise to which this upload belongs.

", - "type": "Enterprise!", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise" - }, - { - "name": "enterpriseServerInstallation", - "description": "

The Enterprise Server installation for which this upload was generated.

", - "type": "EnterpriseServerInstallation!", - "id": "enterpriseserverinstallation", - "href": "/graphql/reference/objects#enterpriseserverinstallation" - }, - { - "name": "id", - "description": "

The Node ID of the EnterpriseServerUserAccountsUpload object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "name", - "description": "

The name of the file uploaded.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "syncState", - "description": "

The synchronization state of the upload.

", - "type": "EnterpriseServerUserAccountsUploadSyncState!", - "id": "enterpriseserveruseraccountsuploadsyncstate", - "href": "/graphql/reference/enums#enterpriseserveruseraccountsuploadsyncstate" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "EnterpriseServerUserAccountsUploadConnection", - "id": "enterpriseserveruseraccountsuploadconnection", - "href": "/graphql/reference/objects#enterpriseserveruseraccountsuploadconnection", - "description": "

The connection type for EnterpriseServerUserAccountsUpload.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[EnterpriseServerUserAccountsUploadEdge]", - "id": "enterpriseserveruseraccountsuploadedge", - "href": "/graphql/reference/objects#enterpriseserveruseraccountsuploadedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[EnterpriseServerUserAccountsUpload]", - "id": "enterpriseserveruseraccountsupload", - "href": "/graphql/reference/objects#enterpriseserveruseraccountsupload" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "EnterpriseServerUserAccountsUploadEdge", - "id": "enterpriseserveruseraccountsuploadedge", - "href": "/graphql/reference/objects#enterpriseserveruseraccountsuploadedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "EnterpriseServerUserAccountsUpload", - "id": "enterpriseserveruseraccountsupload", - "href": "/graphql/reference/objects#enterpriseserveruseraccountsupload" - } - ] - }, - { - "name": "EnterpriseUserAccount", - "id": "enterpriseuseraccount", - "href": "/graphql/reference/objects#enterpriseuseraccount", - "description": "

An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations.

", - "implements": [ - { - "name": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "avatarUrl", - "description": "

A URL pointing to the enterprise user account's public avatar.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "arguments": [ - { - "name": "size", - "description": "

The size of the resulting square image.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "enterprise", - "description": "

The enterprise in which this user account exists.

", - "type": "Enterprise!", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise" - }, - { - "name": "enterpriseInstallations", - "description": "

A list of Enterprise Server installations this user is a member of.

", - "type": "EnterpriseServerInstallationMembershipConnection!", - "id": "enterpriseserverinstallationmembershipconnection", - "href": "/graphql/reference/objects#enterpriseserverinstallationmembershipconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for installations returned from the connection.

", - "type": { - "name": "EnterpriseServerInstallationOrder", - "id": "enterpriseserverinstallationorder", - "href": "/graphql/reference/input-objects#enterpriseserverinstallationorder" - } - }, - { - "name": "query", - "description": "

The search string to look for.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "role", - "description": "

The role of the user in the installation.

", - "type": { - "name": "EnterpriseUserAccountMembershipRole", - "id": "enterpriseuseraccountmembershiprole", - "href": "/graphql/reference/enums#enterpriseuseraccountmembershiprole" - } - } - ] - }, - { - "name": "id", - "description": "

The Node ID of the EnterpriseUserAccount object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "login", - "description": "

An identifier for the enterprise user account, a login or email address.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The name of the enterprise user account.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizations", - "description": "

A list of enterprise organizations this user is a member of.

", - "type": "EnterpriseOrganizationMembershipConnection!", - "id": "enterpriseorganizationmembershipconnection", - "href": "/graphql/reference/objects#enterpriseorganizationmembershipconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for organizations returned from the connection.

", - "type": { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder" - } - }, - { - "name": "query", - "description": "

The search string to look for.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "role", - "description": "

The role of the user in the enterprise organization.

", - "type": { - "name": "EnterpriseUserAccountMembershipRole", - "id": "enterpriseuseraccountmembershiprole", - "href": "/graphql/reference/enums#enterpriseuseraccountmembershiprole" - } - } - ] - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this user.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this user.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user within the enterprise.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "Environment", - "id": "environment", - "href": "/graphql/reference/objects#environment", - "description": "

An environment.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the Environment object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isPinned", - "description": "

Indicates whether or not this environment is currently pinned to the repository.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "latestCompletedDeployment", - "description": "

The latest completed deployment with status success, failure, or error if it exists.

", - "type": "Deployment", - "id": "deployment", - "href": "/graphql/reference/objects#deployment" - }, - { - "name": "name", - "description": "

The name of the environment.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pinnedPosition", - "description": "

The position of the environment if it is pinned, null if it is not pinned.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "protectionRules", - "description": "

The protection rules defined for this environment.

", - "type": "DeploymentProtectionRuleConnection!", - "id": "deploymentprotectionruleconnection", - "href": "/graphql/reference/objects#deploymentprotectionruleconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - } - ] - }, - { - "name": "EnvironmentConnection", - "id": "environmentconnection", - "href": "/graphql/reference/objects#environmentconnection", - "description": "

The connection type for Environment.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[EnvironmentEdge]", - "id": "environmentedge", - "href": "/graphql/reference/objects#environmentedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Environment]", - "id": "environment", - "href": "/graphql/reference/objects#environment" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "EnvironmentEdge", - "id": "environmentedge", - "href": "/graphql/reference/objects#environmentedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Environment", - "id": "environment", - "href": "/graphql/reference/objects#environment" - } - ] - }, - { - "name": "ExternalIdentity", - "id": "externalidentity", - "href": "/graphql/reference/objects#externalidentity", - "description": "

An external identity provisioned by SAML SSO or SCIM. If SAML is configured on\nthe organization, the external identity is visible to (1) organization owners,\n(2) organization owners' personal access tokens (classic) with read:org or\nadmin:org scope, (3) GitHub App with an installation token with read or write\naccess to members. If SAML is configured on the enterprise, the external\nidentity is visible to (1) enterprise owners, (2) enterprise owners' personal\naccess tokens (classic) with read:enterprise or admin:enterprise scope.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "guid", - "description": "

The GUID for this identity.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the ExternalIdentity object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "organizationInvitation", - "description": "

Organization invitation for this SCIM-provisioned external identity.

", - "type": "OrganizationInvitation", - "id": "organizationinvitation", - "href": "/graphql/reference/objects#organizationinvitation" - }, - { - "name": "samlIdentity", - "description": "

SAML Identity attributes.

", - "type": "ExternalIdentitySamlAttributes", - "id": "externalidentitysamlattributes", - "href": "/graphql/reference/objects#externalidentitysamlattributes" - }, - { - "name": "scimIdentity", - "description": "

SCIM Identity attributes.

", - "type": "ExternalIdentityScimAttributes", - "id": "externalidentityscimattributes", - "href": "/graphql/reference/objects#externalidentityscimattributes" - }, - { - "name": "user", - "description": "

User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "ExternalIdentityAttribute", - "id": "externalidentityattribute", - "href": "/graphql/reference/objects#externalidentityattribute", - "description": "

An attribute for the External Identity attributes collection.

", - "fields": [ - { - "name": "metadata", - "description": "

The attribute metadata as JSON.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The attribute name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "value", - "description": "

The attribute value.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "ExternalIdentityConnection", - "id": "externalidentityconnection", - "href": "/graphql/reference/objects#externalidentityconnection", - "description": "

The connection type for ExternalIdentity.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ExternalIdentityEdge]", - "id": "externalidentityedge", - "href": "/graphql/reference/objects#externalidentityedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[ExternalIdentity]", - "id": "externalidentity", - "href": "/graphql/reference/objects#externalidentity" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ExternalIdentityEdge", - "id": "externalidentityedge", - "href": "/graphql/reference/objects#externalidentityedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "ExternalIdentity", - "id": "externalidentity", - "href": "/graphql/reference/objects#externalidentity" - } - ] - }, - { - "name": "ExternalIdentitySamlAttributes", - "id": "externalidentitysamlattributes", - "href": "/graphql/reference/objects#externalidentitysamlattributes", - "description": "

SAML attributes for the External Identity.

", - "fields": [ - { - "name": "attributes", - "description": "

SAML Identity attributes.

", - "type": "[ExternalIdentityAttribute!]!", - "id": "externalidentityattribute", - "href": "/graphql/reference/objects#externalidentityattribute" - }, - { - "name": "emails", - "description": "

The emails associated with the SAML identity.

", - "type": "[UserEmailMetadata!]", - "id": "useremailmetadata", - "href": "/graphql/reference/objects#useremailmetadata" - }, - { - "name": "familyName", - "description": "

Family name of the SAML identity.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "givenName", - "description": "

Given name of the SAML identity.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "groups", - "description": "

The groups linked to this identity in IDP.

", - "type": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "nameId", - "description": "

The NameID of the SAML identity.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "username", - "description": "

The userName of the SAML identity.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "ExternalIdentityScimAttributes", - "id": "externalidentityscimattributes", - "href": "/graphql/reference/objects#externalidentityscimattributes", - "description": "

SCIM attributes for the External Identity.

", - "fields": [ - { - "name": "emails", - "description": "

The emails associated with the SCIM identity.

", - "type": "[UserEmailMetadata!]", - "id": "useremailmetadata", - "href": "/graphql/reference/objects#useremailmetadata" - }, - { - "name": "familyName", - "description": "

Family name of the SCIM identity.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "givenName", - "description": "

Given name of the SCIM identity.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "groups", - "description": "

The groups linked to this identity in IDP.

", - "type": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "username", - "description": "

The userName of the SCIM identity.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "FileExtensionRestrictionParameters", - "id": "fileextensionrestrictionparameters", - "href": "/graphql/reference/objects#fileextensionrestrictionparameters", - "description": "

Prevent commits that include files with specified file extensions from being\npushed to the commit graph. NOTE: This rule is in beta and subject to change.

", - "fields": [ - { - "name": "restrictedFileExtensions", - "description": "

The file extensions that are restricted from being pushed to the commit graph.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "FilePathRestrictionParameters", - "id": "filepathrestrictionparameters", - "href": "/graphql/reference/objects#filepathrestrictionparameters", - "description": "

Prevent commits that include changes in specified file paths from being pushed\nto the commit graph. NOTE: This rule is in beta and subject to change.

", - "fields": [ - { - "name": "restrictedFilePaths", - "description": "

The file paths that are restricted from being pushed to the commit graph.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "FollowerConnection", - "id": "followerconnection", - "href": "/graphql/reference/objects#followerconnection", - "description": "

The connection type for User.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[UserEdge]", - "id": "useredge", - "href": "/graphql/reference/objects#useredge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[User]", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "FollowingConnection", - "id": "followingconnection", - "href": "/graphql/reference/objects#followingconnection", - "description": "

The connection type for User.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[UserEdge]", - "id": "useredge", - "href": "/graphql/reference/objects#useredge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[User]", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "GenericHovercardContext", - "id": "generichovercardcontext", - "href": "/graphql/reference/objects#generichovercardcontext", - "description": "

A generic hovercard context with a message and icon.

", - "implements": [ - { - "name": "HovercardContext", - "id": "hovercardcontext", - "href": "/graphql/reference/interfaces#hovercardcontext" - } - ], - "fields": [ - { - "name": "message", - "description": "

A string describing this context.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "octicon", - "description": "

An octicon to accompany this context.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "Gist", - "id": "gist", - "href": "/graphql/reference/objects#gist", - "description": "

A Gist.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "Starrable", - "id": "starrable", - "href": "/graphql/reference/interfaces#starrable" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "comments", - "description": "

A list of comments associated with the gist.

", - "type": "GistCommentConnection!", - "id": "gistcommentconnection", - "href": "/graphql/reference/objects#gistcommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "description", - "description": "

The gist description.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "files", - "description": "

The files in this gist.

", - "type": "[GistFile]", - "id": "gistfile", - "href": "/graphql/reference/objects#gistfile", - "arguments": [ - { - "name": "limit", - "defaultValue": "10", - "description": "

The maximum number of files to return.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "oid", - "description": "

The oid of the files to return.

", - "type": { - "name": "GitObjectID", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - } - } - ] - }, - { - "name": "forks", - "description": "

A list of forks associated with the gist.

", - "type": "GistConnection!", - "id": "gistconnection", - "href": "/graphql/reference/objects#gistconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for gists returned from the connection.

", - "type": { - "name": "GistOrder", - "id": "gistorder", - "href": "/graphql/reference/input-objects#gistorder" - } - } - ] - }, - { - "name": "id", - "description": "

The Node ID of the Gist object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isFork", - "description": "

Identifies if the gist is a fork.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isPublic", - "description": "

Whether the gist is public or not.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "name", - "description": "

The gist name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "owner", - "description": "

The gist owner.

", - "type": "RepositoryOwner", - "id": "repositoryowner", - "href": "/graphql/reference/interfaces#repositoryowner" - }, - { - "name": "pushedAt", - "description": "

Identifies when the gist was last pushed to.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "resourcePath", - "description": "

The HTML path to this resource.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "stargazerCount", - "description": "

Returns a count of how many stargazers there are on this object.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "stargazers", - "description": "

A list of users who have starred this starrable.

", - "type": "StargazerConnection!", - "id": "stargazerconnection", - "href": "/graphql/reference/objects#stargazerconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Order for connection.

", - "type": { - "name": "StarOrder", - "id": "starorder", - "href": "/graphql/reference/input-objects#starorder" - } - } - ] - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this Gist.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "viewerHasStarred", - "description": "

Returns a boolean indicating whether the viewing user has starred this starrable.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "GistComment", - "id": "gistcomment", - "href": "/graphql/reference/objects#gistcomment", - "description": "

Represents a comment on an Gist.

", - "implements": [ - { - "name": "Comment", - "id": "comment", - "href": "/graphql/reference/interfaces#comment" - }, - { - "name": "Deletable", - "id": "deletable", - "href": "/graphql/reference/interfaces#deletable" - }, - { - "name": "Minimizable", - "id": "minimizable", - "href": "/graphql/reference/interfaces#minimizable" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "Updatable", - "id": "updatable", - "href": "/graphql/reference/interfaces#updatable" - }, - { - "name": "UpdatableComment", - "id": "updatablecomment", - "href": "/graphql/reference/interfaces#updatablecomment" - } - ], - "fields": [ - { - "name": "author", - "description": "

The actor who authored the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "authorAssociation", - "description": "

Author's association with the gist.

", - "type": "CommentAuthorAssociation!", - "id": "commentauthorassociation", - "href": "/graphql/reference/enums#commentauthorassociation" - }, - { - "name": "body", - "description": "

Identifies the comment body.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyHTML", - "description": "

The body rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "bodyText", - "description": "

The body rendered to text.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "createdViaEmail", - "description": "

Check if this comment was created via an email reply.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "editor", - "description": "

The actor who edited the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "gist", - "description": "

The associated gist.

", - "type": "Gist!", - "id": "gist", - "href": "/graphql/reference/objects#gist" - }, - { - "name": "id", - "description": "

The Node ID of the GistComment object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "includesCreatedEdit", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isMinimized", - "description": "

Returns whether or not a comment has been minimized.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "lastEditedAt", - "description": "

The moment the editor made the last edit.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "minimizedReason", - "description": "

Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "publishedAt", - "description": "

Identifies when the comment was published at.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "userContentEdits", - "description": "

A list of edits to this content.

", - "type": "UserContentEditConnection", - "id": "usercontenteditconnection", - "href": "/graphql/reference/objects#usercontenteditconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "viewerCanDelete", - "description": "

Check if the current viewer can delete this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanMinimize", - "description": "

Check if the current viewer can minimize this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUpdate", - "description": "

Check if the current viewer can update this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCannotUpdateReasons", - "description": "

Reasons why the current viewer can not update this comment.

", - "type": "[CommentCannotUpdateReason!]!", - "id": "commentcannotupdatereason", - "href": "/graphql/reference/enums#commentcannotupdatereason" - }, - { - "name": "viewerDidAuthor", - "description": "

Did the viewer author this comment.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "GistCommentConnection", - "id": "gistcommentconnection", - "href": "/graphql/reference/objects#gistcommentconnection", - "description": "

The connection type for GistComment.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[GistCommentEdge]", - "id": "gistcommentedge", - "href": "/graphql/reference/objects#gistcommentedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[GistComment]", - "id": "gistcomment", - "href": "/graphql/reference/objects#gistcomment" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "GistCommentEdge", - "id": "gistcommentedge", - "href": "/graphql/reference/objects#gistcommentedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "GistComment", - "id": "gistcomment", - "href": "/graphql/reference/objects#gistcomment" - } - ] - }, - { - "name": "GistConnection", - "id": "gistconnection", - "href": "/graphql/reference/objects#gistconnection", - "description": "

The connection type for Gist.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[GistEdge]", - "id": "gistedge", - "href": "/graphql/reference/objects#gistedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Gist]", - "id": "gist", - "href": "/graphql/reference/objects#gist" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "GistEdge", - "id": "gistedge", - "href": "/graphql/reference/objects#gistedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Gist", - "id": "gist", - "href": "/graphql/reference/objects#gist" - } - ] - }, - { - "name": "GistFile", - "id": "gistfile", - "href": "/graphql/reference/objects#gistfile", - "description": "

A file in a gist.

", - "fields": [ - { - "name": "encodedName", - "description": "

The file name encoded to remove characters that are invalid in URL paths.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "encoding", - "description": "

The gist file encoding.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "extension", - "description": "

The file extension from the file name.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "isImage", - "description": "

Indicates if this file is an image.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isTruncated", - "description": "

Whether the file's contents were truncated.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "language", - "description": "

The programming language this file is written in.

", - "type": "Language", - "id": "language", - "href": "/graphql/reference/objects#language" - }, - { - "name": "name", - "description": "

The gist file name.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "size", - "description": "

The gist file size in bytes.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "text", - "description": "

UTF8 text data or null if the file is binary.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string", - "arguments": [ - { - "name": "truncate", - "description": "

Optionally truncate the returned file to this length.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - } - ] - }, - { - "name": "GitActor", - "id": "gitactor", - "href": "/graphql/reference/objects#gitactor", - "description": "

Represents an actor in a Git commit (ie. an author or committer).

", - "fields": [ - { - "name": "avatarUrl", - "description": "

A URL pointing to the author's public avatar.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "arguments": [ - { - "name": "size", - "description": "

The size of the resulting square image.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "date", - "description": "

The timestamp of the Git action (authoring or committing).

", - "type": "GitTimestamp", - "id": "gittimestamp", - "href": "/graphql/reference/scalars#gittimestamp" - }, - { - "name": "email", - "description": "

The email in the Git commit.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The name in the Git commit.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "user", - "description": "

The GitHub user corresponding to the email field. Null if no such user exists.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "GitActorConnection", - "id": "gitactorconnection", - "href": "/graphql/reference/objects#gitactorconnection", - "description": "

The connection type for GitActor.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[GitActorEdge]", - "id": "gitactoredge", - "href": "/graphql/reference/objects#gitactoredge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[GitActor]", - "id": "gitactor", - "href": "/graphql/reference/objects#gitactor" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "GitActorEdge", - "id": "gitactoredge", - "href": "/graphql/reference/objects#gitactoredge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "GitActor", - "id": "gitactor", - "href": "/graphql/reference/objects#gitactor" - } - ] - }, - { - "name": "GitHubMetadata", - "id": "githubmetadata", - "href": "/graphql/reference/objects#githubmetadata", - "description": "

Represents information about the GitHub instance.

", - "fields": [ - { - "name": "gitHubServicesSha", - "description": "

Returns a String that's a SHA of github-services.

", - "type": "GitObjectID!", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "isPasswordAuthenticationVerifiable", - "description": "

Whether or not users are verified.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "GpgSignature", - "id": "gpgsignature", - "href": "/graphql/reference/objects#gpgsignature", - "description": "

Represents a GPG signature on a Commit or Tag.

", - "implements": [ - { - "name": "GitSignature", - "id": "gitsignature", - "href": "/graphql/reference/interfaces#gitsignature" - } - ], - "fields": [ - { - "name": "email", - "description": "

Email used to sign this object.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "isValid", - "description": "

True if the signature is valid and verified by GitHub.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "keyId", - "description": "

Hex-encoded ID of the key that signed this object.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "payload", - "description": "

Payload for GPG signing object. Raw ODB object without the signature header.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "signature", - "description": "

ASCII-armored signature header from object.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "signer", - "description": "

GitHub user corresponding to the email signing this commit.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "state", - "description": "

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

", - "type": "GitSignatureState!", - "id": "gitsignaturestate", - "href": "/graphql/reference/enums#gitsignaturestate" - }, - { - "name": "wasSignedByGitHub", - "description": "

True if the signature was made with GitHub's signing key.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "HeadRefDeletedEvent", - "id": "headrefdeletedevent", - "href": "/graphql/reference/objects#headrefdeletedevent", - "description": "

Represents ahead_ref_deletedevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "headRef", - "description": "

Identifies the Ref associated with the head_ref_deleted event.

", - "type": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref" - }, - { - "name": "headRefName", - "description": "

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

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the HeadRefDeletedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "HeadRefForcePushedEvent", - "id": "headrefforcepushedevent", - "href": "/graphql/reference/objects#headrefforcepushedevent", - "description": "

Represents ahead_ref_force_pushedevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "afterCommit", - "description": "

Identifies the after commit SHA for thehead_ref_force_pushedevent.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "beforeCommit", - "description": "

Identifies the before commit SHA for thehead_ref_force_pushedevent.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the HeadRefForcePushedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "ref", - "description": "

Identifies the fully qualified ref name for thehead_ref_force_pushedevent.

", - "type": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref" - } - ] - }, - { - "name": "HeadRefRestoredEvent", - "id": "headrefrestoredevent", - "href": "/graphql/reference/objects#headrefrestoredevent", - "description": "

Represents ahead_ref_restoredevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the HeadRefRestoredEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "Hovercard", - "id": "hovercard", - "href": "/graphql/reference/objects#hovercard", - "description": "

Detail needed to display a hovercard for a user.

", - "fields": [ - { - "name": "contexts", - "description": "

Each of the contexts for this hovercard.

", - "type": "[HovercardContext!]!", - "id": "hovercardcontext", - "href": "/graphql/reference/interfaces#hovercardcontext" - } - ] - }, - { - "name": "IpAllowListEntry", - "id": "ipallowlistentry", - "href": "/graphql/reference/objects#ipallowlistentry", - "description": "

An IP address or range of addresses that is allowed to access an owner's resources.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "allowListValue", - "description": "

A single IP address or range of IP addresses in CIDR notation.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the IpAllowListEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isActive", - "description": "

Whether the entry is currently active.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "name", - "description": "

The name of the IP allow list entry.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "owner", - "description": "

The owner of the IP allow list entry.

", - "type": "IpAllowListOwner!", - "id": "ipallowlistowner", - "href": "/graphql/reference/unions#ipallowlistowner" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "IpAllowListEntryConnection", - "id": "ipallowlistentryconnection", - "href": "/graphql/reference/objects#ipallowlistentryconnection", - "description": "

The connection type for IpAllowListEntry.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[IpAllowListEntryEdge]", - "id": "ipallowlistentryedge", - "href": "/graphql/reference/objects#ipallowlistentryedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[IpAllowListEntry]", - "id": "ipallowlistentry", - "href": "/graphql/reference/objects#ipallowlistentry" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "IpAllowListEntryEdge", - "id": "ipallowlistentryedge", - "href": "/graphql/reference/objects#ipallowlistentryedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "IpAllowListEntry", - "id": "ipallowlistentry", - "href": "/graphql/reference/objects#ipallowlistentry" - } - ] - }, - { - "name": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue", - "description": "

An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.

", - "implements": [ - { - "name": "Assignable", - "id": "assignable", - "href": "/graphql/reference/interfaces#assignable" - }, - { - "name": "Closable", - "id": "closable", - "href": "/graphql/reference/interfaces#closable" - }, - { - "name": "Comment", - "id": "comment", - "href": "/graphql/reference/interfaces#comment" - }, - { - "name": "Deletable", - "id": "deletable", - "href": "/graphql/reference/interfaces#deletable" - }, - { - "name": "Labelable", - "id": "labelable", - "href": "/graphql/reference/interfaces#labelable" - }, - { - "name": "Lockable", - "id": "lockable", - "href": "/graphql/reference/interfaces#lockable" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "ProjectV2Owner", - "id": "projectv2owner", - "href": "/graphql/reference/interfaces#projectv2owner" - }, - { - "name": "Reactable", - "id": "reactable", - "href": "/graphql/reference/interfaces#reactable" - }, - { - "name": "RepositoryNode", - "id": "repositorynode", - "href": "/graphql/reference/interfaces#repositorynode" - }, - { - "name": "Subscribable", - "id": "subscribable", - "href": "/graphql/reference/interfaces#subscribable" - }, - { - "name": "SubscribableThread", - "id": "subscribablethread", - "href": "/graphql/reference/interfaces#subscribablethread" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - }, - { - "name": "Updatable", - "id": "updatable", - "href": "/graphql/reference/interfaces#updatable" - }, - { - "name": "UpdatableComment", - "id": "updatablecomment", - "href": "/graphql/reference/interfaces#updatablecomment" - } - ], - "fields": [ - { - "name": "activeLockReason", - "description": "

Reason that the conversation was locked.

", - "type": "LockReason", - "id": "lockreason", - "href": "/graphql/reference/enums#lockreason" - }, - { - "name": "assignees", - "description": "

A list of Users assigned to this object.

", - "type": "UserConnection!", - "id": "userconnection", - "href": "/graphql/reference/objects#userconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "author", - "description": "

The actor who authored the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "authorAssociation", - "description": "

Author's association with the subject of the comment.

", - "type": "CommentAuthorAssociation!", - "id": "commentauthorassociation", - "href": "/graphql/reference/enums#commentauthorassociation" - }, - { - "name": "body", - "description": "

Identifies the body of the issue.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyHTML", - "description": "

The body rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "bodyResourcePath", - "description": "

The http path for this issue body.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "bodyText", - "description": "

Identifies the body of the issue rendered to text.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyUrl", - "description": "

The http URL for this issue body.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "closed", - "description": "

Indicates if the object is closed (definition of closed may depend on type).

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "closedAt", - "description": "

Identifies the date and time when the object was closed.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "comments", - "description": "

A list of comments associated with the Issue.

", - "type": "IssueCommentConnection!", - "id": "issuecommentconnection", - "href": "/graphql/reference/objects#issuecommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for issue comments returned from the connection.

", - "type": { - "name": "IssueCommentOrder", - "id": "issuecommentorder", - "href": "/graphql/reference/input-objects#issuecommentorder" - } - } - ] - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "createdViaEmail", - "description": "

Check if this comment was created via an email reply.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "editor", - "description": "

The actor who edited the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "fullDatabaseId", - "description": "

Identifies the primary key from the database as a BigInt.

", - "type": "BigInt", - "id": "bigint", - "href": "/graphql/reference/scalars#bigint" - }, - { - "name": "hovercard", - "description": "

The hovercard information for this issue.

", - "type": "Hovercard!", - "id": "hovercard", - "href": "/graphql/reference/objects#hovercard", - "arguments": [ - { - "name": "includeNotificationContexts", - "defaultValue": true, - "description": "

Whether or not to include notification contexts.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "id", - "description": "

The Node ID of the Issue object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "includesCreatedEdit", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "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", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isReadByViewer", - "description": "

Is this issue read by the viewer.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "labels", - "description": "

A list of labels associated with the object.

", - "type": "LabelConnection", - "id": "labelconnection", - "href": "/graphql/reference/objects#labelconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for labels returned from the connection.

", - "type": { - "name": "LabelOrder", - "id": "labelorder", - "href": "/graphql/reference/input-objects#labelorder" - } - } - ] - }, - { - "name": "lastEditedAt", - "description": "

The moment the editor made the last edit.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "linkedBranches", - "description": "

Branches linked to this issue.

", - "type": "LinkedBranchConnection!", - "id": "linkedbranchconnection", - "href": "/graphql/reference/objects#linkedbranchconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "locked", - "description": "

true if the object is locked.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "milestone", - "description": "

Identifies the milestone associated with the issue.

", - "type": "Milestone", - "id": "milestone", - "href": "/graphql/reference/objects#milestone" - }, - { - "name": "number", - "description": "

Identifies the issue number.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "participants", - "description": "

A list of Users that are participating in the Issue conversation.

", - "type": "UserConnection!", - "id": "userconnection", - "href": "/graphql/reference/objects#userconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "projectCards", - "description": "

List of project cards associated with this issue.

", - "type": "ProjectCardConnection!", - "id": "projectcardconnection", - "href": "/graphql/reference/objects#projectcardconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "archivedStates", - "description": "

A list of archived states to filter the cards by.

", - "type": { - "name": "[ProjectCardArchivedState]", - "id": "projectcardarchivedstate", - "href": "/graphql/reference/enums#projectcardarchivedstate" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "projectV2", - "description": "

Find a project by number.

", - "type": "ProjectV2", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2", - "arguments": [ - { - "name": "number", - "description": "

The project number.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "projectsV2", - "description": "

A list of projects under the owner.

", - "type": "ProjectV2Connection!", - "id": "projectv2connection", - "href": "/graphql/reference/objects#projectv2connection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

How to order the returned projects.

", - "type": { - "name": "ProjectV2Order", - "id": "projectv2order", - "href": "/graphql/reference/input-objects#projectv2order" - } - }, - { - "name": "query", - "description": "

A project to search for under the the owner.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "publishedAt", - "description": "

Identifies when the comment was published at.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "reactionGroups", - "description": "

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

", - "type": "[ReactionGroup!]", - "id": "reactiongroup", - "href": "/graphql/reference/objects#reactiongroup" - }, - { - "name": "reactions", - "description": "

A list of Reactions left on the Issue.

", - "type": "ReactionConnection!", - "id": "reactionconnection", - "href": "/graphql/reference/objects#reactionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "content", - "description": "

Allows filtering Reactions by emoji.

", - "type": { - "name": "ReactionContent", - "id": "reactioncontent", - "href": "/graphql/reference/enums#reactioncontent" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Allows specifying the order in which reactions are returned.

", - "type": { - "name": "ReactionOrder", - "id": "reactionorder", - "href": "/graphql/reference/input-objects#reactionorder" - } - } - ] - }, - { - "name": "repository", - "description": "

The repository associated with this node.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this issue.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "state", - "description": "

Identifies the state of the issue.

", - "type": "IssueState!", - "id": "issuestate", - "href": "/graphql/reference/enums#issuestate" - }, - { - "name": "stateReason", - "description": "

Identifies the reason for the issue state.

", - "type": "IssueStateReason", - "id": "issuestatereason", - "href": "/graphql/reference/enums#issuestatereason" - }, - { - "name": "timeline", - "description": "

A list of events, comments, commits, etc. associated with the issue.

", - "type": "IssueTimelineConnection!", - "id": "issuetimelineconnection", - "href": "/graphql/reference/objects#issuetimelineconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "since", - "description": "

Allows filtering timeline events by a since timestamp.

", - "type": { - "name": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - } - ], - "isDeprecated": true, - "deprecationReason": "

timeline will be removed Use Issue.timelineItems instead. Removal on 2020-10-01 UTC.

" - }, - { - "name": "timelineItems", - "description": "

A list of events, comments, commits, etc. associated with the issue.

", - "type": "IssueTimelineItemsConnection!", - "id": "issuetimelineitemsconnection", - "href": "/graphql/reference/objects#issuetimelineitemsconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "itemTypes", - "description": "

Filter timeline items by type.

", - "type": { - "name": "[IssueTimelineItemsItemType!]", - "id": "issuetimelineitemsitemtype", - "href": "/graphql/reference/enums#issuetimelineitemsitemtype" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "since", - "description": "

Filter timeline items by a since timestamp.

", - "type": { - "name": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - }, - { - "name": "skip", - "description": "

Skips the first n elements in the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "title", - "description": "

Identifies the issue title.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "titleHTML", - "description": "

Identifies the issue title rendered to HTML.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this issue.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userContentEdits", - "description": "

A list of edits to this content.

", - "type": "UserContentEditConnection", - "id": "usercontenteditconnection", - "href": "/graphql/reference/objects#usercontenteditconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "viewerCanClose", - "description": "

Indicates if the object can be closed by the viewer.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanDelete", - "description": "

Check if the current viewer can delete this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanReact", - "description": "

Can user react to this subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanReopen", - "description": "

Indicates if the object can be reopened by the viewer.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanSubscribe", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUpdate", - "description": "

Check if the current viewer can update this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCannotUpdateReasons", - "description": "

Reasons why the current viewer can not update this comment.

", - "type": "[CommentCannotUpdateReason!]!", - "id": "commentcannotupdatereason", - "href": "/graphql/reference/enums#commentcannotupdatereason" - }, - { - "name": "viewerDidAuthor", - "description": "

Did the viewer author this comment.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerSubscription", - "description": "

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

", - "type": "SubscriptionState", - "id": "subscriptionstate", - "href": "/graphql/reference/enums#subscriptionstate" - }, - { - "name": "viewerThreadSubscriptionFormAction", - "description": "

Identifies the viewer's thread subscription form action.

", - "type": "ThreadSubscriptionFormAction", - "id": "threadsubscriptionformaction", - "href": "/graphql/reference/enums#threadsubscriptionformaction" - }, - { - "name": "viewerThreadSubscriptionStatus", - "description": "

Identifies the viewer's thread subscription status.

", - "type": "ThreadSubscriptionState", - "id": "threadsubscriptionstate", - "href": "/graphql/reference/enums#threadsubscriptionstate" - } - ] - }, - { - "name": "IssueComment", - "id": "issuecomment", - "href": "/graphql/reference/objects#issuecomment", - "description": "

Represents a comment on an Issue.

", - "implements": [ - { - "name": "Comment", - "id": "comment", - "href": "/graphql/reference/interfaces#comment" - }, - { - "name": "Deletable", - "id": "deletable", - "href": "/graphql/reference/interfaces#deletable" - }, - { - "name": "Minimizable", - "id": "minimizable", - "href": "/graphql/reference/interfaces#minimizable" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "Reactable", - "id": "reactable", - "href": "/graphql/reference/interfaces#reactable" - }, - { - "name": "RepositoryNode", - "id": "repositorynode", - "href": "/graphql/reference/interfaces#repositorynode" - }, - { - "name": "Updatable", - "id": "updatable", - "href": "/graphql/reference/interfaces#updatable" - }, - { - "name": "UpdatableComment", - "id": "updatablecomment", - "href": "/graphql/reference/interfaces#updatablecomment" - } - ], - "fields": [ - { - "name": "author", - "description": "

The actor who authored the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "authorAssociation", - "description": "

Author's association with the subject of the comment.

", - "type": "CommentAuthorAssociation!", - "id": "commentauthorassociation", - "href": "/graphql/reference/enums#commentauthorassociation" - }, - { - "name": "body", - "description": "

The body as Markdown.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyHTML", - "description": "

The body rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "bodyText", - "description": "

The body rendered to text.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "createdViaEmail", - "description": "

Check if this comment was created via an email reply.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "editor", - "description": "

The actor who edited the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "fullDatabaseId", - "description": "

Identifies the primary key from the database as a BigInt.

", - "type": "BigInt", - "id": "bigint", - "href": "/graphql/reference/scalars#bigint" - }, - { - "name": "id", - "description": "

The Node ID of the IssueComment object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "includesCreatedEdit", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isMinimized", - "description": "

Returns whether or not a comment has been minimized.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "issue", - "description": "

Identifies the issue associated with the comment.

", - "type": "Issue!", - "id": "issue", - "href": "/graphql/reference/objects#issue" - }, - { - "name": "lastEditedAt", - "description": "

The moment the editor made the last edit.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "minimizedReason", - "description": "

Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "publishedAt", - "description": "

Identifies when the comment was published at.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "pullRequest", - "description": "

Returns the pull request associated with the comment, if this comment was made on a\npull request.

", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "reactionGroups", - "description": "

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

", - "type": "[ReactionGroup!]", - "id": "reactiongroup", - "href": "/graphql/reference/objects#reactiongroup" - }, - { - "name": "reactions", - "description": "

A list of Reactions left on the Issue.

", - "type": "ReactionConnection!", - "id": "reactionconnection", - "href": "/graphql/reference/objects#reactionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "content", - "description": "

Allows filtering Reactions by emoji.

", - "type": { - "name": "ReactionContent", - "id": "reactioncontent", - "href": "/graphql/reference/enums#reactioncontent" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Allows specifying the order in which reactions are returned.

", - "type": { - "name": "ReactionOrder", - "id": "reactionorder", - "href": "/graphql/reference/input-objects#reactionorder" - } - } - ] - }, - { - "name": "repository", - "description": "

The repository associated with this node.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this issue comment.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this issue comment.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userContentEdits", - "description": "

A list of edits to this content.

", - "type": "UserContentEditConnection", - "id": "usercontenteditconnection", - "href": "/graphql/reference/objects#usercontenteditconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "viewerCanDelete", - "description": "

Check if the current viewer can delete this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanMinimize", - "description": "

Check if the current viewer can minimize this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanReact", - "description": "

Can user react to this subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUpdate", - "description": "

Check if the current viewer can update this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCannotUpdateReasons", - "description": "

Reasons why the current viewer can not update this comment.

", - "type": "[CommentCannotUpdateReason!]!", - "id": "commentcannotupdatereason", - "href": "/graphql/reference/enums#commentcannotupdatereason" - }, - { - "name": "viewerDidAuthor", - "description": "

Did the viewer author this comment.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "IssueCommentConnection", - "id": "issuecommentconnection", - "href": "/graphql/reference/objects#issuecommentconnection", - "description": "

The connection type for IssueComment.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[IssueCommentEdge]", - "id": "issuecommentedge", - "href": "/graphql/reference/objects#issuecommentedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[IssueComment]", - "id": "issuecomment", - "href": "/graphql/reference/objects#issuecomment" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "IssueCommentEdge", - "id": "issuecommentedge", - "href": "/graphql/reference/objects#issuecommentedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "IssueComment", - "id": "issuecomment", - "href": "/graphql/reference/objects#issuecomment" - } - ] - }, - { - "name": "IssueConnection", - "id": "issueconnection", - "href": "/graphql/reference/objects#issueconnection", - "description": "

The connection type for Issue.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[IssueEdge]", - "id": "issueedge", - "href": "/graphql/reference/objects#issueedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Issue]", - "id": "issue", - "href": "/graphql/reference/objects#issue" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "IssueContributionsByRepository", - "id": "issuecontributionsbyrepository", - "href": "/graphql/reference/objects#issuecontributionsbyrepository", - "description": "

This aggregates issues opened by a user within one repository.

", - "fields": [ - { - "name": "contributions", - "description": "

The issue contributions.

", - "type": "CreatedIssueContributionConnection!", - "id": "createdissuecontributionconnection", - "href": "/graphql/reference/objects#createdissuecontributionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for contributions returned from the connection.

", - "type": { - "name": "ContributionOrder", - "id": "contributionorder", - "href": "/graphql/reference/input-objects#contributionorder" - } - } - ] - }, - { - "name": "repository", - "description": "

The repository in which the issues were opened.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "IssueEdge", - "id": "issueedge", - "href": "/graphql/reference/objects#issueedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue" - } - ] - }, - { - "name": "IssueTemplate", - "id": "issuetemplate", - "href": "/graphql/reference/objects#issuetemplate", - "description": "

A repository issue template.

", - "fields": [ - { - "name": "about", - "description": "

The template purpose.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "assignees", - "description": "

The suggested assignees.

", - "type": "UserConnection!", - "id": "userconnection", - "href": "/graphql/reference/objects#userconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "body", - "description": "

The suggested issue body.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "filename", - "description": "

The template filename.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "labels", - "description": "

The suggested issue labels.

", - "type": "LabelConnection", - "id": "labelconnection", - "href": "/graphql/reference/objects#labelconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for labels returned from the connection.

", - "type": { - "name": "LabelOrder", - "id": "labelorder", - "href": "/graphql/reference/input-objects#labelorder" - } - } - ] - }, - { - "name": "name", - "description": "

The template name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "title", - "description": "

The suggested issue title.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "IssueTimelineConnection", - "id": "issuetimelineconnection", - "href": "/graphql/reference/objects#issuetimelineconnection", - "description": "

The connection type for IssueTimelineItem.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[IssueTimelineItemEdge]", - "id": "issuetimelineitemedge", - "href": "/graphql/reference/objects#issuetimelineitemedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[IssueTimelineItem]", - "id": "issuetimelineitem", - "href": "/graphql/reference/unions#issuetimelineitem" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "IssueTimelineItemEdge", - "id": "issuetimelineitemedge", - "href": "/graphql/reference/objects#issuetimelineitemedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "IssueTimelineItem", - "id": "issuetimelineitem", - "href": "/graphql/reference/unions#issuetimelineitem" - } - ] - }, - { - "name": "IssueTimelineItemsConnection", - "id": "issuetimelineitemsconnection", - "href": "/graphql/reference/objects#issuetimelineitemsconnection", - "description": "

The connection type for IssueTimelineItems.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[IssueTimelineItemsEdge]", - "id": "issuetimelineitemsedge", - "href": "/graphql/reference/objects#issuetimelineitemsedge" - }, - { - "name": "filteredCount", - "description": "

Identifies the count of items after applying before and after filters.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[IssueTimelineItems]", - "id": "issuetimelineitems", - "href": "/graphql/reference/unions#issuetimelineitems" - }, - { - "name": "pageCount", - "description": "

Identifies the count of items after applying before/after filters and first/last/skip slicing.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "IssueTimelineItemsEdge", - "id": "issuetimelineitemsedge", - "href": "/graphql/reference/objects#issuetimelineitemsedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "IssueTimelineItems", - "id": "issuetimelineitems", - "href": "/graphql/reference/unions#issuetimelineitems" - } - ] - }, - { - "name": "JoinedGitHubContribution", - "id": "joinedgithubcontribution", - "href": "/graphql/reference/objects#joinedgithubcontribution", - "description": "

Represents a user signing up for a GitHub account.

", - "implements": [ - { - "name": "Contribution", - "id": "contribution", - "href": "/graphql/reference/interfaces#contribution" - } - ], - "fields": [ - { - "name": "isRestricted", - "description": "

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.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "occurredAt", - "description": "

When this contribution was made.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this contribution.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The HTTP URL for this contribution.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user who made this contribution.

", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "Label", - "id": "label", - "href": "/graphql/reference/objects#label", - "description": "

A label for categorizing Issues, Pull Requests, Milestones, or Discussions with a given Repository.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "color", - "description": "

Identifies the label color.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the label was created.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "description", - "description": "

A brief description of this label.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the Label object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isDefault", - "description": "

Indicates whether or not this is a default label.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "issues", - "description": "

A list of issues associated with this label.

", - "type": "IssueConnection!", - "id": "issueconnection", - "href": "/graphql/reference/objects#issueconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "filterBy", - "description": "

Filtering options for issues returned from the connection.

", - "type": { - "name": "IssueFilters", - "id": "issuefilters", - "href": "/graphql/reference/input-objects#issuefilters" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "labels", - "description": "

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

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for issues returned from the connection.

", - "type": { - "name": "IssueOrder", - "id": "issueorder", - "href": "/graphql/reference/input-objects#issueorder" - } - }, - { - "name": "states", - "description": "

A list of states to filter the issues by.

", - "type": { - "name": "[IssueState!]", - "id": "issuestate", - "href": "/graphql/reference/enums#issuestate" - } - } - ] - }, - { - "name": "name", - "description": "

Identifies the label name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequests", - "description": "

A list of pull requests associated with this label.

", - "type": "PullRequestConnection!", - "id": "pullrequestconnection", - "href": "/graphql/reference/objects#pullrequestconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "baseRefName", - "description": "

The base ref name to filter the pull requests by.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "headRefName", - "description": "

The head ref name to filter the pull requests by.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "labels", - "description": "

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

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for pull requests returned from the connection.

", - "type": { - "name": "IssueOrder", - "id": "issueorder", - "href": "/graphql/reference/input-objects#issueorder" - } - }, - { - "name": "states", - "description": "

A list of states to filter the pull requests by.

", - "type": { - "name": "[PullRequestState!]", - "id": "pullrequeststate", - "href": "/graphql/reference/enums#pullrequeststate" - } - } - ] - }, - { - "name": "repository", - "description": "

The repository associated with this label.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this label.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this label.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "LabelConnection", - "id": "labelconnection", - "href": "/graphql/reference/objects#labelconnection", - "description": "

The connection type for Label.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[LabelEdge]", - "id": "labeledge", - "href": "/graphql/reference/objects#labeledge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Label]", - "id": "label", - "href": "/graphql/reference/objects#label" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "LabelEdge", - "id": "labeledge", - "href": "/graphql/reference/objects#labeledge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Label", - "id": "label", - "href": "/graphql/reference/objects#label" - } - ] - }, - { - "name": "LabeledEvent", - "id": "labeledevent", - "href": "/graphql/reference/objects#labeledevent", - "description": "

Represents alabeledevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the LabeledEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "label", - "description": "

Identifies the label associated with thelabeledevent.

", - "type": "Label!", - "id": "label", - "href": "/graphql/reference/objects#label" - }, - { - "name": "labelable", - "description": "

Identifies the Labelable associated with the event.

", - "type": "Labelable!", - "id": "labelable", - "href": "/graphql/reference/interfaces#labelable" - } - ] - }, - { - "name": "Language", - "id": "language", - "href": "/graphql/reference/objects#language", - "description": "

Represents a given language found in repositories.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "color", - "description": "

The color defined for the current language.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the Language object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "name", - "description": "

The name of the current language.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "LanguageConnection", - "id": "languageconnection", - "href": "/graphql/reference/objects#languageconnection", - "description": "

A list of languages associated with the parent.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[LanguageEdge]", - "id": "languageedge", - "href": "/graphql/reference/objects#languageedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Language]", - "id": "language", - "href": "/graphql/reference/objects#language" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "totalSize", - "description": "

The total size in bytes of files written in that language.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "LanguageEdge", - "id": "languageedge", - "href": "/graphql/reference/objects#languageedge", - "description": "

Represents the language of a repository.

", - "fields": [ - { - "name": "cursor", - "description": "", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "", - "type": "Language!", - "id": "language", - "href": "/graphql/reference/objects#language" - }, - { - "name": "size", - "description": "

The number of bytes of code written in the language.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "License", - "id": "license", - "href": "/graphql/reference/objects#license", - "description": "

A repository's open source license.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "body", - "description": "

The full text of the license.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "conditions", - "description": "

The conditions set by the license.

", - "type": "[LicenseRule]!", - "id": "licenserule", - "href": "/graphql/reference/objects#licenserule" - }, - { - "name": "description", - "description": "

A human-readable description of the license.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "featured", - "description": "

Whether the license should be featured.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "hidden", - "description": "

Whether the license should be displayed in license pickers.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "id", - "description": "

The Node ID of the License object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "implementation", - "description": "

Instructions on how to implement the license.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "key", - "description": "

The lowercased SPDX ID of the license.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "limitations", - "description": "

The limitations set by the license.

", - "type": "[LicenseRule]!", - "id": "licenserule", - "href": "/graphql/reference/objects#licenserule" - }, - { - "name": "name", - "description": "

The license full name specified by https://spdx.org/licenses.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "nickname", - "description": "

Customary short name if applicable (e.g, GPLv3).

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "permissions", - "description": "

The permissions set by the license.

", - "type": "[LicenseRule]!", - "id": "licenserule", - "href": "/graphql/reference/objects#licenserule" - }, - { - "name": "pseudoLicense", - "description": "

Whether the license is a pseudo-license placeholder (e.g., other, no-license).

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "spdxId", - "description": "

Short identifier specified by https://spdx.org/licenses.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "url", - "description": "

URL to the license on https://choosealicense.com.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "LicenseRule", - "id": "licenserule", - "href": "/graphql/reference/objects#licenserule", - "description": "

Describes a License's conditions, permissions, and limitations.

", - "fields": [ - { - "name": "description", - "description": "

A description of the rule.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "key", - "description": "

The machine-readable rule key.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "label", - "description": "

The human-readable rule label.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "LinkedBranch", - "id": "linkedbranch", - "href": "/graphql/reference/objects#linkedbranch", - "description": "

A branch linked to an issue.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "id", - "description": "

The Node ID of the LinkedBranch object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "ref", - "description": "

The branch's ref.

", - "type": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref" - } - ] - }, - { - "name": "LinkedBranchConnection", - "id": "linkedbranchconnection", - "href": "/graphql/reference/objects#linkedbranchconnection", - "description": "

A list of branches linked to an issue.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[LinkedBranchEdge]", - "id": "linkedbranchedge", - "href": "/graphql/reference/objects#linkedbranchedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[LinkedBranch]", - "id": "linkedbranch", - "href": "/graphql/reference/objects#linkedbranch" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "LinkedBranchEdge", - "id": "linkedbranchedge", - "href": "/graphql/reference/objects#linkedbranchedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "LinkedBranch", - "id": "linkedbranch", - "href": "/graphql/reference/objects#linkedbranch" - } - ] - }, - { - "name": "LockedEvent", - "id": "lockedevent", - "href": "/graphql/reference/objects#lockedevent", - "description": "

Represents alockedevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the LockedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "lockReason", - "description": "

Reason that the conversation was locked (optional).

", - "type": "LockReason", - "id": "lockreason", - "href": "/graphql/reference/enums#lockreason" - }, - { - "name": "lockable", - "description": "

Object that was locked.

", - "type": "Lockable!", - "id": "lockable", - "href": "/graphql/reference/interfaces#lockable" - } - ] - }, - { - "name": "Mannequin", - "id": "mannequin", - "href": "/graphql/reference/objects#mannequin", - "description": "

A placeholder user for attribution of imported data on GitHub.

", - "implements": [ - { - "name": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "avatarUrl", - "description": "

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

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "arguments": [ - { - "name": "size", - "description": "

The size of the resulting square image.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "claimant", - "description": "

The user that has claimed the data attributed to this mannequin.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "email", - "description": "

The mannequin's email on the source instance.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the Mannequin object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "login", - "description": "

The username of the actor.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "resourcePath", - "description": "

The HTML path to this resource.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The URL to this resource.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "MannequinConnection", - "id": "mannequinconnection", - "href": "/graphql/reference/objects#mannequinconnection", - "description": "

A list of mannequins.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[MannequinEdge]", - "id": "mannequinedge", - "href": "/graphql/reference/objects#mannequinedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Mannequin]", - "id": "mannequin", - "href": "/graphql/reference/objects#mannequin" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "MannequinEdge", - "id": "mannequinedge", - "href": "/graphql/reference/objects#mannequinedge", - "description": "

Represents a mannequin.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Mannequin", - "id": "mannequin", - "href": "/graphql/reference/objects#mannequin" - } - ] - }, - { - "name": "MarkedAsDuplicateEvent", - "id": "markedasduplicateevent", - "href": "/graphql/reference/objects#markedasduplicateevent", - "description": "

Represents amarked_as_duplicateevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "canonical", - "description": "

The authoritative issue or pull request which has been duplicated by another.

", - "type": "IssueOrPullRequest", - "id": "issueorpullrequest", - "href": "/graphql/reference/unions#issueorpullrequest" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "duplicate", - "description": "

The issue or pull request which has been marked as a duplicate of another.

", - "type": "IssueOrPullRequest", - "id": "issueorpullrequest", - "href": "/graphql/reference/unions#issueorpullrequest" - }, - { - "name": "id", - "description": "

The Node ID of the MarkedAsDuplicateEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isCrossRepository", - "description": "

Canonical and duplicate belong to different repositories.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "MaxFilePathLengthParameters", - "id": "maxfilepathlengthparameters", - "href": "/graphql/reference/objects#maxfilepathlengthparameters", - "description": "

Prevent commits that include file paths that exceed a specified character limit\nfrom being pushed to the commit graph. NOTE: This rule is in beta and subject to change.

", - "fields": [ - { - "name": "maxFilePathLength", - "description": "

The maximum amount of characters allowed in file paths.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "MaxFileSizeParameters", - "id": "maxfilesizeparameters", - "href": "/graphql/reference/objects#maxfilesizeparameters", - "description": "

Prevent commits that exceed a specified file size limit from being pushed to the\ncommit. NOTE: This rule is in beta and subject to change.

", - "fields": [ - { - "name": "maxFileSize", - "description": "

The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "MemberFeatureRequestNotification", - "id": "memberfeaturerequestnotification", - "href": "/graphql/reference/objects#memberfeaturerequestnotification", - "description": "

Represents a member feature request notification.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "body", - "description": "

Represents member feature request body containing entity name and the number of feature requests.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the MemberFeatureRequestNotification object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "title", - "description": "

Represents member feature request notification title.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "MembersCanDeleteReposClearAuditEntry", - "id": "memberscandeletereposclearauditentry", - "href": "/graphql/reference/objects#memberscandeletereposclearauditentry", - "description": "

Audit log entry for a members_can_delete_repos.clear event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "EnterpriseAuditEntryData", - "id": "enterpriseauditentrydata", - "href": "/graphql/reference/interfaces#enterpriseauditentrydata" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "enterpriseResourcePath", - "description": "

The HTTP path for this enterprise.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "enterpriseSlug", - "description": "

The slug of the enterprise.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseUrl", - "description": "

The HTTP URL for this enterprise.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "id", - "description": "

The Node ID of the MembersCanDeleteReposClearAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "MembersCanDeleteReposDisableAuditEntry", - "id": "memberscandeletereposdisableauditentry", - "href": "/graphql/reference/objects#memberscandeletereposdisableauditentry", - "description": "

Audit log entry for a members_can_delete_repos.disable event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "EnterpriseAuditEntryData", - "id": "enterpriseauditentrydata", - "href": "/graphql/reference/interfaces#enterpriseauditentrydata" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "enterpriseResourcePath", - "description": "

The HTTP path for this enterprise.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "enterpriseSlug", - "description": "

The slug of the enterprise.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseUrl", - "description": "

The HTTP URL for this enterprise.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "id", - "description": "

The Node ID of the MembersCanDeleteReposDisableAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "MembersCanDeleteReposEnableAuditEntry", - "id": "memberscandeletereposenableauditentry", - "href": "/graphql/reference/objects#memberscandeletereposenableauditentry", - "description": "

Audit log entry for a members_can_delete_repos.enable event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "EnterpriseAuditEntryData", - "id": "enterpriseauditentrydata", - "href": "/graphql/reference/interfaces#enterpriseauditentrydata" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "enterpriseResourcePath", - "description": "

The HTTP path for this enterprise.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "enterpriseSlug", - "description": "

The slug of the enterprise.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseUrl", - "description": "

The HTTP URL for this enterprise.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "id", - "description": "

The Node ID of the MembersCanDeleteReposEnableAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "MentionedEvent", - "id": "mentionedevent", - "href": "/graphql/reference/objects#mentionedevent", - "description": "

Represents amentionedevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the MentionedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - ] - }, - { - "name": "MergeQueue", - "id": "mergequeue", - "href": "/graphql/reference/objects#mergequeue", - "description": "

The queue of pull request entries to be merged into a protected branch in a repository.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "configuration", - "description": "

The configuration for this merge queue.

", - "type": "MergeQueueConfiguration", - "id": "mergequeueconfiguration", - "href": "/graphql/reference/objects#mergequeueconfiguration" - }, - { - "name": "entries", - "description": "

The entries in the queue.

", - "type": "MergeQueueEntryConnection", - "id": "mergequeueentryconnection", - "href": "/graphql/reference/objects#mergequeueentryconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "id", - "description": "

The Node ID of the MergeQueue object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "nextEntryEstimatedTimeToMerge", - "description": "

The estimated time in seconds until a newly added entry would be merged.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "repository", - "description": "

The repository this merge queue belongs to.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this merge queue.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The HTTP URL for this merge queue.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "MergeQueueConfiguration", - "id": "mergequeueconfiguration", - "href": "/graphql/reference/objects#mergequeueconfiguration", - "description": "

Configuration for a MergeQueue.

", - "fields": [ - { - "name": "checkResponseTimeout", - "description": "

The amount of time in minutes to wait for a check response before considering it a failure.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "maximumEntriesToBuild", - "description": "

The maximum number of entries to build at once.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "maximumEntriesToMerge", - "description": "

The maximum number of entries to merge at once.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "mergeMethod", - "description": "

The merge method to use for this queue.

", - "type": "PullRequestMergeMethod", - "id": "pullrequestmergemethod", - "href": "/graphql/reference/enums#pullrequestmergemethod" - }, - { - "name": "mergingStrategy", - "description": "

The strategy to use when merging entries.

", - "type": "MergeQueueMergingStrategy", - "id": "mergequeuemergingstrategy", - "href": "/graphql/reference/enums#mergequeuemergingstrategy" - }, - { - "name": "minimumEntriesToMerge", - "description": "

The minimum number of entries required to merge at once.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "minimumEntriesToMergeWaitTime", - "description": "

The amount of time in minutes to wait before ignoring the minumum number of\nentries in the queue requirement and merging a collection of entries.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "MergeQueueEntry", - "id": "mergequeueentry", - "href": "/graphql/reference/objects#mergequeueentry", - "description": "

Entries in a MergeQueue.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "baseCommit", - "description": "

The base commit for this entry.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "enqueuedAt", - "description": "

The date and time this entry was added to the merge queue.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "enqueuer", - "description": "

The actor that enqueued this entry.

", - "type": "Actor!", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "estimatedTimeToMerge", - "description": "

The estimated time in seconds until this entry will be merged.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "headCommit", - "description": "

The head commit for this entry.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "id", - "description": "

The Node ID of the MergeQueueEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "jump", - "description": "

Whether this pull request should jump the queue.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "mergeQueue", - "description": "

The merge queue that this entry belongs to.

", - "type": "MergeQueue", - "id": "mergequeue", - "href": "/graphql/reference/objects#mergequeue" - }, - { - "name": "position", - "description": "

The position of this entry in the queue.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "pullRequest", - "description": "

The pull request that will be added to a merge group.

", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "solo", - "description": "

Does this pull request need to be deployed on its own.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "state", - "description": "

The state of this entry in the queue.

", - "type": "MergeQueueEntryState!", - "id": "mergequeueentrystate", - "href": "/graphql/reference/enums#mergequeueentrystate" - } - ] - }, - { - "name": "MergeQueueEntryConnection", - "id": "mergequeueentryconnection", - "href": "/graphql/reference/objects#mergequeueentryconnection", - "description": "

The connection type for MergeQueueEntry.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[MergeQueueEntryEdge]", - "id": "mergequeueentryedge", - "href": "/graphql/reference/objects#mergequeueentryedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[MergeQueueEntry]", - "id": "mergequeueentry", - "href": "/graphql/reference/objects#mergequeueentry" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "MergeQueueEntryEdge", - "id": "mergequeueentryedge", - "href": "/graphql/reference/objects#mergequeueentryedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "MergeQueueEntry", - "id": "mergequeueentry", - "href": "/graphql/reference/objects#mergequeueentry" - } - ] - }, - { - "name": "MergedEvent", - "id": "mergedevent", - "href": "/graphql/reference/objects#mergedevent", - "description": "

Represents amergedevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "commit", - "description": "

Identifies the commit associated with the merge event.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the MergedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "mergeRef", - "description": "

Identifies the Ref associated with the merge event.

", - "type": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref" - }, - { - "name": "mergeRefName", - "description": "

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

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this merged event.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The HTTP URL for this merged event.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "MigrationSource", - "id": "migrationsource", - "href": "/graphql/reference/objects#migrationsource", - "description": "

A GitHub Enterprise Importer (GEI) migration source.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "id", - "description": "

The Node ID of the MigrationSource object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "name", - "description": "

The migration source name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "type", - "description": "

The migration source type.

", - "type": "MigrationSourceType!", - "id": "migrationsourcetype", - "href": "/graphql/reference/enums#migrationsourcetype" - }, - { - "name": "url", - "description": "

The migration source URL, for example https://github.com or https://monalisa.ghe.com.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "Milestone", - "id": "milestone", - "href": "/graphql/reference/objects#milestone", - "description": "

Represents a Milestone object on a given repository.

", - "implements": [ - { - "name": "Closable", - "id": "closable", - "href": "/graphql/reference/interfaces#closable" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "closed", - "description": "

Indicates if the object is closed (definition of closed may depend on type).

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "closedAt", - "description": "

Identifies the date and time when the object was closed.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "creator", - "description": "

Identifies the actor who created the milestone.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "description", - "description": "

Identifies the description of the milestone.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "dueOn", - "description": "

Identifies the due date of the milestone.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the Milestone object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "issues", - "description": "

A list of issues associated with the milestone.

", - "type": "IssueConnection!", - "id": "issueconnection", - "href": "/graphql/reference/objects#issueconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "filterBy", - "description": "

Filtering options for issues returned from the connection.

", - "type": { - "name": "IssueFilters", - "id": "issuefilters", - "href": "/graphql/reference/input-objects#issuefilters" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "labels", - "description": "

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

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for issues returned from the connection.

", - "type": { - "name": "IssueOrder", - "id": "issueorder", - "href": "/graphql/reference/input-objects#issueorder" - } - }, - { - "name": "states", - "description": "

A list of states to filter the issues by.

", - "type": { - "name": "[IssueState!]", - "id": "issuestate", - "href": "/graphql/reference/enums#issuestate" - } - } - ] - }, - { - "name": "number", - "description": "

Identifies the number of the milestone.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "progressPercentage", - "description": "

Identifies the percentage complete for the milestone.

", - "type": "Float!", - "id": "float", - "href": "/graphql/reference/scalars#float" - }, - { - "name": "pullRequests", - "description": "

A list of pull requests associated with the milestone.

", - "type": "PullRequestConnection!", - "id": "pullrequestconnection", - "href": "/graphql/reference/objects#pullrequestconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "baseRefName", - "description": "

The base ref name to filter the pull requests by.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "headRefName", - "description": "

The head ref name to filter the pull requests by.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "labels", - "description": "

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

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for pull requests returned from the connection.

", - "type": { - "name": "IssueOrder", - "id": "issueorder", - "href": "/graphql/reference/input-objects#issueorder" - } - }, - { - "name": "states", - "description": "

A list of states to filter the pull requests by.

", - "type": { - "name": "[PullRequestState!]", - "id": "pullrequeststate", - "href": "/graphql/reference/enums#pullrequeststate" - } - } - ] - }, - { - "name": "repository", - "description": "

The repository associated with this milestone.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this milestone.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "state", - "description": "

Identifies the state of the milestone.

", - "type": "MilestoneState!", - "id": "milestonestate", - "href": "/graphql/reference/enums#milestonestate" - }, - { - "name": "title", - "description": "

Identifies the title of the milestone.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this milestone.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "viewerCanClose", - "description": "

Indicates if the object can be closed by the viewer.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanReopen", - "description": "

Indicates if the object can be reopened by the viewer.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "MilestoneConnection", - "id": "milestoneconnection", - "href": "/graphql/reference/objects#milestoneconnection", - "description": "

The connection type for Milestone.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[MilestoneEdge]", - "id": "milestoneedge", - "href": "/graphql/reference/objects#milestoneedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Milestone]", - "id": "milestone", - "href": "/graphql/reference/objects#milestone" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "MilestoneEdge", - "id": "milestoneedge", - "href": "/graphql/reference/objects#milestoneedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Milestone", - "id": "milestone", - "href": "/graphql/reference/objects#milestone" - } - ] - }, - { - "name": "MilestonedEvent", - "id": "milestonedevent", - "href": "/graphql/reference/objects#milestonedevent", - "description": "

Represents amilestonedevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the MilestonedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "milestoneTitle", - "description": "

Identifies the milestone title associated with themilestonedevent.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "subject", - "description": "

Object referenced by event.

", - "type": "MilestoneItem!", - "id": "milestoneitem", - "href": "/graphql/reference/unions#milestoneitem" - } - ] - }, - { - "name": "MovedColumnsInProjectEvent", - "id": "movedcolumnsinprojectevent", - "href": "/graphql/reference/objects#movedcolumnsinprojectevent", - "description": "

Represents amoved_columns_in_projectevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the MovedColumnsInProjectEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "previousProjectColumnName", - "description": "

Column name the issue or pull request was moved from.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "project", - "description": "

Project referenced by event.

", - "type": "Project", - "id": "project", - "href": "/graphql/reference/objects#project" - }, - { - "name": "projectCard", - "description": "

Project card referenced by this project event.

", - "type": "ProjectCard", - "id": "projectcard", - "href": "/graphql/reference/objects#projectcard" - }, - { - "name": "projectColumnName", - "description": "

Column name the issue or pull request was moved to.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "OauthApplicationCreateAuditEntry", - "id": "oauthapplicationcreateauditentry", - "href": "/graphql/reference/objects#oauthapplicationcreateauditentry", - "description": "

Audit log entry for a oauth_application.create event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OauthApplicationAuditEntryData", - "id": "oauthapplicationauditentrydata", - "href": "/graphql/reference/interfaces#oauthapplicationauditentrydata" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "applicationUrl", - "description": "

The application URL of the OAuth application.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "callbackUrl", - "description": "

The callback URL of the OAuth application.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OauthApplicationCreateAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "oauthApplicationName", - "description": "

The name of the OAuth application.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "oauthApplicationResourcePath", - "description": "

The HTTP path for the OAuth application.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "oauthApplicationUrl", - "description": "

The HTTP URL for the OAuth application.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "rateLimit", - "description": "

The rate limit of the OAuth application.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "state", - "description": "

The state of the OAuth application.

", - "type": "OauthApplicationCreateAuditEntryState", - "id": "oauthapplicationcreateauditentrystate", - "href": "/graphql/reference/enums#oauthapplicationcreateauditentrystate" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgAddBillingManagerAuditEntry", - "id": "orgaddbillingmanagerauditentry", - "href": "/graphql/reference/objects#orgaddbillingmanagerauditentry", - "description": "

Audit log entry for a org.add_billing_manager.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgAddBillingManagerAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "invitationEmail", - "description": "

The email address used to invite a billing manager for the organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgAddMemberAuditEntry", - "id": "orgaddmemberauditentry", - "href": "/graphql/reference/objects#orgaddmemberauditentry", - "description": "

Audit log entry for a org.add_member.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgAddMemberAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "permission", - "description": "

The permission level of the member added to the organization.

", - "type": "OrgAddMemberAuditEntryPermission", - "id": "orgaddmemberauditentrypermission", - "href": "/graphql/reference/enums#orgaddmemberauditentrypermission" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgBlockUserAuditEntry", - "id": "orgblockuserauditentry", - "href": "/graphql/reference/objects#orgblockuserauditentry", - "description": "

Audit log entry for a org.block_user.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "blockedUser", - "description": "

The blocked user.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "blockedUserName", - "description": "

The username of the blocked user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "blockedUserResourcePath", - "description": "

The HTTP path for the blocked user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "blockedUserUrl", - "description": "

The HTTP URL for the blocked user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgBlockUserAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgConfigDisableCollaboratorsOnlyAuditEntry", - "id": "orgconfigdisablecollaboratorsonlyauditentry", - "href": "/graphql/reference/objects#orgconfigdisablecollaboratorsonlyauditentry", - "description": "

Audit log entry for a org.config.disable_collaborators_only event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgConfigDisableCollaboratorsOnlyAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgConfigEnableCollaboratorsOnlyAuditEntry", - "id": "orgconfigenablecollaboratorsonlyauditentry", - "href": "/graphql/reference/objects#orgconfigenablecollaboratorsonlyauditentry", - "description": "

Audit log entry for a org.config.enable_collaborators_only event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgConfigEnableCollaboratorsOnlyAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgCreateAuditEntry", - "id": "orgcreateauditentry", - "href": "/graphql/reference/objects#orgcreateauditentry", - "description": "

Audit log entry for a org.create event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "billingPlan", - "description": "

The billing plan for the Organization.

", - "type": "OrgCreateAuditEntryBillingPlan", - "id": "orgcreateauditentrybillingplan", - "href": "/graphql/reference/enums#orgcreateauditentrybillingplan" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgCreateAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgDisableOauthAppRestrictionsAuditEntry", - "id": "orgdisableoauthapprestrictionsauditentry", - "href": "/graphql/reference/objects#orgdisableoauthapprestrictionsauditentry", - "description": "

Audit log entry for a org.disable_oauth_app_restrictions event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgDisableOauthAppRestrictionsAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgDisableSamlAuditEntry", - "id": "orgdisablesamlauditentry", - "href": "/graphql/reference/objects#orgdisablesamlauditentry", - "description": "

Audit log entry for a org.disable_saml event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "digestMethodUrl", - "description": "

The SAML provider's digest algorithm URL.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "id", - "description": "

The Node ID of the OrgDisableSamlAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "issuerUrl", - "description": "

The SAML provider's issuer URL.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "signatureMethodUrl", - "description": "

The SAML provider's signature algorithm URL.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "singleSignOnUrl", - "description": "

The SAML provider's single sign-on URL.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgDisableTwoFactorRequirementAuditEntry", - "id": "orgdisabletwofactorrequirementauditentry", - "href": "/graphql/reference/objects#orgdisabletwofactorrequirementauditentry", - "description": "

Audit log entry for a org.disable_two_factor_requirement event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgDisableTwoFactorRequirementAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgEnableOauthAppRestrictionsAuditEntry", - "id": "orgenableoauthapprestrictionsauditentry", - "href": "/graphql/reference/objects#orgenableoauthapprestrictionsauditentry", - "description": "

Audit log entry for a org.enable_oauth_app_restrictions event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgEnableOauthAppRestrictionsAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgEnableSamlAuditEntry", - "id": "orgenablesamlauditentry", - "href": "/graphql/reference/objects#orgenablesamlauditentry", - "description": "

Audit log entry for a org.enable_saml event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "digestMethodUrl", - "description": "

The SAML provider's digest algorithm URL.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "id", - "description": "

The Node ID of the OrgEnableSamlAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "issuerUrl", - "description": "

The SAML provider's issuer URL.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "signatureMethodUrl", - "description": "

The SAML provider's signature algorithm URL.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "singleSignOnUrl", - "description": "

The SAML provider's single sign-on URL.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgEnableTwoFactorRequirementAuditEntry", - "id": "orgenabletwofactorrequirementauditentry", - "href": "/graphql/reference/objects#orgenabletwofactorrequirementauditentry", - "description": "

Audit log entry for a org.enable_two_factor_requirement event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgEnableTwoFactorRequirementAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgInviteMemberAuditEntry", - "id": "orginvitememberauditentry", - "href": "/graphql/reference/objects#orginvitememberauditentry", - "description": "

Audit log entry for a org.invite_member event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "email", - "description": "

The email address of the organization invitation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the OrgInviteMemberAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationInvitation", - "description": "

The organization invitation.

", - "type": "OrganizationInvitation", - "id": "organizationinvitation", - "href": "/graphql/reference/objects#organizationinvitation" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgInviteToBusinessAuditEntry", - "id": "orginvitetobusinessauditentry", - "href": "/graphql/reference/objects#orginvitetobusinessauditentry", - "description": "

Audit log entry for a org.invite_to_business event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "EnterpriseAuditEntryData", - "id": "enterpriseauditentrydata", - "href": "/graphql/reference/interfaces#enterpriseauditentrydata" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "enterpriseResourcePath", - "description": "

The HTTP path for this enterprise.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "enterpriseSlug", - "description": "

The slug of the enterprise.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseUrl", - "description": "

The HTTP URL for this enterprise.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "id", - "description": "

The Node ID of the OrgInviteToBusinessAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgOauthAppAccessApprovedAuditEntry", - "id": "orgoauthappaccessapprovedauditentry", - "href": "/graphql/reference/objects#orgoauthappaccessapprovedauditentry", - "description": "

Audit log entry for a org.oauth_app_access_approved event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OauthApplicationAuditEntryData", - "id": "oauthapplicationauditentrydata", - "href": "/graphql/reference/interfaces#oauthapplicationauditentrydata" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgOauthAppAccessApprovedAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "oauthApplicationName", - "description": "

The name of the OAuth application.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "oauthApplicationResourcePath", - "description": "

The HTTP path for the OAuth application.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "oauthApplicationUrl", - "description": "

The HTTP URL for the OAuth application.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgOauthAppAccessBlockedAuditEntry", - "id": "orgoauthappaccessblockedauditentry", - "href": "/graphql/reference/objects#orgoauthappaccessblockedauditentry", - "description": "

Audit log entry for a org.oauth_app_access_blocked event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OauthApplicationAuditEntryData", - "id": "oauthapplicationauditentrydata", - "href": "/graphql/reference/interfaces#oauthapplicationauditentrydata" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgOauthAppAccessBlockedAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "oauthApplicationName", - "description": "

The name of the OAuth application.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "oauthApplicationResourcePath", - "description": "

The HTTP path for the OAuth application.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "oauthApplicationUrl", - "description": "

The HTTP URL for the OAuth application.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgOauthAppAccessDeniedAuditEntry", - "id": "orgoauthappaccessdeniedauditentry", - "href": "/graphql/reference/objects#orgoauthappaccessdeniedauditentry", - "description": "

Audit log entry for a org.oauth_app_access_denied event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OauthApplicationAuditEntryData", - "id": "oauthapplicationauditentrydata", - "href": "/graphql/reference/interfaces#oauthapplicationauditentrydata" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgOauthAppAccessDeniedAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "oauthApplicationName", - "description": "

The name of the OAuth application.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "oauthApplicationResourcePath", - "description": "

The HTTP path for the OAuth application.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "oauthApplicationUrl", - "description": "

The HTTP URL for the OAuth application.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgOauthAppAccessRequestedAuditEntry", - "id": "orgoauthappaccessrequestedauditentry", - "href": "/graphql/reference/objects#orgoauthappaccessrequestedauditentry", - "description": "

Audit log entry for a org.oauth_app_access_requested event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OauthApplicationAuditEntryData", - "id": "oauthapplicationauditentrydata", - "href": "/graphql/reference/interfaces#oauthapplicationauditentrydata" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgOauthAppAccessRequestedAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "oauthApplicationName", - "description": "

The name of the OAuth application.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "oauthApplicationResourcePath", - "description": "

The HTTP path for the OAuth application.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "oauthApplicationUrl", - "description": "

The HTTP URL for the OAuth application.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgOauthAppAccessUnblockedAuditEntry", - "id": "orgoauthappaccessunblockedauditentry", - "href": "/graphql/reference/objects#orgoauthappaccessunblockedauditentry", - "description": "

Audit log entry for a org.oauth_app_access_unblocked event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OauthApplicationAuditEntryData", - "id": "oauthapplicationauditentrydata", - "href": "/graphql/reference/interfaces#oauthapplicationauditentrydata" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgOauthAppAccessUnblockedAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "oauthApplicationName", - "description": "

The name of the OAuth application.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "oauthApplicationResourcePath", - "description": "

The HTTP path for the OAuth application.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "oauthApplicationUrl", - "description": "

The HTTP URL for the OAuth application.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgRemoveBillingManagerAuditEntry", - "id": "orgremovebillingmanagerauditentry", - "href": "/graphql/reference/objects#orgremovebillingmanagerauditentry", - "description": "

Audit log entry for a org.remove_billing_manager event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgRemoveBillingManagerAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "reason", - "description": "

The reason for the billing manager being removed.

", - "type": "OrgRemoveBillingManagerAuditEntryReason", - "id": "orgremovebillingmanagerauditentryreason", - "href": "/graphql/reference/enums#orgremovebillingmanagerauditentryreason" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgRemoveMemberAuditEntry", - "id": "orgremovememberauditentry", - "href": "/graphql/reference/objects#orgremovememberauditentry", - "description": "

Audit log entry for a org.remove_member event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgRemoveMemberAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "membershipTypes", - "description": "

The types of membership the member has with the organization.

", - "type": "[OrgRemoveMemberAuditEntryMembershipType!]", - "id": "orgremovememberauditentrymembershiptype", - "href": "/graphql/reference/enums#orgremovememberauditentrymembershiptype" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "reason", - "description": "

The reason for the member being removed.

", - "type": "OrgRemoveMemberAuditEntryReason", - "id": "orgremovememberauditentryreason", - "href": "/graphql/reference/enums#orgremovememberauditentryreason" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgRemoveOutsideCollaboratorAuditEntry", - "id": "orgremoveoutsidecollaboratorauditentry", - "href": "/graphql/reference/objects#orgremoveoutsidecollaboratorauditentry", - "description": "

Audit log entry for a org.remove_outside_collaborator event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgRemoveOutsideCollaboratorAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "membershipTypes", - "description": "

The types of membership the outside collaborator has with the organization.

", - "type": "[OrgRemoveOutsideCollaboratorAuditEntryMembershipType!]", - "id": "orgremoveoutsidecollaboratorauditentrymembershiptype", - "href": "/graphql/reference/enums#orgremoveoutsidecollaboratorauditentrymembershiptype" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "reason", - "description": "

The reason for the outside collaborator being removed from the Organization.

", - "type": "OrgRemoveOutsideCollaboratorAuditEntryReason", - "id": "orgremoveoutsidecollaboratorauditentryreason", - "href": "/graphql/reference/enums#orgremoveoutsidecollaboratorauditentryreason" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgRestoreMemberAuditEntry", - "id": "orgrestorememberauditentry", - "href": "/graphql/reference/objects#orgrestorememberauditentry", - "description": "

Audit log entry for a org.restore_member event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgRestoreMemberAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "restoredCustomEmailRoutingsCount", - "description": "

The number of custom email routings for the restored member.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "restoredIssueAssignmentsCount", - "description": "

The number of issue assignments for the restored member.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "restoredMemberships", - "description": "

Restored organization membership objects.

", - "type": "[OrgRestoreMemberAuditEntryMembership!]", - "id": "orgrestorememberauditentrymembership", - "href": "/graphql/reference/unions#orgrestorememberauditentrymembership" - }, - { - "name": "restoredMembershipsCount", - "description": "

The number of restored memberships.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "restoredRepositoriesCount", - "description": "

The number of repositories of the restored member.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "restoredRepositoryStarsCount", - "description": "

The number of starred repositories for the restored member.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "restoredRepositoryWatchesCount", - "description": "

The number of watched repositories for the restored member.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgRestoreMemberMembershipOrganizationAuditEntryData", - "id": "orgrestoremembermembershiporganizationauditentrydata", - "href": "/graphql/reference/objects#orgrestoremembermembershiporganizationauditentrydata", - "description": "

Metadata for an organization membership for org.restore_member actions.

", - "implements": [ - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgRestoreMemberMembershipRepositoryAuditEntryData", - "id": "orgrestoremembermembershiprepositoryauditentrydata", - "href": "/graphql/reference/objects#orgrestoremembermembershiprepositoryauditentrydata", - "description": "

Metadata for a repository membership for org.restore_member actions.

", - "implements": [ - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgRestoreMemberMembershipTeamAuditEntryData", - "id": "orgrestoremembermembershipteamauditentrydata", - "href": "/graphql/reference/objects#orgrestoremembermembershipteamauditentrydata", - "description": "

Metadata for a team membership for org.restore_member actions.

", - "implements": [ - { - "name": "TeamAuditEntryData", - "id": "teamauditentrydata", - "href": "/graphql/reference/interfaces#teamauditentrydata" - } - ], - "fields": [ - { - "name": "team", - "description": "

The team associated with the action.

", - "type": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - }, - { - "name": "teamName", - "description": "

The name of the team.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "teamResourcePath", - "description": "

The HTTP path for this team.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "teamUrl", - "description": "

The HTTP URL for this team.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgUnblockUserAuditEntry", - "id": "orgunblockuserauditentry", - "href": "/graphql/reference/objects#orgunblockuserauditentry", - "description": "

Audit log entry for a org.unblock_user.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "blockedUser", - "description": "

The user being unblocked by the organization.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "blockedUserName", - "description": "

The username of the blocked user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "blockedUserResourcePath", - "description": "

The HTTP path for the blocked user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "blockedUserUrl", - "description": "

The HTTP URL for the blocked user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgUnblockUserAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgUpdateDefaultRepositoryPermissionAuditEntry", - "id": "orgupdatedefaultrepositorypermissionauditentry", - "href": "/graphql/reference/objects#orgupdatedefaultrepositorypermissionauditentry", - "description": "

Audit log entry for a org.update_default_repository_permission.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgUpdateDefaultRepositoryPermissionAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "permission", - "description": "

The new base repository permission level for the organization.

", - "type": "OrgUpdateDefaultRepositoryPermissionAuditEntryPermission", - "id": "orgupdatedefaultrepositorypermissionauditentrypermission", - "href": "/graphql/reference/enums#orgupdatedefaultrepositorypermissionauditentrypermission" - }, - { - "name": "permissionWas", - "description": "

The former base repository permission level for the organization.

", - "type": "OrgUpdateDefaultRepositoryPermissionAuditEntryPermission", - "id": "orgupdatedefaultrepositorypermissionauditentrypermission", - "href": "/graphql/reference/enums#orgupdatedefaultrepositorypermissionauditentrypermission" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgUpdateMemberAuditEntry", - "id": "orgupdatememberauditentry", - "href": "/graphql/reference/objects#orgupdatememberauditentry", - "description": "

Audit log entry for a org.update_member event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgUpdateMemberAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "permission", - "description": "

The new member permission level for the organization.

", - "type": "OrgUpdateMemberAuditEntryPermission", - "id": "orgupdatememberauditentrypermission", - "href": "/graphql/reference/enums#orgupdatememberauditentrypermission" - }, - { - "name": "permissionWas", - "description": "

The former member permission level for the organization.

", - "type": "OrgUpdateMemberAuditEntryPermission", - "id": "orgupdatememberauditentrypermission", - "href": "/graphql/reference/enums#orgupdatememberauditentrypermission" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrgUpdateMemberRepositoryCreationPermissionAuditEntry", - "id": "orgupdatememberrepositorycreationpermissionauditentry", - "href": "/graphql/reference/objects#orgupdatememberrepositorycreationpermissionauditentry", - "description": "

Audit log entry for a org.update_member_repository_creation_permission event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "canCreateRepositories", - "description": "

Can members create repositories in the organization.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgUpdateMemberRepositoryCreationPermissionAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "visibility", - "description": "

The permission for visibility level of repositories for this organization.

", - "type": "OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility", - "id": "orgupdatememberrepositorycreationpermissionauditentryvisibility", - "href": "/graphql/reference/enums#orgupdatememberrepositorycreationpermissionauditentryvisibility" - } - ] - }, - { - "name": "OrgUpdateMemberRepositoryInvitationPermissionAuditEntry", - "id": "orgupdatememberrepositoryinvitationpermissionauditentry", - "href": "/graphql/reference/objects#orgupdatememberrepositoryinvitationpermissionauditentry", - "description": "

Audit log entry for a org.update_member_repository_invitation_permission event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "canInviteOutsideCollaboratorsToRepositories", - "description": "

Can outside collaborators be invited to repositories in the organization.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the OrgUpdateMemberRepositoryInvitationPermissionAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization", - "description": "

An account on GitHub, with one or more owners, that has repositories, members and teams.

", - "implements": [ - { - "name": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "AnnouncementBanner", - "id": "announcementbanner", - "href": "/graphql/reference/interfaces#announcementbanner" - }, - { - "name": "MemberStatusable", - "id": "memberstatusable", - "href": "/graphql/reference/interfaces#memberstatusable" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "PackageOwner", - "id": "packageowner", - "href": "/graphql/reference/interfaces#packageowner" - }, - { - "name": "ProfileOwner", - "id": "profileowner", - "href": "/graphql/reference/interfaces#profileowner" - }, - { - "name": "ProjectOwner", - "id": "projectowner", - "href": "/graphql/reference/interfaces#projectowner" - }, - { - "name": "ProjectV2Owner", - "id": "projectv2owner", - "href": "/graphql/reference/interfaces#projectv2owner" - }, - { - "name": "ProjectV2Recent", - "id": "projectv2recent", - "href": "/graphql/reference/interfaces#projectv2recent" - }, - { - "name": "RepositoryDiscussionAuthor", - "id": "repositorydiscussionauthor", - "href": "/graphql/reference/interfaces#repositorydiscussionauthor" - }, - { - "name": "RepositoryDiscussionCommentAuthor", - "id": "repositorydiscussioncommentauthor", - "href": "/graphql/reference/interfaces#repositorydiscussioncommentauthor" - }, - { - "name": "RepositoryOwner", - "id": "repositoryowner", - "href": "/graphql/reference/interfaces#repositoryowner" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "announcement", - "description": "

The text of the announcement.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "announcementCreatedAt", - "description": "

The date the announcement was created.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "announcementExpiresAt", - "description": "

The expiration date of the announcement, if any.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "announcementUserDismissible", - "description": "

Whether the announcement can be dismissed by the user.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "anyPinnableItems", - "description": "

Determine if this repository owner has any items that can be pinned to their profile.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "arguments": [ - { - "name": "type", - "description": "

Filter to only a particular kind of pinnable item.

", - "type": { - "name": "PinnableItemType", - "id": "pinnableitemtype", - "href": "/graphql/reference/enums#pinnableitemtype" - } - } - ] - }, - { - "name": "archivedAt", - "description": "

Identifies the date and time when the organization was archived.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "auditLog", - "description": "

Audit log entries of the organization.

", - "type": "OrganizationAuditEntryConnection!", - "id": "organizationauditentryconnection", - "href": "/graphql/reference/objects#organizationauditentryconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for the returned audit log entries.

", - "type": { - "name": "AuditLogOrder", - "id": "auditlogorder", - "href": "/graphql/reference/input-objects#auditlogorder" - } - }, - { - "name": "query", - "description": "

The query string to filter audit entries.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "avatarUrl", - "description": "

A URL pointing to the organization's public avatar.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "arguments": [ - { - "name": "size", - "description": "

The size of the resulting square image.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "description", - "description": "

The organization's public profile description.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "descriptionHTML", - "description": "

The organization's public profile description rendered to HTML.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "domains", - "description": "

A list of domains owned by the organization.

", - "type": "VerifiableDomainConnection", - "id": "verifiabledomainconnection", - "href": "/graphql/reference/objects#verifiabledomainconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "isApproved", - "description": "

Filter by if the domain is approved.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "isVerified", - "description": "

Filter by if the domain is verified.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for verifiable domains returned.

", - "type": { - "name": "VerifiableDomainOrder", - "id": "verifiabledomainorder", - "href": "/graphql/reference/input-objects#verifiabledomainorder" - } - } - ] - }, - { - "name": "email", - "description": "

The organization's public email.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseOwners", - "description": "

A list of owners of the organization's enterprise account.

", - "type": "OrganizationEnterpriseOwnerConnection!", - "id": "organizationenterpriseownerconnection", - "href": "/graphql/reference/objects#organizationenterpriseownerconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for enterprise owners returned from the connection.

", - "type": { - "name": "OrgEnterpriseOwnerOrder", - "id": "orgenterpriseownerorder", - "href": "/graphql/reference/input-objects#orgenterpriseownerorder" - } - }, - { - "name": "organizationRole", - "description": "

The organization role to filter by.

", - "type": { - "name": "RoleInOrganization", - "id": "roleinorganization", - "href": "/graphql/reference/enums#roleinorganization" - } - }, - { - "name": "query", - "description": "

The search string to look for.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "id", - "description": "

The Node ID of the Organization object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "ipAllowListEnabledSetting", - "description": "

The setting value for whether the organization has an IP allow list enabled.

", - "type": "IpAllowListEnabledSettingValue!", - "id": "ipallowlistenabledsettingvalue", - "href": "/graphql/reference/enums#ipallowlistenabledsettingvalue" - }, - { - "name": "ipAllowListEntries", - "description": "

The IP addresses that are allowed to access resources owned by the organization.

", - "type": "IpAllowListEntryConnection!", - "id": "ipallowlistentryconnection", - "href": "/graphql/reference/objects#ipallowlistentryconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for IP allow list entries returned.

", - "type": { - "name": "IpAllowListEntryOrder", - "id": "ipallowlistentryorder", - "href": "/graphql/reference/input-objects#ipallowlistentryorder" - } - } - ] - }, - { - "name": "ipAllowListForInstalledAppsEnabledSetting", - "description": "

The setting value for whether the organization has IP allow list configuration for installed GitHub Apps enabled.

", - "type": "IpAllowListForInstalledAppsEnabledSettingValue!", - "id": "ipallowlistforinstalledappsenabledsettingvalue", - "href": "/graphql/reference/enums#ipallowlistforinstalledappsenabledsettingvalue" - }, - { - "name": "isVerified", - "description": "

Whether the organization has verified its profile email and website.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "itemShowcase", - "description": "

Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

", - "type": "ProfileItemShowcase!", - "id": "profileitemshowcase", - "href": "/graphql/reference/objects#profileitemshowcase" - }, - { - "name": "location", - "description": "

The organization's public profile location.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "login", - "description": "

The organization's login name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "mannequins", - "description": "

A list of all mannequins for this organization.

", - "type": "MannequinConnection!", - "id": "mannequinconnection", - "href": "/graphql/reference/objects#mannequinconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "login", - "description": "

Filter mannequins by login.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for mannequins returned from the connection.

", - "type": { - "name": "MannequinOrder", - "id": "mannequinorder", - "href": "/graphql/reference/input-objects#mannequinorder" - } - } - ] - }, - { - "name": "memberStatuses", - "description": "

Get the status messages members of this entity have set that are either public or visible only to the organization.

", - "type": "UserStatusConnection!", - "id": "userstatusconnection", - "href": "/graphql/reference/objects#userstatusconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for user statuses returned from the connection.

", - "type": { - "name": "UserStatusOrder", - "id": "userstatusorder", - "href": "/graphql/reference/input-objects#userstatusorder" - } - } - ] - }, - { - "name": "membersCanForkPrivateRepositories", - "description": "

Members can fork private repositories in this organization.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "membersWithRole", - "description": "

A list of users who are members of this organization.

", - "type": "OrganizationMemberConnection!", - "id": "organizationmemberconnection", - "href": "/graphql/reference/objects#organizationmemberconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "name", - "description": "

The organization's public profile name.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "newTeamResourcePath", - "description": "

The HTTP path creating a new team.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "newTeamUrl", - "description": "

The HTTP URL creating a new team.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "notificationDeliveryRestrictionEnabledSetting", - "description": "

Indicates if email notification delivery for this organization is restricted to verified or approved domains.

", - "type": "NotificationRestrictionSettingValue!", - "id": "notificationrestrictionsettingvalue", - "href": "/graphql/reference/enums#notificationrestrictionsettingvalue" - }, - { - "name": "organizationBillingEmail", - "description": "

The billing email for the organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "packages", - "description": "

A list of packages under the owner.

", - "type": "PackageConnection!", - "id": "packageconnection", - "href": "/graphql/reference/objects#packageconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "names", - "description": "

Find packages by their names.

", - "type": { - "name": "[String]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "orderBy", - "description": "

Ordering of the returned packages.

", - "type": { - "name": "PackageOrder", - "id": "packageorder", - "href": "/graphql/reference/input-objects#packageorder" - } - }, - { - "name": "packageType", - "description": "

Filter registry package by type.

", - "type": { - "name": "PackageType", - "id": "packagetype", - "href": "/graphql/reference/enums#packagetype" - } - }, - { - "name": "repositoryId", - "description": "

Find packages in a repository by ID.

", - "type": { - "name": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - } - ] - }, - { - "name": "pendingMembers", - "description": "

A list of users who have been invited to join this organization.

", - "type": "UserConnection!", - "id": "userconnection", - "href": "/graphql/reference/objects#userconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "pinnableItems", - "description": "

A list of repositories and gists this profile owner can pin to their profile.

", - "type": "PinnableItemConnection!", - "id": "pinnableitemconnection", - "href": "/graphql/reference/objects#pinnableitemconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "types", - "description": "

Filter the types of pinnable items that are returned.

", - "type": { - "name": "[PinnableItemType!]", - "id": "pinnableitemtype", - "href": "/graphql/reference/enums#pinnableitemtype" - } - } - ] - }, - { - "name": "pinnedItems", - "description": "

A list of repositories and gists this profile owner has pinned to their profile.

", - "type": "PinnableItemConnection!", - "id": "pinnableitemconnection", - "href": "/graphql/reference/objects#pinnableitemconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "types", - "description": "

Filter the types of pinned items that are returned.

", - "type": { - "name": "[PinnableItemType!]", - "id": "pinnableitemtype", - "href": "/graphql/reference/enums#pinnableitemtype" - } - } - ] - }, - { - "name": "pinnedItemsRemaining", - "description": "

Returns how many more items this profile owner can pin to their profile.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "project", - "description": "

Find project by number.

", - "type": "Project", - "id": "project", - "href": "/graphql/reference/objects#project", - "arguments": [ - { - "name": "number", - "description": "

The project number to find.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "projectV2", - "description": "

Find a project by number.

", - "type": "ProjectV2", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2", - "arguments": [ - { - "name": "number", - "description": "

The project number.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "projects", - "description": "

A list of projects under the owner.

", - "type": "ProjectConnection!", - "id": "projectconnection", - "href": "/graphql/reference/objects#projectconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for projects returned from the connection.

", - "type": { - "name": "ProjectOrder", - "id": "projectorder", - "href": "/graphql/reference/input-objects#projectorder" - } - }, - { - "name": "search", - "description": "

Query to search projects by, currently only searching by name.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "states", - "description": "

A list of states to filter the projects by.

", - "type": { - "name": "[ProjectState!]", - "id": "projectstate", - "href": "/graphql/reference/enums#projectstate" - } - } - ] - }, - { - "name": "projectsResourcePath", - "description": "

The HTTP path listing organization's projects.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "projectsUrl", - "description": "

The HTTP URL listing organization's projects.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "projectsV2", - "description": "

A list of projects under the owner.

", - "type": "ProjectV2Connection!", - "id": "projectv2connection", - "href": "/graphql/reference/objects#projectv2connection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

How to order the returned projects.

", - "type": { - "name": "ProjectV2Order", - "id": "projectv2order", - "href": "/graphql/reference/input-objects#projectv2order" - } - }, - { - "name": "query", - "description": "

A project to search for under the the owner.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "recentProjects", - "description": "

Recent projects that this user has modified in the context of the owner.

", - "type": "ProjectV2Connection!", - "id": "projectv2connection", - "href": "/graphql/reference/objects#projectv2connection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "repositories", - "description": "

A list of repositories that the user owns.

", - "type": "RepositoryConnection!", - "id": "repositoryconnection", - "href": "/graphql/reference/objects#repositoryconnection", - "arguments": [ - { - "name": "affiliations", - "description": "

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

", - "type": { - "name": "[RepositoryAffiliation]", - "id": "repositoryaffiliation", - "href": "/graphql/reference/enums#repositoryaffiliation" - } - }, - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "hasIssuesEnabled", - "description": "

If non-null, filters repositories according to whether they have issues enabled.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "isArchived", - "description": "

If non-null, filters repositories according to whether they are archived and not maintained.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "isFork", - "description": "

If non-null, filters repositories according to whether they are forks of another repository.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "isLocked", - "description": "

If non-null, filters repositories according to whether they have been locked.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for repositories returned from the connection.

", - "type": { - "name": "RepositoryOrder", - "id": "repositoryorder", - "href": "/graphql/reference/input-objects#repositoryorder" - } - }, - { - "name": "ownerAffiliations", - "description": "

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.

", - "type": { - "name": "[RepositoryAffiliation]", - "id": "repositoryaffiliation", - "href": "/graphql/reference/enums#repositoryaffiliation" - } - }, - { - "name": "privacy", - "description": "

If non-null, filters repositories according to privacy. Internal\nrepositories are considered private; consider using the visibility argument\nif only internal repositories are needed. Cannot be combined with the\nvisibility argument.

", - "type": { - "name": "RepositoryPrivacy", - "id": "repositoryprivacy", - "href": "/graphql/reference/enums#repositoryprivacy" - } - }, - { - "name": "visibility", - "description": "

If non-null, filters repositories according to visibility. Cannot be combined with the privacy argument.

", - "type": { - "name": "RepositoryVisibility", - "id": "repositoryvisibility", - "href": "/graphql/reference/enums#repositoryvisibility" - } - } - ] - }, - { - "name": "repository", - "description": "

Find Repository.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "arguments": [ - { - "name": "followRenames", - "defaultValue": true, - "description": "

Follow repository renames. If disabled, a repository referenced by its old name will return an error.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "name", - "description": "

Name of Repository to find.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "repositoryDiscussionComments", - "description": "

Discussion comments this user has authored.

", - "type": "DiscussionCommentConnection!", - "id": "discussioncommentconnection", - "href": "/graphql/reference/objects#discussioncommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "onlyAnswers", - "defaultValue": false, - "description": "

Filter discussion comments to only those that were marked as the answer.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "repositoryId", - "description": "

Filter discussion comments to only those in a specific repository.

", - "type": { - "name": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - } - ] - }, - { - "name": "repositoryDiscussions", - "description": "

Discussions this user has started.

", - "type": "DiscussionConnection!", - "id": "discussionconnection", - "href": "/graphql/reference/objects#discussionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "answered", - "description": "

Filter discussions to only those that have been answered or not. Defaults to\nincluding both answered and unanswered discussions.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for discussions returned from the connection.

", - "type": { - "name": "DiscussionOrder", - "id": "discussionorder", - "href": "/graphql/reference/input-objects#discussionorder" - } - }, - { - "name": "repositoryId", - "description": "

Filter discussions to only those in a specific repository.

", - "type": { - "name": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - }, - { - "name": "states", - "description": "

A list of states to filter the discussions by.

", - "type": { - "name": "[DiscussionState!]", - "id": "discussionstate", - "href": "/graphql/reference/enums#discussionstate" - } - } - ] - }, - { - "name": "repositoryMigrations", - "description": "

A list of all repository migrations for this organization.

", - "type": "RepositoryMigrationConnection!", - "id": "repositorymigrationconnection", - "href": "/graphql/reference/objects#repositorymigrationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for repository migrations returned.

", - "type": { - "name": "RepositoryMigrationOrder", - "id": "repositorymigrationorder", - "href": "/graphql/reference/input-objects#repositorymigrationorder" - } - }, - { - "name": "repositoryName", - "description": "

Filter repository migrations by repository name.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "state", - "description": "

Filter repository migrations by state.

", - "type": { - "name": "MigrationState", - "id": "migrationstate", - "href": "/graphql/reference/enums#migrationstate" - } - } - ] - }, - { - "name": "requiresTwoFactorAuthentication", - "description": "

When true the organization requires all members, billing managers, and outside\ncollaborators to enable two-factor authentication.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this organization.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "ruleset", - "description": "

Returns a single ruleset from the current organization by ID.

", - "type": "RepositoryRuleset", - "id": "repositoryruleset", - "href": "/graphql/reference/objects#repositoryruleset", - "arguments": [ - { - "name": "databaseId", - "description": "

The ID of the ruleset to be returned.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "rulesets", - "description": "

A list of rulesets for this organization.

", - "type": "RepositoryRulesetConnection", - "id": "repositoryrulesetconnection", - "href": "/graphql/reference/objects#repositoryrulesetconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "includeParents", - "defaultValue": true, - "description": "

Return rulesets configured at higher levels that apply to this organization.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "samlIdentityProvider", - "description": "

The Organization's SAML identity provider. Visible to (1) organization owners,\n(2) organization owners' personal access tokens (classic) with read:org or\nadmin:org scope, (3) GitHub App with an installation token with read or write\naccess to members.

", - "type": "OrganizationIdentityProvider", - "id": "organizationidentityprovider", - "href": "/graphql/reference/objects#organizationidentityprovider" - }, - { - "name": "team", - "description": "

Find an organization's team by its slug.

", - "type": "Team", - "id": "team", - "href": "/graphql/reference/objects#team", - "arguments": [ - { - "name": "slug", - "description": "

The name or slug of the team to find.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "teams", - "description": "

A list of teams in this organization.

", - "type": "TeamConnection!", - "id": "teamconnection", - "href": "/graphql/reference/objects#teamconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "ldapMapped", - "description": "

If true, filters teams that are mapped to an LDAP Group (Enterprise only).

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "notificationSetting", - "description": "

If non-null, filters teams according to notification setting.

", - "type": { - "name": "TeamNotificationSetting", - "id": "teamnotificationsetting", - "href": "/graphql/reference/enums#teamnotificationsetting" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for teams returned from the connection.

", - "type": { - "name": "TeamOrder", - "id": "teamorder", - "href": "/graphql/reference/input-objects#teamorder" - } - }, - { - "name": "privacy", - "description": "

If non-null, filters teams according to privacy.

", - "type": { - "name": "TeamPrivacy", - "id": "teamprivacy", - "href": "/graphql/reference/enums#teamprivacy" - } - }, - { - "name": "query", - "description": "

If non-null, filters teams with query on team name and team slug.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "role", - "description": "

If non-null, filters teams according to whether the viewer is an admin or member on team.

", - "type": { - "name": "TeamRole", - "id": "teamrole", - "href": "/graphql/reference/enums#teamrole" - } - }, - { - "name": "rootTeamsOnly", - "defaultValue": false, - "description": "

If true, restrict to only root teams.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "userLogins", - "description": "

User logins to filter by.

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "teamsResourcePath", - "description": "

The HTTP path listing organization's teams.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "teamsUrl", - "description": "

The HTTP URL listing organization's teams.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "twitterUsername", - "description": "

The organization's Twitter username.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this organization.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "viewerCanAdminister", - "description": "

Organization is adminable by the viewer.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanChangePinnedItems", - "description": "

Can the viewer pin repositories and gists to the profile?.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanCreateProjects", - "description": "

Can the current viewer create new projects on this owner.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanCreateRepositories", - "description": "

Viewer can create repositories on this organization.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanCreateTeams", - "description": "

Viewer can create teams on this organization.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerIsAMember", - "description": "

Viewer is an active member of this organization.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerIsFollowing", - "description": "

Whether or not this Organization is followed by the viewer.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "webCommitSignoffRequired", - "description": "

Whether contributors are required to sign off on web-based commits for repositories in this organization.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "websiteUrl", - "description": "

The organization's public profile URL.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrganizationAuditEntryConnection", - "id": "organizationauditentryconnection", - "href": "/graphql/reference/objects#organizationauditentryconnection", - "description": "

The connection type for OrganizationAuditEntry.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[OrganizationAuditEntryEdge]", - "id": "organizationauditentryedge", - "href": "/graphql/reference/objects#organizationauditentryedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[OrganizationAuditEntry]", - "id": "organizationauditentry", - "href": "/graphql/reference/unions#organizationauditentry" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "OrganizationAuditEntryEdge", - "id": "organizationauditentryedge", - "href": "/graphql/reference/objects#organizationauditentryedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "OrganizationAuditEntry", - "id": "organizationauditentry", - "href": "/graphql/reference/unions#organizationauditentry" - } - ] - }, - { - "name": "OrganizationConnection", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "description": "

A list of organizations managed by an enterprise.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[OrganizationEdge]", - "id": "organizationedge", - "href": "/graphql/reference/objects#organizationedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Organization]", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "OrganizationEdge", - "id": "organizationedge", - "href": "/graphql/reference/objects#organizationedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - } - ] - }, - { - "name": "OrganizationEnterpriseOwnerConnection", - "id": "organizationenterpriseownerconnection", - "href": "/graphql/reference/objects#organizationenterpriseownerconnection", - "description": "

The connection type for User.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[OrganizationEnterpriseOwnerEdge]", - "id": "organizationenterpriseowneredge", - "href": "/graphql/reference/objects#organizationenterpriseowneredge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[User]", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "OrganizationEnterpriseOwnerEdge", - "id": "organizationenterpriseowneredge", - "href": "/graphql/reference/objects#organizationenterpriseowneredge", - "description": "

An enterprise owner in the context of an organization that is part of the enterprise.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "organizationRole", - "description": "

The role of the owner with respect to the organization.

", - "type": "RoleInOrganization!", - "id": "roleinorganization", - "href": "/graphql/reference/enums#roleinorganization" - } - ] - }, - { - "name": "OrganizationIdentityProvider", - "id": "organizationidentityprovider", - "href": "/graphql/reference/objects#organizationidentityprovider", - "description": "

An Identity Provider configured to provision SAML and SCIM identities for\nOrganizations. Visible to (1) organization owners, (2) organization owners'\npersonal access tokens (classic) with read:org or admin:org scope, (3) GitHub\nApp with an installation token with read or write access to members.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "digestMethod", - "description": "

The digest algorithm used to sign SAML requests for the Identity Provider.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "externalIdentities", - "description": "

External Identities provisioned by this Identity Provider.

", - "type": "ExternalIdentityConnection!", - "id": "externalidentityconnection", - "href": "/graphql/reference/objects#externalidentityconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "login", - "description": "

Filter to external identities with the users login.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "membersOnly", - "description": "

Filter to external identities with valid org membership only.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "userName", - "description": "

Filter to external identities with the users userName/NameID attribute.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "id", - "description": "

The Node ID of the OrganizationIdentityProvider object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "idpCertificate", - "description": "

The x509 certificate used by the Identity Provider to sign assertions and responses.

", - "type": "X509Certificate", - "id": "x509certificate", - "href": "/graphql/reference/scalars#x509certificate" - }, - { - "name": "issuer", - "description": "

The Issuer Entity ID for the SAML Identity Provider.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organization", - "description": "

Organization this Identity Provider belongs to.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "signatureMethod", - "description": "

The signature algorithm used to sign SAML requests for the Identity Provider.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "ssoUrl", - "description": "

The URL endpoint for the Identity Provider's SAML SSO.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrganizationInvitation", - "id": "organizationinvitation", - "href": "/graphql/reference/objects#organizationinvitation", - "description": "

An Invitation for a user to an organization.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "email", - "description": "

The email address of the user invited to the organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the OrganizationInvitation object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "invitationSource", - "description": "

The source of the invitation.

", - "type": "OrganizationInvitationSource!", - "id": "organizationinvitationsource", - "href": "/graphql/reference/enums#organizationinvitationsource" - }, - { - "name": "invitationType", - "description": "

The type of invitation that was sent (e.g. email, user).

", - "type": "OrganizationInvitationType!", - "id": "organizationinvitationtype", - "href": "/graphql/reference/enums#organizationinvitationtype" - }, - { - "name": "invitee", - "description": "

The user who was invited to the organization.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "inviter", - "description": "

The user who created the invitation.

", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user", - "isDeprecated": true, - "deprecationReason": "

inviter will be removed. inviter will be replaced by inviterActor. Removal on 2024-07-01 UTC.

" - }, - { - "name": "inviterActor", - "description": "

The user who created the invitation.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "organization", - "description": "

The organization the invite is for.

", - "type": "Organization!", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "role", - "description": "

The user's pending role in the organization (e.g. member, owner).

", - "type": "OrganizationInvitationRole!", - "id": "organizationinvitationrole", - "href": "/graphql/reference/enums#organizationinvitationrole" - } - ] - }, - { - "name": "OrganizationInvitationConnection", - "id": "organizationinvitationconnection", - "href": "/graphql/reference/objects#organizationinvitationconnection", - "description": "

The connection type for OrganizationInvitation.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[OrganizationInvitationEdge]", - "id": "organizationinvitationedge", - "href": "/graphql/reference/objects#organizationinvitationedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[OrganizationInvitation]", - "id": "organizationinvitation", - "href": "/graphql/reference/objects#organizationinvitation" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "OrganizationInvitationEdge", - "id": "organizationinvitationedge", - "href": "/graphql/reference/objects#organizationinvitationedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "OrganizationInvitation", - "id": "organizationinvitation", - "href": "/graphql/reference/objects#organizationinvitation" - } - ] - }, - { - "name": "OrganizationMemberConnection", - "id": "organizationmemberconnection", - "href": "/graphql/reference/objects#organizationmemberconnection", - "description": "

A list of users who belong to the organization.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[OrganizationMemberEdge]", - "id": "organizationmemberedge", - "href": "/graphql/reference/objects#organizationmemberedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[User]", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "OrganizationMemberEdge", - "id": "organizationmemberedge", - "href": "/graphql/reference/objects#organizationmemberedge", - "description": "

Represents a user within an organization.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "hasTwoFactorEnabled", - "description": "

Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "role", - "description": "

The role this user has in the organization.

", - "type": "OrganizationMemberRole", - "id": "organizationmemberrole", - "href": "/graphql/reference/enums#organizationmemberrole" - } - ] - }, - { - "name": "OrganizationMigration", - "id": "organizationmigration", - "href": "/graphql/reference/objects#organizationmigration", - "description": "

A GitHub Enterprise Importer (GEI) organization migration.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "failureReason", - "description": "

The reason the organization migration failed.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the OrganizationMigration object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "remainingRepositoriesCount", - "description": "

The remaining amount of repos to be migrated.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "sourceOrgName", - "description": "

The name of the source organization to be migrated.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "sourceOrgUrl", - "description": "

The URL of the source organization to migrate.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "state", - "description": "

The migration state.

", - "type": "OrganizationMigrationState!", - "id": "organizationmigrationstate", - "href": "/graphql/reference/enums#organizationmigrationstate" - }, - { - "name": "targetOrgName", - "description": "

The name of the target organization.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "totalRepositoriesCount", - "description": "

The total amount of repositories to be migrated.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "OrganizationTeamsHovercardContext", - "id": "organizationteamshovercardcontext", - "href": "/graphql/reference/objects#organizationteamshovercardcontext", - "description": "

An organization teams hovercard context.

", - "implements": [ - { - "name": "HovercardContext", - "id": "hovercardcontext", - "href": "/graphql/reference/interfaces#hovercardcontext" - } - ], - "fields": [ - { - "name": "message", - "description": "

A string describing this context.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "octicon", - "description": "

An octicon to accompany this context.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "relevantTeams", - "description": "

Teams in this organization the user is a member of that are relevant.

", - "type": "TeamConnection!", - "id": "teamconnection", - "href": "/graphql/reference/objects#teamconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "teamsResourcePath", - "description": "

The path for the full team list for this user.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "teamsUrl", - "description": "

The URL for the full team list for this user.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "totalTeamCount", - "description": "

The total number of teams the user is on in the organization.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "OrganizationsHovercardContext", - "id": "organizationshovercardcontext", - "href": "/graphql/reference/objects#organizationshovercardcontext", - "description": "

An organization list hovercard context.

", - "implements": [ - { - "name": "HovercardContext", - "id": "hovercardcontext", - "href": "/graphql/reference/interfaces#hovercardcontext" - } - ], - "fields": [ - { - "name": "message", - "description": "

A string describing this context.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "octicon", - "description": "

An octicon to accompany this context.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "relevantOrganizations", - "description": "

Organizations this user is a member of that are relevant.

", - "type": "OrganizationConnection!", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for the User's organizations.

", - "type": { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder" - } - } - ] - }, - { - "name": "totalOrganizationCount", - "description": "

The total number of organizations this user is in.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "Package", - "id": "package", - "href": "/graphql/reference/objects#package", - "description": "

Information for an uploaded package.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "id", - "description": "

The Node ID of the Package object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "latestVersion", - "description": "

Find the latest version for the package.

", - "type": "PackageVersion", - "id": "packageversion", - "href": "/graphql/reference/objects#packageversion" - }, - { - "name": "name", - "description": "

Identifies the name of the package.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "packageType", - "description": "

Identifies the type of the package.

", - "type": "PackageType!", - "id": "packagetype", - "href": "/graphql/reference/enums#packagetype" - }, - { - "name": "repository", - "description": "

The repository this package belongs to.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "statistics", - "description": "

Statistics about package activity.

", - "type": "PackageStatistics", - "id": "packagestatistics", - "href": "/graphql/reference/objects#packagestatistics" - }, - { - "name": "version", - "description": "

Find package version by version string.

", - "type": "PackageVersion", - "id": "packageversion", - "href": "/graphql/reference/objects#packageversion", - "arguments": [ - { - "name": "version", - "description": "

The package version.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "versions", - "description": "

list of versions for this package.

", - "type": "PackageVersionConnection!", - "id": "packageversionconnection", - "href": "/graphql/reference/objects#packageversionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering of the returned packages.

", - "type": { - "name": "PackageVersionOrder", - "id": "packageversionorder", - "href": "/graphql/reference/input-objects#packageversionorder" - } - } - ] - } - ] - }, - { - "name": "PackageConnection", - "id": "packageconnection", - "href": "/graphql/reference/objects#packageconnection", - "description": "

The connection type for Package.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[PackageEdge]", - "id": "packageedge", - "href": "/graphql/reference/objects#packageedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Package]", - "id": "package", - "href": "/graphql/reference/objects#package" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "PackageEdge", - "id": "packageedge", - "href": "/graphql/reference/objects#packageedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Package", - "id": "package", - "href": "/graphql/reference/objects#package" - } - ] - }, - { - "name": "PackageFile", - "id": "packagefile", - "href": "/graphql/reference/objects#packagefile", - "description": "

A file in a package version.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "id", - "description": "

The Node ID of the PackageFile object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "md5", - "description": "

MD5 hash of the file.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

Name of the file.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "packageVersion", - "description": "

The package version this file belongs to.

", - "type": "PackageVersion", - "id": "packageversion", - "href": "/graphql/reference/objects#packageversion" - }, - { - "name": "sha1", - "description": "

SHA1 hash of the file.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "sha256", - "description": "

SHA256 hash of the file.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "size", - "description": "

Size of the file in bytes.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

URL to download the asset.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "PackageFileConnection", - "id": "packagefileconnection", - "href": "/graphql/reference/objects#packagefileconnection", - "description": "

The connection type for PackageFile.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[PackageFileEdge]", - "id": "packagefileedge", - "href": "/graphql/reference/objects#packagefileedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[PackageFile]", - "id": "packagefile", - "href": "/graphql/reference/objects#packagefile" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "PackageFileEdge", - "id": "packagefileedge", - "href": "/graphql/reference/objects#packagefileedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "PackageFile", - "id": "packagefile", - "href": "/graphql/reference/objects#packagefile" - } - ] - }, - { - "name": "PackageStatistics", - "id": "packagestatistics", - "href": "/graphql/reference/objects#packagestatistics", - "description": "

Represents a object that contains package activity statistics such as downloads.

", - "fields": [ - { - "name": "downloadsTotalCount", - "description": "

Number of times the package was downloaded since it was created.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "PackageTag", - "id": "packagetag", - "href": "/graphql/reference/objects#packagetag", - "description": "

A version tag contains the mapping between a tag name and a version.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "id", - "description": "

The Node ID of the PackageTag object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "name", - "description": "

Identifies the tag name of the version.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "version", - "description": "

Version that the tag is associated with.

", - "type": "PackageVersion", - "id": "packageversion", - "href": "/graphql/reference/objects#packageversion" - } - ] - }, - { - "name": "PackageVersion", - "id": "packageversion", - "href": "/graphql/reference/objects#packageversion", - "description": "

Information about a specific package version.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "files", - "description": "

List of files associated with this package version.

", - "type": "PackageFileConnection!", - "id": "packagefileconnection", - "href": "/graphql/reference/objects#packagefileconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering of the returned package files.

", - "type": { - "name": "PackageFileOrder", - "id": "packagefileorder", - "href": "/graphql/reference/input-objects#packagefileorder" - } - } - ] - }, - { - "name": "id", - "description": "

The Node ID of the PackageVersion object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "package", - "description": "

The package associated with this version.

", - "type": "Package", - "id": "package", - "href": "/graphql/reference/objects#package" - }, - { - "name": "platform", - "description": "

The platform this version was built for.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "preRelease", - "description": "

Whether or not this version is a pre-release.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "readme", - "description": "

The README of this package version.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "release", - "description": "

The release associated with this package version.

", - "type": "Release", - "id": "release", - "href": "/graphql/reference/objects#release" - }, - { - "name": "statistics", - "description": "

Statistics about package activity.

", - "type": "PackageVersionStatistics", - "id": "packageversionstatistics", - "href": "/graphql/reference/objects#packageversionstatistics" - }, - { - "name": "summary", - "description": "

The package version summary.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "version", - "description": "

The version string.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "PackageVersionConnection", - "id": "packageversionconnection", - "href": "/graphql/reference/objects#packageversionconnection", - "description": "

The connection type for PackageVersion.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[PackageVersionEdge]", - "id": "packageversionedge", - "href": "/graphql/reference/objects#packageversionedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[PackageVersion]", - "id": "packageversion", - "href": "/graphql/reference/objects#packageversion" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "PackageVersionEdge", - "id": "packageversionedge", - "href": "/graphql/reference/objects#packageversionedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "PackageVersion", - "id": "packageversion", - "href": "/graphql/reference/objects#packageversion" - } - ] - }, - { - "name": "PackageVersionStatistics", - "id": "packageversionstatistics", - "href": "/graphql/reference/objects#packageversionstatistics", - "description": "

Represents a object that contains package version activity statistics such as downloads.

", - "fields": [ - { - "name": "downloadsTotalCount", - "description": "

Number of times the package was downloaded since it was created.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "PageInfo", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo", - "description": "

Information about pagination in a connection.

", - "fields": [ - { - "name": "endCursor", - "description": "

When paginating forwards, the cursor to continue.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "hasNextPage", - "description": "

When paginating forwards, are there more items?.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "hasPreviousPage", - "description": "

When paginating backwards, are there more items?.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "startCursor", - "description": "

When paginating backwards, the cursor to continue.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "PermissionSource", - "id": "permissionsource", - "href": "/graphql/reference/objects#permissionsource", - "description": "

A level of permission and source for a user's access to a repository.

", - "fields": [ - { - "name": "organization", - "description": "

The organization the repository belongs to.

", - "type": "Organization!", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "permission", - "description": "

The level of access this source has granted to the user.

", - "type": "DefaultRepositoryPermissionField!", - "id": "defaultrepositorypermissionfield", - "href": "/graphql/reference/enums#defaultrepositorypermissionfield" - }, - { - "name": "roleName", - "description": "

The name of the role this source has granted to the user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "source", - "description": "

The source of this permission.

", - "type": "PermissionGranter!", - "id": "permissiongranter", - "href": "/graphql/reference/unions#permissiongranter" - } - ] - }, - { - "name": "PinnableItemConnection", - "id": "pinnableitemconnection", - "href": "/graphql/reference/objects#pinnableitemconnection", - "description": "

The connection type for PinnableItem.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[PinnableItemEdge]", - "id": "pinnableitemedge", - "href": "/graphql/reference/objects#pinnableitemedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[PinnableItem]", - "id": "pinnableitem", - "href": "/graphql/reference/unions#pinnableitem" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "PinnableItemEdge", - "id": "pinnableitemedge", - "href": "/graphql/reference/objects#pinnableitemedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "PinnableItem", - "id": "pinnableitem", - "href": "/graphql/reference/unions#pinnableitem" - } - ] - }, - { - "name": "PinnedDiscussion", - "id": "pinneddiscussion", - "href": "/graphql/reference/objects#pinneddiscussion", - "description": "

A Pinned Discussion is a discussion pinned to a repository's index page.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "RepositoryNode", - "id": "repositorynode", - "href": "/graphql/reference/interfaces#repositorynode" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "discussion", - "description": "

The discussion that was pinned.

", - "type": "Discussion!", - "id": "discussion", - "href": "/graphql/reference/objects#discussion" - }, - { - "name": "gradientStopColors", - "description": "

Color stops of the chosen gradient.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the PinnedDiscussion object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pattern", - "description": "

Background texture pattern.

", - "type": "PinnedDiscussionPattern!", - "id": "pinneddiscussionpattern", - "href": "/graphql/reference/enums#pinneddiscussionpattern" - }, - { - "name": "pinnedBy", - "description": "

The actor that pinned this discussion.

", - "type": "Actor!", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "preconfiguredGradient", - "description": "

Preconfigured background gradient option.

", - "type": "PinnedDiscussionGradient", - "id": "pinneddiscussiongradient", - "href": "/graphql/reference/enums#pinneddiscussiongradient" - }, - { - "name": "repository", - "description": "

The repository associated with this node.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "PinnedDiscussionConnection", - "id": "pinneddiscussionconnection", - "href": "/graphql/reference/objects#pinneddiscussionconnection", - "description": "

The connection type for PinnedDiscussion.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[PinnedDiscussionEdge]", - "id": "pinneddiscussionedge", - "href": "/graphql/reference/objects#pinneddiscussionedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[PinnedDiscussion]", - "id": "pinneddiscussion", - "href": "/graphql/reference/objects#pinneddiscussion" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "PinnedDiscussionEdge", - "id": "pinneddiscussionedge", - "href": "/graphql/reference/objects#pinneddiscussionedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "PinnedDiscussion", - "id": "pinneddiscussion", - "href": "/graphql/reference/objects#pinneddiscussion" - } - ] - }, - { - "name": "PinnedEnvironment", - "id": "pinnedenvironment", - "href": "/graphql/reference/objects#pinnedenvironment", - "description": "

Represents a pinned environment on a given repository.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the pinned environment was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "environment", - "description": "

Identifies the environment associated.

", - "type": "Environment!", - "id": "environment", - "href": "/graphql/reference/objects#environment" - }, - { - "name": "id", - "description": "

The Node ID of the PinnedEnvironment object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "position", - "description": "

Identifies the position of the pinned environment.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "repository", - "description": "

The repository that this environment was pinned to.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "PinnedEnvironmentConnection", - "id": "pinnedenvironmentconnection", - "href": "/graphql/reference/objects#pinnedenvironmentconnection", - "description": "

The connection type for PinnedEnvironment.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[PinnedEnvironmentEdge]", - "id": "pinnedenvironmentedge", - "href": "/graphql/reference/objects#pinnedenvironmentedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[PinnedEnvironment]", - "id": "pinnedenvironment", - "href": "/graphql/reference/objects#pinnedenvironment" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "PinnedEnvironmentEdge", - "id": "pinnedenvironmentedge", - "href": "/graphql/reference/objects#pinnedenvironmentedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "PinnedEnvironment", - "id": "pinnedenvironment", - "href": "/graphql/reference/objects#pinnedenvironment" - } - ] - }, - { - "name": "PinnedEvent", - "id": "pinnedevent", - "href": "/graphql/reference/objects#pinnedevent", - "description": "

Represents apinnedevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the PinnedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "issue", - "description": "

Identifies the issue associated with the event.

", - "type": "Issue!", - "id": "issue", - "href": "/graphql/reference/objects#issue" - } - ] - }, - { - "name": "PinnedIssue", - "id": "pinnedissue", - "href": "/graphql/reference/objects#pinnedissue", - "description": "

A Pinned Issue is a issue pinned to a repository's index page.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "fullDatabaseId", - "description": "

Identifies the primary key from the database as a BigInt.

", - "type": "BigInt", - "id": "bigint", - "href": "/graphql/reference/scalars#bigint" - }, - { - "name": "id", - "description": "

The Node ID of the PinnedIssue object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "issue", - "description": "

The issue that was pinned.

", - "type": "Issue!", - "id": "issue", - "href": "/graphql/reference/objects#issue" - }, - { - "name": "pinnedBy", - "description": "

The actor that pinned this issue.

", - "type": "Actor!", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "repository", - "description": "

The repository that this issue was pinned to.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "PinnedIssueConnection", - "id": "pinnedissueconnection", - "href": "/graphql/reference/objects#pinnedissueconnection", - "description": "

The connection type for PinnedIssue.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[PinnedIssueEdge]", - "id": "pinnedissueedge", - "href": "/graphql/reference/objects#pinnedissueedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[PinnedIssue]", - "id": "pinnedissue", - "href": "/graphql/reference/objects#pinnedissue" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "PinnedIssueEdge", - "id": "pinnedissueedge", - "href": "/graphql/reference/objects#pinnedissueedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "PinnedIssue", - "id": "pinnedissue", - "href": "/graphql/reference/objects#pinnedissue" - } - ] - }, - { - "name": "PrivateRepositoryForkingDisableAuditEntry", - "id": "privaterepositoryforkingdisableauditentry", - "href": "/graphql/reference/objects#privaterepositoryforkingdisableauditentry", - "description": "

Audit log entry for a private_repository_forking.disable event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "EnterpriseAuditEntryData", - "id": "enterpriseauditentrydata", - "href": "/graphql/reference/interfaces#enterpriseauditentrydata" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "enterpriseResourcePath", - "description": "

The HTTP path for this enterprise.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "enterpriseSlug", - "description": "

The slug of the enterprise.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseUrl", - "description": "

The HTTP URL for this enterprise.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "id", - "description": "

The Node ID of the PrivateRepositoryForkingDisableAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "PrivateRepositoryForkingEnableAuditEntry", - "id": "privaterepositoryforkingenableauditentry", - "href": "/graphql/reference/objects#privaterepositoryforkingenableauditentry", - "description": "

Audit log entry for a private_repository_forking.enable event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "EnterpriseAuditEntryData", - "id": "enterpriseauditentrydata", - "href": "/graphql/reference/interfaces#enterpriseauditentrydata" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "enterpriseResourcePath", - "description": "

The HTTP path for this enterprise.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "enterpriseSlug", - "description": "

The slug of the enterprise.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseUrl", - "description": "

The HTTP URL for this enterprise.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "id", - "description": "

The Node ID of the PrivateRepositoryForkingEnableAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "ProfileItemShowcase", - "id": "profileitemshowcase", - "href": "/graphql/reference/objects#profileitemshowcase", - "description": "

A curatable list of repositories relating to a repository owner, which defaults\nto showing the most popular repositories they own.

", - "fields": [ - { - "name": "hasPinnedItems", - "description": "

Whether or not the owner has pinned any repositories or gists.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "items", - "description": "

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.

", - "type": "PinnableItemConnection!", - "id": "pinnableitemconnection", - "href": "/graphql/reference/objects#pinnableitemconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - } - ] - }, - { - "name": "Project", - "id": "project", - "href": "/graphql/reference/objects#project", - "description": "

Projects manage issues, pull requests and notes within a project owner.

", - "implements": [ - { - "name": "Closable", - "id": "closable", - "href": "/graphql/reference/interfaces#closable" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "Updatable", - "id": "updatable", - "href": "/graphql/reference/interfaces#updatable" - } - ], - "fields": [ - { - "name": "body", - "description": "

The project's description body.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyHTML", - "description": "

The projects description body rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "closed", - "description": "

Indicates if the object is closed (definition of closed may depend on type).

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "closedAt", - "description": "

Identifies the date and time when the object was closed.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "columns", - "description": "

List of columns in the project.

", - "type": "ProjectColumnConnection!", - "id": "projectcolumnconnection", - "href": "/graphql/reference/objects#projectcolumnconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "creator", - "description": "

The actor who originally created the project.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the Project object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "name", - "description": "

The project's name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "number", - "description": "

The project's number.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "owner", - "description": "

The project's owner. Currently limited to repositories, organizations, and users.

", - "type": "ProjectOwner!", - "id": "projectowner", - "href": "/graphql/reference/interfaces#projectowner" - }, - { - "name": "pendingCards", - "description": "

List of pending cards in this project.

", - "type": "ProjectCardConnection!", - "id": "projectcardconnection", - "href": "/graphql/reference/objects#projectcardconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "archivedStates", - "description": "

A list of archived states to filter the cards by.

", - "type": { - "name": "[ProjectCardArchivedState]", - "id": "projectcardarchivedstate", - "href": "/graphql/reference/enums#projectcardarchivedstate" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "progress", - "description": "

Project progress details.

", - "type": "ProjectProgress!", - "id": "projectprogress", - "href": "/graphql/reference/objects#projectprogress" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this project.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "state", - "description": "

Whether the project is open or closed.

", - "type": "ProjectState!", - "id": "projectstate", - "href": "/graphql/reference/enums#projectstate" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this project.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "viewerCanClose", - "description": "

Indicates if the object can be closed by the viewer.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanReopen", - "description": "

Indicates if the object can be reopened by the viewer.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUpdate", - "description": "

Check if the current viewer can update this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "ProjectCard", - "id": "projectcard", - "href": "/graphql/reference/objects#projectcard", - "description": "

A card in a project.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "column", - "description": "

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.

", - "type": "ProjectColumn", - "id": "projectcolumn", - "href": "/graphql/reference/objects#projectcolumn" - }, - { - "name": "content", - "description": "

The card content item.

", - "type": "ProjectCardItem", - "id": "projectcarditem", - "href": "/graphql/reference/unions#projectcarditem" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "creator", - "description": "

The actor who created this card.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the ProjectCard object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isArchived", - "description": "

Whether the card is archived.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "note", - "description": "

The card note.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "project", - "description": "

The project that contains this card.

", - "type": "Project!", - "id": "project", - "href": "/graphql/reference/objects#project" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this card.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "state", - "description": "

The state of ProjectCard.

", - "type": "ProjectCardState", - "id": "projectcardstate", - "href": "/graphql/reference/enums#projectcardstate" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this card.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "ProjectCardConnection", - "id": "projectcardconnection", - "href": "/graphql/reference/objects#projectcardconnection", - "description": "

The connection type for ProjectCard.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ProjectCardEdge]", - "id": "projectcardedge", - "href": "/graphql/reference/objects#projectcardedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[ProjectCard]", - "id": "projectcard", - "href": "/graphql/reference/objects#projectcard" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ProjectCardEdge", - "id": "projectcardedge", - "href": "/graphql/reference/objects#projectcardedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "ProjectCard", - "id": "projectcard", - "href": "/graphql/reference/objects#projectcard" - } - ] - }, - { - "name": "ProjectColumn", - "id": "projectcolumn", - "href": "/graphql/reference/objects#projectcolumn", - "description": "

A column inside a project.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "cards", - "description": "

List of cards in the column.

", - "type": "ProjectCardConnection!", - "id": "projectcardconnection", - "href": "/graphql/reference/objects#projectcardconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "archivedStates", - "description": "

A list of archived states to filter the cards by.

", - "type": { - "name": "[ProjectCardArchivedState]", - "id": "projectcardarchivedstate", - "href": "/graphql/reference/enums#projectcardarchivedstate" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the ProjectColumn object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "name", - "description": "

The project column's name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "project", - "description": "

The project that contains this column.

", - "type": "Project!", - "id": "project", - "href": "/graphql/reference/objects#project" - }, - { - "name": "purpose", - "description": "

The semantic purpose of the column.

", - "type": "ProjectColumnPurpose", - "id": "projectcolumnpurpose", - "href": "/graphql/reference/enums#projectcolumnpurpose" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this project column.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this project column.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "ProjectColumnConnection", - "id": "projectcolumnconnection", - "href": "/graphql/reference/objects#projectcolumnconnection", - "description": "

The connection type for ProjectColumn.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ProjectColumnEdge]", - "id": "projectcolumnedge", - "href": "/graphql/reference/objects#projectcolumnedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[ProjectColumn]", - "id": "projectcolumn", - "href": "/graphql/reference/objects#projectcolumn" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ProjectColumnEdge", - "id": "projectcolumnedge", - "href": "/graphql/reference/objects#projectcolumnedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "ProjectColumn", - "id": "projectcolumn", - "href": "/graphql/reference/objects#projectcolumn" - } - ] - }, - { - "name": "ProjectConnection", - "id": "projectconnection", - "href": "/graphql/reference/objects#projectconnection", - "description": "

A list of projects associated with the owner.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ProjectEdge]", - "id": "projectedge", - "href": "/graphql/reference/objects#projectedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Project]", - "id": "project", - "href": "/graphql/reference/objects#project" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ProjectEdge", - "id": "projectedge", - "href": "/graphql/reference/objects#projectedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Project", - "id": "project", - "href": "/graphql/reference/objects#project" - } - ] - }, - { - "name": "ProjectProgress", - "id": "projectprogress", - "href": "/graphql/reference/objects#projectprogress", - "description": "

Project progress stats.

", - "fields": [ - { - "name": "doneCount", - "description": "

The number of done cards.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "donePercentage", - "description": "

The percentage of done cards.

", - "type": "Float!", - "id": "float", - "href": "/graphql/reference/scalars#float" - }, - { - "name": "enabled", - "description": "

Whether progress tracking is enabled and cards with purpose exist for this project.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "inProgressCount", - "description": "

The number of in-progress cards.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "inProgressPercentage", - "description": "

The percentage of in-progress cards.

", - "type": "Float!", - "id": "float", - "href": "/graphql/reference/scalars#float" - }, - { - "name": "todoCount", - "description": "

The number of to do cards.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "todoPercentage", - "description": "

The percentage of to do cards.

", - "type": "Float!", - "id": "float", - "href": "/graphql/reference/scalars#float" - } - ] - }, - { - "name": "ProjectV2", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2", - "description": "

New projects that manage issues, pull requests and drafts using tables and boards.

", - "implements": [ - { - "name": "Closable", - "id": "closable", - "href": "/graphql/reference/interfaces#closable" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "Updatable", - "id": "updatable", - "href": "/graphql/reference/interfaces#updatable" - } - ], - "fields": [ - { - "name": "closed", - "description": "

Returns true if the project is closed.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "closedAt", - "description": "

Identifies the date and time when the object was closed.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "creator", - "description": "

The actor who originally created the project.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "field", - "description": "

A field of the project.

", - "type": "ProjectV2FieldConfiguration", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration", - "arguments": [ - { - "name": "name", - "description": "

The name of the field.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "fields", - "description": "

List of fields and their constraints in the project.

", - "type": "ProjectV2FieldConfigurationConnection!", - "id": "projectv2fieldconfigurationconnection", - "href": "/graphql/reference/objects#projectv2fieldconfigurationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for project v2 fields returned from the connection.

", - "type": { - "name": "ProjectV2FieldOrder", - "id": "projectv2fieldorder", - "href": "/graphql/reference/input-objects#projectv2fieldorder" - } - } - ] - }, - { - "name": "id", - "description": "

The Node ID of the ProjectV2 object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "items", - "description": "

List of items in the project.

", - "type": "ProjectV2ItemConnection!", - "id": "projectv2itemconnection", - "href": "/graphql/reference/objects#projectv2itemconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for project v2 items returned from the connection.

", - "type": { - "name": "ProjectV2ItemOrder", - "id": "projectv2itemorder", - "href": "/graphql/reference/input-objects#projectv2itemorder" - } - } - ] - }, - { - "name": "number", - "description": "

The project's number.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "owner", - "description": "

The project's owner. Currently limited to organizations and users.

", - "type": "ProjectV2Owner!", - "id": "projectv2owner", - "href": "/graphql/reference/interfaces#projectv2owner" - }, - { - "name": "public", - "description": "

Returns true if the project is public.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "readme", - "description": "

The project's readme.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositories", - "description": "

The repositories the project is linked to.

", - "type": "RepositoryConnection!", - "id": "repositoryconnection", - "href": "/graphql/reference/objects#repositoryconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for repositories returned from the connection.

", - "type": { - "name": "RepositoryOrder", - "id": "repositoryorder", - "href": "/graphql/reference/input-objects#repositoryorder" - } - } - ] - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this project.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "shortDescription", - "description": "

The project's short description.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "teams", - "description": "

The teams the project is linked to.

", - "type": "TeamConnection!", - "id": "teamconnection", - "href": "/graphql/reference/objects#teamconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for teams returned from this connection.

", - "type": { - "name": "TeamOrder", - "id": "teamorder", - "href": "/graphql/reference/input-objects#teamorder" - } - } - ] - }, - { - "name": "template", - "description": "

Returns true if this project is a template.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "title", - "description": "

The project's name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this project.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "view", - "description": "

A view of the project.

", - "type": "ProjectV2View", - "id": "projectv2view", - "href": "/graphql/reference/objects#projectv2view", - "arguments": [ - { - "name": "number", - "description": "

The number of a view belonging to the project.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "viewerCanClose", - "description": "

Indicates if the object can be closed by the viewer.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanReopen", - "description": "

Indicates if the object can be reopened by the viewer.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUpdate", - "description": "

Check if the current viewer can update this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "views", - "description": "

List of views in the project.

", - "type": "ProjectV2ViewConnection!", - "id": "projectv2viewconnection", - "href": "/graphql/reference/objects#projectv2viewconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for project v2 views returned from the connection.

", - "type": { - "name": "ProjectV2ViewOrder", - "id": "projectv2vieworder", - "href": "/graphql/reference/input-objects#projectv2vieworder" - } - } - ] - }, - { - "name": "workflow", - "description": "

A workflow of the project.

", - "type": "ProjectV2Workflow", - "id": "projectv2workflow", - "href": "/graphql/reference/objects#projectv2workflow", - "arguments": [ - { - "name": "number", - "description": "

The number of a workflow belonging to the project.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "workflows", - "description": "

List of the workflows in the project.

", - "type": "ProjectV2WorkflowConnection!", - "id": "projectv2workflowconnection", - "href": "/graphql/reference/objects#projectv2workflowconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for project v2 workflows returned from the connection.

", - "type": { - "name": "ProjectV2WorkflowOrder", - "id": "projectv2workfloworder", - "href": "/graphql/reference/input-objects#projectv2workfloworder" - } - } - ] - } - ] - }, - { - "name": "ProjectV2ActorConnection", - "id": "projectv2actorconnection", - "href": "/graphql/reference/objects#projectv2actorconnection", - "description": "

The connection type for ProjectV2Actor.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ProjectV2ActorEdge]", - "id": "projectv2actoredge", - "href": "/graphql/reference/objects#projectv2actoredge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[ProjectV2Actor]", - "id": "projectv2actor", - "href": "/graphql/reference/unions#projectv2actor" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ProjectV2ActorEdge", - "id": "projectv2actoredge", - "href": "/graphql/reference/objects#projectv2actoredge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "ProjectV2Actor", - "id": "projectv2actor", - "href": "/graphql/reference/unions#projectv2actor" - } - ] - }, - { - "name": "ProjectV2Connection", - "id": "projectv2connection", - "href": "/graphql/reference/objects#projectv2connection", - "description": "

The connection type for ProjectV2.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ProjectV2Edge]", - "id": "projectv2edge", - "href": "/graphql/reference/objects#projectv2edge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[ProjectV2]", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ProjectV2Edge", - "id": "projectv2edge", - "href": "/graphql/reference/objects#projectv2edge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "ProjectV2", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2" - } - ] - }, - { - "name": "ProjectV2Field", - "id": "projectv2field", - "href": "/graphql/reference/objects#projectv2field", - "description": "

A field inside a project.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "ProjectV2FieldCommon", - "id": "projectv2fieldcommon", - "href": "/graphql/reference/interfaces#projectv2fieldcommon" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "dataType", - "description": "

The field's type.

", - "type": "ProjectV2FieldType!", - "id": "projectv2fieldtype", - "href": "/graphql/reference/enums#projectv2fieldtype" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the ProjectV2Field object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "name", - "description": "

The project field's name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "project", - "description": "

The project that contains this field.

", - "type": "ProjectV2!", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "ProjectV2FieldConfigurationConnection", - "id": "projectv2fieldconfigurationconnection", - "href": "/graphql/reference/objects#projectv2fieldconfigurationconnection", - "description": "

The connection type for ProjectV2FieldConfiguration.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ProjectV2FieldConfigurationEdge]", - "id": "projectv2fieldconfigurationedge", - "href": "/graphql/reference/objects#projectv2fieldconfigurationedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[ProjectV2FieldConfiguration]", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ProjectV2FieldConfigurationEdge", - "id": "projectv2fieldconfigurationedge", - "href": "/graphql/reference/objects#projectv2fieldconfigurationedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "ProjectV2FieldConfiguration", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration" - } - ] - }, - { - "name": "ProjectV2FieldConnection", - "id": "projectv2fieldconnection", - "href": "/graphql/reference/objects#projectv2fieldconnection", - "description": "

The connection type for ProjectV2Field.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ProjectV2FieldEdge]", - "id": "projectv2fieldedge", - "href": "/graphql/reference/objects#projectv2fieldedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[ProjectV2Field]", - "id": "projectv2field", - "href": "/graphql/reference/objects#projectv2field" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ProjectV2FieldEdge", - "id": "projectv2fieldedge", - "href": "/graphql/reference/objects#projectv2fieldedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "ProjectV2Field", - "id": "projectv2field", - "href": "/graphql/reference/objects#projectv2field" - } - ] - }, - { - "name": "ProjectV2Item", - "id": "projectv2item", - "href": "/graphql/reference/objects#projectv2item", - "description": "

An item within a Project.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "content", - "description": "

The content of the referenced draft issue, issue, or pull request.

", - "type": "ProjectV2ItemContent", - "id": "projectv2itemcontent", - "href": "/graphql/reference/unions#projectv2itemcontent" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "creator", - "description": "

The actor who created the item.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "fieldValueByName", - "description": "

The field value of the first project field which matches thenameargument that is set on the item.

", - "type": "ProjectV2ItemFieldValue", - "id": "projectv2itemfieldvalue", - "href": "/graphql/reference/unions#projectv2itemfieldvalue", - "arguments": [ - { - "name": "name", - "description": "

The name of the field to return the field value of.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "fieldValues", - "description": "

The field values that are set on the item.

", - "type": "ProjectV2ItemFieldValueConnection!", - "id": "projectv2itemfieldvalueconnection", - "href": "/graphql/reference/objects#projectv2itemfieldvalueconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for project v2 item field values returned from the connection.

", - "type": { - "name": "ProjectV2ItemFieldValueOrder", - "id": "projectv2itemfieldvalueorder", - "href": "/graphql/reference/input-objects#projectv2itemfieldvalueorder" - } - } - ] - }, - { - "name": "fullDatabaseId", - "description": "

Identifies the primary key from the database as a BigInt.

", - "type": "BigInt", - "id": "bigint", - "href": "/graphql/reference/scalars#bigint" - }, - { - "name": "id", - "description": "

The Node ID of the ProjectV2Item object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isArchived", - "description": "

Whether the item is archived.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "project", - "description": "

The project that contains this item.

", - "type": "ProjectV2!", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2" - }, - { - "name": "type", - "description": "

The type of the item.

", - "type": "ProjectV2ItemType!", - "id": "projectv2itemtype", - "href": "/graphql/reference/enums#projectv2itemtype" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "ProjectV2ItemConnection", - "id": "projectv2itemconnection", - "href": "/graphql/reference/objects#projectv2itemconnection", - "description": "

The connection type for ProjectV2Item.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ProjectV2ItemEdge]", - "id": "projectv2itemedge", - "href": "/graphql/reference/objects#projectv2itemedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[ProjectV2Item]", - "id": "projectv2item", - "href": "/graphql/reference/objects#projectv2item" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ProjectV2ItemEdge", - "id": "projectv2itemedge", - "href": "/graphql/reference/objects#projectv2itemedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "ProjectV2Item", - "id": "projectv2item", - "href": "/graphql/reference/objects#projectv2item" - } - ] - }, - { - "name": "ProjectV2ItemFieldDateValue", - "id": "projectv2itemfielddatevalue", - "href": "/graphql/reference/objects#projectv2itemfielddatevalue", - "description": "

The value of a date field in a Project item.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "ProjectV2ItemFieldValueCommon", - "id": "projectv2itemfieldvaluecommon", - "href": "/graphql/reference/interfaces#projectv2itemfieldvaluecommon" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "creator", - "description": "

The actor who created the item.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "date", - "description": "

Date value for the field.

", - "type": "Date", - "id": "date", - "href": "/graphql/reference/scalars#date" - }, - { - "name": "field", - "description": "

The project field that contains this value.

", - "type": "ProjectV2FieldConfiguration!", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration" - }, - { - "name": "id", - "description": "

The Node ID of the ProjectV2ItemFieldDateValue object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "item", - "description": "

The project item that contains this value.

", - "type": "ProjectV2Item!", - "id": "projectv2item", - "href": "/graphql/reference/objects#projectv2item" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "ProjectV2ItemFieldIterationValue", - "id": "projectv2itemfielditerationvalue", - "href": "/graphql/reference/objects#projectv2itemfielditerationvalue", - "description": "

The value of an iteration field in a Project item.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "ProjectV2ItemFieldValueCommon", - "id": "projectv2itemfieldvaluecommon", - "href": "/graphql/reference/interfaces#projectv2itemfieldvaluecommon" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "creator", - "description": "

The actor who created the item.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "duration", - "description": "

The duration of the iteration in days.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "field", - "description": "

The project field that contains this value.

", - "type": "ProjectV2FieldConfiguration!", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration" - }, - { - "name": "id", - "description": "

The Node ID of the ProjectV2ItemFieldIterationValue object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "item", - "description": "

The project item that contains this value.

", - "type": "ProjectV2Item!", - "id": "projectv2item", - "href": "/graphql/reference/objects#projectv2item" - }, - { - "name": "iterationId", - "description": "

The ID of the iteration.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "startDate", - "description": "

The start date of the iteration.

", - "type": "Date!", - "id": "date", - "href": "/graphql/reference/scalars#date" - }, - { - "name": "title", - "description": "

The title of the iteration.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "titleHTML", - "description": "

The title of the iteration, with HTML.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "ProjectV2ItemFieldLabelValue", - "id": "projectv2itemfieldlabelvalue", - "href": "/graphql/reference/objects#projectv2itemfieldlabelvalue", - "description": "

The value of the labels field in a Project item.

", - "fields": [ - { - "name": "field", - "description": "

The field that contains this value.

", - "type": "ProjectV2FieldConfiguration!", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration" - }, - { - "name": "labels", - "description": "

Labels value of a field.

", - "type": "LabelConnection", - "id": "labelconnection", - "href": "/graphql/reference/objects#labelconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - } - ] - }, - { - "name": "ProjectV2ItemFieldMilestoneValue", - "id": "projectv2itemfieldmilestonevalue", - "href": "/graphql/reference/objects#projectv2itemfieldmilestonevalue", - "description": "

The value of a milestone field in a Project item.

", - "fields": [ - { - "name": "field", - "description": "

The field that contains this value.

", - "type": "ProjectV2FieldConfiguration!", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration" - }, - { - "name": "milestone", - "description": "

Milestone value of a field.

", - "type": "Milestone", - "id": "milestone", - "href": "/graphql/reference/objects#milestone" - } - ] - }, - { - "name": "ProjectV2ItemFieldNumberValue", - "id": "projectv2itemfieldnumbervalue", - "href": "/graphql/reference/objects#projectv2itemfieldnumbervalue", - "description": "

The value of a number field in a Project item.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "ProjectV2ItemFieldValueCommon", - "id": "projectv2itemfieldvaluecommon", - "href": "/graphql/reference/interfaces#projectv2itemfieldvaluecommon" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "creator", - "description": "

The actor who created the item.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "field", - "description": "

The project field that contains this value.

", - "type": "ProjectV2FieldConfiguration!", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration" - }, - { - "name": "id", - "description": "

The Node ID of the ProjectV2ItemFieldNumberValue object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "item", - "description": "

The project item that contains this value.

", - "type": "ProjectV2Item!", - "id": "projectv2item", - "href": "/graphql/reference/objects#projectv2item" - }, - { - "name": "number", - "description": "

Number as a float(8).

", - "type": "Float", - "id": "float", - "href": "/graphql/reference/scalars#float" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "ProjectV2ItemFieldPullRequestValue", - "id": "projectv2itemfieldpullrequestvalue", - "href": "/graphql/reference/objects#projectv2itemfieldpullrequestvalue", - "description": "

The value of a pull request field in a Project item.

", - "fields": [ - { - "name": "field", - "description": "

The field that contains this value.

", - "type": "ProjectV2FieldConfiguration!", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration" - }, - { - "name": "pullRequests", - "description": "

The pull requests for this field.

", - "type": "PullRequestConnection", - "id": "pullrequestconnection", - "href": "/graphql/reference/objects#pullrequestconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for pull requests.

", - "type": { - "name": "PullRequestOrder", - "id": "pullrequestorder", - "href": "/graphql/reference/input-objects#pullrequestorder" - } - } - ] - } - ] - }, - { - "name": "ProjectV2ItemFieldRepositoryValue", - "id": "projectv2itemfieldrepositoryvalue", - "href": "/graphql/reference/objects#projectv2itemfieldrepositoryvalue", - "description": "

The value of a repository field in a Project item.

", - "fields": [ - { - "name": "field", - "description": "

The field that contains this value.

", - "type": "ProjectV2FieldConfiguration!", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration" - }, - { - "name": "repository", - "description": "

The repository for this field.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "ProjectV2ItemFieldReviewerValue", - "id": "projectv2itemfieldreviewervalue", - "href": "/graphql/reference/objects#projectv2itemfieldreviewervalue", - "description": "

The value of a reviewers field in a Project item.

", - "fields": [ - { - "name": "field", - "description": "

The field that contains this value.

", - "type": "ProjectV2FieldConfiguration!", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration" - }, - { - "name": "reviewers", - "description": "

The reviewers for this field.

", - "type": "RequestedReviewerConnection", - "id": "requestedreviewerconnection", - "href": "/graphql/reference/objects#requestedreviewerconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - } - ] - }, - { - "name": "ProjectV2ItemFieldSingleSelectValue", - "id": "projectv2itemfieldsingleselectvalue", - "href": "/graphql/reference/objects#projectv2itemfieldsingleselectvalue", - "description": "

The value of a single select field in a Project item.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "ProjectV2ItemFieldValueCommon", - "id": "projectv2itemfieldvaluecommon", - "href": "/graphql/reference/interfaces#projectv2itemfieldvaluecommon" - } - ], - "fields": [ - { - "name": "color", - "description": "

The color applied to the selected single-select option.

", - "type": "ProjectV2SingleSelectFieldOptionColor!", - "id": "projectv2singleselectfieldoptioncolor", - "href": "/graphql/reference/enums#projectv2singleselectfieldoptioncolor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "creator", - "description": "

The actor who created the item.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "description", - "description": "

A plain-text description of the selected single-select option, such as what the option means.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "descriptionHTML", - "description": "

The description of the selected single-select option, including HTML tags.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "field", - "description": "

The project field that contains this value.

", - "type": "ProjectV2FieldConfiguration!", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration" - }, - { - "name": "id", - "description": "

The Node ID of the ProjectV2ItemFieldSingleSelectValue object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "item", - "description": "

The project item that contains this value.

", - "type": "ProjectV2Item!", - "id": "projectv2item", - "href": "/graphql/reference/objects#projectv2item" - }, - { - "name": "name", - "description": "

The name of the selected single select option.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "nameHTML", - "description": "

The html name of the selected single select option.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "optionId", - "description": "

The id of the selected single select option.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "ProjectV2ItemFieldTextValue", - "id": "projectv2itemfieldtextvalue", - "href": "/graphql/reference/objects#projectv2itemfieldtextvalue", - "description": "

The value of a text field in a Project item.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "ProjectV2ItemFieldValueCommon", - "id": "projectv2itemfieldvaluecommon", - "href": "/graphql/reference/interfaces#projectv2itemfieldvaluecommon" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "creator", - "description": "

The actor who created the item.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "field", - "description": "

The project field that contains this value.

", - "type": "ProjectV2FieldConfiguration!", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration" - }, - { - "name": "id", - "description": "

The Node ID of the ProjectV2ItemFieldTextValue object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "item", - "description": "

The project item that contains this value.

", - "type": "ProjectV2Item!", - "id": "projectv2item", - "href": "/graphql/reference/objects#projectv2item" - }, - { - "name": "text", - "description": "

Text value of a field.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "ProjectV2ItemFieldUserValue", - "id": "projectv2itemfielduservalue", - "href": "/graphql/reference/objects#projectv2itemfielduservalue", - "description": "

The value of a user field in a Project item.

", - "fields": [ - { - "name": "field", - "description": "

The field that contains this value.

", - "type": "ProjectV2FieldConfiguration!", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration" - }, - { - "name": "users", - "description": "

The users for this field.

", - "type": "UserConnection", - "id": "userconnection", - "href": "/graphql/reference/objects#userconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - } - ] - }, - { - "name": "ProjectV2ItemFieldValueConnection", - "id": "projectv2itemfieldvalueconnection", - "href": "/graphql/reference/objects#projectv2itemfieldvalueconnection", - "description": "

The connection type for ProjectV2ItemFieldValue.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ProjectV2ItemFieldValueEdge]", - "id": "projectv2itemfieldvalueedge", - "href": "/graphql/reference/objects#projectv2itemfieldvalueedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[ProjectV2ItemFieldValue]", - "id": "projectv2itemfieldvalue", - "href": "/graphql/reference/unions#projectv2itemfieldvalue" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ProjectV2ItemFieldValueEdge", - "id": "projectv2itemfieldvalueedge", - "href": "/graphql/reference/objects#projectv2itemfieldvalueedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "ProjectV2ItemFieldValue", - "id": "projectv2itemfieldvalue", - "href": "/graphql/reference/unions#projectv2itemfieldvalue" - } - ] - }, - { - "name": "ProjectV2IterationField", - "id": "projectv2iterationfield", - "href": "/graphql/reference/objects#projectv2iterationfield", - "description": "

An iteration field inside a project.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "ProjectV2FieldCommon", - "id": "projectv2fieldcommon", - "href": "/graphql/reference/interfaces#projectv2fieldcommon" - } - ], - "fields": [ - { - "name": "configuration", - "description": "

Iteration configuration settings.

", - "type": "ProjectV2IterationFieldConfiguration!", - "id": "projectv2iterationfieldconfiguration", - "href": "/graphql/reference/objects#projectv2iterationfieldconfiguration" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "dataType", - "description": "

The field's type.

", - "type": "ProjectV2FieldType!", - "id": "projectv2fieldtype", - "href": "/graphql/reference/enums#projectv2fieldtype" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the ProjectV2IterationField object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "name", - "description": "

The project field's name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "project", - "description": "

The project that contains this field.

", - "type": "ProjectV2!", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "ProjectV2IterationFieldConfiguration", - "id": "projectv2iterationfieldconfiguration", - "href": "/graphql/reference/objects#projectv2iterationfieldconfiguration", - "description": "

Iteration field configuration for a project.

", - "fields": [ - { - "name": "completedIterations", - "description": "

The iteration's completed iterations.

", - "type": "[ProjectV2IterationFieldIteration!]!", - "id": "projectv2iterationfielditeration", - "href": "/graphql/reference/objects#projectv2iterationfielditeration" - }, - { - "name": "duration", - "description": "

The iteration's duration in days.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "iterations", - "description": "

The iteration's iterations.

", - "type": "[ProjectV2IterationFieldIteration!]!", - "id": "projectv2iterationfielditeration", - "href": "/graphql/reference/objects#projectv2iterationfielditeration" - }, - { - "name": "startDay", - "description": "

The iteration's start day of the week.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ProjectV2IterationFieldIteration", - "id": "projectv2iterationfielditeration", - "href": "/graphql/reference/objects#projectv2iterationfielditeration", - "description": "

Iteration field iteration settings for a project.

", - "fields": [ - { - "name": "duration", - "description": "

The iteration's duration in days.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The iteration's ID.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "startDate", - "description": "

The iteration's start date.

", - "type": "Date!", - "id": "date", - "href": "/graphql/reference/scalars#date" - }, - { - "name": "title", - "description": "

The iteration's title.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "titleHTML", - "description": "

The iteration's html title.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "ProjectV2SingleSelectField", - "id": "projectv2singleselectfield", - "href": "/graphql/reference/objects#projectv2singleselectfield", - "description": "

A single select field inside a project.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "ProjectV2FieldCommon", - "id": "projectv2fieldcommon", - "href": "/graphql/reference/interfaces#projectv2fieldcommon" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "dataType", - "description": "

The field's type.

", - "type": "ProjectV2FieldType!", - "id": "projectv2fieldtype", - "href": "/graphql/reference/enums#projectv2fieldtype" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the ProjectV2SingleSelectField object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "name", - "description": "

The project field's name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "options", - "description": "

Options for the single select field.

", - "type": "[ProjectV2SingleSelectFieldOption!]!", - "id": "projectv2singleselectfieldoption", - "href": "/graphql/reference/objects#projectv2singleselectfieldoption", - "arguments": [ - { - "name": "names", - "description": "

Filter returned options to only those matching these names, case insensitive.

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "project", - "description": "

The project that contains this field.

", - "type": "ProjectV2!", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "ProjectV2SingleSelectFieldOption", - "id": "projectv2singleselectfieldoption", - "href": "/graphql/reference/objects#projectv2singleselectfieldoption", - "description": "

Single select field option for a configuration for a project.

", - "fields": [ - { - "name": "color", - "description": "

The option's display color.

", - "type": "ProjectV2SingleSelectFieldOptionColor!", - "id": "projectv2singleselectfieldoptioncolor", - "href": "/graphql/reference/enums#projectv2singleselectfieldoptioncolor" - }, - { - "name": "description", - "description": "

The option's plain-text description.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "descriptionHTML", - "description": "

The option's description, possibly containing HTML.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The option's ID.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The option's name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "nameHTML", - "description": "

The option's html name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "ProjectV2SortBy", - "id": "projectv2sortby", - "href": "/graphql/reference/objects#projectv2sortby", - "description": "

Represents a sort by field and direction.

", - "fields": [ - { - "name": "direction", - "description": "

The direction of the sorting. Possible values are ASC and DESC.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field by which items are sorted.

", - "type": "ProjectV2Field!", - "id": "projectv2field", - "href": "/graphql/reference/objects#projectv2field" - } - ] - }, - { - "name": "ProjectV2SortByConnection", - "id": "projectv2sortbyconnection", - "href": "/graphql/reference/objects#projectv2sortbyconnection", - "description": "

The connection type for ProjectV2SortBy.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ProjectV2SortByEdge]", - "id": "projectv2sortbyedge", - "href": "/graphql/reference/objects#projectv2sortbyedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[ProjectV2SortBy]", - "id": "projectv2sortby", - "href": "/graphql/reference/objects#projectv2sortby" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ProjectV2SortByEdge", - "id": "projectv2sortbyedge", - "href": "/graphql/reference/objects#projectv2sortbyedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "ProjectV2SortBy", - "id": "projectv2sortby", - "href": "/graphql/reference/objects#projectv2sortby" - } - ] - }, - { - "name": "ProjectV2SortByField", - "id": "projectv2sortbyfield", - "href": "/graphql/reference/objects#projectv2sortbyfield", - "description": "

Represents a sort by field and direction.

", - "fields": [ - { - "name": "direction", - "description": "

The direction of the sorting. Possible values are ASC and DESC.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field by which items are sorted.

", - "type": "ProjectV2FieldConfiguration!", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration" - } - ] - }, - { - "name": "ProjectV2SortByFieldConnection", - "id": "projectv2sortbyfieldconnection", - "href": "/graphql/reference/objects#projectv2sortbyfieldconnection", - "description": "

The connection type for ProjectV2SortByField.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ProjectV2SortByFieldEdge]", - "id": "projectv2sortbyfieldedge", - "href": "/graphql/reference/objects#projectv2sortbyfieldedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[ProjectV2SortByField]", - "id": "projectv2sortbyfield", - "href": "/graphql/reference/objects#projectv2sortbyfield" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ProjectV2SortByFieldEdge", - "id": "projectv2sortbyfieldedge", - "href": "/graphql/reference/objects#projectv2sortbyfieldedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "ProjectV2SortByField", - "id": "projectv2sortbyfield", - "href": "/graphql/reference/objects#projectv2sortbyfield" - } - ] - }, - { - "name": "ProjectV2View", - "id": "projectv2view", - "href": "/graphql/reference/objects#projectv2view", - "description": "

A view within a ProjectV2.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "fields", - "description": "

The view's visible fields.

", - "type": "ProjectV2FieldConfigurationConnection", - "id": "projectv2fieldconfigurationconnection", - "href": "/graphql/reference/objects#projectv2fieldconfigurationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for the project v2 fields returned from the connection.

", - "type": { - "name": "ProjectV2FieldOrder", - "id": "projectv2fieldorder", - "href": "/graphql/reference/input-objects#projectv2fieldorder" - } - } - ] - }, - { - "name": "filter", - "description": "

The project view's filter.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "groupBy", - "description": "

The view's group-by field.

", - "type": "ProjectV2FieldConnection", - "id": "projectv2fieldconnection", - "href": "/graphql/reference/objects#projectv2fieldconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for the project v2 fields returned from the connection.

", - "type": { - "name": "ProjectV2FieldOrder", - "id": "projectv2fieldorder", - "href": "/graphql/reference/input-objects#projectv2fieldorder" - } - } - ], - "isDeprecated": true, - "deprecationReason": "

The ProjectV2View#order_by API is deprecated in favour of the more capable ProjectV2View#group_by_field API. Check out the ProjectV2View#group_by_fields API as an example for the more capable alternative. Removal on 2023-04-01 UTC.

" - }, - { - "name": "groupByFields", - "description": "

The view's group-by field.

", - "type": "ProjectV2FieldConfigurationConnection", - "id": "projectv2fieldconfigurationconnection", - "href": "/graphql/reference/objects#projectv2fieldconfigurationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for the project v2 fields returned from the connection.

", - "type": { - "name": "ProjectV2FieldOrder", - "id": "projectv2fieldorder", - "href": "/graphql/reference/input-objects#projectv2fieldorder" - } - } - ] - }, - { - "name": "id", - "description": "

The Node ID of the ProjectV2View object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "layout", - "description": "

The project view's layout.

", - "type": "ProjectV2ViewLayout!", - "id": "projectv2viewlayout", - "href": "/graphql/reference/enums#projectv2viewlayout" - }, - { - "name": "name", - "description": "

The project view's name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "number", - "description": "

The project view's number.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "project", - "description": "

The project that contains this view.

", - "type": "ProjectV2!", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2" - }, - { - "name": "sortBy", - "description": "

The view's sort-by config.

", - "type": "ProjectV2SortByConnection", - "id": "projectv2sortbyconnection", - "href": "/graphql/reference/objects#projectv2sortbyconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ], - "isDeprecated": true, - "deprecationReason": "

The ProjectV2View#sort_by API is deprecated in favour of the more capable ProjectV2View#sort_by_fields API. Check out the ProjectV2View#sort_by_fields API as an example for the more capable alternative. Removal on 2023-04-01 UTC.

" - }, - { - "name": "sortByFields", - "description": "

The view's sort-by config.

", - "type": "ProjectV2SortByFieldConnection", - "id": "projectv2sortbyfieldconnection", - "href": "/graphql/reference/objects#projectv2sortbyfieldconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "verticalGroupBy", - "description": "

The view's vertical-group-by field.

", - "type": "ProjectV2FieldConnection", - "id": "projectv2fieldconnection", - "href": "/graphql/reference/objects#projectv2fieldconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for the project v2 fields returned from the connection.

", - "type": { - "name": "ProjectV2FieldOrder", - "id": "projectv2fieldorder", - "href": "/graphql/reference/input-objects#projectv2fieldorder" - } - } - ], - "isDeprecated": true, - "deprecationReason": "

The ProjectV2View#vertical_group_by API is deprecated in favour of the more capable ProjectV2View#vertical_group_by_fields API. Check out the ProjectV2View#vertical_group_by_fields API as an example for the more capable alternative. Removal on 2023-04-01 UTC.

" - }, - { - "name": "verticalGroupByFields", - "description": "

The view's vertical-group-by field.

", - "type": "ProjectV2FieldConfigurationConnection", - "id": "projectv2fieldconfigurationconnection", - "href": "/graphql/reference/objects#projectv2fieldconfigurationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for the project v2 fields returned from the connection.

", - "type": { - "name": "ProjectV2FieldOrder", - "id": "projectv2fieldorder", - "href": "/graphql/reference/input-objects#projectv2fieldorder" - } - } - ] - }, - { - "name": "visibleFields", - "description": "

The view's visible fields.

", - "type": "ProjectV2FieldConnection", - "id": "projectv2fieldconnection", - "href": "/graphql/reference/objects#projectv2fieldconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for the project v2 fields returned from the connection.

", - "type": { - "name": "ProjectV2FieldOrder", - "id": "projectv2fieldorder", - "href": "/graphql/reference/input-objects#projectv2fieldorder" - } - } - ], - "isDeprecated": true, - "deprecationReason": "

The ProjectV2View#visibleFields API is deprecated in favour of the more capable ProjectV2View#fields API. Check out the ProjectV2View#fields API as an example for the more capable alternative. Removal on 2023-01-01 UTC.

" - } - ] - }, - { - "name": "ProjectV2ViewConnection", - "id": "projectv2viewconnection", - "href": "/graphql/reference/objects#projectv2viewconnection", - "description": "

The connection type for ProjectV2View.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ProjectV2ViewEdge]", - "id": "projectv2viewedge", - "href": "/graphql/reference/objects#projectv2viewedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[ProjectV2View]", - "id": "projectv2view", - "href": "/graphql/reference/objects#projectv2view" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ProjectV2ViewEdge", - "id": "projectv2viewedge", - "href": "/graphql/reference/objects#projectv2viewedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "ProjectV2View", - "id": "projectv2view", - "href": "/graphql/reference/objects#projectv2view" - } - ] - }, - { - "name": "ProjectV2Workflow", - "id": "projectv2workflow", - "href": "/graphql/reference/objects#projectv2workflow", - "description": "

A workflow inside a project.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "enabled", - "description": "

Whether the workflow is enabled.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "id", - "description": "

The Node ID of the ProjectV2Workflow object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "name", - "description": "

The name of the workflow.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "number", - "description": "

The number of the workflow.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "project", - "description": "

The project that contains this workflow.

", - "type": "ProjectV2!", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "ProjectV2WorkflowConnection", - "id": "projectv2workflowconnection", - "href": "/graphql/reference/objects#projectv2workflowconnection", - "description": "

The connection type for ProjectV2Workflow.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ProjectV2WorkflowEdge]", - "id": "projectv2workflowedge", - "href": "/graphql/reference/objects#projectv2workflowedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[ProjectV2Workflow]", - "id": "projectv2workflow", - "href": "/graphql/reference/objects#projectv2workflow" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ProjectV2WorkflowEdge", - "id": "projectv2workflowedge", - "href": "/graphql/reference/objects#projectv2workflowedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "ProjectV2Workflow", - "id": "projectv2workflow", - "href": "/graphql/reference/objects#projectv2workflow" - } - ] - }, - { - "name": "PropertyTargetDefinition", - "id": "propertytargetdefinition", - "href": "/graphql/reference/objects#propertytargetdefinition", - "description": "

A property that must match.

", - "fields": [ - { - "name": "name", - "description": "

The name of the property.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "propertyValues", - "description": "

The values to match for.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "PublicKey", - "id": "publickey", - "href": "/graphql/reference/objects#publickey", - "description": "

A user's public key.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "accessedAt", - "description": "

The last time this authorization was used to perform an action. Values will be null for keys not owned by the user.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "createdAt", - "description": "

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.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "fingerprint", - "description": "

The fingerprint for this PublicKey.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the PublicKey object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isReadOnly", - "description": "

Whether this PublicKey is read-only or not. Values will be null for keys not owned by the user.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "key", - "description": "

The public key string.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "updatedAt", - "description": "

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.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "PublicKeyConnection", - "id": "publickeyconnection", - "href": "/graphql/reference/objects#publickeyconnection", - "description": "

The connection type for PublicKey.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[PublicKeyEdge]", - "id": "publickeyedge", - "href": "/graphql/reference/objects#publickeyedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[PublicKey]", - "id": "publickey", - "href": "/graphql/reference/objects#publickey" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "PublicKeyEdge", - "id": "publickeyedge", - "href": "/graphql/reference/objects#publickeyedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "PublicKey", - "id": "publickey", - "href": "/graphql/reference/objects#publickey" - } - ] - }, - { - "name": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest", - "description": "

A repository pull request.

", - "implements": [ - { - "name": "Assignable", - "id": "assignable", - "href": "/graphql/reference/interfaces#assignable" - }, - { - "name": "Closable", - "id": "closable", - "href": "/graphql/reference/interfaces#closable" - }, - { - "name": "Comment", - "id": "comment", - "href": "/graphql/reference/interfaces#comment" - }, - { - "name": "Labelable", - "id": "labelable", - "href": "/graphql/reference/interfaces#labelable" - }, - { - "name": "Lockable", - "id": "lockable", - "href": "/graphql/reference/interfaces#lockable" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "ProjectV2Owner", - "id": "projectv2owner", - "href": "/graphql/reference/interfaces#projectv2owner" - }, - { - "name": "Reactable", - "id": "reactable", - "href": "/graphql/reference/interfaces#reactable" - }, - { - "name": "RepositoryNode", - "id": "repositorynode", - "href": "/graphql/reference/interfaces#repositorynode" - }, - { - "name": "Subscribable", - "id": "subscribable", - "href": "/graphql/reference/interfaces#subscribable" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - }, - { - "name": "Updatable", - "id": "updatable", - "href": "/graphql/reference/interfaces#updatable" - }, - { - "name": "UpdatableComment", - "id": "updatablecomment", - "href": "/graphql/reference/interfaces#updatablecomment" - } - ], - "fields": [ - { - "name": "activeLockReason", - "description": "

Reason that the conversation was locked.

", - "type": "LockReason", - "id": "lockreason", - "href": "/graphql/reference/enums#lockreason" - }, - { - "name": "additions", - "description": "

The number of additions in this pull request.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "assignees", - "description": "

A list of Users assigned to this object.

", - "type": "UserConnection!", - "id": "userconnection", - "href": "/graphql/reference/objects#userconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "author", - "description": "

The actor who authored the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "authorAssociation", - "description": "

Author's association with the subject of the comment.

", - "type": "CommentAuthorAssociation!", - "id": "commentauthorassociation", - "href": "/graphql/reference/enums#commentauthorassociation" - }, - { - "name": "autoMergeRequest", - "description": "

Returns the auto-merge request object if one exists for this pull request.

", - "type": "AutoMergeRequest", - "id": "automergerequest", - "href": "/graphql/reference/objects#automergerequest" - }, - { - "name": "baseRef", - "description": "

Identifies the base Ref associated with the pull request.

", - "type": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref" - }, - { - "name": "baseRefName", - "description": "

Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "baseRefOid", - "description": "

Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.

", - "type": "GitObjectID!", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "baseRepository", - "description": "

The repository associated with this pull request's base Ref.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "body", - "description": "

The body as Markdown.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyHTML", - "description": "

The body rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "bodyText", - "description": "

The body rendered to text.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "canBeRebased", - "description": "

Whether or not the pull request is rebaseable.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "changedFiles", - "description": "

The number of changed files in this pull request.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "checksResourcePath", - "description": "

The HTTP path for the checks of this pull request.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "checksUrl", - "description": "

The HTTP URL for the checks of this pull request.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "closed", - "description": "

true if the pull request is closed.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "closedAt", - "description": "

Identifies the date and time when the object was closed.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "closingIssuesReferences", - "description": "

List of issues that were may be closed by this pull request.

", - "type": "IssueConnection", - "id": "issueconnection", - "href": "/graphql/reference/objects#issueconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for issues returned from the connection.

", - "type": { - "name": "IssueOrder", - "id": "issueorder", - "href": "/graphql/reference/input-objects#issueorder" - } - }, - { - "name": "userLinkedOnly", - "defaultValue": false, - "description": "

Return only manually linked Issues.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "comments", - "description": "

A list of comments associated with the pull request.

", - "type": "IssueCommentConnection!", - "id": "issuecommentconnection", - "href": "/graphql/reference/objects#issuecommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for issue comments returned from the connection.

", - "type": { - "name": "IssueCommentOrder", - "id": "issuecommentorder", - "href": "/graphql/reference/input-objects#issuecommentorder" - } - } - ] - }, - { - "name": "commits", - "description": "

A list of commits present in this pull request's head branch not present in the base branch.

", - "type": "PullRequestCommitConnection!", - "id": "pullrequestcommitconnection", - "href": "/graphql/reference/objects#pullrequestcommitconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "createdViaEmail", - "description": "

Check if this comment was created via an email reply.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int", - "isDeprecated": true, - "deprecationReason": "

databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2024-07-01 UTC.

" - }, - { - "name": "deletions", - "description": "

The number of deletions in this pull request.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "editor", - "description": "

The actor who edited this pull request's body.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "files", - "description": "

Lists the files changed within this pull request.

", - "type": "PullRequestChangedFileConnection", - "id": "pullrequestchangedfileconnection", - "href": "/graphql/reference/objects#pullrequestchangedfileconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "fullDatabaseId", - "description": "

Identifies the primary key from the database as a BigInt.

", - "type": "BigInt", - "id": "bigint", - "href": "/graphql/reference/scalars#bigint" - }, - { - "name": "headRef", - "description": "

Identifies the head Ref associated with the pull request.

", - "type": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref" - }, - { - "name": "headRefName", - "description": "

Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "headRefOid", - "description": "

Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.

", - "type": "GitObjectID!", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "headRepository", - "description": "

The repository associated with this pull request's head Ref.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "headRepositoryOwner", - "description": "

The owner of the repository associated with this pull request's head Ref.

", - "type": "RepositoryOwner", - "id": "repositoryowner", - "href": "/graphql/reference/interfaces#repositoryowner" - }, - { - "name": "hovercard", - "description": "

The hovercard information for this issue.

", - "type": "Hovercard!", - "id": "hovercard", - "href": "/graphql/reference/objects#hovercard", - "arguments": [ - { - "name": "includeNotificationContexts", - "defaultValue": true, - "description": "

Whether or not to include notification contexts.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "id", - "description": "

The Node ID of the PullRequest object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "includesCreatedEdit", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isCrossRepository", - "description": "

The head and base repositories are different.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isDraft", - "description": "

Identifies if the pull request is a draft.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isInMergeQueue", - "description": "

Indicates whether the pull request is in a merge queue.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isMergeQueueEnabled", - "description": "

Indicates whether the pull request's base ref has a merge queue enabled.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isReadByViewer", - "description": "

Is this pull request read by the viewer.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "labels", - "description": "

A list of labels associated with the object.

", - "type": "LabelConnection", - "id": "labelconnection", - "href": "/graphql/reference/objects#labelconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for labels returned from the connection.

", - "type": { - "name": "LabelOrder", - "id": "labelorder", - "href": "/graphql/reference/input-objects#labelorder" - } - } - ] - }, - { - "name": "lastEditedAt", - "description": "

The moment the editor made the last edit.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "latestOpinionatedReviews", - "description": "

A list of latest reviews per user associated with the pull request.

", - "type": "PullRequestReviewConnection", - "id": "pullrequestreviewconnection", - "href": "/graphql/reference/objects#pullrequestreviewconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "writersOnly", - "defaultValue": false, - "description": "

Only return reviews from user who have write access to the repository.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "latestReviews", - "description": "

A list of latest reviews per user associated with the pull request that are not also pending review.

", - "type": "PullRequestReviewConnection", - "id": "pullrequestreviewconnection", - "href": "/graphql/reference/objects#pullrequestreviewconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "locked", - "description": "

true if the pull request is locked.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "maintainerCanModify", - "description": "

Indicates whether maintainers can modify the pull request.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "mergeCommit", - "description": "

The commit that was created when this pull request was merged.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "mergeQueue", - "description": "

The merge queue for the pull request's base branch.

", - "type": "MergeQueue", - "id": "mergequeue", - "href": "/graphql/reference/objects#mergequeue" - }, - { - "name": "mergeQueueEntry", - "description": "

The merge queue entry of the pull request in the base branch's merge queue.

", - "type": "MergeQueueEntry", - "id": "mergequeueentry", - "href": "/graphql/reference/objects#mergequeueentry" - }, - { - "name": "mergeStateStatus", - "description": "

Detailed information about the current pull request merge state status.

", - "type": "MergeStateStatus!", - "id": "mergestatestatus", - "href": "/graphql/reference/enums#mergestatestatus" - }, - { - "name": "mergeable", - "description": "

Whether or not the pull request can be merged based on the existence of merge conflicts.

", - "type": "MergeableState!", - "id": "mergeablestate", - "href": "/graphql/reference/enums#mergeablestate" - }, - { - "name": "merged", - "description": "

Whether or not the pull request was merged.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "mergedAt", - "description": "

The date and time that the pull request was merged.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "mergedBy", - "description": "

The actor who merged the pull request.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "milestone", - "description": "

Identifies the milestone associated with the pull request.

", - "type": "Milestone", - "id": "milestone", - "href": "/graphql/reference/objects#milestone" - }, - { - "name": "number", - "description": "

Identifies the pull request number.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "participants", - "description": "

A list of Users that are participating in the Pull Request conversation.

", - "type": "UserConnection!", - "id": "userconnection", - "href": "/graphql/reference/objects#userconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "permalink", - "description": "

The permalink to the pull request.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "potentialMergeCommit", - "description": "

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.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "projectCards", - "description": "

List of project cards associated with this pull request.

", - "type": "ProjectCardConnection!", - "id": "projectcardconnection", - "href": "/graphql/reference/objects#projectcardconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "archivedStates", - "description": "

A list of archived states to filter the cards by.

", - "type": { - "name": "[ProjectCardArchivedState]", - "id": "projectcardarchivedstate", - "href": "/graphql/reference/enums#projectcardarchivedstate" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "projectV2", - "description": "

Find a project by number.

", - "type": "ProjectV2", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2", - "arguments": [ - { - "name": "number", - "description": "

The project number.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "projectsV2", - "description": "

A list of projects under the owner.

", - "type": "ProjectV2Connection!", - "id": "projectv2connection", - "href": "/graphql/reference/objects#projectv2connection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

How to order the returned projects.

", - "type": { - "name": "ProjectV2Order", - "id": "projectv2order", - "href": "/graphql/reference/input-objects#projectv2order" - } - }, - { - "name": "query", - "description": "

A project to search for under the the owner.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "publishedAt", - "description": "

Identifies when the comment was published at.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "reactionGroups", - "description": "

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

", - "type": "[ReactionGroup!]", - "id": "reactiongroup", - "href": "/graphql/reference/objects#reactiongroup" - }, - { - "name": "reactions", - "description": "

A list of Reactions left on the Issue.

", - "type": "ReactionConnection!", - "id": "reactionconnection", - "href": "/graphql/reference/objects#reactionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "content", - "description": "

Allows filtering Reactions by emoji.

", - "type": { - "name": "ReactionContent", - "id": "reactioncontent", - "href": "/graphql/reference/enums#reactioncontent" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Allows specifying the order in which reactions are returned.

", - "type": { - "name": "ReactionOrder", - "id": "reactionorder", - "href": "/graphql/reference/input-objects#reactionorder" - } - } - ] - }, - { - "name": "repository", - "description": "

The repository associated with this node.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this pull request.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "revertResourcePath", - "description": "

The HTTP path for reverting this pull request.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "revertUrl", - "description": "

The HTTP URL for reverting this pull request.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "reviewDecision", - "description": "

The current status of this pull request with respect to code review.

", - "type": "PullRequestReviewDecision", - "id": "pullrequestreviewdecision", - "href": "/graphql/reference/enums#pullrequestreviewdecision" - }, - { - "name": "reviewRequests", - "description": "

A list of review requests associated with the pull request.

", - "type": "ReviewRequestConnection", - "id": "reviewrequestconnection", - "href": "/graphql/reference/objects#reviewrequestconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "reviewThreads", - "description": "

The list of all review threads for this pull request.

", - "type": "PullRequestReviewThreadConnection!", - "id": "pullrequestreviewthreadconnection", - "href": "/graphql/reference/objects#pullrequestreviewthreadconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "reviews", - "description": "

A list of reviews associated with the pull request.

", - "type": "PullRequestReviewConnection", - "id": "pullrequestreviewconnection", - "href": "/graphql/reference/objects#pullrequestreviewconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "author", - "description": "

Filter by author of the review.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "states", - "description": "

A list of states to filter the reviews.

", - "type": { - "name": "[PullRequestReviewState!]", - "id": "pullrequestreviewstate", - "href": "/graphql/reference/enums#pullrequestreviewstate" - } - } - ] - }, - { - "name": "state", - "description": "

Identifies the state of the pull request.

", - "type": "PullRequestState!", - "id": "pullrequeststate", - "href": "/graphql/reference/enums#pullrequeststate" - }, - { - "name": "statusCheckRollup", - "description": "

Check and Status rollup information for the PR's head ref.

", - "type": "StatusCheckRollup", - "id": "statuscheckrollup", - "href": "/graphql/reference/objects#statuscheckrollup" - }, - { - "name": "suggestedReviewers", - "description": "

A list of reviewer suggestions based on commit history and past review comments.

", - "type": "[SuggestedReviewer]!", - "id": "suggestedreviewer", - "href": "/graphql/reference/objects#suggestedreviewer" - }, - { - "name": "timeline", - "description": "

A list of events, comments, commits, etc. associated with the pull request.

", - "type": "PullRequestTimelineConnection!", - "id": "pullrequesttimelineconnection", - "href": "/graphql/reference/objects#pullrequesttimelineconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "since", - "description": "

Allows filtering timeline events by a since timestamp.

", - "type": { - "name": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - } - ], - "isDeprecated": true, - "deprecationReason": "

timeline will be removed Use PullRequest.timelineItems instead. Removal on 2020-10-01 UTC.

" - }, - { - "name": "timelineItems", - "description": "

A list of events, comments, commits, etc. associated with the pull request.

", - "type": "PullRequestTimelineItemsConnection!", - "id": "pullrequesttimelineitemsconnection", - "href": "/graphql/reference/objects#pullrequesttimelineitemsconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "itemTypes", - "description": "

Filter timeline items by type.

", - "type": { - "name": "[PullRequestTimelineItemsItemType!]", - "id": "pullrequesttimelineitemsitemtype", - "href": "/graphql/reference/enums#pullrequesttimelineitemsitemtype" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "since", - "description": "

Filter timeline items by a since timestamp.

", - "type": { - "name": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - }, - { - "name": "skip", - "description": "

Skips the first n elements in the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "title", - "description": "

Identifies the pull request title.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "titleHTML", - "description": "

Identifies the pull request title rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "totalCommentsCount", - "description": "

Returns a count of how many comments this pull request has received.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this pull request.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userContentEdits", - "description": "

A list of edits to this content.

", - "type": "UserContentEditConnection", - "id": "usercontenteditconnection", - "href": "/graphql/reference/objects#usercontenteditconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "viewerCanApplySuggestion", - "description": "

Whether or not the viewer can apply suggestion.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanClose", - "description": "

Indicates if the object can be closed by the viewer.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanDeleteHeadRef", - "description": "

Check if the viewer can restore the deleted head ref.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanDisableAutoMerge", - "description": "

Whether or not the viewer can disable auto-merge.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanEditFiles", - "description": "

Can the viewer edit files within this pull request.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanEnableAutoMerge", - "description": "

Whether or not the viewer can enable auto-merge.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanMergeAsAdmin", - "description": "

Indicates whether the viewer can bypass branch protections and merge the pull request immediately.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanReact", - "description": "

Can user react to this subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanReopen", - "description": "

Indicates if the object can be reopened by the viewer.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanSubscribe", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUpdate", - "description": "

Check if the current viewer can update this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUpdateBranch", - "description": "

Whether or not the viewer can update the head ref of this PR, by merging or rebasing the base ref.\nIf the head ref is up to date or unable to be updated by this user, this will return false.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCannotUpdateReasons", - "description": "

Reasons why the current viewer can not update this comment.

", - "type": "[CommentCannotUpdateReason!]!", - "id": "commentcannotupdatereason", - "href": "/graphql/reference/enums#commentcannotupdatereason" - }, - { - "name": "viewerDidAuthor", - "description": "

Did the viewer author this comment.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerLatestReview", - "description": "

The latest review given from the viewer.

", - "type": "PullRequestReview", - "id": "pullrequestreview", - "href": "/graphql/reference/objects#pullrequestreview" - }, - { - "name": "viewerLatestReviewRequest", - "description": "

The person who has requested the viewer for review on this pull request.

", - "type": "ReviewRequest", - "id": "reviewrequest", - "href": "/graphql/reference/objects#reviewrequest" - }, - { - "name": "viewerMergeBodyText", - "description": "

The merge body text for the viewer and method.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string", - "arguments": [ - { - "name": "mergeType", - "description": "

The merge method for the message.

", - "type": { - "name": "PullRequestMergeMethod", - "id": "pullrequestmergemethod", - "href": "/graphql/reference/enums#pullrequestmergemethod" - } - } - ] - }, - { - "name": "viewerMergeHeadlineText", - "description": "

The merge headline text for the viewer and method.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string", - "arguments": [ - { - "name": "mergeType", - "description": "

The merge method for the message.

", - "type": { - "name": "PullRequestMergeMethod", - "id": "pullrequestmergemethod", - "href": "/graphql/reference/enums#pullrequestmergemethod" - } - } - ] - }, - { - "name": "viewerSubscription", - "description": "

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

", - "type": "SubscriptionState", - "id": "subscriptionstate", - "href": "/graphql/reference/enums#subscriptionstate" - } - ] - }, - { - "name": "PullRequestChangedFile", - "id": "pullrequestchangedfile", - "href": "/graphql/reference/objects#pullrequestchangedfile", - "description": "

A file changed in a pull request.

", - "fields": [ - { - "name": "additions", - "description": "

The number of additions to the file.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "changeType", - "description": "

How the file was changed in this PullRequest.

", - "type": "PatchStatus!", - "id": "patchstatus", - "href": "/graphql/reference/enums#patchstatus" - }, - { - "name": "deletions", - "description": "

The number of deletions to the file.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "path", - "description": "

The path of the file.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "viewerViewedState", - "description": "

The state of the file for the viewer.

", - "type": "FileViewedState!", - "id": "fileviewedstate", - "href": "/graphql/reference/enums#fileviewedstate" - } - ] - }, - { - "name": "PullRequestChangedFileConnection", - "id": "pullrequestchangedfileconnection", - "href": "/graphql/reference/objects#pullrequestchangedfileconnection", - "description": "

The connection type for PullRequestChangedFile.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[PullRequestChangedFileEdge]", - "id": "pullrequestchangedfileedge", - "href": "/graphql/reference/objects#pullrequestchangedfileedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[PullRequestChangedFile]", - "id": "pullrequestchangedfile", - "href": "/graphql/reference/objects#pullrequestchangedfile" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "PullRequestChangedFileEdge", - "id": "pullrequestchangedfileedge", - "href": "/graphql/reference/objects#pullrequestchangedfileedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "PullRequestChangedFile", - "id": "pullrequestchangedfile", - "href": "/graphql/reference/objects#pullrequestchangedfile" - } - ] - }, - { - "name": "PullRequestCommit", - "id": "pullrequestcommit", - "href": "/graphql/reference/objects#pullrequestcommit", - "description": "

Represents a Git commit part of a pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "commit", - "description": "

The Git commit object.

", - "type": "Commit!", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "id", - "description": "

The Node ID of the PullRequestCommit object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pullRequest", - "description": "

The pull request this commit belongs to.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this pull request commit.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The HTTP URL for this pull request commit.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "PullRequestCommitCommentThread", - "id": "pullrequestcommitcommentthread", - "href": "/graphql/reference/objects#pullrequestcommitcommentthread", - "description": "

Represents a commit comment thread part of a pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "RepositoryNode", - "id": "repositorynode", - "href": "/graphql/reference/interfaces#repositorynode" - } - ], - "fields": [ - { - "name": "comments", - "description": "

The comments that exist in this thread.

", - "type": "CommitCommentConnection!", - "id": "commitcommentconnection", - "href": "/graphql/reference/objects#commitcommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "commit", - "description": "

The commit the comments were made on.

", - "type": "Commit!", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "id", - "description": "

The Node ID of the PullRequestCommitCommentThread object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "path", - "description": "

The file the comments were made on.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "position", - "description": "

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

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "pullRequest", - "description": "

The pull request this commit comment thread belongs to.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "repository", - "description": "

The repository associated with this node.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "PullRequestCommitConnection", - "id": "pullrequestcommitconnection", - "href": "/graphql/reference/objects#pullrequestcommitconnection", - "description": "

The connection type for PullRequestCommit.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[PullRequestCommitEdge]", - "id": "pullrequestcommitedge", - "href": "/graphql/reference/objects#pullrequestcommitedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[PullRequestCommit]", - "id": "pullrequestcommit", - "href": "/graphql/reference/objects#pullrequestcommit" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "PullRequestCommitEdge", - "id": "pullrequestcommitedge", - "href": "/graphql/reference/objects#pullrequestcommitedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "PullRequestCommit", - "id": "pullrequestcommit", - "href": "/graphql/reference/objects#pullrequestcommit" - } - ] - }, - { - "name": "PullRequestConnection", - "id": "pullrequestconnection", - "href": "/graphql/reference/objects#pullrequestconnection", - "description": "

The connection type for PullRequest.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[PullRequestEdge]", - "id": "pullrequestedge", - "href": "/graphql/reference/objects#pullrequestedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[PullRequest]", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "PullRequestContributionsByRepository", - "id": "pullrequestcontributionsbyrepository", - "href": "/graphql/reference/objects#pullrequestcontributionsbyrepository", - "description": "

This aggregates pull requests opened by a user within one repository.

", - "fields": [ - { - "name": "contributions", - "description": "

The pull request contributions.

", - "type": "CreatedPullRequestContributionConnection!", - "id": "createdpullrequestcontributionconnection", - "href": "/graphql/reference/objects#createdpullrequestcontributionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for contributions returned from the connection.

", - "type": { - "name": "ContributionOrder", - "id": "contributionorder", - "href": "/graphql/reference/input-objects#contributionorder" - } - } - ] - }, - { - "name": "repository", - "description": "

The repository in which the pull requests were opened.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "PullRequestEdge", - "id": "pullrequestedge", - "href": "/graphql/reference/objects#pullrequestedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "PullRequestParameters", - "id": "pullrequestparameters", - "href": "/graphql/reference/objects#pullrequestparameters", - "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", - "fields": [ - { - "name": "dismissStaleReviewsOnPush", - "description": "

New, reviewable commits pushed will dismiss previous pull request review approvals.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requireCodeOwnerReview", - "description": "

Require an approving review in pull requests that modify files that have a designated code owner.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requireLastPushApproval", - "description": "

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiredApprovingReviewCount", - "description": "

The number of approving reviews that are required before a pull request can be merged.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "requiredReviewThreadResolution", - "description": "

All conversations on code must be resolved before a pull request can be merged.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "PullRequestReview", - "id": "pullrequestreview", - "href": "/graphql/reference/objects#pullrequestreview", - "description": "

A review object for a given pull request.

", - "implements": [ - { - "name": "Comment", - "id": "comment", - "href": "/graphql/reference/interfaces#comment" - }, - { - "name": "Deletable", - "id": "deletable", - "href": "/graphql/reference/interfaces#deletable" - }, - { - "name": "Minimizable", - "id": "minimizable", - "href": "/graphql/reference/interfaces#minimizable" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "Reactable", - "id": "reactable", - "href": "/graphql/reference/interfaces#reactable" - }, - { - "name": "RepositoryNode", - "id": "repositorynode", - "href": "/graphql/reference/interfaces#repositorynode" - }, - { - "name": "Updatable", - "id": "updatable", - "href": "/graphql/reference/interfaces#updatable" - }, - { - "name": "UpdatableComment", - "id": "updatablecomment", - "href": "/graphql/reference/interfaces#updatablecomment" - } - ], - "fields": [ - { - "name": "author", - "description": "

The actor who authored the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "authorAssociation", - "description": "

Author's association with the subject of the comment.

", - "type": "CommentAuthorAssociation!", - "id": "commentauthorassociation", - "href": "/graphql/reference/enums#commentauthorassociation" - }, - { - "name": "authorCanPushToRepository", - "description": "

Indicates whether the author of this review has push access to the repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "body", - "description": "

Identifies the pull request review body.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyHTML", - "description": "

The body rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "bodyText", - "description": "

The body of this review rendered as plain text.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "comments", - "description": "

A list of review comments for the current pull request review.

", - "type": "PullRequestReviewCommentConnection!", - "id": "pullrequestreviewcommentconnection", - "href": "/graphql/reference/objects#pullrequestreviewcommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "commit", - "description": "

Identifies the commit associated with this pull request review.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "createdViaEmail", - "description": "

Check if this comment was created via an email reply.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int", - "isDeprecated": true, - "deprecationReason": "

databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2024-07-01 UTC.

" - }, - { - "name": "editor", - "description": "

The actor who edited the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "fullDatabaseId", - "description": "

Identifies the primary key from the database as a BigInt.

", - "type": "BigInt", - "id": "bigint", - "href": "/graphql/reference/scalars#bigint" - }, - { - "name": "id", - "description": "

The Node ID of the PullRequestReview object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "includesCreatedEdit", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isMinimized", - "description": "

Returns whether or not a comment has been minimized.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "lastEditedAt", - "description": "

The moment the editor made the last edit.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "minimizedReason", - "description": "

Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "onBehalfOf", - "description": "

A list of teams that this review was made on behalf of.

", - "type": "TeamConnection!", - "id": "teamconnection", - "href": "/graphql/reference/objects#teamconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "publishedAt", - "description": "

Identifies when the comment was published at.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "pullRequest", - "description": "

Identifies the pull request associated with this pull request review.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "reactionGroups", - "description": "

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

", - "type": "[ReactionGroup!]", - "id": "reactiongroup", - "href": "/graphql/reference/objects#reactiongroup" - }, - { - "name": "reactions", - "description": "

A list of Reactions left on the Issue.

", - "type": "ReactionConnection!", - "id": "reactionconnection", - "href": "/graphql/reference/objects#reactionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "content", - "description": "

Allows filtering Reactions by emoji.

", - "type": { - "name": "ReactionContent", - "id": "reactioncontent", - "href": "/graphql/reference/enums#reactioncontent" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Allows specifying the order in which reactions are returned.

", - "type": { - "name": "ReactionOrder", - "id": "reactionorder", - "href": "/graphql/reference/input-objects#reactionorder" - } - } - ] - }, - { - "name": "repository", - "description": "

The repository associated with this node.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resourcePath", - "description": "

The HTTP path permalink for this PullRequestReview.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "state", - "description": "

Identifies the current state of the pull request review.

", - "type": "PullRequestReviewState!", - "id": "pullrequestreviewstate", - "href": "/graphql/reference/enums#pullrequestreviewstate" - }, - { - "name": "submittedAt", - "description": "

Identifies when the Pull Request Review was submitted.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL permalink for this PullRequestReview.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userContentEdits", - "description": "

A list of edits to this content.

", - "type": "UserContentEditConnection", - "id": "usercontenteditconnection", - "href": "/graphql/reference/objects#usercontenteditconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "viewerCanDelete", - "description": "

Check if the current viewer can delete this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanMinimize", - "description": "

Check if the current viewer can minimize this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanReact", - "description": "

Can user react to this subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUpdate", - "description": "

Check if the current viewer can update this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCannotUpdateReasons", - "description": "

Reasons why the current viewer can not update this comment.

", - "type": "[CommentCannotUpdateReason!]!", - "id": "commentcannotupdatereason", - "href": "/graphql/reference/enums#commentcannotupdatereason" - }, - { - "name": "viewerDidAuthor", - "description": "

Did the viewer author this comment.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "PullRequestReviewComment", - "id": "pullrequestreviewcomment", - "href": "/graphql/reference/objects#pullrequestreviewcomment", - "description": "

A review comment associated with a given repository pull request.

", - "implements": [ - { - "name": "Comment", - "id": "comment", - "href": "/graphql/reference/interfaces#comment" - }, - { - "name": "Deletable", - "id": "deletable", - "href": "/graphql/reference/interfaces#deletable" - }, - { - "name": "Minimizable", - "id": "minimizable", - "href": "/graphql/reference/interfaces#minimizable" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "Reactable", - "id": "reactable", - "href": "/graphql/reference/interfaces#reactable" - }, - { - "name": "RepositoryNode", - "id": "repositorynode", - "href": "/graphql/reference/interfaces#repositorynode" - }, - { - "name": "Updatable", - "id": "updatable", - "href": "/graphql/reference/interfaces#updatable" - }, - { - "name": "UpdatableComment", - "id": "updatablecomment", - "href": "/graphql/reference/interfaces#updatablecomment" - } - ], - "fields": [ - { - "name": "author", - "description": "

The actor who authored the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "authorAssociation", - "description": "

Author's association with the subject of the comment.

", - "type": "CommentAuthorAssociation!", - "id": "commentauthorassociation", - "href": "/graphql/reference/enums#commentauthorassociation" - }, - { - "name": "body", - "description": "

The comment body of this review comment.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyHTML", - "description": "

The body rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "bodyText", - "description": "

The comment body of this review comment rendered as plain text.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "commit", - "description": "

Identifies the commit associated with the comment.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "createdAt", - "description": "

Identifies when the comment was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "createdViaEmail", - "description": "

Check if this comment was created via an email reply.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int", - "isDeprecated": true, - "deprecationReason": "

databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2024-07-01 UTC.

" - }, - { - "name": "diffHunk", - "description": "

The diff hunk to which the comment applies.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "draftedAt", - "description": "

Identifies when the comment was created in a draft state.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "editor", - "description": "

The actor who edited the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "fullDatabaseId", - "description": "

Identifies the primary key from the database as a BigInt.

", - "type": "BigInt", - "id": "bigint", - "href": "/graphql/reference/scalars#bigint" - }, - { - "name": "id", - "description": "

The Node ID of the PullRequestReviewComment object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "includesCreatedEdit", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isMinimized", - "description": "

Returns whether or not a comment has been minimized.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "lastEditedAt", - "description": "

The moment the editor made the last edit.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "line", - "description": "

The end line number on the file to which the comment applies.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "minimizedReason", - "description": "

Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "originalCommit", - "description": "

Identifies the original commit associated with the comment.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "originalLine", - "description": "

The end line number on the file to which the comment applied when it was first created.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "originalPosition", - "description": "

The original line index in the diff to which the comment applies.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int", - "isDeprecated": true, - "deprecationReason": "

We are phasing out diff-relative positioning for PR comments Removal on 2023-10-01 UTC.

" - }, - { - "name": "originalStartLine", - "description": "

The start line number on the file to which the comment applied when it was first created.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "outdated", - "description": "

Identifies when the comment body is outdated.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "path", - "description": "

The path to which the comment applies.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "position", - "description": "

The line index in the diff to which the comment applies.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int", - "isDeprecated": true, - "deprecationReason": "

We are phasing out diff-relative positioning for PR comments Use the line and startLine fields instead, which are file line numbers instead of diff line numbers Removal on 2023-10-01 UTC.

" - }, - { - "name": "publishedAt", - "description": "

Identifies when the comment was published at.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "pullRequest", - "description": "

The pull request associated with this review comment.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "pullRequestReview", - "description": "

The pull request review associated with this review comment.

", - "type": "PullRequestReview", - "id": "pullrequestreview", - "href": "/graphql/reference/objects#pullrequestreview" - }, - { - "name": "reactionGroups", - "description": "

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

", - "type": "[ReactionGroup!]", - "id": "reactiongroup", - "href": "/graphql/reference/objects#reactiongroup" - }, - { - "name": "reactions", - "description": "

A list of Reactions left on the Issue.

", - "type": "ReactionConnection!", - "id": "reactionconnection", - "href": "/graphql/reference/objects#reactionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "content", - "description": "

Allows filtering Reactions by emoji.

", - "type": { - "name": "ReactionContent", - "id": "reactioncontent", - "href": "/graphql/reference/enums#reactioncontent" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Allows specifying the order in which reactions are returned.

", - "type": { - "name": "ReactionOrder", - "id": "reactionorder", - "href": "/graphql/reference/input-objects#reactionorder" - } - } - ] - }, - { - "name": "replyTo", - "description": "

The comment this is a reply to.

", - "type": "PullRequestReviewComment", - "id": "pullrequestreviewcomment", - "href": "/graphql/reference/objects#pullrequestreviewcomment" - }, - { - "name": "repository", - "description": "

The repository associated with this node.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resourcePath", - "description": "

The HTTP path permalink for this review comment.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "startLine", - "description": "

The start line number on the file to which the comment applies.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "state", - "description": "

Identifies the state of the comment.

", - "type": "PullRequestReviewCommentState!", - "id": "pullrequestreviewcommentstate", - "href": "/graphql/reference/enums#pullrequestreviewcommentstate" - }, - { - "name": "subjectType", - "description": "

The level at which the comments in the corresponding thread are targeted, can be a diff line or a file.

", - "type": "PullRequestReviewThreadSubjectType!", - "id": "pullrequestreviewthreadsubjecttype", - "href": "/graphql/reference/enums#pullrequestreviewthreadsubjecttype" - }, - { - "name": "updatedAt", - "description": "

Identifies when the comment was last updated.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL permalink for this review comment.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userContentEdits", - "description": "

A list of edits to this content.

", - "type": "UserContentEditConnection", - "id": "usercontenteditconnection", - "href": "/graphql/reference/objects#usercontenteditconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "viewerCanDelete", - "description": "

Check if the current viewer can delete this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanMinimize", - "description": "

Check if the current viewer can minimize this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanReact", - "description": "

Can user react to this subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUpdate", - "description": "

Check if the current viewer can update this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCannotUpdateReasons", - "description": "

Reasons why the current viewer can not update this comment.

", - "type": "[CommentCannotUpdateReason!]!", - "id": "commentcannotupdatereason", - "href": "/graphql/reference/enums#commentcannotupdatereason" - }, - { - "name": "viewerDidAuthor", - "description": "

Did the viewer author this comment.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "PullRequestReviewCommentConnection", - "id": "pullrequestreviewcommentconnection", - "href": "/graphql/reference/objects#pullrequestreviewcommentconnection", - "description": "

The connection type for PullRequestReviewComment.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[PullRequestReviewCommentEdge]", - "id": "pullrequestreviewcommentedge", - "href": "/graphql/reference/objects#pullrequestreviewcommentedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[PullRequestReviewComment]", - "id": "pullrequestreviewcomment", - "href": "/graphql/reference/objects#pullrequestreviewcomment" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "PullRequestReviewCommentEdge", - "id": "pullrequestreviewcommentedge", - "href": "/graphql/reference/objects#pullrequestreviewcommentedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "PullRequestReviewComment", - "id": "pullrequestreviewcomment", - "href": "/graphql/reference/objects#pullrequestreviewcomment" - } - ] - }, - { - "name": "PullRequestReviewConnection", - "id": "pullrequestreviewconnection", - "href": "/graphql/reference/objects#pullrequestreviewconnection", - "description": "

The connection type for PullRequestReview.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[PullRequestReviewEdge]", - "id": "pullrequestreviewedge", - "href": "/graphql/reference/objects#pullrequestreviewedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[PullRequestReview]", - "id": "pullrequestreview", - "href": "/graphql/reference/objects#pullrequestreview" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "PullRequestReviewContributionsByRepository", - "id": "pullrequestreviewcontributionsbyrepository", - "href": "/graphql/reference/objects#pullrequestreviewcontributionsbyrepository", - "description": "

This aggregates pull request reviews made by a user within one repository.

", - "fields": [ - { - "name": "contributions", - "description": "

The pull request review contributions.

", - "type": "CreatedPullRequestReviewContributionConnection!", - "id": "createdpullrequestreviewcontributionconnection", - "href": "/graphql/reference/objects#createdpullrequestreviewcontributionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for contributions returned from the connection.

", - "type": { - "name": "ContributionOrder", - "id": "contributionorder", - "href": "/graphql/reference/input-objects#contributionorder" - } - } - ] - }, - { - "name": "repository", - "description": "

The repository in which the pull request reviews were made.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "PullRequestReviewEdge", - "id": "pullrequestreviewedge", - "href": "/graphql/reference/objects#pullrequestreviewedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "PullRequestReview", - "id": "pullrequestreview", - "href": "/graphql/reference/objects#pullrequestreview" - } - ] - }, - { - "name": "PullRequestReviewThread", - "id": "pullrequestreviewthread", - "href": "/graphql/reference/objects#pullrequestreviewthread", - "description": "

A threaded list of comments for a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "comments", - "description": "

A list of pull request comments associated with the thread.

", - "type": "PullRequestReviewCommentConnection!", - "id": "pullrequestreviewcommentconnection", - "href": "/graphql/reference/objects#pullrequestreviewcommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "skip", - "description": "

Skips the first n elements in the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "diffSide", - "description": "

The side of the diff on which this thread was placed.

", - "type": "DiffSide!", - "id": "diffside", - "href": "/graphql/reference/enums#diffside" - }, - { - "name": "id", - "description": "

The Node ID of the PullRequestReviewThread object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isCollapsed", - "description": "

Whether or not the thread has been collapsed (resolved).

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isOutdated", - "description": "

Indicates whether this thread was outdated by newer changes.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isResolved", - "description": "

Whether this thread has been resolved.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "line", - "description": "

The line in the file to which this thread refers.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "originalLine", - "description": "

The original line in the file to which this thread refers.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "originalStartLine", - "description": "

The original start line in the file to which this thread refers (multi-line only).

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "path", - "description": "

Identifies the file path of this thread.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequest", - "description": "

Identifies the pull request associated with this thread.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "repository", - "description": "

Identifies the repository associated with this thread.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resolvedBy", - "description": "

The user who resolved this thread.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "startDiffSide", - "description": "

The side of the diff that the first line of the thread starts on (multi-line only).

", - "type": "DiffSide", - "id": "diffside", - "href": "/graphql/reference/enums#diffside" - }, - { - "name": "startLine", - "description": "

The start line in the file to which this thread refers (multi-line only).

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "subjectType", - "description": "

The level at which the comments in the corresponding thread are targeted, can be a diff line or a file.

", - "type": "PullRequestReviewThreadSubjectType!", - "id": "pullrequestreviewthreadsubjecttype", - "href": "/graphql/reference/enums#pullrequestreviewthreadsubjecttype" - }, - { - "name": "viewerCanReply", - "description": "

Indicates whether the current viewer can reply to this thread.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanResolve", - "description": "

Whether or not the viewer can resolve this thread.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUnresolve", - "description": "

Whether or not the viewer can unresolve this thread.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "PullRequestReviewThreadConnection", - "id": "pullrequestreviewthreadconnection", - "href": "/graphql/reference/objects#pullrequestreviewthreadconnection", - "description": "

Review comment threads for a pull request review.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[PullRequestReviewThreadEdge]", - "id": "pullrequestreviewthreadedge", - "href": "/graphql/reference/objects#pullrequestreviewthreadedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[PullRequestReviewThread]", - "id": "pullrequestreviewthread", - "href": "/graphql/reference/objects#pullrequestreviewthread" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "PullRequestReviewThreadEdge", - "id": "pullrequestreviewthreadedge", - "href": "/graphql/reference/objects#pullrequestreviewthreadedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "PullRequestReviewThread", - "id": "pullrequestreviewthread", - "href": "/graphql/reference/objects#pullrequestreviewthread" - } - ] - }, - { - "name": "PullRequestRevisionMarker", - "id": "pullrequestrevisionmarker", - "href": "/graphql/reference/objects#pullrequestrevisionmarker", - "description": "

Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.

", - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "lastSeenCommit", - "description": "

The last commit the viewer has seen.

", - "type": "Commit!", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "pullRequest", - "description": "

The pull request to which the marker belongs.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "PullRequestTemplate", - "id": "pullrequesttemplate", - "href": "/graphql/reference/objects#pullrequesttemplate", - "description": "

A repository pull request template.

", - "fields": [ - { - "name": "body", - "description": "

The body of the template.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "filename", - "description": "

The filename of the template.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repository", - "description": "

The repository the template belongs to.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "PullRequestThread", - "id": "pullrequestthread", - "href": "/graphql/reference/objects#pullrequestthread", - "description": "

A threaded list of comments for a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "comments", - "description": "

A list of pull request comments associated with the thread.

", - "type": "PullRequestReviewCommentConnection!", - "id": "pullrequestreviewcommentconnection", - "href": "/graphql/reference/objects#pullrequestreviewcommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "skip", - "description": "

Skips the first n elements in the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "diffSide", - "description": "

The side of the diff on which this thread was placed.

", - "type": "DiffSide!", - "id": "diffside", - "href": "/graphql/reference/enums#diffside" - }, - { - "name": "id", - "description": "

The Node ID of the PullRequestThread object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isCollapsed", - "description": "

Whether or not the thread has been collapsed (resolved).

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isOutdated", - "description": "

Indicates whether this thread was outdated by newer changes.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isResolved", - "description": "

Whether this thread has been resolved.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "line", - "description": "

The line in the file to which this thread refers.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "path", - "description": "

Identifies the file path of this thread.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequest", - "description": "

Identifies the pull request associated with this thread.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "repository", - "description": "

Identifies the repository associated with this thread.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resolvedBy", - "description": "

The user who resolved this thread.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "startDiffSide", - "description": "

The side of the diff that the first line of the thread starts on (multi-line only).

", - "type": "DiffSide", - "id": "diffside", - "href": "/graphql/reference/enums#diffside" - }, - { - "name": "startLine", - "description": "

The line of the first file diff in the thread.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "subjectType", - "description": "

The level at which the comments in the corresponding thread are targeted, can be a diff line or a file.

", - "type": "PullRequestReviewThreadSubjectType!", - "id": "pullrequestreviewthreadsubjecttype", - "href": "/graphql/reference/enums#pullrequestreviewthreadsubjecttype" - }, - { - "name": "viewerCanReply", - "description": "

Indicates whether the current viewer can reply to this thread.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanResolve", - "description": "

Whether or not the viewer can resolve this thread.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUnresolve", - "description": "

Whether or not the viewer can unresolve this thread.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "PullRequestTimelineConnection", - "id": "pullrequesttimelineconnection", - "href": "/graphql/reference/objects#pullrequesttimelineconnection", - "description": "

The connection type for PullRequestTimelineItem.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[PullRequestTimelineItemEdge]", - "id": "pullrequesttimelineitemedge", - "href": "/graphql/reference/objects#pullrequesttimelineitemedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[PullRequestTimelineItem]", - "id": "pullrequesttimelineitem", - "href": "/graphql/reference/unions#pullrequesttimelineitem" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "PullRequestTimelineItemEdge", - "id": "pullrequesttimelineitemedge", - "href": "/graphql/reference/objects#pullrequesttimelineitemedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "PullRequestTimelineItem", - "id": "pullrequesttimelineitem", - "href": "/graphql/reference/unions#pullrequesttimelineitem" - } - ] - }, - { - "name": "PullRequestTimelineItemsConnection", - "id": "pullrequesttimelineitemsconnection", - "href": "/graphql/reference/objects#pullrequesttimelineitemsconnection", - "description": "

The connection type for PullRequestTimelineItems.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[PullRequestTimelineItemsEdge]", - "id": "pullrequesttimelineitemsedge", - "href": "/graphql/reference/objects#pullrequesttimelineitemsedge" - }, - { - "name": "filteredCount", - "description": "

Identifies the count of items after applying before and after filters.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[PullRequestTimelineItems]", - "id": "pullrequesttimelineitems", - "href": "/graphql/reference/unions#pullrequesttimelineitems" - }, - { - "name": "pageCount", - "description": "

Identifies the count of items after applying before/after filters and first/last/skip slicing.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "PullRequestTimelineItemsEdge", - "id": "pullrequesttimelineitemsedge", - "href": "/graphql/reference/objects#pullrequesttimelineitemsedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "PullRequestTimelineItems", - "id": "pullrequesttimelineitems", - "href": "/graphql/reference/unions#pullrequesttimelineitems" - } - ] - }, - { - "name": "Push", - "id": "push", - "href": "/graphql/reference/objects#push", - "description": "

A Git push.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "id", - "description": "

The Node ID of the Push object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "nextSha", - "description": "

The SHA after the push.

", - "type": "GitObjectID", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "permalink", - "description": "

The permalink for this push.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "previousSha", - "description": "

The SHA before the push.

", - "type": "GitObjectID", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "pusher", - "description": "

The actor who pushed.

", - "type": "Actor!", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "repository", - "description": "

The repository that was pushed to.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "PushAllowance", - "id": "pushallowance", - "href": "/graphql/reference/objects#pushallowance", - "description": "

A team, user, or app who has the ability to push to a protected branch.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

The actor that can push.

", - "type": "PushAllowanceActor", - "id": "pushallowanceactor", - "href": "/graphql/reference/unions#pushallowanceactor" - }, - { - "name": "branchProtectionRule", - "description": "

Identifies the branch protection rule associated with the allowed user, team, or app.

", - "type": "BranchProtectionRule", - "id": "branchprotectionrule", - "href": "/graphql/reference/objects#branchprotectionrule" - }, - { - "name": "id", - "description": "

The Node ID of the PushAllowance object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - ] - }, - { - "name": "PushAllowanceConnection", - "id": "pushallowanceconnection", - "href": "/graphql/reference/objects#pushallowanceconnection", - "description": "

The connection type for PushAllowance.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[PushAllowanceEdge]", - "id": "pushallowanceedge", - "href": "/graphql/reference/objects#pushallowanceedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[PushAllowance]", - "id": "pushallowance", - "href": "/graphql/reference/objects#pushallowance" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "PushAllowanceEdge", - "id": "pushallowanceedge", - "href": "/graphql/reference/objects#pushallowanceedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "PushAllowance", - "id": "pushallowance", - "href": "/graphql/reference/objects#pushallowance" - } - ] - }, - { - "name": "RateLimit", - "id": "ratelimit", - "href": "/graphql/reference/objects#ratelimit", - "description": "

Represents the client's rate limit.

", - "fields": [ - { - "name": "cost", - "description": "

The point cost for the current query counting against the rate limit.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "limit", - "description": "

The maximum number of points the client is permitted to consume in a 60 minute window.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "nodeCount", - "description": "

The maximum number of nodes this query may return.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "remaining", - "description": "

The number of points remaining in the current rate limit window.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "resetAt", - "description": "

The time at which the current rate limit window resets in UTC epoch seconds.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "used", - "description": "

The number of points used in the current rate limit window.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ReactingUserConnection", - "id": "reactinguserconnection", - "href": "/graphql/reference/objects#reactinguserconnection", - "description": "

The connection type for User.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ReactingUserEdge]", - "id": "reactinguseredge", - "href": "/graphql/reference/objects#reactinguseredge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[User]", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ReactingUserEdge", - "id": "reactinguseredge", - "href": "/graphql/reference/objects#reactinguseredge", - "description": "

Represents a user that's made a reaction.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "reactedAt", - "description": "

The moment when the user made the reaction.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "Reaction", - "id": "reaction", - "href": "/graphql/reference/objects#reaction", - "description": "

An emoji reaction to a particular piece of content.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "content", - "description": "

Identifies the emoji reaction.

", - "type": "ReactionContent!", - "id": "reactioncontent", - "href": "/graphql/reference/enums#reactioncontent" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the Reaction object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "reactable", - "description": "

The reactable piece of content.

", - "type": "Reactable!", - "id": "reactable", - "href": "/graphql/reference/interfaces#reactable" - }, - { - "name": "user", - "description": "

Identifies the user who created this reaction.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "ReactionConnection", - "id": "reactionconnection", - "href": "/graphql/reference/objects#reactionconnection", - "description": "

A list of reactions that have been left on the subject.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ReactionEdge]", - "id": "reactionedge", - "href": "/graphql/reference/objects#reactionedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Reaction]", - "id": "reaction", - "href": "/graphql/reference/objects#reaction" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "viewerHasReacted", - "description": "

Whether or not the authenticated user has left a reaction on the subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "ReactionEdge", - "id": "reactionedge", - "href": "/graphql/reference/objects#reactionedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Reaction", - "id": "reaction", - "href": "/graphql/reference/objects#reaction" - } - ] - }, - { - "name": "ReactionGroup", - "id": "reactiongroup", - "href": "/graphql/reference/objects#reactiongroup", - "description": "

A group of emoji reactions to a particular piece of content.

", - "fields": [ - { - "name": "content", - "description": "

Identifies the emoji reaction.

", - "type": "ReactionContent!", - "id": "reactioncontent", - "href": "/graphql/reference/enums#reactioncontent" - }, - { - "name": "createdAt", - "description": "

Identifies when the reaction was created.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "reactors", - "description": "

Reactors to the reaction subject with the emotion represented by this reaction group.

", - "type": "ReactorConnection!", - "id": "reactorconnection", - "href": "/graphql/reference/objects#reactorconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "subject", - "description": "

The subject that was reacted to.

", - "type": "Reactable!", - "id": "reactable", - "href": "/graphql/reference/interfaces#reactable" - }, - { - "name": "users", - "description": "

Users who have reacted to the reaction subject with the emotion represented by this reaction group.

", - "type": "ReactingUserConnection!", - "id": "reactinguserconnection", - "href": "/graphql/reference/objects#reactinguserconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ], - "isDeprecated": true, - "deprecationReason": "

Reactors can now be mannequins, bots, and organizations. Use the reactors field instead. Removal on 2021-10-01 UTC.

" - }, - { - "name": "viewerHasReacted", - "description": "

Whether or not the authenticated user has left a reaction on the subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "ReactorConnection", - "id": "reactorconnection", - "href": "/graphql/reference/objects#reactorconnection", - "description": "

The connection type for Reactor.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ReactorEdge]", - "id": "reactoredge", - "href": "/graphql/reference/objects#reactoredge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Reactor]", - "id": "reactor", - "href": "/graphql/reference/unions#reactor" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ReactorEdge", - "id": "reactoredge", - "href": "/graphql/reference/objects#reactoredge", - "description": "

Represents an author of a reaction.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The author of the reaction.

", - "type": "Reactor!", - "id": "reactor", - "href": "/graphql/reference/unions#reactor" - }, - { - "name": "reactedAt", - "description": "

The moment when the user made the reaction.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "ReadyForReviewEvent", - "id": "readyforreviewevent", - "href": "/graphql/reference/objects#readyforreviewevent", - "description": "

Represents aready_for_reviewevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the ReadyForReviewEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this ready for review event.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The HTTP URL for this ready for review event.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref", - "description": "

Represents a Git reference.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "associatedPullRequests", - "description": "

A list of pull requests with this ref as the head ref.

", - "type": "PullRequestConnection!", - "id": "pullrequestconnection", - "href": "/graphql/reference/objects#pullrequestconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "baseRefName", - "description": "

The base ref name to filter the pull requests by.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "headRefName", - "description": "

The head ref name to filter the pull requests by.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "labels", - "description": "

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

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for pull requests returned from the connection.

", - "type": { - "name": "IssueOrder", - "id": "issueorder", - "href": "/graphql/reference/input-objects#issueorder" - } - }, - { - "name": "states", - "description": "

A list of states to filter the pull requests by.

", - "type": { - "name": "[PullRequestState!]", - "id": "pullrequeststate", - "href": "/graphql/reference/enums#pullrequeststate" - } - } - ] - }, - { - "name": "branchProtectionRule", - "description": "

Branch protection rules for this ref.

", - "type": "BranchProtectionRule", - "id": "branchprotectionrule", - "href": "/graphql/reference/objects#branchprotectionrule" - }, - { - "name": "compare", - "description": "

Compares the current ref as a base ref to another head ref, if the comparison can be made.

", - "type": "Comparison", - "id": "comparison", - "href": "/graphql/reference/objects#comparison", - "arguments": [ - { - "name": "headRef", - "description": "

The head ref to compare against.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "id", - "description": "

The Node ID of the Ref object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "name", - "description": "

The ref name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "prefix", - "description": "

The ref's prefix, such as refs/heads/ or refs/tags/.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "refUpdateRule", - "description": "

Branch protection rules that are viewable by non-admins.

", - "type": "RefUpdateRule", - "id": "refupdaterule", - "href": "/graphql/reference/objects#refupdaterule" - }, - { - "name": "repository", - "description": "

The repository the ref belongs to.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "rules", - "description": "

A list of rules from active Repository and Organization rulesets that apply to this ref.

", - "type": "RepositoryRuleConnection", - "id": "repositoryruleconnection", - "href": "/graphql/reference/objects#repositoryruleconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for repository rules.

", - "type": { - "name": "RepositoryRuleOrder", - "id": "repositoryruleorder", - "href": "/graphql/reference/input-objects#repositoryruleorder" - } - } - ] - }, - { - "name": "target", - "description": "

The object the ref points to. Returns null when object does not exist.

", - "type": "GitObject", - "id": "gitobject", - "href": "/graphql/reference/interfaces#gitobject" - } - ] - }, - { - "name": "RefConnection", - "id": "refconnection", - "href": "/graphql/reference/objects#refconnection", - "description": "

The connection type for Ref.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[RefEdge]", - "id": "refedge", - "href": "/graphql/reference/objects#refedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Ref]", - "id": "ref", - "href": "/graphql/reference/objects#ref" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "RefEdge", - "id": "refedge", - "href": "/graphql/reference/objects#refedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref" - } - ] - }, - { - "name": "RefNameConditionTarget", - "id": "refnameconditiontarget", - "href": "/graphql/reference/objects#refnameconditiontarget", - "description": "

Parameters to be used for the ref_name condition.

", - "fields": [ - { - "name": "exclude", - "description": "

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "include", - "description": "

Array of ref names or patterns to include. One of these patterns must match\nfor the condition to pass. Also accepts ~DEFAULT_BRANCH to include the\ndefault branch or ~ALL to include all branches.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "RefUpdateRule", - "id": "refupdaterule", - "href": "/graphql/reference/objects#refupdaterule", - "description": "

Branch protection rules that are enforced on the viewer.

", - "fields": [ - { - "name": "allowsDeletions", - "description": "

Can this branch be deleted.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "allowsForcePushes", - "description": "

Are force pushes allowed on this branch.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "blocksCreations", - "description": "

Can matching branches be created.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "pattern", - "description": "

Identifies the protection rule pattern.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "requiredApprovingReviewCount", - "description": "

Number of approving reviews required to update matching branches.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "requiredStatusCheckContexts", - "description": "

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

", - "type": "[String]", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "requiresCodeOwnerReviews", - "description": "

Are reviews from code owners required to update matching branches.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresConversationResolution", - "description": "

Are conversations required to be resolved before merging.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresLinearHistory", - "description": "

Are merge commits prohibited from being pushed to this branch.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresSignatures", - "description": "

Are commits required to be signed.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerAllowedToDismissReviews", - "description": "

Is the viewer allowed to dismiss reviews.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanPush", - "description": "

Can the viewer push to the branch.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "ReferencedEvent", - "id": "referencedevent", - "href": "/graphql/reference/objects#referencedevent", - "description": "

Represents areferencedevent on a given ReferencedSubject.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "commit", - "description": "

Identifies the commit associated with thereferencedevent.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "commitRepository", - "description": "

Identifies the repository associated with thereferencedevent.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the ReferencedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isCrossRepository", - "description": "

Reference originated in a different repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isDirectReference", - "description": "

Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "subject", - "description": "

Object referenced by event.

", - "type": "ReferencedSubject!", - "id": "referencedsubject", - "href": "/graphql/reference/unions#referencedsubject" - } - ] - }, - { - "name": "Release", - "id": "release", - "href": "/graphql/reference/objects#release", - "description": "

A release contains the content for a release.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "Reactable", - "id": "reactable", - "href": "/graphql/reference/interfaces#reactable" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "author", - "description": "

The author of the release.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "description", - "description": "

The description of the release.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "descriptionHTML", - "description": "

The description of this release rendered to HTML.

", - "type": "HTML", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "id", - "description": "

The Node ID of the Release object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isDraft", - "description": "

Whether or not the release is a draft.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isLatest", - "description": "

Whether or not the release is the latest releast.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isPrerelease", - "description": "

Whether or not the release is a prerelease.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "mentions", - "description": "

A list of users mentioned in the release description.

", - "type": "UserConnection", - "id": "userconnection", - "href": "/graphql/reference/objects#userconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "name", - "description": "

The title of the release.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "publishedAt", - "description": "

Identifies the date and time when the release was created.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "reactionGroups", - "description": "

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

", - "type": "[ReactionGroup!]", - "id": "reactiongroup", - "href": "/graphql/reference/objects#reactiongroup" - }, - { - "name": "reactions", - "description": "

A list of Reactions left on the Issue.

", - "type": "ReactionConnection!", - "id": "reactionconnection", - "href": "/graphql/reference/objects#reactionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "content", - "description": "

Allows filtering Reactions by emoji.

", - "type": { - "name": "ReactionContent", - "id": "reactioncontent", - "href": "/graphql/reference/enums#reactioncontent" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Allows specifying the order in which reactions are returned.

", - "type": { - "name": "ReactionOrder", - "id": "reactionorder", - "href": "/graphql/reference/input-objects#reactionorder" - } - } - ] - }, - { - "name": "releaseAssets", - "description": "

List of releases assets which are dependent on this release.

", - "type": "ReleaseAssetConnection!", - "id": "releaseassetconnection", - "href": "/graphql/reference/objects#releaseassetconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "name", - "description": "

A name to filter the assets by.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "repository", - "description": "

The repository that the release belongs to.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this issue.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "shortDescriptionHTML", - "description": "

A description of the release, rendered to HTML without any links in it.

", - "type": "HTML", - "id": "html", - "href": "/graphql/reference/scalars#html", - "arguments": [ - { - "name": "limit", - "defaultValue": "200", - "description": "

How many characters to return.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "tag", - "description": "

The Git tag the release points to.

", - "type": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref" - }, - { - "name": "tagCommit", - "description": "

The tag commit for this release.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "tagName", - "description": "

The name of the release's Git tag.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this issue.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "viewerCanReact", - "description": "

Can user react to this subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "ReleaseAsset", - "id": "releaseasset", - "href": "/graphql/reference/objects#releaseasset", - "description": "

A release asset contains the content for a release asset.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "contentType", - "description": "

The asset's content-type.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "downloadCount", - "description": "

The number of times this asset was downloaded.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "downloadUrl", - "description": "

Identifies the URL where you can download the release asset via the browser.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "id", - "description": "

The Node ID of the ReleaseAsset object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "name", - "description": "

Identifies the title of the release asset.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "release", - "description": "

Release that the asset is associated with.

", - "type": "Release", - "id": "release", - "href": "/graphql/reference/objects#release" - }, - { - "name": "size", - "description": "

The size (in bytes) of the asset.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "uploadedBy", - "description": "

The user that performed the upload.

", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "url", - "description": "

Identifies the URL of the release asset.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "ReleaseAssetConnection", - "id": "releaseassetconnection", - "href": "/graphql/reference/objects#releaseassetconnection", - "description": "

The connection type for ReleaseAsset.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ReleaseAssetEdge]", - "id": "releaseassetedge", - "href": "/graphql/reference/objects#releaseassetedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[ReleaseAsset]", - "id": "releaseasset", - "href": "/graphql/reference/objects#releaseasset" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ReleaseAssetEdge", - "id": "releaseassetedge", - "href": "/graphql/reference/objects#releaseassetedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "ReleaseAsset", - "id": "releaseasset", - "href": "/graphql/reference/objects#releaseasset" - } - ] - }, - { - "name": "ReleaseConnection", - "id": "releaseconnection", - "href": "/graphql/reference/objects#releaseconnection", - "description": "

The connection type for Release.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ReleaseEdge]", - "id": "releaseedge", - "href": "/graphql/reference/objects#releaseedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Release]", - "id": "release", - "href": "/graphql/reference/objects#release" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ReleaseEdge", - "id": "releaseedge", - "href": "/graphql/reference/objects#releaseedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Release", - "id": "release", - "href": "/graphql/reference/objects#release" - } - ] - }, - { - "name": "RemovedFromMergeQueueEvent", - "id": "removedfrommergequeueevent", - "href": "/graphql/reference/objects#removedfrommergequeueevent", - "description": "

Represents aremoved_from_merge_queueevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "beforeCommit", - "description": "

Identifies the before commit SHA for theremoved_from_merge_queueevent.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "enqueuer", - "description": "

The user who removed this Pull Request from the merge queue.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "id", - "description": "

The Node ID of the RemovedFromMergeQueueEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "mergeQueue", - "description": "

The merge queue where this pull request was removed from.

", - "type": "MergeQueue", - "id": "mergequeue", - "href": "/graphql/reference/objects#mergequeue" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "reason", - "description": "

The reason this pull request was removed from the queue.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "RemovedFromProjectEvent", - "id": "removedfromprojectevent", - "href": "/graphql/reference/objects#removedfromprojectevent", - "description": "

Represents aremoved_from_projectevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the RemovedFromProjectEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "project", - "description": "

Project referenced by event.

", - "type": "Project", - "id": "project", - "href": "/graphql/reference/objects#project" - }, - { - "name": "projectColumnName", - "description": "

Column name referenced by this project event.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "RenamedTitleEvent", - "id": "renamedtitleevent", - "href": "/graphql/reference/objects#renamedtitleevent", - "description": "

Represents arenamedevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "currentTitle", - "description": "

Identifies the current title of the issue or pull request.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the RenamedTitleEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "previousTitle", - "description": "

Identifies the previous title of the issue or pull request.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "subject", - "description": "

Subject that was renamed.

", - "type": "RenamedTitleSubject!", - "id": "renamedtitlesubject", - "href": "/graphql/reference/unions#renamedtitlesubject" - } - ] - }, - { - "name": "ReopenedEvent", - "id": "reopenedevent", - "href": "/graphql/reference/objects#reopenedevent", - "description": "

Represents areopenedevent on any Closable.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "closable", - "description": "

Object that was reopened.

", - "type": "Closable!", - "id": "closable", - "href": "/graphql/reference/interfaces#closable" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the ReopenedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "stateReason", - "description": "

The reason the issue state was changed to open.

", - "type": "IssueStateReason", - "id": "issuestatereason", - "href": "/graphql/reference/enums#issuestatereason" - } - ] - }, - { - "name": "RepoAccessAuditEntry", - "id": "repoaccessauditentry", - "href": "/graphql/reference/objects#repoaccessauditentry", - "description": "

Audit log entry for a repo.access event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepoAccessAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "visibility", - "description": "

The visibility of the repository.

", - "type": "RepoAccessAuditEntryVisibility", - "id": "repoaccessauditentryvisibility", - "href": "/graphql/reference/enums#repoaccessauditentryvisibility" - } - ] - }, - { - "name": "RepoAddMemberAuditEntry", - "id": "repoaddmemberauditentry", - "href": "/graphql/reference/objects#repoaddmemberauditentry", - "description": "

Audit log entry for a repo.add_member event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepoAddMemberAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "visibility", - "description": "

The visibility of the repository.

", - "type": "RepoAddMemberAuditEntryVisibility", - "id": "repoaddmemberauditentryvisibility", - "href": "/graphql/reference/enums#repoaddmemberauditentryvisibility" - } - ] - }, - { - "name": "RepoAddTopicAuditEntry", - "id": "repoaddtopicauditentry", - "href": "/graphql/reference/objects#repoaddtopicauditentry", - "description": "

Audit log entry for a repo.add_topic event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - }, - { - "name": "TopicAuditEntryData", - "id": "topicauditentrydata", - "href": "/graphql/reference/interfaces#topicauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepoAddTopicAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "topic", - "description": "

The name of the topic added to the repository.

", - "type": "Topic", - "id": "topic", - "href": "/graphql/reference/objects#topic" - }, - { - "name": "topicName", - "description": "

The name of the topic added to the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "RepoArchivedAuditEntry", - "id": "repoarchivedauditentry", - "href": "/graphql/reference/objects#repoarchivedauditentry", - "description": "

Audit log entry for a repo.archived event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepoArchivedAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "visibility", - "description": "

The visibility of the repository.

", - "type": "RepoArchivedAuditEntryVisibility", - "id": "repoarchivedauditentryvisibility", - "href": "/graphql/reference/enums#repoarchivedauditentryvisibility" - } - ] - }, - { - "name": "RepoChangeMergeSettingAuditEntry", - "id": "repochangemergesettingauditentry", - "href": "/graphql/reference/objects#repochangemergesettingauditentry", - "description": "

Audit log entry for a repo.change_merge_setting event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepoChangeMergeSettingAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isEnabled", - "description": "

Whether the change was to enable (true) or disable (false) the merge type.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "mergeType", - "description": "

The merge method affected by the change.

", - "type": "RepoChangeMergeSettingAuditEntryMergeType", - "id": "repochangemergesettingauditentrymergetype", - "href": "/graphql/reference/enums#repochangemergesettingauditentrymergetype" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "RepoConfigDisableAnonymousGitAccessAuditEntry", - "id": "repoconfigdisableanonymousgitaccessauditentry", - "href": "/graphql/reference/objects#repoconfigdisableanonymousgitaccessauditentry", - "description": "

Audit log entry for a repo.config.disable_anonymous_git_access event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepoConfigDisableAnonymousGitAccessAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "RepoConfigDisableCollaboratorsOnlyAuditEntry", - "id": "repoconfigdisablecollaboratorsonlyauditentry", - "href": "/graphql/reference/objects#repoconfigdisablecollaboratorsonlyauditentry", - "description": "

Audit log entry for a repo.config.disable_collaborators_only event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepoConfigDisableCollaboratorsOnlyAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "RepoConfigDisableContributorsOnlyAuditEntry", - "id": "repoconfigdisablecontributorsonlyauditentry", - "href": "/graphql/reference/objects#repoconfigdisablecontributorsonlyauditentry", - "description": "

Audit log entry for a repo.config.disable_contributors_only event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepoConfigDisableContributorsOnlyAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "RepoConfigDisableSockpuppetDisallowedAuditEntry", - "id": "repoconfigdisablesockpuppetdisallowedauditentry", - "href": "/graphql/reference/objects#repoconfigdisablesockpuppetdisallowedauditentry", - "description": "

Audit log entry for a repo.config.disable_sockpuppet_disallowed event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepoConfigDisableSockpuppetDisallowedAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "RepoConfigEnableAnonymousGitAccessAuditEntry", - "id": "repoconfigenableanonymousgitaccessauditentry", - "href": "/graphql/reference/objects#repoconfigenableanonymousgitaccessauditentry", - "description": "

Audit log entry for a repo.config.enable_anonymous_git_access event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepoConfigEnableAnonymousGitAccessAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "RepoConfigEnableCollaboratorsOnlyAuditEntry", - "id": "repoconfigenablecollaboratorsonlyauditentry", - "href": "/graphql/reference/objects#repoconfigenablecollaboratorsonlyauditentry", - "description": "

Audit log entry for a repo.config.enable_collaborators_only event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepoConfigEnableCollaboratorsOnlyAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "RepoConfigEnableContributorsOnlyAuditEntry", - "id": "repoconfigenablecontributorsonlyauditentry", - "href": "/graphql/reference/objects#repoconfigenablecontributorsonlyauditentry", - "description": "

Audit log entry for a repo.config.enable_contributors_only event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepoConfigEnableContributorsOnlyAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "RepoConfigEnableSockpuppetDisallowedAuditEntry", - "id": "repoconfigenablesockpuppetdisallowedauditentry", - "href": "/graphql/reference/objects#repoconfigenablesockpuppetdisallowedauditentry", - "description": "

Audit log entry for a repo.config.enable_sockpuppet_disallowed event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepoConfigEnableSockpuppetDisallowedAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "RepoConfigLockAnonymousGitAccessAuditEntry", - "id": "repoconfiglockanonymousgitaccessauditentry", - "href": "/graphql/reference/objects#repoconfiglockanonymousgitaccessauditentry", - "description": "

Audit log entry for a repo.config.lock_anonymous_git_access event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepoConfigLockAnonymousGitAccessAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "RepoConfigUnlockAnonymousGitAccessAuditEntry", - "id": "repoconfigunlockanonymousgitaccessauditentry", - "href": "/graphql/reference/objects#repoconfigunlockanonymousgitaccessauditentry", - "description": "

Audit log entry for a repo.config.unlock_anonymous_git_access event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepoConfigUnlockAnonymousGitAccessAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "RepoCreateAuditEntry", - "id": "repocreateauditentry", - "href": "/graphql/reference/objects#repocreateauditentry", - "description": "

Audit log entry for a repo.create event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "forkParentName", - "description": "

The name of the parent repository for this forked repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "forkSourceName", - "description": "

The name of the root repository for this network.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the RepoCreateAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "visibility", - "description": "

The visibility of the repository.

", - "type": "RepoCreateAuditEntryVisibility", - "id": "repocreateauditentryvisibility", - "href": "/graphql/reference/enums#repocreateauditentryvisibility" - } - ] - }, - { - "name": "RepoDestroyAuditEntry", - "id": "repodestroyauditentry", - "href": "/graphql/reference/objects#repodestroyauditentry", - "description": "

Audit log entry for a repo.destroy event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepoDestroyAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "visibility", - "description": "

The visibility of the repository.

", - "type": "RepoDestroyAuditEntryVisibility", - "id": "repodestroyauditentryvisibility", - "href": "/graphql/reference/enums#repodestroyauditentryvisibility" - } - ] - }, - { - "name": "RepoRemoveMemberAuditEntry", - "id": "reporemovememberauditentry", - "href": "/graphql/reference/objects#reporemovememberauditentry", - "description": "

Audit log entry for a repo.remove_member event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepoRemoveMemberAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "visibility", - "description": "

The visibility of the repository.

", - "type": "RepoRemoveMemberAuditEntryVisibility", - "id": "reporemovememberauditentryvisibility", - "href": "/graphql/reference/enums#reporemovememberauditentryvisibility" - } - ] - }, - { - "name": "RepoRemoveTopicAuditEntry", - "id": "reporemovetopicauditentry", - "href": "/graphql/reference/objects#reporemovetopicauditentry", - "description": "

Audit log entry for a repo.remove_topic event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - }, - { - "name": "TopicAuditEntryData", - "id": "topicauditentrydata", - "href": "/graphql/reference/interfaces#topicauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepoRemoveTopicAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "topic", - "description": "

The name of the topic added to the repository.

", - "type": "Topic", - "id": "topic", - "href": "/graphql/reference/objects#topic" - }, - { - "name": "topicName", - "description": "

The name of the topic added to the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "description": "

A repository contains the content for a project.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "PackageOwner", - "id": "packageowner", - "href": "/graphql/reference/interfaces#packageowner" - }, - { - "name": "ProjectOwner", - "id": "projectowner", - "href": "/graphql/reference/interfaces#projectowner" - }, - { - "name": "ProjectV2Recent", - "id": "projectv2recent", - "href": "/graphql/reference/interfaces#projectv2recent" - }, - { - "name": "RepositoryInfo", - "id": "repositoryinfo", - "href": "/graphql/reference/interfaces#repositoryinfo" - }, - { - "name": "Starrable", - "id": "starrable", - "href": "/graphql/reference/interfaces#starrable" - }, - { - "name": "Subscribable", - "id": "subscribable", - "href": "/graphql/reference/interfaces#subscribable" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "allowUpdateBranch", - "description": "

Whether or not a pull request head branch that is behind its base branch can\nalways be updated even if it is not required to be up to date before merging.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "archivedAt", - "description": "

Identifies the date and time when the repository was archived.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "assignableUsers", - "description": "

A list of users that can be assigned to issues in this repository.

", - "type": "UserConnection!", - "id": "userconnection", - "href": "/graphql/reference/objects#userconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "query", - "description": "

Filters users with query on user name and login.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "autoMergeAllowed", - "description": "

Whether or not Auto-merge can be enabled on pull requests in this repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "branchProtectionRules", - "description": "

A list of branch protection rules for this repository.

", - "type": "BranchProtectionRuleConnection!", - "id": "branchprotectionruleconnection", - "href": "/graphql/reference/objects#branchprotectionruleconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "codeOfConduct", - "description": "

Returns the code of conduct for this repository.

", - "type": "CodeOfConduct", - "id": "codeofconduct", - "href": "/graphql/reference/objects#codeofconduct" - }, - { - "name": "codeowners", - "description": "

Information extracted from the repository's CODEOWNERS file.

", - "type": "RepositoryCodeowners", - "id": "repositorycodeowners", - "href": "/graphql/reference/objects#repositorycodeowners", - "arguments": [ - { - "name": "refName", - "description": "

The ref name used to return the associated CODEOWNERS file.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "collaborators", - "description": "

A list of collaborators associated with the repository.

", - "type": "RepositoryCollaboratorConnection", - "id": "repositorycollaboratorconnection", - "href": "/graphql/reference/objects#repositorycollaboratorconnection", - "arguments": [ - { - "name": "affiliation", - "description": "

Collaborators affiliation level with a repository.

", - "type": { - "name": "CollaboratorAffiliation", - "id": "collaboratoraffiliation", - "href": "/graphql/reference/enums#collaboratoraffiliation" - } - }, - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "login", - "description": "

The login of one specific collaborator.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "query", - "description": "

Filters users with query on user name and login.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "commitComments", - "description": "

A list of commit comments associated with the repository.

", - "type": "CommitCommentConnection!", - "id": "commitcommentconnection", - "href": "/graphql/reference/objects#commitcommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "contactLinks", - "description": "

Returns a list of contact links associated to the repository.

", - "type": "[RepositoryContactLink!]", - "id": "repositorycontactlink", - "href": "/graphql/reference/objects#repositorycontactlink" - }, - { - "name": "contributingGuidelines", - "description": "

Returns the contributing guidelines for this repository.

", - "type": "ContributingGuidelines", - "id": "contributingguidelines", - "href": "/graphql/reference/objects#contributingguidelines" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "defaultBranchRef", - "description": "

The Ref associated with the repository's default branch.

", - "type": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref" - }, - { - "name": "deleteBranchOnMerge", - "description": "

Whether or not branches are automatically deleted when merged in this repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "dependencyGraphManifests", - "description": "

A list of dependency manifests contained in the repository.

", - "type": "DependencyGraphManifestConnection", - "id": "dependencygraphmanifestconnection", - "href": "/graphql/reference/objects#dependencygraphmanifestconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "dependenciesAfter", - "description": "

Cursor to paginate dependencies.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "dependenciesFirst", - "description": "

Number of dependencies to fetch.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "withDependencies", - "description": "

Flag to scope to only manifests with dependencies.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "deployKeys", - "description": "

A list of deploy keys that are on this repository.

", - "type": "DeployKeyConnection!", - "id": "deploykeyconnection", - "href": "/graphql/reference/objects#deploykeyconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "deployments", - "description": "

Deployments associated with the repository.

", - "type": "DeploymentConnection!", - "id": "deploymentconnection", - "href": "/graphql/reference/objects#deploymentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "environments", - "description": "

Environments to list deployments for.

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for deployments returned from the connection.

", - "type": { - "name": "DeploymentOrder", - "id": "deploymentorder", - "href": "/graphql/reference/input-objects#deploymentorder" - } - } - ] - }, - { - "name": "description", - "description": "

The description of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "descriptionHTML", - "description": "

The description of the repository rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "discussion", - "description": "

Returns a single discussion from the current repository by number.

", - "type": "Discussion", - "id": "discussion", - "href": "/graphql/reference/objects#discussion", - "arguments": [ - { - "name": "number", - "description": "

The number for the discussion to be returned.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "discussionCategories", - "description": "

A list of discussion categories that are available in the repository.

", - "type": "DiscussionCategoryConnection!", - "id": "discussioncategoryconnection", - "href": "/graphql/reference/objects#discussioncategoryconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "filterByAssignable", - "defaultValue": false, - "description": "

Filter by categories that are assignable by the viewer.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "discussionCategory", - "description": "

A discussion category by slug.

", - "type": "DiscussionCategory", - "id": "discussioncategory", - "href": "/graphql/reference/objects#discussioncategory", - "arguments": [ - { - "name": "slug", - "description": "

The slug of the discussion category to be returned.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "discussions", - "description": "

A list of discussions that have been opened in the repository.

", - "type": "DiscussionConnection!", - "id": "discussionconnection", - "href": "/graphql/reference/objects#discussionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "answered", - "description": "

Only show answered or unanswered discussions.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "categoryId", - "description": "

Only include discussions that belong to the category with this ID.

", - "type": { - "name": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for discussions returned from the connection.

", - "type": { - "name": "DiscussionOrder", - "id": "discussionorder", - "href": "/graphql/reference/input-objects#discussionorder" - } - }, - { - "name": "states", - "description": "

A list of states to filter the discussions by.

", - "type": { - "name": "[DiscussionState!]", - "id": "discussionstate", - "href": "/graphql/reference/enums#discussionstate" - } - } - ] - }, - { - "name": "diskUsage", - "description": "

The number of kilobytes this repository occupies on disk.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "environment", - "description": "

Returns a single active environment from the current repository by name.

", - "type": "Environment", - "id": "environment", - "href": "/graphql/reference/objects#environment", - "arguments": [ - { - "name": "name", - "description": "

The name of the environment to be returned.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "environments", - "description": "

A list of environments that are in this repository.

", - "type": "EnvironmentConnection!", - "id": "environmentconnection", - "href": "/graphql/reference/objects#environmentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "names", - "description": "

The names of the environments to be returned.

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for the environments.

", - "type": { - "name": "Environments", - "id": "environments", - "href": "/graphql/reference/input-objects#environments" - } - }, - { - "name": "pinnedEnvironmentFilter", - "defaultValue": "ALL", - "description": "

Filter to control pinned environments return.

", - "type": { - "name": "EnvironmentPinnedFilterField", - "id": "environmentpinnedfilterfield", - "href": "/graphql/reference/enums#environmentpinnedfilterfield" - } - } - ] - }, - { - "name": "forkCount", - "description": "

Returns how many forks there are of this repository in the whole network.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "forkingAllowed", - "description": "

Whether this repository allows forks.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "forks", - "description": "

A list of direct forked repositories.

", - "type": "RepositoryConnection!", - "id": "repositoryconnection", - "href": "/graphql/reference/objects#repositoryconnection", - "arguments": [ - { - "name": "affiliations", - "description": "

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

", - "type": { - "name": "[RepositoryAffiliation]", - "id": "repositoryaffiliation", - "href": "/graphql/reference/enums#repositoryaffiliation" - } - }, - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "hasIssuesEnabled", - "description": "

If non-null, filters repositories according to whether they have issues enabled.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "isLocked", - "description": "

If non-null, filters repositories according to whether they have been locked.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for repositories returned from the connection.

", - "type": { - "name": "RepositoryOrder", - "id": "repositoryorder", - "href": "/graphql/reference/input-objects#repositoryorder" - } - }, - { - "name": "ownerAffiliations", - "description": "

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.

", - "type": { - "name": "[RepositoryAffiliation]", - "id": "repositoryaffiliation", - "href": "/graphql/reference/enums#repositoryaffiliation" - } - }, - { - "name": "privacy", - "description": "

If non-null, filters repositories according to privacy. Internal\nrepositories are considered private; consider using the visibility argument\nif only internal repositories are needed. Cannot be combined with the\nvisibility argument.

", - "type": { - "name": "RepositoryPrivacy", - "id": "repositoryprivacy", - "href": "/graphql/reference/enums#repositoryprivacy" - } - }, - { - "name": "visibility", - "description": "

If non-null, filters repositories according to visibility. Cannot be combined with the privacy argument.

", - "type": { - "name": "RepositoryVisibility", - "id": "repositoryvisibility", - "href": "/graphql/reference/enums#repositoryvisibility" - } - } - ] - }, - { - "name": "hasAnonymousAccessEnabled", - "description": "

Indicates if the repository has anonymous Git read access feature enabled.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "hasDiscussionsEnabled", - "description": "

Indicates if the repository has the Discussions feature enabled.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "hasIssuesEnabled", - "description": "

Indicates if the repository has issues feature enabled.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "hasProjectsEnabled", - "description": "

Indicates if the repository has the Projects feature enabled.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "hasVulnerabilityAlertsEnabled", - "description": "

Whether vulnerability alerts are enabled for the repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "hasWikiEnabled", - "description": "

Indicates if the repository has wiki feature enabled.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "homepageUrl", - "description": "

The repository's URL.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "id", - "description": "

The Node ID of the Repository object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isArchived", - "description": "

Indicates if the repository is unmaintained.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isBlankIssuesEnabled", - "description": "

Returns true if blank issue creation is allowed.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isDisabled", - "description": "

Returns whether or not this repository disabled.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isEmpty", - "description": "

Returns whether or not this repository is empty.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isFork", - "description": "

Identifies if the repository is a fork.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isInOrganization", - "description": "

Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isLocked", - "description": "

Indicates if the repository has been locked or not.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isMirror", - "description": "

Identifies if the repository is a mirror.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isPrivate", - "description": "

Identifies if the repository is private or internal.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isSecurityPolicyEnabled", - "description": "

Returns true if this repository has a security policy.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isTemplate", - "description": "

Identifies if the repository is a template that can be used to generate new repositories.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isUserConfigurationRepository", - "description": "

Is this repository a user configuration repository?.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "issue", - "description": "

Returns a single issue from the current repository by number.

", - "type": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue", - "arguments": [ - { - "name": "number", - "description": "

The number for the issue to be returned.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "issueOrPullRequest", - "description": "

Returns a single issue-like object from the current repository by number.

", - "type": "IssueOrPullRequest", - "id": "issueorpullrequest", - "href": "/graphql/reference/unions#issueorpullrequest", - "arguments": [ - { - "name": "number", - "description": "

The number for the issue to be returned.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "issueTemplates", - "description": "

Returns a list of issue templates associated to the repository.

", - "type": "[IssueTemplate!]", - "id": "issuetemplate", - "href": "/graphql/reference/objects#issuetemplate" - }, - { - "name": "issues", - "description": "

A list of issues that have been opened in the repository.

", - "type": "IssueConnection!", - "id": "issueconnection", - "href": "/graphql/reference/objects#issueconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "filterBy", - "description": "

Filtering options for issues returned from the connection.

", - "type": { - "name": "IssueFilters", - "id": "issuefilters", - "href": "/graphql/reference/input-objects#issuefilters" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "labels", - "description": "

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

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for issues returned from the connection.

", - "type": { - "name": "IssueOrder", - "id": "issueorder", - "href": "/graphql/reference/input-objects#issueorder" - } - }, - { - "name": "states", - "description": "

A list of states to filter the issues by.

", - "type": { - "name": "[IssueState!]", - "id": "issuestate", - "href": "/graphql/reference/enums#issuestate" - } - } - ] - }, - { - "name": "label", - "description": "

Returns a single label by name.

", - "type": "Label", - "id": "label", - "href": "/graphql/reference/objects#label", - "arguments": [ - { - "name": "name", - "description": "

Label name.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "labels", - "description": "

A list of labels associated with the repository.

", - "type": "LabelConnection", - "id": "labelconnection", - "href": "/graphql/reference/objects#labelconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for labels returned from the connection.

", - "type": { - "name": "LabelOrder", - "id": "labelorder", - "href": "/graphql/reference/input-objects#labelorder" - } - }, - { - "name": "query", - "description": "

If provided, searches labels by name and description.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "languages", - "description": "

A list containing a breakdown of the language composition of the repository.

", - "type": "LanguageConnection", - "id": "languageconnection", - "href": "/graphql/reference/objects#languageconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Order for connection.

", - "type": { - "name": "LanguageOrder", - "id": "languageorder", - "href": "/graphql/reference/input-objects#languageorder" - } - } - ] - }, - { - "name": "latestRelease", - "description": "

Get the latest release for the repository if one exists.

", - "type": "Release", - "id": "release", - "href": "/graphql/reference/objects#release" - }, - { - "name": "licenseInfo", - "description": "

The license associated with the repository.

", - "type": "License", - "id": "license", - "href": "/graphql/reference/objects#license" - }, - { - "name": "lockReason", - "description": "

The reason the repository has been locked.

", - "type": "RepositoryLockReason", - "id": "repositorylockreason", - "href": "/graphql/reference/enums#repositorylockreason" - }, - { - "name": "mentionableUsers", - "description": "

A list of Users that can be mentioned in the context of the repository.

", - "type": "UserConnection!", - "id": "userconnection", - "href": "/graphql/reference/objects#userconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "query", - "description": "

Filters users with query on user name and login.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "mergeCommitAllowed", - "description": "

Whether or not PRs are merged with a merge commit on this repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "mergeCommitMessage", - "description": "

How the default commit message will be generated when merging a pull request.

", - "type": "MergeCommitMessage!", - "id": "mergecommitmessage", - "href": "/graphql/reference/enums#mergecommitmessage" - }, - { - "name": "mergeCommitTitle", - "description": "

How the default commit title will be generated when merging a pull request.

", - "type": "MergeCommitTitle!", - "id": "mergecommittitle", - "href": "/graphql/reference/enums#mergecommittitle" - }, - { - "name": "mergeQueue", - "description": "

The merge queue for a specified branch, otherwise the default branch if not provided.

", - "type": "MergeQueue", - "id": "mergequeue", - "href": "/graphql/reference/objects#mergequeue", - "arguments": [ - { - "name": "branch", - "description": "

The name of the branch to get the merge queue for. Case sensitive.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "milestone", - "description": "

Returns a single milestone from the current repository by number.

", - "type": "Milestone", - "id": "milestone", - "href": "/graphql/reference/objects#milestone", - "arguments": [ - { - "name": "number", - "description": "

The number for the milestone to be returned.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "milestones", - "description": "

A list of milestones associated with the repository.

", - "type": "MilestoneConnection", - "id": "milestoneconnection", - "href": "/graphql/reference/objects#milestoneconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for milestones.

", - "type": { - "name": "MilestoneOrder", - "id": "milestoneorder", - "href": "/graphql/reference/input-objects#milestoneorder" - } - }, - { - "name": "query", - "description": "

Filters milestones with a query on the title.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "states", - "description": "

Filter by the state of the milestones.

", - "type": { - "name": "[MilestoneState!]", - "id": "milestonestate", - "href": "/graphql/reference/enums#milestonestate" - } - } - ] - }, - { - "name": "mirrorUrl", - "description": "

The repository's original mirror URL.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "name", - "description": "

The name of the repository.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "nameWithOwner", - "description": "

The repository's name with owner.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "object", - "description": "

A Git object in the repository.

", - "type": "GitObject", - "id": "gitobject", - "href": "/graphql/reference/interfaces#gitobject", - "arguments": [ - { - "name": "expression", - "description": "

A Git revision expression suitable for rev-parse.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "oid", - "description": "

The Git object ID.

", - "type": { - "name": "GitObjectID", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - } - } - ] - }, - { - "name": "openGraphImageUrl", - "description": "

The image used to represent this repository in Open Graph data.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "owner", - "description": "

The User owner of the repository.

", - "type": "RepositoryOwner!", - "id": "repositoryowner", - "href": "/graphql/reference/interfaces#repositoryowner" - }, - { - "name": "packages", - "description": "

A list of packages under the owner.

", - "type": "PackageConnection!", - "id": "packageconnection", - "href": "/graphql/reference/objects#packageconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "names", - "description": "

Find packages by their names.

", - "type": { - "name": "[String]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "orderBy", - "description": "

Ordering of the returned packages.

", - "type": { - "name": "PackageOrder", - "id": "packageorder", - "href": "/graphql/reference/input-objects#packageorder" - } - }, - { - "name": "packageType", - "description": "

Filter registry package by type.

", - "type": { - "name": "PackageType", - "id": "packagetype", - "href": "/graphql/reference/enums#packagetype" - } - }, - { - "name": "repositoryId", - "description": "

Find packages in a repository by ID.

", - "type": { - "name": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - } - ] - }, - { - "name": "parent", - "description": "

The repository parent, if this is a fork.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "pinnedDiscussions", - "description": "

A list of discussions that have been pinned in this repository.

", - "type": "PinnedDiscussionConnection!", - "id": "pinneddiscussionconnection", - "href": "/graphql/reference/objects#pinneddiscussionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "pinnedEnvironments", - "description": "

A list of pinned environments for this repository.

", - "type": "PinnedEnvironmentConnection", - "id": "pinnedenvironmentconnection", - "href": "/graphql/reference/objects#pinnedenvironmentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for the environments.

", - "type": { - "name": "PinnedEnvironmentOrder", - "id": "pinnedenvironmentorder", - "href": "/graphql/reference/input-objects#pinnedenvironmentorder" - } - } - ] - }, - { - "name": "pinnedIssues", - "description": "

A list of pinned issues for this repository.

", - "type": "PinnedIssueConnection", - "id": "pinnedissueconnection", - "href": "/graphql/reference/objects#pinnedissueconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "planFeatures", - "description": "

Returns information about the availability of certain features and limits based on the repository's billing plan.

", - "type": "RepositoryPlanFeatures!", - "id": "repositoryplanfeatures", - "href": "/graphql/reference/objects#repositoryplanfeatures" - }, - { - "name": "primaryLanguage", - "description": "

The primary language of the repository's code.

", - "type": "Language", - "id": "language", - "href": "/graphql/reference/objects#language" - }, - { - "name": "project", - "description": "

Find project by number.

", - "type": "Project", - "id": "project", - "href": "/graphql/reference/objects#project", - "arguments": [ - { - "name": "number", - "description": "

The project number to find.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "projects", - "description": "

A list of projects under the owner.

", - "type": "ProjectConnection!", - "id": "projectconnection", - "href": "/graphql/reference/objects#projectconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for projects returned from the connection.

", - "type": { - "name": "ProjectOrder", - "id": "projectorder", - "href": "/graphql/reference/input-objects#projectorder" - } - }, - { - "name": "search", - "description": "

Query to search projects by, currently only searching by name.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "states", - "description": "

A list of states to filter the projects by.

", - "type": { - "name": "[ProjectState!]", - "id": "projectstate", - "href": "/graphql/reference/enums#projectstate" - } - } - ] - }, - { - "name": "projectsResourcePath", - "description": "

The HTTP path listing the repository's projects.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "projectsUrl", - "description": "

The HTTP URL listing the repository's projects.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "pullRequest", - "description": "

Returns a single pull request from the current repository by number.

", - "type": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest", - "arguments": [ - { - "name": "number", - "description": "

The number for the pull request to be returned.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "pullRequestTemplates", - "description": "

Returns a list of pull request templates associated to the repository.

", - "type": "[PullRequestTemplate!]", - "id": "pullrequesttemplate", - "href": "/graphql/reference/objects#pullrequesttemplate" - }, - { - "name": "pullRequests", - "description": "

A list of pull requests that have been opened in the repository.

", - "type": "PullRequestConnection!", - "id": "pullrequestconnection", - "href": "/graphql/reference/objects#pullrequestconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "baseRefName", - "description": "

The base ref name to filter the pull requests by.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "headRefName", - "description": "

The head ref name to filter the pull requests by.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "labels", - "description": "

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

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for pull requests returned from the connection.

", - "type": { - "name": "IssueOrder", - "id": "issueorder", - "href": "/graphql/reference/input-objects#issueorder" - } - }, - { - "name": "states", - "description": "

A list of states to filter the pull requests by.

", - "type": { - "name": "[PullRequestState!]", - "id": "pullrequeststate", - "href": "/graphql/reference/enums#pullrequeststate" - } - } - ] - }, - { - "name": "pushedAt", - "description": "

Identifies the date and time when the repository was last pushed to.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "rebaseMergeAllowed", - "description": "

Whether or not rebase-merging is enabled on this repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "recentProjects", - "description": "

Recent projects that this user has modified in the context of the owner.

", - "type": "ProjectV2Connection!", - "id": "projectv2connection", - "href": "/graphql/reference/objects#projectv2connection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "ref", - "description": "

Fetch a given ref from the repository.

", - "type": "Ref", - "id": "ref", - "href": "/graphql/reference/objects#ref", - "arguments": [ - { - "name": "qualifiedName", - "description": "

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).

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "refs", - "description": "

Fetch a list of refs from the repository.

", - "type": "RefConnection", - "id": "refconnection", - "href": "/graphql/reference/objects#refconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "direction", - "description": "

DEPRECATED: use orderBy. The ordering direction.

", - "type": { - "name": "OrderDirection", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for refs returned from the connection.

", - "type": { - "name": "RefOrder", - "id": "reforder", - "href": "/graphql/reference/input-objects#reforder" - } - }, - { - "name": "query", - "description": "

Filters refs with query on name.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "refPrefix", - "description": "

A ref name prefix like refs/heads/, refs/tags/, etc.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "release", - "description": "

Lookup a single release given various criteria.

", - "type": "Release", - "id": "release", - "href": "/graphql/reference/objects#release", - "arguments": [ - { - "name": "tagName", - "description": "

The name of the Tag the Release was created from.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "releases", - "description": "

List of releases which are dependent on this repository.

", - "type": "ReleaseConnection!", - "id": "releaseconnection", - "href": "/graphql/reference/objects#releaseconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Order for connection.

", - "type": { - "name": "ReleaseOrder", - "id": "releaseorder", - "href": "/graphql/reference/input-objects#releaseorder" - } - } - ] - }, - { - "name": "repositoryTopics", - "description": "

A list of applied repository-topic associations for this repository.

", - "type": "RepositoryTopicConnection!", - "id": "repositorytopicconnection", - "href": "/graphql/reference/objects#repositorytopicconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this repository.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "ruleset", - "description": "

Returns a single ruleset from the current repository by ID.

", - "type": "RepositoryRuleset", - "id": "repositoryruleset", - "href": "/graphql/reference/objects#repositoryruleset", - "arguments": [ - { - "name": "databaseId", - "description": "

The ID of the ruleset to be returned.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "includeParents", - "defaultValue": true, - "description": "

Include rulesets configured at higher levels that apply to this repository.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "rulesets", - "description": "

A list of rulesets for this repository.

", - "type": "RepositoryRulesetConnection", - "id": "repositoryrulesetconnection", - "href": "/graphql/reference/objects#repositoryrulesetconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "includeParents", - "defaultValue": true, - "description": "

Return rulesets configured at higher levels that apply to this repository.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "securityPolicyUrl", - "description": "

The security policy URL.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "shortDescriptionHTML", - "description": "

A description of the repository, rendered to HTML without any links in it.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html", - "arguments": [ - { - "name": "limit", - "defaultValue": "200", - "description": "

How many characters to return.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "squashMergeAllowed", - "description": "

Whether or not squash-merging is enabled on this repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "squashMergeCommitMessage", - "description": "

How the default commit message will be generated when squash merging a pull request.

", - "type": "SquashMergeCommitMessage!", - "id": "squashmergecommitmessage", - "href": "/graphql/reference/enums#squashmergecommitmessage" - }, - { - "name": "squashMergeCommitTitle", - "description": "

How the default commit title will be generated when squash merging a pull request.

", - "type": "SquashMergeCommitTitle!", - "id": "squashmergecommittitle", - "href": "/graphql/reference/enums#squashmergecommittitle" - }, - { - "name": "squashPrTitleUsedAsDefault", - "description": "

Whether a squash merge commit can use the pull request title as default.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "isDeprecated": true, - "deprecationReason": "

squashPrTitleUsedAsDefault will be removed. Use Repository.squashMergeCommitTitle instead. Removal on 2023-04-01 UTC.

" - }, - { - "name": "sshUrl", - "description": "

The SSH URL to clone this repository.

", - "type": "GitSSHRemote!", - "id": "gitsshremote", - "href": "/graphql/reference/scalars#gitsshremote" - }, - { - "name": "stargazerCount", - "description": "

Returns a count of how many stargazers there are on this object.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "stargazers", - "description": "

A list of users who have starred this starrable.

", - "type": "StargazerConnection!", - "id": "stargazerconnection", - "href": "/graphql/reference/objects#stargazerconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Order for connection.

", - "type": { - "name": "StarOrder", - "id": "starorder", - "href": "/graphql/reference/input-objects#starorder" - } - } - ] - }, - { - "name": "submodules", - "description": "

Returns a list of all submodules in this repository parsed from the\n.gitmodules file as of the default branch's HEAD commit.

", - "type": "SubmoduleConnection!", - "id": "submoduleconnection", - "href": "/graphql/reference/objects#submoduleconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "tempCloneToken", - "description": "

Temporary authentication token for cloning this repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "templateRepository", - "description": "

The repository from which this repository was generated, if any.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this repository.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "usesCustomOpenGraphImage", - "description": "

Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanAdminister", - "description": "

Indicates whether the viewer has admin permissions on this repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanCreateProjects", - "description": "

Can the current viewer create new projects on this owner.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanSubscribe", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUpdateTopics", - "description": "

Indicates whether the viewer can update the topics of this repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerDefaultCommitEmail", - "description": "

The last commit email for the viewer.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "viewerDefaultMergeMethod", - "description": "

The last used merge method by the viewer or the default for the repository.

", - "type": "PullRequestMergeMethod!", - "id": "pullrequestmergemethod", - "href": "/graphql/reference/enums#pullrequestmergemethod" - }, - { - "name": "viewerHasStarred", - "description": "

Returns a boolean indicating whether the viewing user has starred this starrable.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerPermission", - "description": "

The users permission level on the repository. Will return null if authenticated as an GitHub App.

", - "type": "RepositoryPermission", - "id": "repositorypermission", - "href": "/graphql/reference/enums#repositorypermission" - }, - { - "name": "viewerPossibleCommitEmails", - "description": "

A list of emails this viewer can commit with.

", - "type": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "viewerSubscription", - "description": "

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

", - "type": "SubscriptionState", - "id": "subscriptionstate", - "href": "/graphql/reference/enums#subscriptionstate" - }, - { - "name": "visibility", - "description": "

Indicates the repository's visibility level.

", - "type": "RepositoryVisibility!", - "id": "repositoryvisibility", - "href": "/graphql/reference/enums#repositoryvisibility" - }, - { - "name": "vulnerabilityAlert", - "description": "

Returns a single vulnerability alert from the current repository by number.

", - "type": "RepositoryVulnerabilityAlert", - "id": "repositoryvulnerabilityalert", - "href": "/graphql/reference/objects#repositoryvulnerabilityalert", - "arguments": [ - { - "name": "number", - "description": "

The number for the vulnerability alert to be returned.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "vulnerabilityAlerts", - "description": "

A list of vulnerability alerts that are on this repository.

", - "type": "RepositoryVulnerabilityAlertConnection", - "id": "repositoryvulnerabilityalertconnection", - "href": "/graphql/reference/objects#repositoryvulnerabilityalertconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "dependencyScopes", - "description": "

Filter by the scope of the alert's dependency.

", - "type": { - "name": "[RepositoryVulnerabilityAlertDependencyScope!]", - "id": "repositoryvulnerabilityalertdependencyscope", - "href": "/graphql/reference/enums#repositoryvulnerabilityalertdependencyscope" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "states", - "description": "

Filter by the state of the alert.

", - "type": { - "name": "[RepositoryVulnerabilityAlertState!]", - "id": "repositoryvulnerabilityalertstate", - "href": "/graphql/reference/enums#repositoryvulnerabilityalertstate" - } - } - ] - }, - { - "name": "watchers", - "description": "

A list of users watching the repository.

", - "type": "UserConnection!", - "id": "userconnection", - "href": "/graphql/reference/objects#userconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "webCommitSignoffRequired", - "description": "

Whether contributors are required to sign off on web-based commits in this repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "RepositoryCodeowners", - "id": "repositorycodeowners", - "href": "/graphql/reference/objects#repositorycodeowners", - "description": "

Information extracted from a repository's CODEOWNERS file.

", - "fields": [ - { - "name": "errors", - "description": "

Any problems that were encountered while parsing the CODEOWNERS file.

", - "type": "[RepositoryCodeownersError!]!", - "id": "repositorycodeownerserror", - "href": "/graphql/reference/objects#repositorycodeownerserror" - } - ] - }, - { - "name": "RepositoryCodeownersError", - "id": "repositorycodeownerserror", - "href": "/graphql/reference/objects#repositorycodeownerserror", - "description": "

An error in a CODEOWNERS file.

", - "fields": [ - { - "name": "column", - "description": "

The column number where the error occurs.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "kind", - "description": "

A short string describing the type of error.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "line", - "description": "

The line number where the error occurs.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "message", - "description": "

A complete description of the error, combining information from other fields.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "path", - "description": "

The path to the file when the error occurs.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "source", - "description": "

The content of the line where the error occurs.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "suggestion", - "description": "

A suggestion of how to fix the error.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "RepositoryCollaboratorConnection", - "id": "repositorycollaboratorconnection", - "href": "/graphql/reference/objects#repositorycollaboratorconnection", - "description": "

The connection type for User.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[RepositoryCollaboratorEdge]", - "id": "repositorycollaboratoredge", - "href": "/graphql/reference/objects#repositorycollaboratoredge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[User]", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "RepositoryCollaboratorEdge", - "id": "repositorycollaboratoredge", - "href": "/graphql/reference/objects#repositorycollaboratoredge", - "description": "

Represents a user who is a collaborator of a repository.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "permission", - "description": "

The permission the user has on the repository.

", - "type": "RepositoryPermission!", - "id": "repositorypermission", - "href": "/graphql/reference/enums#repositorypermission" - }, - { - "name": "permissionSources", - "description": "

A list of sources for the user's access to the repository.

", - "type": "[PermissionSource!]", - "id": "permissionsource", - "href": "/graphql/reference/objects#permissionsource" - } - ] - }, - { - "name": "RepositoryConnection", - "id": "repositoryconnection", - "href": "/graphql/reference/objects#repositoryconnection", - "description": "

A list of repositories owned by the subject.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[RepositoryEdge]", - "id": "repositoryedge", - "href": "/graphql/reference/objects#repositoryedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Repository]", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "totalDiskUsage", - "description": "

The total size in kilobytes of all repositories in the connection. Value will\nnever be larger than max 32-bit signed integer.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "RepositoryContactLink", - "id": "repositorycontactlink", - "href": "/graphql/reference/objects#repositorycontactlink", - "description": "

A repository contact link.

", - "fields": [ - { - "name": "about", - "description": "

The contact link purpose.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The contact link name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "url", - "description": "

The contact link URL.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "RepositoryEdge", - "id": "repositoryedge", - "href": "/graphql/reference/objects#repositoryedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "RepositoryIdConditionTarget", - "id": "repositoryidconditiontarget", - "href": "/graphql/reference/objects#repositoryidconditiontarget", - "description": "

Parameters to be used for the repository_id condition.

", - "fields": [ - { - "name": "repositoryIds", - "description": "

One of these repo IDs must match the repo.

", - "type": "[ID!]!", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - ] - }, - { - "name": "RepositoryInvitation", - "id": "repositoryinvitation", - "href": "/graphql/reference/objects#repositoryinvitation", - "description": "

An invitation for a user to be added to a repository.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "email", - "description": "

The email address that received the invitation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the RepositoryInvitation object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "invitee", - "description": "

The user who received the invitation.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "inviter", - "description": "

The user who created the invitation.

", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "permalink", - "description": "

The permalink for this repository invitation.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "permission", - "description": "

The permission granted on this repository by this invitation.

", - "type": "RepositoryPermission!", - "id": "repositorypermission", - "href": "/graphql/reference/enums#repositorypermission" - }, - { - "name": "repository", - "description": "

The Repository the user is invited to.

", - "type": "RepositoryInfo", - "id": "repositoryinfo", - "href": "/graphql/reference/interfaces#repositoryinfo" - } - ] - }, - { - "name": "RepositoryInvitationConnection", - "id": "repositoryinvitationconnection", - "href": "/graphql/reference/objects#repositoryinvitationconnection", - "description": "

A list of repository invitations.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[RepositoryInvitationEdge]", - "id": "repositoryinvitationedge", - "href": "/graphql/reference/objects#repositoryinvitationedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[RepositoryInvitation]", - "id": "repositoryinvitation", - "href": "/graphql/reference/objects#repositoryinvitation" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "RepositoryInvitationEdge", - "id": "repositoryinvitationedge", - "href": "/graphql/reference/objects#repositoryinvitationedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "RepositoryInvitation", - "id": "repositoryinvitation", - "href": "/graphql/reference/objects#repositoryinvitation" - } - ] - }, - { - "name": "RepositoryMigration", - "id": "repositorymigration", - "href": "/graphql/reference/objects#repositorymigration", - "description": "

A GitHub Enterprise Importer (GEI) repository migration.

", - "implements": [ - { - "name": "Migration", - "id": "migration", - "href": "/graphql/reference/interfaces#migration" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "continueOnError", - "description": "

The migration flag to continue on error.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "failureReason", - "description": "

The reason the migration failed.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the RepositoryMigration object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "migrationLogUrl", - "description": "

The URL for the migration log (expires 1 day after migration completes).

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "migrationSource", - "description": "

The migration source.

", - "type": "MigrationSource!", - "id": "migrationsource", - "href": "/graphql/reference/objects#migrationsource" - }, - { - "name": "repositoryName", - "description": "

The target repository name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "sourceUrl", - "description": "

The migration source URL, for example https://github.com or https://monalisa.ghe.com.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "state", - "description": "

The migration state.

", - "type": "MigrationState!", - "id": "migrationstate", - "href": "/graphql/reference/enums#migrationstate" - }, - { - "name": "warningsCount", - "description": "

The number of warnings encountered for this migration. To review the warnings,\ncheck the Migration Log.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "RepositoryMigrationConnection", - "id": "repositorymigrationconnection", - "href": "/graphql/reference/objects#repositorymigrationconnection", - "description": "

A list of migrations.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[RepositoryMigrationEdge]", - "id": "repositorymigrationedge", - "href": "/graphql/reference/objects#repositorymigrationedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[RepositoryMigration]", - "id": "repositorymigration", - "href": "/graphql/reference/objects#repositorymigration" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "RepositoryMigrationEdge", - "id": "repositorymigrationedge", - "href": "/graphql/reference/objects#repositorymigrationedge", - "description": "

Represents a repository migration.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "RepositoryMigration", - "id": "repositorymigration", - "href": "/graphql/reference/objects#repositorymigration" - } - ] - }, - { - "name": "RepositoryNameConditionTarget", - "id": "repositorynameconditiontarget", - "href": "/graphql/reference/objects#repositorynameconditiontarget", - "description": "

Parameters to be used for the repository_name condition.

", - "fields": [ - { - "name": "exclude", - "description": "

Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "include", - "description": "

Array of repository names or patterns to include. One of these patterns must\nmatch for the condition to pass. Also accepts ~ALL to include all repositories.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "protected", - "description": "

Target changes that match these patterns will be prevented except by those with bypass permissions.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "RepositoryPlanFeatures", - "id": "repositoryplanfeatures", - "href": "/graphql/reference/objects#repositoryplanfeatures", - "description": "

Information about the availability of features and limits for a repository based on its billing plan.

", - "fields": [ - { - "name": "codeowners", - "description": "

Whether reviews can be automatically requested and enforced with a CODEOWNERS file.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "draftPullRequests", - "description": "

Whether pull requests can be created as or converted to draft.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "maximumAssignees", - "description": "

Maximum number of users that can be assigned to an issue or pull request.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "maximumManualReviewRequests", - "description": "

Maximum number of manually-requested reviews on a pull request.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "teamReviewRequests", - "description": "

Whether teams can be requested to review pull requests.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "RepositoryPropertyConditionTarget", - "id": "repositorypropertyconditiontarget", - "href": "/graphql/reference/objects#repositorypropertyconditiontarget", - "description": "

Parameters to be used for the repository_property condition.

", - "fields": [ - { - "name": "exclude", - "description": "

Array of repository properties that must not match.

", - "type": "[PropertyTargetDefinition!]!", - "id": "propertytargetdefinition", - "href": "/graphql/reference/objects#propertytargetdefinition" - }, - { - "name": "include", - "description": "

Array of repository properties that must match.

", - "type": "[PropertyTargetDefinition!]!", - "id": "propertytargetdefinition", - "href": "/graphql/reference/objects#propertytargetdefinition" - } - ] - }, - { - "name": "RepositoryRule", - "id": "repositoryrule", - "href": "/graphql/reference/objects#repositoryrule", - "description": "

A repository rule.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "id", - "description": "

The Node ID of the RepositoryRule object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "parameters", - "description": "

The parameters for this rule.

", - "type": "RuleParameters", - "id": "ruleparameters", - "href": "/graphql/reference/unions#ruleparameters" - }, - { - "name": "repositoryRuleset", - "description": "

The repository ruleset associated with this rule configuration.

", - "type": "RepositoryRuleset", - "id": "repositoryruleset", - "href": "/graphql/reference/objects#repositoryruleset" - }, - { - "name": "type", - "description": "

The type of rule.

", - "type": "RepositoryRuleType!", - "id": "repositoryruletype", - "href": "/graphql/reference/enums#repositoryruletype" - } - ] - }, - { - "name": "RepositoryRuleConditions", - "id": "repositoryruleconditions", - "href": "/graphql/reference/objects#repositoryruleconditions", - "description": "

Set of conditions that determine if a ruleset will evaluate.

", - "fields": [ - { - "name": "refName", - "description": "

Configuration for the ref_name condition.

", - "type": "RefNameConditionTarget", - "id": "refnameconditiontarget", - "href": "/graphql/reference/objects#refnameconditiontarget" - }, - { - "name": "repositoryId", - "description": "

Configuration for the repository_id condition.

", - "type": "RepositoryIdConditionTarget", - "id": "repositoryidconditiontarget", - "href": "/graphql/reference/objects#repositoryidconditiontarget" - }, - { - "name": "repositoryName", - "description": "

Configuration for the repository_name condition.

", - "type": "RepositoryNameConditionTarget", - "id": "repositorynameconditiontarget", - "href": "/graphql/reference/objects#repositorynameconditiontarget" - }, - { - "name": "repositoryProperty", - "description": "

Configuration for the repository_property condition.

", - "type": "RepositoryPropertyConditionTarget", - "id": "repositorypropertyconditiontarget", - "href": "/graphql/reference/objects#repositorypropertyconditiontarget" - } - ] - }, - { - "name": "RepositoryRuleConnection", - "id": "repositoryruleconnection", - "href": "/graphql/reference/objects#repositoryruleconnection", - "description": "

The connection type for RepositoryRule.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[RepositoryRuleEdge]", - "id": "repositoryruleedge", - "href": "/graphql/reference/objects#repositoryruleedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[RepositoryRule]", - "id": "repositoryrule", - "href": "/graphql/reference/objects#repositoryrule" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "RepositoryRuleEdge", - "id": "repositoryruleedge", - "href": "/graphql/reference/objects#repositoryruleedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "RepositoryRule", - "id": "repositoryrule", - "href": "/graphql/reference/objects#repositoryrule" - } - ] - }, - { - "name": "RepositoryRuleset", - "id": "repositoryruleset", - "href": "/graphql/reference/objects#repositoryruleset", - "description": "

A repository ruleset.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "bypassActors", - "description": "

The actors that can bypass this ruleset.

", - "type": "RepositoryRulesetBypassActorConnection", - "id": "repositoryrulesetbypassactorconnection", - "href": "/graphql/reference/objects#repositoryrulesetbypassactorconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "conditions", - "description": "

The set of conditions that must evaluate to true for this ruleset to apply.

", - "type": "RepositoryRuleConditions!", - "id": "repositoryruleconditions", - "href": "/graphql/reference/objects#repositoryruleconditions" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "enforcement", - "description": "

The enforcement level of this ruleset.

", - "type": "RuleEnforcement!", - "id": "ruleenforcement", - "href": "/graphql/reference/enums#ruleenforcement" - }, - { - "name": "id", - "description": "

The Node ID of the RepositoryRuleset object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "name", - "description": "

Name of the ruleset.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "rules", - "description": "

List of rules.

", - "type": "RepositoryRuleConnection", - "id": "repositoryruleconnection", - "href": "/graphql/reference/objects#repositoryruleconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "type", - "description": "

The type of rule.

", - "type": { - "name": "RepositoryRuleType", - "id": "repositoryruletype", - "href": "/graphql/reference/enums#repositoryruletype" - } - } - ] - }, - { - "name": "source", - "description": "

Source of ruleset.

", - "type": "RuleSource!", - "id": "rulesource", - "href": "/graphql/reference/unions#rulesource" - }, - { - "name": "target", - "description": "

Target of the ruleset.

", - "type": "RepositoryRulesetTarget", - "id": "repositoryrulesettarget", - "href": "/graphql/reference/enums#repositoryrulesettarget" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "RepositoryRulesetBypassActor", - "id": "repositoryrulesetbypassactor", - "href": "/graphql/reference/objects#repositoryrulesetbypassactor", - "description": "

A team or app that has the ability to bypass a rules defined on a ruleset.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

The actor that can bypass rules.

", - "type": "BypassActor", - "id": "bypassactor", - "href": "/graphql/reference/unions#bypassactor" - }, - { - "name": "bypassMode", - "description": "

The mode for the bypass actor.

", - "type": "RepositoryRulesetBypassActorBypassMode", - "id": "repositoryrulesetbypassactorbypassmode", - "href": "/graphql/reference/enums#repositoryrulesetbypassactorbypassmode" - }, - { - "name": "deployKey", - "description": "

This actor represents the ability for a deploy key to bypass.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "id", - "description": "

The Node ID of the RepositoryRulesetBypassActor object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "organizationAdmin", - "description": "

This actor represents the ability for an organization owner to bypass.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "repositoryRoleDatabaseId", - "description": "

If the actor is a repository role, the repository role's ID that can bypass.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "repositoryRoleName", - "description": "

If the actor is a repository role, the repository role's name that can bypass.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryRuleset", - "description": "

Identifies the ruleset associated with the allowed actor.

", - "type": "RepositoryRuleset", - "id": "repositoryruleset", - "href": "/graphql/reference/objects#repositoryruleset" - } - ] - }, - { - "name": "RepositoryRulesetBypassActorConnection", - "id": "repositoryrulesetbypassactorconnection", - "href": "/graphql/reference/objects#repositoryrulesetbypassactorconnection", - "description": "

The connection type for RepositoryRulesetBypassActor.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[RepositoryRulesetBypassActorEdge]", - "id": "repositoryrulesetbypassactoredge", - "href": "/graphql/reference/objects#repositoryrulesetbypassactoredge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[RepositoryRulesetBypassActor]", - "id": "repositoryrulesetbypassactor", - "href": "/graphql/reference/objects#repositoryrulesetbypassactor" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "RepositoryRulesetBypassActorEdge", - "id": "repositoryrulesetbypassactoredge", - "href": "/graphql/reference/objects#repositoryrulesetbypassactoredge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "RepositoryRulesetBypassActor", - "id": "repositoryrulesetbypassactor", - "href": "/graphql/reference/objects#repositoryrulesetbypassactor" - } - ] - }, - { - "name": "RepositoryRulesetConnection", - "id": "repositoryrulesetconnection", - "href": "/graphql/reference/objects#repositoryrulesetconnection", - "description": "

The connection type for RepositoryRuleset.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[RepositoryRulesetEdge]", - "id": "repositoryrulesetedge", - "href": "/graphql/reference/objects#repositoryrulesetedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[RepositoryRuleset]", - "id": "repositoryruleset", - "href": "/graphql/reference/objects#repositoryruleset" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "RepositoryRulesetEdge", - "id": "repositoryrulesetedge", - "href": "/graphql/reference/objects#repositoryrulesetedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "RepositoryRuleset", - "id": "repositoryruleset", - "href": "/graphql/reference/objects#repositoryruleset" - } - ] - }, - { - "name": "RepositoryTopic", - "id": "repositorytopic", - "href": "/graphql/reference/objects#repositorytopic", - "description": "

A repository-topic connects a repository to a topic.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "id", - "description": "

The Node ID of the RepositoryTopic object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this repository-topic.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "topic", - "description": "

The topic.

", - "type": "Topic!", - "id": "topic", - "href": "/graphql/reference/objects#topic" - }, - { - "name": "url", - "description": "

The HTTP URL for this repository-topic.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "RepositoryTopicConnection", - "id": "repositorytopicconnection", - "href": "/graphql/reference/objects#repositorytopicconnection", - "description": "

The connection type for RepositoryTopic.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[RepositoryTopicEdge]", - "id": "repositorytopicedge", - "href": "/graphql/reference/objects#repositorytopicedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[RepositoryTopic]", - "id": "repositorytopic", - "href": "/graphql/reference/objects#repositorytopic" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "RepositoryTopicEdge", - "id": "repositorytopicedge", - "href": "/graphql/reference/objects#repositorytopicedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "RepositoryTopic", - "id": "repositorytopic", - "href": "/graphql/reference/objects#repositorytopic" - } - ] - }, - { - "name": "RepositoryVisibilityChangeDisableAuditEntry", - "id": "repositoryvisibilitychangedisableauditentry", - "href": "/graphql/reference/objects#repositoryvisibilitychangedisableauditentry", - "description": "

Audit log entry for a repository_visibility_change.disable event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "EnterpriseAuditEntryData", - "id": "enterpriseauditentrydata", - "href": "/graphql/reference/interfaces#enterpriseauditentrydata" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "enterpriseResourcePath", - "description": "

The HTTP path for this enterprise.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "enterpriseSlug", - "description": "

The slug of the enterprise.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseUrl", - "description": "

The HTTP URL for this enterprise.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "id", - "description": "

The Node ID of the RepositoryVisibilityChangeDisableAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "RepositoryVisibilityChangeEnableAuditEntry", - "id": "repositoryvisibilitychangeenableauditentry", - "href": "/graphql/reference/objects#repositoryvisibilitychangeenableauditentry", - "description": "

Audit log entry for a repository_visibility_change.enable event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "EnterpriseAuditEntryData", - "id": "enterpriseauditentrydata", - "href": "/graphql/reference/interfaces#enterpriseauditentrydata" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "enterpriseResourcePath", - "description": "

The HTTP path for this enterprise.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "enterpriseSlug", - "description": "

The slug of the enterprise.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseUrl", - "description": "

The HTTP URL for this enterprise.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "id", - "description": "

The Node ID of the RepositoryVisibilityChangeEnableAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "RepositoryVulnerabilityAlert", - "id": "repositoryvulnerabilityalert", - "href": "/graphql/reference/objects#repositoryvulnerabilityalert", - "description": "

A Dependabot alert for a repository with a dependency affected by a security vulnerability.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "RepositoryNode", - "id": "repositorynode", - "href": "/graphql/reference/interfaces#repositorynode" - } - ], - "fields": [ - { - "name": "autoDismissedAt", - "description": "

When was the alert auto-dismissed?.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "createdAt", - "description": "

When was the alert created?.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "dependabotUpdate", - "description": "

The associated Dependabot update.

", - "type": "DependabotUpdate", - "id": "dependabotupdate", - "href": "/graphql/reference/objects#dependabotupdate" - }, - { - "name": "dependencyScope", - "description": "

The scope of an alert's dependency.

", - "type": "RepositoryVulnerabilityAlertDependencyScope", - "id": "repositoryvulnerabilityalertdependencyscope", - "href": "/graphql/reference/enums#repositoryvulnerabilityalertdependencyscope" - }, - { - "name": "dismissComment", - "description": "

Comment explaining the reason the alert was dismissed.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "dismissReason", - "description": "

The reason the alert was dismissed.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "dismissedAt", - "description": "

When was the alert dismissed?.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "dismisser", - "description": "

The user who dismissed the alert.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "fixedAt", - "description": "

When was the alert fixed?.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the RepositoryVulnerabilityAlert object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "number", - "description": "

Identifies the alert number.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "repository", - "description": "

The associated repository.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "securityAdvisory", - "description": "

The associated security advisory.

", - "type": "SecurityAdvisory", - "id": "securityadvisory", - "href": "/graphql/reference/objects#securityadvisory" - }, - { - "name": "securityVulnerability", - "description": "

The associated security vulnerability.

", - "type": "SecurityVulnerability", - "id": "securityvulnerability", - "href": "/graphql/reference/objects#securityvulnerability" - }, - { - "name": "state", - "description": "

Identifies the state of the alert.

", - "type": "RepositoryVulnerabilityAlertState!", - "id": "repositoryvulnerabilityalertstate", - "href": "/graphql/reference/enums#repositoryvulnerabilityalertstate" - }, - { - "name": "vulnerableManifestFilename", - "description": "

The vulnerable manifest filename.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "vulnerableManifestPath", - "description": "

The vulnerable manifest path.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "vulnerableRequirements", - "description": "

The vulnerable requirements.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "RepositoryVulnerabilityAlertConnection", - "id": "repositoryvulnerabilityalertconnection", - "href": "/graphql/reference/objects#repositoryvulnerabilityalertconnection", - "description": "

The connection type for RepositoryVulnerabilityAlert.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[RepositoryVulnerabilityAlertEdge]", - "id": "repositoryvulnerabilityalertedge", - "href": "/graphql/reference/objects#repositoryvulnerabilityalertedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[RepositoryVulnerabilityAlert]", - "id": "repositoryvulnerabilityalert", - "href": "/graphql/reference/objects#repositoryvulnerabilityalert" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "RepositoryVulnerabilityAlertEdge", - "id": "repositoryvulnerabilityalertedge", - "href": "/graphql/reference/objects#repositoryvulnerabilityalertedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "RepositoryVulnerabilityAlert", - "id": "repositoryvulnerabilityalert", - "href": "/graphql/reference/objects#repositoryvulnerabilityalert" - } - ] - }, - { - "name": "RequestedReviewerConnection", - "id": "requestedreviewerconnection", - "href": "/graphql/reference/objects#requestedreviewerconnection", - "description": "

The connection type for RequestedReviewer.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[RequestedReviewerEdge]", - "id": "requestedrevieweredge", - "href": "/graphql/reference/objects#requestedrevieweredge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[RequestedReviewer]", - "id": "requestedreviewer", - "href": "/graphql/reference/unions#requestedreviewer" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "RequestedReviewerEdge", - "id": "requestedrevieweredge", - "href": "/graphql/reference/objects#requestedrevieweredge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "RequestedReviewer", - "id": "requestedreviewer", - "href": "/graphql/reference/unions#requestedreviewer" - } - ] - }, - { - "name": "RequiredDeploymentsParameters", - "id": "requireddeploymentsparameters", - "href": "/graphql/reference/objects#requireddeploymentsparameters", - "description": "

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

", - "fields": [ - { - "name": "requiredDeploymentEnvironments", - "description": "

The environments that must be successfully deployed to before branches can be merged.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "RequiredStatusCheckDescription", - "id": "requiredstatuscheckdescription", - "href": "/graphql/reference/objects#requiredstatuscheckdescription", - "description": "

Represents a required status check for a protected branch, but not any specific run of that check.

", - "fields": [ - { - "name": "app", - "description": "

The App that must provide this status in order for it to be accepted.

", - "type": "App", - "id": "app", - "href": "/graphql/reference/objects#app" - }, - { - "name": "context", - "description": "

The name of this status.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "RequiredStatusChecksParameters", - "id": "requiredstatuschecksparameters", - "href": "/graphql/reference/objects#requiredstatuschecksparameters", - "description": "

Choose which status checks must pass before the ref is updated. When enabled,\ncommits must first be pushed to another ref where the checks pass.

", - "fields": [ - { - "name": "requiredStatusChecks", - "description": "

Status checks that are required.

", - "type": "[StatusCheckConfiguration!]!", - "id": "statuscheckconfiguration", - "href": "/graphql/reference/objects#statuscheckconfiguration" - }, - { - "name": "strictRequiredStatusChecksPolicy", - "description": "

Whether pull requests targeting a matching branch must be tested with the\nlatest code. This setting will not take effect unless at least one status\ncheck is enabled.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "RestrictedContribution", - "id": "restrictedcontribution", - "href": "/graphql/reference/objects#restrictedcontribution", - "description": "

Represents a private contribution a user made on GitHub.

", - "implements": [ - { - "name": "Contribution", - "id": "contribution", - "href": "/graphql/reference/interfaces#contribution" - } - ], - "fields": [ - { - "name": "isRestricted", - "description": "

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.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "occurredAt", - "description": "

When this contribution was made.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this contribution.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The HTTP URL for this contribution.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user who made this contribution.

", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "ReviewDismissalAllowance", - "id": "reviewdismissalallowance", - "href": "/graphql/reference/objects#reviewdismissalallowance", - "description": "

A user, team, or app who has the ability to dismiss a review on a protected branch.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

The actor that can dismiss.

", - "type": "ReviewDismissalAllowanceActor", - "id": "reviewdismissalallowanceactor", - "href": "/graphql/reference/unions#reviewdismissalallowanceactor" - }, - { - "name": "branchProtectionRule", - "description": "

Identifies the branch protection rule associated with the allowed user, team, or app.

", - "type": "BranchProtectionRule", - "id": "branchprotectionrule", - "href": "/graphql/reference/objects#branchprotectionrule" - }, - { - "name": "id", - "description": "

The Node ID of the ReviewDismissalAllowance object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - ] - }, - { - "name": "ReviewDismissalAllowanceConnection", - "id": "reviewdismissalallowanceconnection", - "href": "/graphql/reference/objects#reviewdismissalallowanceconnection", - "description": "

The connection type for ReviewDismissalAllowance.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ReviewDismissalAllowanceEdge]", - "id": "reviewdismissalallowanceedge", - "href": "/graphql/reference/objects#reviewdismissalallowanceedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[ReviewDismissalAllowance]", - "id": "reviewdismissalallowance", - "href": "/graphql/reference/objects#reviewdismissalallowance" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ReviewDismissalAllowanceEdge", - "id": "reviewdismissalallowanceedge", - "href": "/graphql/reference/objects#reviewdismissalallowanceedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "ReviewDismissalAllowance", - "id": "reviewdismissalallowance", - "href": "/graphql/reference/objects#reviewdismissalallowance" - } - ] - }, - { - "name": "ReviewDismissedEvent", - "id": "reviewdismissedevent", - "href": "/graphql/reference/objects#reviewdismissedevent", - "description": "

Represents areview_dismissedevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "dismissalMessage", - "description": "

Identifies the optional message associated with thereview_dismissedevent.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "dismissalMessageHTML", - "description": "

Identifies the optional message associated with the event, rendered to HTML.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the ReviewDismissedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "previousReviewState", - "description": "

Identifies the previous state of the review with thereview_dismissedevent.

", - "type": "PullRequestReviewState!", - "id": "pullrequestreviewstate", - "href": "/graphql/reference/enums#pullrequestreviewstate" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "pullRequestCommit", - "description": "

Identifies the commit which caused the review to become stale.

", - "type": "PullRequestCommit", - "id": "pullrequestcommit", - "href": "/graphql/reference/objects#pullrequestcommit" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this review dismissed event.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "review", - "description": "

Identifies the review associated with thereview_dismissedevent.

", - "type": "PullRequestReview", - "id": "pullrequestreview", - "href": "/graphql/reference/objects#pullrequestreview" - }, - { - "name": "url", - "description": "

The HTTP URL for this review dismissed event.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "ReviewRequest", - "id": "reviewrequest", - "href": "/graphql/reference/objects#reviewrequest", - "description": "

A request for a user to review a pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "asCodeOwner", - "description": "

Whether this request was created for a code owner.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the ReviewRequest object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pullRequest", - "description": "

Identifies the pull request associated with this review request.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "requestedReviewer", - "description": "

The reviewer that is requested.

", - "type": "RequestedReviewer", - "id": "requestedreviewer", - "href": "/graphql/reference/unions#requestedreviewer" - } - ] - }, - { - "name": "ReviewRequestConnection", - "id": "reviewrequestconnection", - "href": "/graphql/reference/objects#reviewrequestconnection", - "description": "

The connection type for ReviewRequest.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[ReviewRequestEdge]", - "id": "reviewrequestedge", - "href": "/graphql/reference/objects#reviewrequestedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[ReviewRequest]", - "id": "reviewrequest", - "href": "/graphql/reference/objects#reviewrequest" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ReviewRequestEdge", - "id": "reviewrequestedge", - "href": "/graphql/reference/objects#reviewrequestedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "ReviewRequest", - "id": "reviewrequest", - "href": "/graphql/reference/objects#reviewrequest" - } - ] - }, - { - "name": "ReviewRequestRemovedEvent", - "id": "reviewrequestremovedevent", - "href": "/graphql/reference/objects#reviewrequestremovedevent", - "description": "

Represents anreview_request_removedevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the ReviewRequestRemovedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "requestedReviewer", - "description": "

Identifies the reviewer whose review request was removed.

", - "type": "RequestedReviewer", - "id": "requestedreviewer", - "href": "/graphql/reference/unions#requestedreviewer" - } - ] - }, - { - "name": "ReviewRequestedEvent", - "id": "reviewrequestedevent", - "href": "/graphql/reference/objects#reviewrequestedevent", - "description": "

Represents anreview_requestedevent on a given pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the ReviewRequestedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pullRequest", - "description": "

PullRequest referenced by event.

", - "type": "PullRequest!", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "requestedReviewer", - "description": "

Identifies the reviewer whose review was requested.

", - "type": "RequestedReviewer", - "id": "requestedreviewer", - "href": "/graphql/reference/unions#requestedreviewer" - } - ] - }, - { - "name": "ReviewStatusHovercardContext", - "id": "reviewstatushovercardcontext", - "href": "/graphql/reference/objects#reviewstatushovercardcontext", - "description": "

A hovercard context with a message describing the current code review state of the pull\nrequest.

", - "implements": [ - { - "name": "HovercardContext", - "id": "hovercardcontext", - "href": "/graphql/reference/interfaces#hovercardcontext" - } - ], - "fields": [ - { - "name": "message", - "description": "

A string describing this context.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "octicon", - "description": "

An octicon to accompany this context.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "reviewDecision", - "description": "

The current status of the pull request with respect to code review.

", - "type": "PullRequestReviewDecision", - "id": "pullrequestreviewdecision", - "href": "/graphql/reference/enums#pullrequestreviewdecision" - } - ] - }, - { - "name": "SavedReply", - "id": "savedreply", - "href": "/graphql/reference/objects#savedreply", - "description": "

A Saved Reply is text a user can use to reply quickly.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "body", - "description": "

The body of the saved reply.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyHTML", - "description": "

The saved reply body rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the SavedReply object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "title", - "description": "

The title of the saved reply.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "user", - "description": "

The user that saved this reply.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - } - ] - }, - { - "name": "SavedReplyConnection", - "id": "savedreplyconnection", - "href": "/graphql/reference/objects#savedreplyconnection", - "description": "

The connection type for SavedReply.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[SavedReplyEdge]", - "id": "savedreplyedge", - "href": "/graphql/reference/objects#savedreplyedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[SavedReply]", - "id": "savedreply", - "href": "/graphql/reference/objects#savedreply" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "SavedReplyEdge", - "id": "savedreplyedge", - "href": "/graphql/reference/objects#savedreplyedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "SavedReply", - "id": "savedreply", - "href": "/graphql/reference/objects#savedreply" - } - ] - }, - { - "name": "SearchResultItemConnection", - "id": "searchresultitemconnection", - "href": "/graphql/reference/objects#searchresultitemconnection", - "description": "

A list of results that matched against a search query. Regardless of the number\nof matches, a maximum of 1,000 results will be available across all types,\npotentially split across many pages.

", - "fields": [ - { - "name": "codeCount", - "description": "

The total number of pieces of code that matched the search query. Regardless\nof the total number of matches, a maximum of 1,000 results will be available\nacross all types.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "discussionCount", - "description": "

The total number of discussions that matched the search query. Regardless of\nthe total number of matches, a maximum of 1,000 results will be available\nacross all types.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[SearchResultItemEdge]", - "id": "searchresultitemedge", - "href": "/graphql/reference/objects#searchresultitemedge" - }, - { - "name": "issueCount", - "description": "

The total number of issues that matched the search query. Regardless of the\ntotal number of matches, a maximum of 1,000 results will be available across all types.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[SearchResultItem]", - "id": "searchresultitem", - "href": "/graphql/reference/unions#searchresultitem" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "repositoryCount", - "description": "

The total number of repositories that matched the search query. Regardless of\nthe total number of matches, a maximum of 1,000 results will be available\nacross all types.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "userCount", - "description": "

The total number of users that matched the search query. Regardless of the\ntotal number of matches, a maximum of 1,000 results will be available across all types.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "wikiCount", - "description": "

The total number of wiki pages that matched the search query. Regardless of\nthe total number of matches, a maximum of 1,000 results will be available\nacross all types.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "SearchResultItemEdge", - "id": "searchresultitemedge", - "href": "/graphql/reference/objects#searchresultitemedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "SearchResultItem", - "id": "searchresultitem", - "href": "/graphql/reference/unions#searchresultitem" - }, - { - "name": "textMatches", - "description": "

Text matches on the result found.

", - "type": "[TextMatch]", - "id": "textmatch", - "href": "/graphql/reference/objects#textmatch" - } - ] - }, - { - "name": "SecurityAdvisory", - "id": "securityadvisory", - "href": "/graphql/reference/objects#securityadvisory", - "description": "

A GitHub Security Advisory.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "classification", - "description": "

The classification of the advisory.

", - "type": "SecurityAdvisoryClassification!", - "id": "securityadvisoryclassification", - "href": "/graphql/reference/enums#securityadvisoryclassification" - }, - { - "name": "cvss", - "description": "

The CVSS associated with this advisory.

", - "type": "CVSS!", - "id": "cvss", - "href": "/graphql/reference/objects#cvss" - }, - { - "name": "cwes", - "description": "

CWEs associated with this Advisory.

", - "type": "CWEConnection!", - "id": "cweconnection", - "href": "/graphql/reference/objects#cweconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "description", - "description": "

This is a long plaintext description of the advisory.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ghsaId", - "description": "

The GitHub Security Advisory ID.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the SecurityAdvisory object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "identifiers", - "description": "

A list of identifiers for this advisory.

", - "type": "[SecurityAdvisoryIdentifier!]!", - "id": "securityadvisoryidentifier", - "href": "/graphql/reference/objects#securityadvisoryidentifier" - }, - { - "name": "notificationsPermalink", - "description": "

The permalink for the advisory's dependabot alerts page.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "origin", - "description": "

The organization that originated the advisory.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "permalink", - "description": "

The permalink for the advisory.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "publishedAt", - "description": "

When the advisory was published.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "references", - "description": "

A list of references for this advisory.

", - "type": "[SecurityAdvisoryReference!]!", - "id": "securityadvisoryreference", - "href": "/graphql/reference/objects#securityadvisoryreference" - }, - { - "name": "severity", - "description": "

The severity of the advisory.

", - "type": "SecurityAdvisorySeverity!", - "id": "securityadvisoryseverity", - "href": "/graphql/reference/enums#securityadvisoryseverity" - }, - { - "name": "summary", - "description": "

A short plaintext summary of the advisory.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "updatedAt", - "description": "

When the advisory was last updated.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "vulnerabilities", - "description": "

Vulnerabilities associated with this Advisory.

", - "type": "SecurityVulnerabilityConnection!", - "id": "securityvulnerabilityconnection", - "href": "/graphql/reference/objects#securityvulnerabilityconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "classifications", - "description": "

A list of advisory classifications to filter vulnerabilities by.

", - "type": { - "name": "[SecurityAdvisoryClassification!]", - "id": "securityadvisoryclassification", - "href": "/graphql/reference/enums#securityadvisoryclassification" - } - }, - { - "name": "ecosystem", - "description": "

An ecosystem to filter vulnerabilities by.

", - "type": { - "name": "SecurityAdvisoryEcosystem", - "id": "securityadvisoryecosystem", - "href": "/graphql/reference/enums#securityadvisoryecosystem" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "package", - "description": "

A package name to filter vulnerabilities by.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "severities", - "description": "

A list of severities to filter vulnerabilities by.

", - "type": { - "name": "[SecurityAdvisorySeverity!]", - "id": "securityadvisoryseverity", - "href": "/graphql/reference/enums#securityadvisoryseverity" - } - } - ] - }, - { - "name": "withdrawnAt", - "description": "

When the advisory was withdrawn, if it has been withdrawn.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "SecurityAdvisoryConnection", - "id": "securityadvisoryconnection", - "href": "/graphql/reference/objects#securityadvisoryconnection", - "description": "

The connection type for SecurityAdvisory.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[SecurityAdvisoryEdge]", - "id": "securityadvisoryedge", - "href": "/graphql/reference/objects#securityadvisoryedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[SecurityAdvisory]", - "id": "securityadvisory", - "href": "/graphql/reference/objects#securityadvisory" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "SecurityAdvisoryEdge", - "id": "securityadvisoryedge", - "href": "/graphql/reference/objects#securityadvisoryedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "SecurityAdvisory", - "id": "securityadvisory", - "href": "/graphql/reference/objects#securityadvisory" - } - ] - }, - { - "name": "SecurityAdvisoryIdentifier", - "id": "securityadvisoryidentifier", - "href": "/graphql/reference/objects#securityadvisoryidentifier", - "description": "

A GitHub Security Advisory Identifier.

", - "fields": [ - { - "name": "type", - "description": "

The identifier type, e.g. GHSA, CVE.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "value", - "description": "

The identifier.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "SecurityAdvisoryPackage", - "id": "securityadvisorypackage", - "href": "/graphql/reference/objects#securityadvisorypackage", - "description": "

An individual package.

", - "fields": [ - { - "name": "ecosystem", - "description": "

The ecosystem the package belongs to, e.g. RUBYGEMS, NPM.

", - "type": "SecurityAdvisoryEcosystem!", - "id": "securityadvisoryecosystem", - "href": "/graphql/reference/enums#securityadvisoryecosystem" - }, - { - "name": "name", - "description": "

The package name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "SecurityAdvisoryPackageVersion", - "id": "securityadvisorypackageversion", - "href": "/graphql/reference/objects#securityadvisorypackageversion", - "description": "

An individual package version.

", - "fields": [ - { - "name": "identifier", - "description": "

The package name or version.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "SecurityAdvisoryReference", - "id": "securityadvisoryreference", - "href": "/graphql/reference/objects#securityadvisoryreference", - "description": "

A GitHub Security Advisory Reference.

", - "fields": [ - { - "name": "url", - "description": "

A publicly accessible reference.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "SecurityVulnerability", - "id": "securityvulnerability", - "href": "/graphql/reference/objects#securityvulnerability", - "description": "

An individual vulnerability within an Advisory.

", - "fields": [ - { - "name": "advisory", - "description": "

The Advisory associated with this Vulnerability.

", - "type": "SecurityAdvisory!", - "id": "securityadvisory", - "href": "/graphql/reference/objects#securityadvisory" - }, - { - "name": "firstPatchedVersion", - "description": "

The first version containing a fix for the vulnerability.

", - "type": "SecurityAdvisoryPackageVersion", - "id": "securityadvisorypackageversion", - "href": "/graphql/reference/objects#securityadvisorypackageversion" - }, - { - "name": "package", - "description": "

A description of the vulnerable package.

", - "type": "SecurityAdvisoryPackage!", - "id": "securityadvisorypackage", - "href": "/graphql/reference/objects#securityadvisorypackage" - }, - { - "name": "severity", - "description": "

The severity of the vulnerability within this package.

", - "type": "SecurityAdvisorySeverity!", - "id": "securityadvisoryseverity", - "href": "/graphql/reference/enums#securityadvisoryseverity" - }, - { - "name": "updatedAt", - "description": "

When the vulnerability was last updated.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "vulnerableVersionRange", - "description": "

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
", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "SecurityVulnerabilityConnection", - "id": "securityvulnerabilityconnection", - "href": "/graphql/reference/objects#securityvulnerabilityconnection", - "description": "

The connection type for SecurityVulnerability.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[SecurityVulnerabilityEdge]", - "id": "securityvulnerabilityedge", - "href": "/graphql/reference/objects#securityvulnerabilityedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[SecurityVulnerability]", - "id": "securityvulnerability", - "href": "/graphql/reference/objects#securityvulnerability" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "SecurityVulnerabilityEdge", - "id": "securityvulnerabilityedge", - "href": "/graphql/reference/objects#securityvulnerabilityedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "SecurityVulnerability", - "id": "securityvulnerability", - "href": "/graphql/reference/objects#securityvulnerability" - } - ] - }, - { - "name": "SmimeSignature", - "id": "smimesignature", - "href": "/graphql/reference/objects#smimesignature", - "description": "

Represents an S/MIME signature on a Commit or Tag.

", - "implements": [ - { - "name": "GitSignature", - "id": "gitsignature", - "href": "/graphql/reference/interfaces#gitsignature" - } - ], - "fields": [ - { - "name": "email", - "description": "

Email used to sign this object.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "isValid", - "description": "

True if the signature is valid and verified by GitHub.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "payload", - "description": "

Payload for GPG signing object. Raw ODB object without the signature header.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "signature", - "description": "

ASCII-armored signature header from object.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "signer", - "description": "

GitHub user corresponding to the email signing this commit.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "state", - "description": "

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

", - "type": "GitSignatureState!", - "id": "gitsignaturestate", - "href": "/graphql/reference/enums#gitsignaturestate" - }, - { - "name": "wasSignedByGitHub", - "description": "

True if the signature was made with GitHub's signing key.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "SocialAccount", - "id": "socialaccount", - "href": "/graphql/reference/objects#socialaccount", - "description": "

Social media profile associated with a user.

", - "fields": [ - { - "name": "displayName", - "description": "

Name of the social media account as it appears on the profile.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "provider", - "description": "

Software or company that hosts the social media account.

", - "type": "SocialAccountProvider!", - "id": "socialaccountprovider", - "href": "/graphql/reference/enums#socialaccountprovider" - }, - { - "name": "url", - "description": "

URL of the social media account.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "SocialAccountConnection", - "id": "socialaccountconnection", - "href": "/graphql/reference/objects#socialaccountconnection", - "description": "

The connection type for SocialAccount.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[SocialAccountEdge]", - "id": "socialaccountedge", - "href": "/graphql/reference/objects#socialaccountedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[SocialAccount]", - "id": "socialaccount", - "href": "/graphql/reference/objects#socialaccount" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "SocialAccountEdge", - "id": "socialaccountedge", - "href": "/graphql/reference/objects#socialaccountedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "SocialAccount", - "id": "socialaccount", - "href": "/graphql/reference/objects#socialaccount" - } - ] - }, - { - "name": "SshSignature", - "id": "sshsignature", - "href": "/graphql/reference/objects#sshsignature", - "description": "

Represents an SSH signature on a Commit or Tag.

", - "implements": [ - { - "name": "GitSignature", - "id": "gitsignature", - "href": "/graphql/reference/interfaces#gitsignature" - } - ], - "fields": [ - { - "name": "email", - "description": "

Email used to sign this object.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "isValid", - "description": "

True if the signature is valid and verified by GitHub.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "keyFingerprint", - "description": "

Hex-encoded fingerprint of the key that signed this object.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "payload", - "description": "

Payload for GPG signing object. Raw ODB object without the signature header.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "signature", - "description": "

ASCII-armored signature header from object.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "signer", - "description": "

GitHub user corresponding to the email signing this commit.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "state", - "description": "

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

", - "type": "GitSignatureState!", - "id": "gitsignaturestate", - "href": "/graphql/reference/enums#gitsignaturestate" - }, - { - "name": "wasSignedByGitHub", - "description": "

True if the signature was made with GitHub's signing key.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "StargazerConnection", - "id": "stargazerconnection", - "href": "/graphql/reference/objects#stargazerconnection", - "description": "

The connection type for User.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[StargazerEdge]", - "id": "stargazeredge", - "href": "/graphql/reference/objects#stargazeredge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[User]", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "StargazerEdge", - "id": "stargazeredge", - "href": "/graphql/reference/objects#stargazeredge", - "description": "

Represents a user that's starred a repository.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "starredAt", - "description": "

Identifies when the item was starred.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "StarredRepositoryConnection", - "id": "starredrepositoryconnection", - "href": "/graphql/reference/objects#starredrepositoryconnection", - "description": "

The connection type for Repository.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[StarredRepositoryEdge]", - "id": "starredrepositoryedge", - "href": "/graphql/reference/objects#starredrepositoryedge" - }, - { - "name": "isOverLimit", - "description": "

Is the list of stars for this user truncated? This is true for users that have many stars.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Repository]", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "StarredRepositoryEdge", - "id": "starredrepositoryedge", - "href": "/graphql/reference/objects#starredrepositoryedge", - "description": "

Represents a starred repository.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "starredAt", - "description": "

Identifies when the item was starred.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "Status", - "id": "status", - "href": "/graphql/reference/objects#status", - "description": "

Represents a commit status.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "combinedContexts", - "description": "

A list of status contexts and check runs for this commit.

", - "type": "StatusCheckRollupContextConnection!", - "id": "statuscheckrollupcontextconnection", - "href": "/graphql/reference/objects#statuscheckrollupcontextconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "commit", - "description": "

The commit this status is attached to.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "context", - "description": "

Looks up an individual status context by context name.

", - "type": "StatusContext", - "id": "statuscontext", - "href": "/graphql/reference/objects#statuscontext", - "arguments": [ - { - "name": "name", - "description": "

The context name.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "contexts", - "description": "

The individual status contexts for this commit.

", - "type": "[StatusContext!]!", - "id": "statuscontext", - "href": "/graphql/reference/objects#statuscontext" - }, - { - "name": "id", - "description": "

The Node ID of the Status object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "state", - "description": "

The combined commit status.

", - "type": "StatusState!", - "id": "statusstate", - "href": "/graphql/reference/enums#statusstate" - } - ] - }, - { - "name": "StatusCheckConfiguration", - "id": "statuscheckconfiguration", - "href": "/graphql/reference/objects#statuscheckconfiguration", - "description": "

Required status check.

", - "fields": [ - { - "name": "context", - "description": "

The status check context name that must be present on the commit.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "integrationId", - "description": "

The optional integration ID that this status check must originate from.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "StatusCheckRollup", - "id": "statuscheckrollup", - "href": "/graphql/reference/objects#statuscheckrollup", - "description": "

Represents the rollup for both the check runs and status for a commit.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "commit", - "description": "

The commit the status and check runs are attached to.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "contexts", - "description": "

A list of status contexts and check runs for this commit.

", - "type": "StatusCheckRollupContextConnection!", - "id": "statuscheckrollupcontextconnection", - "href": "/graphql/reference/objects#statuscheckrollupcontextconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "id", - "description": "

The Node ID of the StatusCheckRollup object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "state", - "description": "

The combined status for the commit.

", - "type": "StatusState!", - "id": "statusstate", - "href": "/graphql/reference/enums#statusstate" - } - ] - }, - { - "name": "StatusCheckRollupContextConnection", - "id": "statuscheckrollupcontextconnection", - "href": "/graphql/reference/objects#statuscheckrollupcontextconnection", - "description": "

The connection type for StatusCheckRollupContext.

", - "fields": [ - { - "name": "checkRunCount", - "description": "

The number of check runs in this rollup.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "checkRunCountsByState", - "description": "

Counts of check runs by state.

", - "type": "[CheckRunStateCount!]", - "id": "checkrunstatecount", - "href": "/graphql/reference/objects#checkrunstatecount" - }, - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[StatusCheckRollupContextEdge]", - "id": "statuscheckrollupcontextedge", - "href": "/graphql/reference/objects#statuscheckrollupcontextedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[StatusCheckRollupContext]", - "id": "statuscheckrollupcontext", - "href": "/graphql/reference/unions#statuscheckrollupcontext" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "statusContextCount", - "description": "

The number of status contexts in this rollup.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "statusContextCountsByState", - "description": "

Counts of status contexts by state.

", - "type": "[StatusContextStateCount!]", - "id": "statuscontextstatecount", - "href": "/graphql/reference/objects#statuscontextstatecount" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "StatusCheckRollupContextEdge", - "id": "statuscheckrollupcontextedge", - "href": "/graphql/reference/objects#statuscheckrollupcontextedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "StatusCheckRollupContext", - "id": "statuscheckrollupcontext", - "href": "/graphql/reference/unions#statuscheckrollupcontext" - } - ] - }, - { - "name": "StatusContext", - "id": "statuscontext", - "href": "/graphql/reference/objects#statuscontext", - "description": "

Represents an individual commit status context.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "RequirableByPullRequest", - "id": "requirablebypullrequest", - "href": "/graphql/reference/interfaces#requirablebypullrequest" - } - ], - "fields": [ - { - "name": "avatarUrl", - "description": "

The avatar of the OAuth application or the user that created the status.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "arguments": [ - { - "name": "size", - "defaultValue": "40", - "description": "

The size of the resulting square image.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "commit", - "description": "

This commit this status context is attached to.

", - "type": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "context", - "description": "

The name of this status context.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "creator", - "description": "

The actor who created this status context.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "description", - "description": "

The description for this status context.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the StatusContext object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isRequired", - "description": "

Whether this is required to pass before merging for a specific pull request.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "arguments": [ - { - "name": "pullRequestId", - "description": "

The id of the pull request this is required for.

", - "type": { - "name": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - }, - { - "name": "pullRequestNumber", - "description": "

The number of the pull request this is required for.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "state", - "description": "

The state of this status context.

", - "type": "StatusState!", - "id": "statusstate", - "href": "/graphql/reference/enums#statusstate" - }, - { - "name": "targetUrl", - "description": "

The URL for this status context.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "StatusContextStateCount", - "id": "statuscontextstatecount", - "href": "/graphql/reference/objects#statuscontextstatecount", - "description": "

Represents a count of the state of a status context.

", - "fields": [ - { - "name": "count", - "description": "

The number of statuses with this state.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "state", - "description": "

The state of a status context.

", - "type": "StatusState!", - "id": "statusstate", - "href": "/graphql/reference/enums#statusstate" - } - ] - }, - { - "name": "Submodule", - "id": "submodule", - "href": "/graphql/reference/objects#submodule", - "description": "

A pointer to a repository at a specific revision embedded inside another repository.

", - "fields": [ - { - "name": "branch", - "description": "

The branch of the upstream submodule for tracking updates.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "gitUrl", - "description": "

The git URL of the submodule repository.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "name", - "description": "

The name of the submodule in .gitmodules.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "nameRaw", - "description": "

The name of the submodule in .gitmodules (Base64-encoded).

", - "type": "Base64String!", - "id": "base64string", - "href": "/graphql/reference/scalars#base64string" - }, - { - "name": "path", - "description": "

The path in the superproject that this submodule is located in.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pathRaw", - "description": "

The path in the superproject that this submodule is located in (Base64-encoded).

", - "type": "Base64String!", - "id": "base64string", - "href": "/graphql/reference/scalars#base64string" - }, - { - "name": "subprojectCommitOid", - "description": "

The commit revision of the subproject repository being tracked by the submodule.

", - "type": "GitObjectID", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - } - ] - }, - { - "name": "SubmoduleConnection", - "id": "submoduleconnection", - "href": "/graphql/reference/objects#submoduleconnection", - "description": "

The connection type for Submodule.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[SubmoduleEdge]", - "id": "submoduleedge", - "href": "/graphql/reference/objects#submoduleedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Submodule]", - "id": "submodule", - "href": "/graphql/reference/objects#submodule" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "SubmoduleEdge", - "id": "submoduleedge", - "href": "/graphql/reference/objects#submoduleedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Submodule", - "id": "submodule", - "href": "/graphql/reference/objects#submodule" - } - ] - }, - { - "name": "SubscribedEvent", - "id": "subscribedevent", - "href": "/graphql/reference/objects#subscribedevent", - "description": "

Represents asubscribedevent on a given Subscribable.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the SubscribedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "subscribable", - "description": "

Object referenced by event.

", - "type": "Subscribable!", - "id": "subscribable", - "href": "/graphql/reference/interfaces#subscribable" - } - ] - }, - { - "name": "SuggestedReviewer", - "id": "suggestedreviewer", - "href": "/graphql/reference/objects#suggestedreviewer", - "description": "

A suggestion to review a pull request based on a user's commit history and review comments.

", - "fields": [ - { - "name": "isAuthor", - "description": "

Is this suggestion based on past commits?.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isCommenter", - "description": "

Is this suggestion based on past review comments?.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "reviewer", - "description": "

Identifies the user suggested to review the pull request.

", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "Tag", - "id": "tag", - "href": "/graphql/reference/objects#tag", - "description": "

Represents a Git tag.

", - "implements": [ - { - "name": "GitObject", - "id": "gitobject", - "href": "/graphql/reference/interfaces#gitobject" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "abbreviatedOid", - "description": "

An abbreviated version of the Git object ID.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "commitResourcePath", - "description": "

The HTTP path for this Git object.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "commitUrl", - "description": "

The HTTP URL for this Git object.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "id", - "description": "

The Node ID of the Tag object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "message", - "description": "

The Git tag message.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The Git tag name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "oid", - "description": "

The Git object ID.

", - "type": "GitObjectID!", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "repository", - "description": "

The Repository the Git object belongs to.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "tagger", - "description": "

Details about the tag author.

", - "type": "GitActor", - "id": "gitactor", - "href": "/graphql/reference/objects#gitactor" - }, - { - "name": "target", - "description": "

The Git object the tag points to.

", - "type": "GitObject!", - "id": "gitobject", - "href": "/graphql/reference/interfaces#gitobject" - } - ] - }, - { - "name": "TagNamePatternParameters", - "id": "tagnamepatternparameters", - "href": "/graphql/reference/objects#tagnamepatternparameters", - "description": "

Parameters to be used for the tag_name_pattern rule.

", - "fields": [ - { - "name": "name", - "description": "

How this rule will appear to users.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "operator", - "description": "

The operator to use for matching.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pattern", - "description": "

The pattern to match with.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "Team", - "id": "team", - "href": "/graphql/reference/objects#team", - "description": "

A team of users in an organization.

", - "implements": [ - { - "name": "MemberStatusable", - "id": "memberstatusable", - "href": "/graphql/reference/interfaces#memberstatusable" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "Subscribable", - "id": "subscribable", - "href": "/graphql/reference/interfaces#subscribable" - } - ], - "fields": [ - { - "name": "ancestors", - "description": "

A list of teams that are ancestors of this team.

", - "type": "TeamConnection!", - "id": "teamconnection", - "href": "/graphql/reference/objects#teamconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "avatarUrl", - "description": "

A URL pointing to the team's avatar.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "arguments": [ - { - "name": "size", - "defaultValue": "400", - "description": "

The size in pixels of the resulting square image.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "childTeams", - "description": "

List of child teams belonging to this team.

", - "type": "TeamConnection!", - "id": "teamconnection", - "href": "/graphql/reference/objects#teamconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "immediateOnly", - "defaultValue": true, - "description": "

Whether to list immediate child teams or all descendant child teams.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Order for connection.

", - "type": { - "name": "TeamOrder", - "id": "teamorder", - "href": "/graphql/reference/input-objects#teamorder" - } - }, - { - "name": "userLogins", - "description": "

User logins to filter by.

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "combinedSlug", - "description": "

The slug corresponding to the organization and team.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "description", - "description": "

The description of the team.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "discussion", - "description": "

Find a team discussion by its number.

", - "type": "TeamDiscussion", - "id": "teamdiscussion", - "href": "/graphql/reference/objects#teamdiscussion", - "arguments": [ - { - "name": "number", - "description": "

The sequence number of the discussion to find.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "discussions", - "description": "

A list of team discussions.

", - "type": "TeamDiscussionConnection!", - "id": "teamdiscussionconnection", - "href": "/graphql/reference/objects#teamdiscussionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "isPinned", - "description": "

If provided, filters discussions according to whether or not they are pinned.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Order for connection.

", - "type": { - "name": "TeamDiscussionOrder", - "id": "teamdiscussionorder", - "href": "/graphql/reference/input-objects#teamdiscussionorder" - } - } - ] - }, - { - "name": "discussionsResourcePath", - "description": "

The HTTP path for team discussions.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "discussionsUrl", - "description": "

The HTTP URL for team discussions.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "editTeamResourcePath", - "description": "

The HTTP path for editing this team.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "editTeamUrl", - "description": "

The HTTP URL for editing this team.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "id", - "description": "

The Node ID of the Team object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "invitations", - "description": "

A list of pending invitations for users to this team.

", - "type": "OrganizationInvitationConnection", - "id": "organizationinvitationconnection", - "href": "/graphql/reference/objects#organizationinvitationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "memberStatuses", - "description": "

Get the status messages members of this entity have set that are either public or visible only to the organization.

", - "type": "UserStatusConnection!", - "id": "userstatusconnection", - "href": "/graphql/reference/objects#userstatusconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for user statuses returned from the connection.

", - "type": { - "name": "UserStatusOrder", - "id": "userstatusorder", - "href": "/graphql/reference/input-objects#userstatusorder" - } - } - ] - }, - { - "name": "members", - "description": "

A list of users who are members of this team.

", - "type": "TeamMemberConnection!", - "id": "teammemberconnection", - "href": "/graphql/reference/objects#teammemberconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "membership", - "defaultValue": "ALL", - "description": "

Filter by membership type.

", - "type": { - "name": "TeamMembershipType", - "id": "teammembershiptype", - "href": "/graphql/reference/enums#teammembershiptype" - } - }, - { - "name": "orderBy", - "description": "

Order for the connection.

", - "type": { - "name": "TeamMemberOrder", - "id": "teammemberorder", - "href": "/graphql/reference/input-objects#teammemberorder" - } - }, - { - "name": "query", - "description": "

The search string to look for.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "role", - "description": "

Filter by team member role.

", - "type": { - "name": "TeamMemberRole", - "id": "teammemberrole", - "href": "/graphql/reference/enums#teammemberrole" - } - } - ] - }, - { - "name": "membersResourcePath", - "description": "

The HTTP path for the team' members.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "membersUrl", - "description": "

The HTTP URL for the team' members.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "name", - "description": "

The name of the team.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "newTeamResourcePath", - "description": "

The HTTP path creating a new team.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "newTeamUrl", - "description": "

The HTTP URL creating a new team.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "notificationSetting", - "description": "

The notification setting that the team has set.

", - "type": "TeamNotificationSetting!", - "id": "teamnotificationsetting", - "href": "/graphql/reference/enums#teamnotificationsetting" - }, - { - "name": "organization", - "description": "

The organization that owns this team.

", - "type": "Organization!", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "parentTeam", - "description": "

The parent team of the team.

", - "type": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - }, - { - "name": "privacy", - "description": "

The level of privacy the team has.

", - "type": "TeamPrivacy!", - "id": "teamprivacy", - "href": "/graphql/reference/enums#teamprivacy" - }, - { - "name": "repositories", - "description": "

A list of repositories this team has access to.

", - "type": "TeamRepositoryConnection!", - "id": "teamrepositoryconnection", - "href": "/graphql/reference/objects#teamrepositoryconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Order for the connection.

", - "type": { - "name": "TeamRepositoryOrder", - "id": "teamrepositoryorder", - "href": "/graphql/reference/input-objects#teamrepositoryorder" - } - }, - { - "name": "query", - "description": "

The search string to look for. Repositories will be returned where the name contains your search string.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "repositoriesResourcePath", - "description": "

The HTTP path for this team's repositories.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoriesUrl", - "description": "

The HTTP URL for this team's repositories.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this team.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "reviewRequestDelegationAlgorithm", - "description": "

What algorithm is used for review assignment for this team.

", - "type": "TeamReviewAssignmentAlgorithm", - "id": "teamreviewassignmentalgorithm", - "href": "/graphql/reference/enums#teamreviewassignmentalgorithm" - }, - { - "name": "reviewRequestDelegationEnabled", - "description": "

True if review assignment is enabled for this team.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "reviewRequestDelegationMemberCount", - "description": "

How many team members are required for review assignment for this team.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "reviewRequestDelegationNotifyTeam", - "description": "

When assigning team members via delegation, whether the entire team should be notified as well.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "slug", - "description": "

The slug corresponding to the team.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "teamsResourcePath", - "description": "

The HTTP path for this team's teams.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "teamsUrl", - "description": "

The HTTP URL for this team's teams.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this team.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "viewerCanAdminister", - "description": "

Team is adminable by the viewer.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanSubscribe", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerSubscription", - "description": "

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

", - "type": "SubscriptionState", - "id": "subscriptionstate", - "href": "/graphql/reference/enums#subscriptionstate" - } - ] - }, - { - "name": "TeamAddMemberAuditEntry", - "id": "teamaddmemberauditentry", - "href": "/graphql/reference/objects#teamaddmemberauditentry", - "description": "

Audit log entry for a team.add_member event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "TeamAuditEntryData", - "id": "teamauditentrydata", - "href": "/graphql/reference/interfaces#teamauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the TeamAddMemberAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isLdapMapped", - "description": "

Whether the team was mapped to an LDAP Group.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "team", - "description": "

The team associated with the action.

", - "type": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - }, - { - "name": "teamName", - "description": "

The name of the team.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "teamResourcePath", - "description": "

The HTTP path for this team.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "teamUrl", - "description": "

The HTTP URL for this team.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "TeamAddRepositoryAuditEntry", - "id": "teamaddrepositoryauditentry", - "href": "/graphql/reference/objects#teamaddrepositoryauditentry", - "description": "

Audit log entry for a team.add_repository event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - }, - { - "name": "TeamAuditEntryData", - "id": "teamauditentrydata", - "href": "/graphql/reference/interfaces#teamauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the TeamAddRepositoryAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isLdapMapped", - "description": "

Whether the team was mapped to an LDAP Group.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "team", - "description": "

The team associated with the action.

", - "type": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - }, - { - "name": "teamName", - "description": "

The name of the team.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "teamResourcePath", - "description": "

The HTTP path for this team.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "teamUrl", - "description": "

The HTTP URL for this team.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "TeamChangeParentTeamAuditEntry", - "id": "teamchangeparentteamauditentry", - "href": "/graphql/reference/objects#teamchangeparentteamauditentry", - "description": "

Audit log entry for a team.change_parent_team event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "TeamAuditEntryData", - "id": "teamauditentrydata", - "href": "/graphql/reference/interfaces#teamauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the TeamChangeParentTeamAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isLdapMapped", - "description": "

Whether the team was mapped to an LDAP Group.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "parentTeam", - "description": "

The new parent team.

", - "type": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - }, - { - "name": "parentTeamName", - "description": "

The name of the new parent team.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "parentTeamNameWas", - "description": "

The name of the former parent team.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "parentTeamResourcePath", - "description": "

The HTTP path for the parent team.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "parentTeamUrl", - "description": "

The HTTP URL for the parent team.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "parentTeamWas", - "description": "

The former parent team.

", - "type": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - }, - { - "name": "parentTeamWasResourcePath", - "description": "

The HTTP path for the previous parent team.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "parentTeamWasUrl", - "description": "

The HTTP URL for the previous parent team.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "team", - "description": "

The team associated with the action.

", - "type": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - }, - { - "name": "teamName", - "description": "

The name of the team.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "teamResourcePath", - "description": "

The HTTP path for this team.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "teamUrl", - "description": "

The HTTP URL for this team.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "TeamConnection", - "id": "teamconnection", - "href": "/graphql/reference/objects#teamconnection", - "description": "

The connection type for Team.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[TeamEdge]", - "id": "teamedge", - "href": "/graphql/reference/objects#teamedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Team]", - "id": "team", - "href": "/graphql/reference/objects#team" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "TeamDiscussion", - "id": "teamdiscussion", - "href": "/graphql/reference/objects#teamdiscussion", - "description": "

A team discussion.

", - "implements": [ - { - "name": "Comment", - "id": "comment", - "href": "/graphql/reference/interfaces#comment" - }, - { - "name": "Deletable", - "id": "deletable", - "href": "/graphql/reference/interfaces#deletable" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "Reactable", - "id": "reactable", - "href": "/graphql/reference/interfaces#reactable" - }, - { - "name": "Subscribable", - "id": "subscribable", - "href": "/graphql/reference/interfaces#subscribable" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - }, - { - "name": "Updatable", - "id": "updatable", - "href": "/graphql/reference/interfaces#updatable" - }, - { - "name": "UpdatableComment", - "id": "updatablecomment", - "href": "/graphql/reference/interfaces#updatablecomment" - } - ], - "fields": [ - { - "name": "author", - "description": "

The actor who authored the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "authorAssociation", - "description": "

Author's association with the discussion's team.

", - "type": "CommentAuthorAssociation!", - "id": "commentauthorassociation", - "href": "/graphql/reference/enums#commentauthorassociation", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "body", - "description": "

The body as Markdown.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyHTML", - "description": "

The body rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "bodyText", - "description": "

The body rendered to text.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyVersion", - "description": "

Identifies the discussion body hash.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "comments", - "description": "

A list of comments on this discussion.

", - "type": "TeamDiscussionCommentConnection!", - "id": "teamdiscussioncommentconnection", - "href": "/graphql/reference/objects#teamdiscussioncommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "fromComment", - "description": "

When provided, filters the connection such that results begin with the comment with this number.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Order for connection.

", - "type": { - "name": "TeamDiscussionCommentOrder", - "id": "teamdiscussioncommentorder", - "href": "/graphql/reference/input-objects#teamdiscussioncommentorder" - } - } - ], - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "commentsResourcePath", - "description": "

The HTTP path for discussion comments.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "commentsUrl", - "description": "

The HTTP URL for discussion comments.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "createdViaEmail", - "description": "

Check if this comment was created via an email reply.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "editor", - "description": "

The actor who edited the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "id", - "description": "

The Node ID of the TeamDiscussion object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "includesCreatedEdit", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isPinned", - "description": "

Whether or not the discussion is pinned.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "isPrivate", - "description": "

Whether or not the discussion is only visible to team members and organization owners.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "lastEditedAt", - "description": "

The moment the editor made the last edit.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "number", - "description": "

Identifies the discussion within its team.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "publishedAt", - "description": "

Identifies when the comment was published at.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "reactionGroups", - "description": "

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

", - "type": "[ReactionGroup!]", - "id": "reactiongroup", - "href": "/graphql/reference/objects#reactiongroup" - }, - { - "name": "reactions", - "description": "

A list of Reactions left on the Issue.

", - "type": "ReactionConnection!", - "id": "reactionconnection", - "href": "/graphql/reference/objects#reactionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "content", - "description": "

Allows filtering Reactions by emoji.

", - "type": { - "name": "ReactionContent", - "id": "reactioncontent", - "href": "/graphql/reference/enums#reactioncontent" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Allows specifying the order in which reactions are returned.

", - "type": { - "name": "ReactionOrder", - "id": "reactionorder", - "href": "/graphql/reference/input-objects#reactionorder" - } - } - ] - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this discussion.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "team", - "description": "

The team that defines the context of this discussion.

", - "type": "Team!", - "id": "team", - "href": "/graphql/reference/objects#team", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "title", - "description": "

The title of the discussion.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this discussion.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "userContentEdits", - "description": "

A list of edits to this content.

", - "type": "UserContentEditConnection", - "id": "usercontenteditconnection", - "href": "/graphql/reference/objects#usercontenteditconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "viewerCanDelete", - "description": "

Check if the current viewer can delete this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanPin", - "description": "

Whether or not the current viewer can pin this discussion.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "viewerCanReact", - "description": "

Can user react to this subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanSubscribe", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUpdate", - "description": "

Check if the current viewer can update this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCannotUpdateReasons", - "description": "

Reasons why the current viewer can not update this comment.

", - "type": "[CommentCannotUpdateReason!]!", - "id": "commentcannotupdatereason", - "href": "/graphql/reference/enums#commentcannotupdatereason" - }, - { - "name": "viewerDidAuthor", - "description": "

Did the viewer author this comment.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerSubscription", - "description": "

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

", - "type": "SubscriptionState", - "id": "subscriptionstate", - "href": "/graphql/reference/enums#subscriptionstate" - } - ] - }, - { - "name": "TeamDiscussionComment", - "id": "teamdiscussioncomment", - "href": "/graphql/reference/objects#teamdiscussioncomment", - "description": "

A comment on a team discussion.

", - "implements": [ - { - "name": "Comment", - "id": "comment", - "href": "/graphql/reference/interfaces#comment" - }, - { - "name": "Deletable", - "id": "deletable", - "href": "/graphql/reference/interfaces#deletable" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "Reactable", - "id": "reactable", - "href": "/graphql/reference/interfaces#reactable" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - }, - { - "name": "Updatable", - "id": "updatable", - "href": "/graphql/reference/interfaces#updatable" - }, - { - "name": "UpdatableComment", - "id": "updatablecomment", - "href": "/graphql/reference/interfaces#updatablecomment" - } - ], - "fields": [ - { - "name": "author", - "description": "

The actor who authored the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "authorAssociation", - "description": "

Author's association with the comment's team.

", - "type": "CommentAuthorAssociation!", - "id": "commentauthorassociation", - "href": "/graphql/reference/enums#commentauthorassociation", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "body", - "description": "

The body as Markdown.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyHTML", - "description": "

The body rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "bodyText", - "description": "

The body rendered to text.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyVersion", - "description": "

The current version of the body content.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "createdViaEmail", - "description": "

Check if this comment was created via an email reply.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "discussion", - "description": "

The discussion this comment is about.

", - "type": "TeamDiscussion!", - "id": "teamdiscussion", - "href": "/graphql/reference/objects#teamdiscussion", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "editor", - "description": "

The actor who edited the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "id", - "description": "

The Node ID of the TeamDiscussionComment object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "includesCreatedEdit", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "lastEditedAt", - "description": "

The moment the editor made the last edit.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "number", - "description": "

Identifies the comment number.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "publishedAt", - "description": "

Identifies when the comment was published at.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "reactionGroups", - "description": "

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

", - "type": "[ReactionGroup!]", - "id": "reactiongroup", - "href": "/graphql/reference/objects#reactiongroup" - }, - { - "name": "reactions", - "description": "

A list of Reactions left on the Issue.

", - "type": "ReactionConnection!", - "id": "reactionconnection", - "href": "/graphql/reference/objects#reactionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "content", - "description": "

Allows filtering Reactions by emoji.

", - "type": { - "name": "ReactionContent", - "id": "reactioncontent", - "href": "/graphql/reference/enums#reactioncontent" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Allows specifying the order in which reactions are returned.

", - "type": { - "name": "ReactionOrder", - "id": "reactionorder", - "href": "/graphql/reference/input-objects#reactionorder" - } - } - ] - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this comment.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this comment.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "isDeprecated": true, - "deprecationReason": "

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

" - }, - { - "name": "userContentEdits", - "description": "

A list of edits to this content.

", - "type": "UserContentEditConnection", - "id": "usercontenteditconnection", - "href": "/graphql/reference/objects#usercontenteditconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "viewerCanDelete", - "description": "

Check if the current viewer can delete this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanReact", - "description": "

Can user react to this subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanUpdate", - "description": "

Check if the current viewer can update this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCannotUpdateReasons", - "description": "

Reasons why the current viewer can not update this comment.

", - "type": "[CommentCannotUpdateReason!]!", - "id": "commentcannotupdatereason", - "href": "/graphql/reference/enums#commentcannotupdatereason" - }, - { - "name": "viewerDidAuthor", - "description": "

Did the viewer author this comment.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "TeamDiscussionCommentConnection", - "id": "teamdiscussioncommentconnection", - "href": "/graphql/reference/objects#teamdiscussioncommentconnection", - "description": "

The connection type for TeamDiscussionComment.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[TeamDiscussionCommentEdge]", - "id": "teamdiscussioncommentedge", - "href": "/graphql/reference/objects#teamdiscussioncommentedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[TeamDiscussionComment]", - "id": "teamdiscussioncomment", - "href": "/graphql/reference/objects#teamdiscussioncomment" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "TeamDiscussionCommentEdge", - "id": "teamdiscussioncommentedge", - "href": "/graphql/reference/objects#teamdiscussioncommentedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "TeamDiscussionComment", - "id": "teamdiscussioncomment", - "href": "/graphql/reference/objects#teamdiscussioncomment" - } - ] - }, - { - "name": "TeamDiscussionConnection", - "id": "teamdiscussionconnection", - "href": "/graphql/reference/objects#teamdiscussionconnection", - "description": "

The connection type for TeamDiscussion.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[TeamDiscussionEdge]", - "id": "teamdiscussionedge", - "href": "/graphql/reference/objects#teamdiscussionedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[TeamDiscussion]", - "id": "teamdiscussion", - "href": "/graphql/reference/objects#teamdiscussion" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "TeamDiscussionEdge", - "id": "teamdiscussionedge", - "href": "/graphql/reference/objects#teamdiscussionedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "TeamDiscussion", - "id": "teamdiscussion", - "href": "/graphql/reference/objects#teamdiscussion" - } - ] - }, - { - "name": "TeamEdge", - "id": "teamedge", - "href": "/graphql/reference/objects#teamedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - } - ] - }, - { - "name": "TeamMemberConnection", - "id": "teammemberconnection", - "href": "/graphql/reference/objects#teammemberconnection", - "description": "

The connection type for User.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[TeamMemberEdge]", - "id": "teammemberedge", - "href": "/graphql/reference/objects#teammemberedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[User]", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "TeamMemberEdge", - "id": "teammemberedge", - "href": "/graphql/reference/objects#teammemberedge", - "description": "

Represents a user who is a member of a team.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "memberAccessResourcePath", - "description": "

The HTTP path to the organization's member access page.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "memberAccessUrl", - "description": "

The HTTP URL to the organization's member access page.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "node", - "description": "", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "role", - "description": "

The role the member has on the team.

", - "type": "TeamMemberRole!", - "id": "teammemberrole", - "href": "/graphql/reference/enums#teammemberrole" - } - ] - }, - { - "name": "TeamRemoveMemberAuditEntry", - "id": "teamremovememberauditentry", - "href": "/graphql/reference/objects#teamremovememberauditentry", - "description": "

Audit log entry for a team.remove_member event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "TeamAuditEntryData", - "id": "teamauditentrydata", - "href": "/graphql/reference/interfaces#teamauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the TeamRemoveMemberAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isLdapMapped", - "description": "

Whether the team was mapped to an LDAP Group.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "team", - "description": "

The team associated with the action.

", - "type": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - }, - { - "name": "teamName", - "description": "

The name of the team.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "teamResourcePath", - "description": "

The HTTP path for this team.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "teamUrl", - "description": "

The HTTP URL for this team.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "TeamRemoveRepositoryAuditEntry", - "id": "teamremoverepositoryauditentry", - "href": "/graphql/reference/objects#teamremoverepositoryauditentry", - "description": "

Audit log entry for a team.remove_repository event.

", - "implements": [ - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata" - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata" - }, - { - "name": "TeamAuditEntryData", - "id": "teamauditentrydata", - "href": "/graphql/reference/interfaces#teamauditentrydata" - } - ], - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "id", - "description": "

The Node ID of the TeamRemoveRepositoryAuditEntry object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isLdapMapped", - "description": "

Whether the team was mapped to an LDAP Group.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "team", - "description": "

The team associated with the action.

", - "type": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - }, - { - "name": "teamName", - "description": "

The name of the team.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "teamResourcePath", - "description": "

The HTTP path for this team.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "teamUrl", - "description": "

The HTTP URL for this team.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "TeamRepositoryConnection", - "id": "teamrepositoryconnection", - "href": "/graphql/reference/objects#teamrepositoryconnection", - "description": "

The connection type for Repository.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[TeamRepositoryEdge]", - "id": "teamrepositoryedge", - "href": "/graphql/reference/objects#teamrepositoryedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[Repository]", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "TeamRepositoryEdge", - "id": "teamrepositoryedge", - "href": "/graphql/reference/objects#teamrepositoryedge", - "description": "

Represents a team repository.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "permission", - "description": "

The permission level the team has on the repository.

", - "type": "RepositoryPermission!", - "id": "repositorypermission", - "href": "/graphql/reference/enums#repositorypermission" - } - ] - }, - { - "name": "TextMatch", - "id": "textmatch", - "href": "/graphql/reference/objects#textmatch", - "description": "

A text match within a search result.

", - "fields": [ - { - "name": "fragment", - "description": "

The specific text fragment within the property matched on.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "highlights", - "description": "

Highlights within the matched fragment.

", - "type": "[TextMatchHighlight!]!", - "id": "textmatchhighlight", - "href": "/graphql/reference/objects#textmatchhighlight" - }, - { - "name": "property", - "description": "

The property matched on.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "TextMatchHighlight", - "id": "textmatchhighlight", - "href": "/graphql/reference/objects#textmatchhighlight", - "description": "

Represents a single highlight in a search result match.

", - "fields": [ - { - "name": "beginIndice", - "description": "

The indice in the fragment where the matched text begins.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "endIndice", - "description": "

The indice in the fragment where the matched text ends.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "text", - "description": "

The text matched.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "Topic", - "id": "topic", - "href": "/graphql/reference/objects#topic", - "description": "

A topic aggregates entities that are related to a subject.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "Starrable", - "id": "starrable", - "href": "/graphql/reference/interfaces#starrable" - } - ], - "fields": [ - { - "name": "id", - "description": "

The Node ID of the Topic object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "name", - "description": "

The topic's name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "relatedTopics", - "description": "

A list of related topics, including aliases of this topic, sorted with the most relevant\nfirst. Returns up to 10 Topics.

", - "type": "[Topic!]!", - "id": "topic", - "href": "/graphql/reference/objects#topic", - "arguments": [ - { - "name": "first", - "defaultValue": "3", - "description": "

How many topics to return.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "repositories", - "description": "

A list of repositories.

", - "type": "RepositoryConnection!", - "id": "repositoryconnection", - "href": "/graphql/reference/objects#repositoryconnection", - "arguments": [ - { - "name": "affiliations", - "description": "

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

", - "type": { - "name": "[RepositoryAffiliation]", - "id": "repositoryaffiliation", - "href": "/graphql/reference/enums#repositoryaffiliation" - } - }, - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "hasIssuesEnabled", - "description": "

If non-null, filters repositories according to whether they have issues enabled.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "isLocked", - "description": "

If non-null, filters repositories according to whether they have been locked.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for repositories returned from the connection.

", - "type": { - "name": "RepositoryOrder", - "id": "repositoryorder", - "href": "/graphql/reference/input-objects#repositoryorder" - } - }, - { - "name": "ownerAffiliations", - "description": "

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.

", - "type": { - "name": "[RepositoryAffiliation]", - "id": "repositoryaffiliation", - "href": "/graphql/reference/enums#repositoryaffiliation" - } - }, - { - "name": "privacy", - "description": "

If non-null, filters repositories according to privacy. Internal\nrepositories are considered private; consider using the visibility argument\nif only internal repositories are needed. Cannot be combined with the\nvisibility argument.

", - "type": { - "name": "RepositoryPrivacy", - "id": "repositoryprivacy", - "href": "/graphql/reference/enums#repositoryprivacy" - } - }, - { - "name": "visibility", - "description": "

If non-null, filters repositories according to visibility. Cannot be combined with the privacy argument.

", - "type": { - "name": "RepositoryVisibility", - "id": "repositoryvisibility", - "href": "/graphql/reference/enums#repositoryvisibility" - } - } - ] - }, - { - "name": "stargazerCount", - "description": "

Returns a count of how many stargazers there are on this object.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "stargazers", - "description": "

A list of users who have starred this starrable.

", - "type": "StargazerConnection!", - "id": "stargazerconnection", - "href": "/graphql/reference/objects#stargazerconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Order for connection.

", - "type": { - "name": "StarOrder", - "id": "starorder", - "href": "/graphql/reference/input-objects#starorder" - } - } - ] - }, - { - "name": "viewerHasStarred", - "description": "

Returns a boolean indicating whether the viewing user has starred this starrable.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "TransferredEvent", - "id": "transferredevent", - "href": "/graphql/reference/objects#transferredevent", - "description": "

Represents atransferredevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "fromRepository", - "description": "

The repository this came from.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "id", - "description": "

The Node ID of the TransferredEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "issue", - "description": "

Identifies the issue associated with the event.

", - "type": "Issue!", - "id": "issue", - "href": "/graphql/reference/objects#issue" - } - ] - }, - { - "name": "Tree", - "id": "tree", - "href": "/graphql/reference/objects#tree", - "description": "

Represents a Git tree.

", - "implements": [ - { - "name": "GitObject", - "id": "gitobject", - "href": "/graphql/reference/interfaces#gitobject" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "abbreviatedOid", - "description": "

An abbreviated version of the Git object ID.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "commitResourcePath", - "description": "

The HTTP path for this Git object.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "commitUrl", - "description": "

The HTTP URL for this Git object.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "entries", - "description": "

A list of tree entries.

", - "type": "[TreeEntry!]", - "id": "treeentry", - "href": "/graphql/reference/objects#treeentry" - }, - { - "name": "id", - "description": "

The Node ID of the Tree object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "oid", - "description": "

The Git object ID.

", - "type": "GitObjectID!", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "repository", - "description": "

The Repository the Git object belongs to.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "TreeEntry", - "id": "treeentry", - "href": "/graphql/reference/objects#treeentry", - "description": "

Represents a Git tree entry.

", - "fields": [ - { - "name": "extension", - "description": "

The extension of the file.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "isGenerated", - "description": "

Whether or not this tree entry is generated.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "language", - "description": "

The programming language this file is written in.

", - "type": "Language", - "id": "language", - "href": "/graphql/reference/objects#language" - }, - { - "name": "lineCount", - "description": "

Number of lines in the file.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "mode", - "description": "

Entry file mode.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "name", - "description": "

Entry file name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "nameRaw", - "description": "

Entry file name. (Base64-encoded).

", - "type": "Base64String!", - "id": "base64string", - "href": "/graphql/reference/scalars#base64string" - }, - { - "name": "object", - "description": "

Entry file object.

", - "type": "GitObject", - "id": "gitobject", - "href": "/graphql/reference/interfaces#gitobject" - }, - { - "name": "oid", - "description": "

Entry file Git object ID.

", - "type": "GitObjectID!", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "path", - "description": "

The full path of the file.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pathRaw", - "description": "

The full path of the file. (Base64-encoded).

", - "type": "Base64String", - "id": "base64string", - "href": "/graphql/reference/scalars#base64string" - }, - { - "name": "repository", - "description": "

The Repository the tree entry belongs to.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "size", - "description": "

Entry byte size.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "submodule", - "description": "

If the TreeEntry is for a directory occupied by a submodule project, this returns the corresponding submodule.

", - "type": "Submodule", - "id": "submodule", - "href": "/graphql/reference/objects#submodule" - }, - { - "name": "type", - "description": "

Entry file type.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "UnassignedEvent", - "id": "unassignedevent", - "href": "/graphql/reference/objects#unassignedevent", - "description": "

Represents anunassignedevent on any assignable object.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "assignable", - "description": "

Identifies the assignable associated with the event.

", - "type": "Assignable!", - "id": "assignable", - "href": "/graphql/reference/interfaces#assignable" - }, - { - "name": "assignee", - "description": "

Identifies the user or mannequin that was unassigned.

", - "type": "Assignee", - "id": "assignee", - "href": "/graphql/reference/unions#assignee" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the UnassignedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "user", - "description": "

Identifies the subject (user) who was unassigned.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user", - "isDeprecated": true, - "deprecationReason": "

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

" - } - ] - }, - { - "name": "UnknownSignature", - "id": "unknownsignature", - "href": "/graphql/reference/objects#unknownsignature", - "description": "

Represents an unknown signature on a Commit or Tag.

", - "implements": [ - { - "name": "GitSignature", - "id": "gitsignature", - "href": "/graphql/reference/interfaces#gitsignature" - } - ], - "fields": [ - { - "name": "email", - "description": "

Email used to sign this object.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "isValid", - "description": "

True if the signature is valid and verified by GitHub.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "payload", - "description": "

Payload for GPG signing object. Raw ODB object without the signature header.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "signature", - "description": "

ASCII-armored signature header from object.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "signer", - "description": "

GitHub user corresponding to the email signing this commit.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "state", - "description": "

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

", - "type": "GitSignatureState!", - "id": "gitsignaturestate", - "href": "/graphql/reference/enums#gitsignaturestate" - }, - { - "name": "wasSignedByGitHub", - "description": "

True if the signature was made with GitHub's signing key.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "UnlabeledEvent", - "id": "unlabeledevent", - "href": "/graphql/reference/objects#unlabeledevent", - "description": "

Represents anunlabeledevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the UnlabeledEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "label", - "description": "

Identifies the label associated with theunlabeledevent.

", - "type": "Label!", - "id": "label", - "href": "/graphql/reference/objects#label" - }, - { - "name": "labelable", - "description": "

Identifies the Labelable associated with the event.

", - "type": "Labelable!", - "id": "labelable", - "href": "/graphql/reference/interfaces#labelable" - } - ] - }, - { - "name": "UnlockedEvent", - "id": "unlockedevent", - "href": "/graphql/reference/objects#unlockedevent", - "description": "

Represents anunlockedevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the UnlockedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "lockable", - "description": "

Object that was unlocked.

", - "type": "Lockable!", - "id": "lockable", - "href": "/graphql/reference/interfaces#lockable" - } - ] - }, - { - "name": "UnmarkedAsDuplicateEvent", - "id": "unmarkedasduplicateevent", - "href": "/graphql/reference/objects#unmarkedasduplicateevent", - "description": "

Represents anunmarked_as_duplicateevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "canonical", - "description": "

The authoritative issue or pull request which has been duplicated by another.

", - "type": "IssueOrPullRequest", - "id": "issueorpullrequest", - "href": "/graphql/reference/unions#issueorpullrequest" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "duplicate", - "description": "

The issue or pull request which has been marked as a duplicate of another.

", - "type": "IssueOrPullRequest", - "id": "issueorpullrequest", - "href": "/graphql/reference/unions#issueorpullrequest" - }, - { - "name": "id", - "description": "

The Node ID of the UnmarkedAsDuplicateEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isCrossRepository", - "description": "

Canonical and duplicate belong to different repositories.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "UnpinnedEvent", - "id": "unpinnedevent", - "href": "/graphql/reference/objects#unpinnedevent", - "description": "

Represents anunpinnedevent on a given issue or pull request.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the UnpinnedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "issue", - "description": "

Identifies the issue associated with the event.

", - "type": "Issue!", - "id": "issue", - "href": "/graphql/reference/objects#issue" - } - ] - }, - { - "name": "UnsubscribedEvent", - "id": "unsubscribedevent", - "href": "/graphql/reference/objects#unsubscribedevent", - "description": "

Represents anunsubscribedevent on a given Subscribable.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the UnsubscribedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "subscribable", - "description": "

Object referenced by event.

", - "type": "Subscribable!", - "id": "subscribable", - "href": "/graphql/reference/interfaces#subscribable" - } - ] - }, - { - "name": "UpdateParameters", - "id": "updateparameters", - "href": "/graphql/reference/objects#updateparameters", - "description": "

Only allow users with bypass permission to update matching refs.

", - "fields": [ - { - "name": "updateAllowsFetchAndMerge", - "description": "

Branch can pull changes from its upstream repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "User", - "id": "user", - "href": "/graphql/reference/objects#user", - "description": "

A user is an individual's account on GitHub that owns repositories and can make new content.

", - "implements": [ - { - "name": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "PackageOwner", - "id": "packageowner", - "href": "/graphql/reference/interfaces#packageowner" - }, - { - "name": "ProfileOwner", - "id": "profileowner", - "href": "/graphql/reference/interfaces#profileowner" - }, - { - "name": "ProjectOwner", - "id": "projectowner", - "href": "/graphql/reference/interfaces#projectowner" - }, - { - "name": "ProjectV2Owner", - "id": "projectv2owner", - "href": "/graphql/reference/interfaces#projectv2owner" - }, - { - "name": "ProjectV2Recent", - "id": "projectv2recent", - "href": "/graphql/reference/interfaces#projectv2recent" - }, - { - "name": "RepositoryDiscussionAuthor", - "id": "repositorydiscussionauthor", - "href": "/graphql/reference/interfaces#repositorydiscussionauthor" - }, - { - "name": "RepositoryDiscussionCommentAuthor", - "id": "repositorydiscussioncommentauthor", - "href": "/graphql/reference/interfaces#repositorydiscussioncommentauthor" - }, - { - "name": "RepositoryOwner", - "id": "repositoryowner", - "href": "/graphql/reference/interfaces#repositoryowner" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "anyPinnableItems", - "description": "

Determine if this repository owner has any items that can be pinned to their profile.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "arguments": [ - { - "name": "type", - "description": "

Filter to only a particular kind of pinnable item.

", - "type": { - "name": "PinnableItemType", - "id": "pinnableitemtype", - "href": "/graphql/reference/enums#pinnableitemtype" - } - } - ] - }, - { - "name": "avatarUrl", - "description": "

A URL pointing to the user's public avatar.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "arguments": [ - { - "name": "size", - "description": "

The size of the resulting square image.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "bio", - "description": "

The user's public profile bio.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bioHTML", - "description": "

The user's public profile bio as HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "canReceiveOrganizationEmailsWhenNotificationsRestricted", - "description": "

Could this user receive email notifications, if the organization had notification restrictions enabled?.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "arguments": [ - { - "name": "login", - "description": "

The login of the organization to check.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "commitComments", - "description": "

A list of commit comments made by this user.

", - "type": "CommitCommentConnection!", - "id": "commitcommentconnection", - "href": "/graphql/reference/objects#commitcommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "company", - "description": "

The user's public profile company.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "companyHTML", - "description": "

The user's public profile company as HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "contributionsCollection", - "description": "

The collection of contributions this user has made to different repositories.

", - "type": "ContributionsCollection!", - "id": "contributionscollection", - "href": "/graphql/reference/objects#contributionscollection", - "arguments": [ - { - "name": "from", - "description": "

Only contributions made at this time or later will be counted. If omitted, defaults to a year ago.

", - "type": { - "name": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - }, - { - "name": "organizationID", - "description": "

The ID of the organization used to filter contributions.

", - "type": { - "name": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - }, - { - "name": "to", - "description": "

Only contributions made before and up to (including) this time will be\ncounted. If omitted, defaults to the current time or one year from the\nprovided from argument.

", - "type": { - "name": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - } - ] - }, - { - "name": "copilotEndpoints", - "description": "

The user's Copilot endpoint information.

", - "type": "CopilotEndpoints", - "id": "copilotendpoints", - "href": "/graphql/reference/objects#copilotendpoints" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "email", - "description": "

The user's publicly visible profile email.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterprises", - "description": "

A list of enterprises that the user belongs to.

", - "type": "EnterpriseConnection", - "id": "enterpriseconnection", - "href": "/graphql/reference/objects#enterpriseconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "membershipType", - "defaultValue": "ALL", - "description": "

Filter enterprises returned based on the user's membership type.

", - "type": { - "name": "EnterpriseMembershipType", - "id": "enterprisemembershiptype", - "href": "/graphql/reference/enums#enterprisemembershiptype" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for the User's enterprises.

", - "type": { - "name": "EnterpriseOrder", - "id": "enterpriseorder", - "href": "/graphql/reference/input-objects#enterpriseorder" - } - } - ] - }, - { - "name": "followers", - "description": "

A list of users the given user is followed by.

", - "type": "FollowerConnection!", - "id": "followerconnection", - "href": "/graphql/reference/objects#followerconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "following", - "description": "

A list of users the given user is following.

", - "type": "FollowingConnection!", - "id": "followingconnection", - "href": "/graphql/reference/objects#followingconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "gist", - "description": "

Find gist by repo name.

", - "type": "Gist", - "id": "gist", - "href": "/graphql/reference/objects#gist", - "arguments": [ - { - "name": "name", - "description": "

The gist name to find.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "gistComments", - "description": "

A list of gist comments made by this user.

", - "type": "GistCommentConnection!", - "id": "gistcommentconnection", - "href": "/graphql/reference/objects#gistcommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "gists", - "description": "

A list of the Gists the user has created.

", - "type": "GistConnection!", - "id": "gistconnection", - "href": "/graphql/reference/objects#gistconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for gists returned from the connection.

", - "type": { - "name": "GistOrder", - "id": "gistorder", - "href": "/graphql/reference/input-objects#gistorder" - } - }, - { - "name": "privacy", - "description": "

Filters Gists according to privacy.

", - "type": { - "name": "GistPrivacy", - "id": "gistprivacy", - "href": "/graphql/reference/enums#gistprivacy" - } - } - ] - }, - { - "name": "hovercard", - "description": "

The hovercard information for this user in a given context.

", - "type": "Hovercard!", - "id": "hovercard", - "href": "/graphql/reference/objects#hovercard", - "arguments": [ - { - "name": "primarySubjectId", - "description": "

The ID of the subject to get the hovercard in the context of.

", - "type": { - "name": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - } - ] - }, - { - "name": "id", - "description": "

The Node ID of the User object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isBountyHunter", - "description": "

Whether or not this user is a participant in the GitHub Security Bug Bounty.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isCampusExpert", - "description": "

Whether or not this user is a participant in the GitHub Campus Experts Program.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isDeveloperProgramMember", - "description": "

Whether or not this user is a GitHub Developer Program member.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isEmployee", - "description": "

Whether or not this user is a GitHub employee.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isFollowingViewer", - "description": "

Whether or not this user is following the viewer. Inverse of viewerIsFollowing.

", - "type": "Boolean!", - "id": "boolean", - "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", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isHireable", - "description": "

Whether or not the user has marked themselves as for hire.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isSiteAdmin", - "description": "

Whether or not this user is a site administrator.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isViewer", - "description": "

Whether or not this user is the viewing user.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "issueComments", - "description": "

A list of issue comments made by this user.

", - "type": "IssueCommentConnection!", - "id": "issuecommentconnection", - "href": "/graphql/reference/objects#issuecommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for issue comments returned from the connection.

", - "type": { - "name": "IssueCommentOrder", - "id": "issuecommentorder", - "href": "/graphql/reference/input-objects#issuecommentorder" - } - } - ] - }, - { - "name": "issues", - "description": "

A list of issues associated with this user.

", - "type": "IssueConnection!", - "id": "issueconnection", - "href": "/graphql/reference/objects#issueconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "filterBy", - "description": "

Filtering options for issues returned from the connection.

", - "type": { - "name": "IssueFilters", - "id": "issuefilters", - "href": "/graphql/reference/input-objects#issuefilters" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "labels", - "description": "

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

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for issues returned from the connection.

", - "type": { - "name": "IssueOrder", - "id": "issueorder", - "href": "/graphql/reference/input-objects#issueorder" - } - }, - { - "name": "states", - "description": "

A list of states to filter the issues by.

", - "type": { - "name": "[IssueState!]", - "id": "issuestate", - "href": "/graphql/reference/enums#issuestate" - } - } - ] - }, - { - "name": "itemShowcase", - "description": "

Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

", - "type": "ProfileItemShowcase!", - "id": "profileitemshowcase", - "href": "/graphql/reference/objects#profileitemshowcase" - }, - { - "name": "lists", - "description": "

A user-curated list of repositories.

", - "type": "UserListConnection!", - "id": "userlistconnection", - "href": "/graphql/reference/objects#userlistconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "location", - "description": "

The user's public profile location.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "login", - "description": "

The username used to login.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The user's public profile name.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organization", - "description": "

Find an organization by its login that the user belongs to.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization", - "arguments": [ - { - "name": "login", - "description": "

The login of the organization to find.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "organizationVerifiedDomainEmails", - "description": "

Verified email addresses that match verified domains for a specified organization the user is a member of.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string", - "arguments": [ - { - "name": "login", - "description": "

The login of the organization to match verified domains from.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "organizations", - "description": "

A list of organizations the user belongs to.

", - "type": "OrganizationConnection!", - "id": "organizationconnection", - "href": "/graphql/reference/objects#organizationconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for the User's organizations.

", - "type": { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder" - } - } - ] - }, - { - "name": "packages", - "description": "

A list of packages under the owner.

", - "type": "PackageConnection!", - "id": "packageconnection", - "href": "/graphql/reference/objects#packageconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "names", - "description": "

Find packages by their names.

", - "type": { - "name": "[String]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "orderBy", - "description": "

Ordering of the returned packages.

", - "type": { - "name": "PackageOrder", - "id": "packageorder", - "href": "/graphql/reference/input-objects#packageorder" - } - }, - { - "name": "packageType", - "description": "

Filter registry package by type.

", - "type": { - "name": "PackageType", - "id": "packagetype", - "href": "/graphql/reference/enums#packagetype" - } - }, - { - "name": "repositoryId", - "description": "

Find packages in a repository by ID.

", - "type": { - "name": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - } - ] - }, - { - "name": "pinnableItems", - "description": "

A list of repositories and gists this profile owner can pin to their profile.

", - "type": "PinnableItemConnection!", - "id": "pinnableitemconnection", - "href": "/graphql/reference/objects#pinnableitemconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "types", - "description": "

Filter the types of pinnable items that are returned.

", - "type": { - "name": "[PinnableItemType!]", - "id": "pinnableitemtype", - "href": "/graphql/reference/enums#pinnableitemtype" - } - } - ] - }, - { - "name": "pinnedItems", - "description": "

A list of repositories and gists this profile owner has pinned to their profile.

", - "type": "PinnableItemConnection!", - "id": "pinnableitemconnection", - "href": "/graphql/reference/objects#pinnableitemconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "types", - "description": "

Filter the types of pinned items that are returned.

", - "type": { - "name": "[PinnableItemType!]", - "id": "pinnableitemtype", - "href": "/graphql/reference/enums#pinnableitemtype" - } - } - ] - }, - { - "name": "pinnedItemsRemaining", - "description": "

Returns how many more items this profile owner can pin to their profile.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "project", - "description": "

Find project by number.

", - "type": "Project", - "id": "project", - "href": "/graphql/reference/objects#project", - "arguments": [ - { - "name": "number", - "description": "

The project number to find.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "projectV2", - "description": "

Find a project by number.

", - "type": "ProjectV2", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2", - "arguments": [ - { - "name": "number", - "description": "

The project number.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "projects", - "description": "

A list of projects under the owner.

", - "type": "ProjectConnection!", - "id": "projectconnection", - "href": "/graphql/reference/objects#projectconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for projects returned from the connection.

", - "type": { - "name": "ProjectOrder", - "id": "projectorder", - "href": "/graphql/reference/input-objects#projectorder" - } - }, - { - "name": "search", - "description": "

Query to search projects by, currently only searching by name.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "states", - "description": "

A list of states to filter the projects by.

", - "type": { - "name": "[ProjectState!]", - "id": "projectstate", - "href": "/graphql/reference/enums#projectstate" - } - } - ] - }, - { - "name": "projectsResourcePath", - "description": "

The HTTP path listing user's projects.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "projectsUrl", - "description": "

The HTTP URL listing user's projects.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "projectsV2", - "description": "

A list of projects under the owner.

", - "type": "ProjectV2Connection!", - "id": "projectv2connection", - "href": "/graphql/reference/objects#projectv2connection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

How to order the returned projects.

", - "type": { - "name": "ProjectV2Order", - "id": "projectv2order", - "href": "/graphql/reference/input-objects#projectv2order" - } - }, - { - "name": "query", - "description": "

A project to search for under the the owner.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "pronouns", - "description": "

The user's profile pronouns.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "publicKeys", - "description": "

A list of public keys associated with this user.

", - "type": "PublicKeyConnection!", - "id": "publickeyconnection", - "href": "/graphql/reference/objects#publickeyconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "pullRequests", - "description": "

A list of pull requests associated with this user.

", - "type": "PullRequestConnection!", - "id": "pullrequestconnection", - "href": "/graphql/reference/objects#pullrequestconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "baseRefName", - "description": "

The base ref name to filter the pull requests by.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "headRefName", - "description": "

The head ref name to filter the pull requests by.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "labels", - "description": "

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

", - "type": { - "name": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for pull requests returned from the connection.

", - "type": { - "name": "IssueOrder", - "id": "issueorder", - "href": "/graphql/reference/input-objects#issueorder" - } - }, - { - "name": "states", - "description": "

A list of states to filter the pull requests by.

", - "type": { - "name": "[PullRequestState!]", - "id": "pullrequeststate", - "href": "/graphql/reference/enums#pullrequeststate" - } - } - ] - }, - { - "name": "recentProjects", - "description": "

Recent projects that this user has modified in the context of the owner.

", - "type": "ProjectV2Connection!", - "id": "projectv2connection", - "href": "/graphql/reference/objects#projectv2connection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "repositories", - "description": "

A list of repositories that the user owns.

", - "type": "RepositoryConnection!", - "id": "repositoryconnection", - "href": "/graphql/reference/objects#repositoryconnection", - "arguments": [ - { - "name": "affiliations", - "description": "

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

", - "type": { - "name": "[RepositoryAffiliation]", - "id": "repositoryaffiliation", - "href": "/graphql/reference/enums#repositoryaffiliation" - } - }, - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "hasIssuesEnabled", - "description": "

If non-null, filters repositories according to whether they have issues enabled.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "isArchived", - "description": "

If non-null, filters repositories according to whether they are archived and not maintained.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "isFork", - "description": "

If non-null, filters repositories according to whether they are forks of another repository.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "isLocked", - "description": "

If non-null, filters repositories according to whether they have been locked.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for repositories returned from the connection.

", - "type": { - "name": "RepositoryOrder", - "id": "repositoryorder", - "href": "/graphql/reference/input-objects#repositoryorder" - } - }, - { - "name": "ownerAffiliations", - "description": "

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.

", - "type": { - "name": "[RepositoryAffiliation]", - "id": "repositoryaffiliation", - "href": "/graphql/reference/enums#repositoryaffiliation" - } - }, - { - "name": "privacy", - "description": "

If non-null, filters repositories according to privacy. Internal\nrepositories are considered private; consider using the visibility argument\nif only internal repositories are needed. Cannot be combined with the\nvisibility argument.

", - "type": { - "name": "RepositoryPrivacy", - "id": "repositoryprivacy", - "href": "/graphql/reference/enums#repositoryprivacy" - } - }, - { - "name": "visibility", - "description": "

If non-null, filters repositories according to visibility. Cannot be combined with the privacy argument.

", - "type": { - "name": "RepositoryVisibility", - "id": "repositoryvisibility", - "href": "/graphql/reference/enums#repositoryvisibility" - } - } - ] - }, - { - "name": "repositoriesContributedTo", - "description": "

A list of repositories that the user recently contributed to.

", - "type": "RepositoryConnection!", - "id": "repositoryconnection", - "href": "/graphql/reference/objects#repositoryconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "contributionTypes", - "description": "

If non-null, include only the specified types of contributions. The\nGitHub.com UI uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY].

", - "type": { - "name": "[RepositoryContributionType]", - "id": "repositorycontributiontype", - "href": "/graphql/reference/enums#repositorycontributiontype" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "hasIssues", - "description": "

If non-null, filters repositories according to whether they have issues enabled.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "includeUserRepositories", - "description": "

If true, include user repositories.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "isLocked", - "description": "

If non-null, filters repositories according to whether they have been locked.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for repositories returned from the connection.

", - "type": { - "name": "RepositoryOrder", - "id": "repositoryorder", - "href": "/graphql/reference/input-objects#repositoryorder" - } - }, - { - "name": "privacy", - "description": "

If non-null, filters repositories according to privacy.

", - "type": { - "name": "RepositoryPrivacy", - "id": "repositoryprivacy", - "href": "/graphql/reference/enums#repositoryprivacy" - } - } - ] - }, - { - "name": "repository", - "description": "

Find Repository.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "arguments": [ - { - "name": "followRenames", - "defaultValue": true, - "description": "

Follow repository renames. If disabled, a repository referenced by its old name will return an error.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "name", - "description": "

Name of Repository to find.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "repositoryDiscussionComments", - "description": "

Discussion comments this user has authored.

", - "type": "DiscussionCommentConnection!", - "id": "discussioncommentconnection", - "href": "/graphql/reference/objects#discussioncommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "onlyAnswers", - "defaultValue": false, - "description": "

Filter discussion comments to only those that were marked as the answer.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "repositoryId", - "description": "

Filter discussion comments to only those in a specific repository.

", - "type": { - "name": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - } - ] - }, - { - "name": "repositoryDiscussions", - "description": "

Discussions this user has started.

", - "type": "DiscussionConnection!", - "id": "discussionconnection", - "href": "/graphql/reference/objects#discussionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "answered", - "description": "

Filter discussions to only those that have been answered or not. Defaults to\nincluding both answered and unanswered discussions.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for discussions returned from the connection.

", - "type": { - "name": "DiscussionOrder", - "id": "discussionorder", - "href": "/graphql/reference/input-objects#discussionorder" - } - }, - { - "name": "repositoryId", - "description": "

Filter discussions to only those in a specific repository.

", - "type": { - "name": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - }, - { - "name": "states", - "description": "

A list of states to filter the discussions by.

", - "type": { - "name": "[DiscussionState!]", - "id": "discussionstate", - "href": "/graphql/reference/enums#discussionstate" - } - } - ] - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this user.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "savedReplies", - "description": "

Replies this user has saved.

", - "type": "SavedReplyConnection", - "id": "savedreplyconnection", - "href": "/graphql/reference/objects#savedreplyconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

The field to order saved replies by.

", - "type": { - "name": "SavedReplyOrder", - "id": "savedreplyorder", - "href": "/graphql/reference/input-objects#savedreplyorder" - } - } - ] - }, - { - "name": "socialAccounts", - "description": "

The user's social media accounts, ordered as they appear on the user's profile.

", - "type": "SocialAccountConnection!", - "id": "socialaccountconnection", - "href": "/graphql/reference/objects#socialaccountconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "starredRepositories", - "description": "

Repositories the user has starred.

", - "type": "StarredRepositoryConnection!", - "id": "starredrepositoryconnection", - "href": "/graphql/reference/objects#starredrepositoryconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Order for connection.

", - "type": { - "name": "StarOrder", - "id": "starorder", - "href": "/graphql/reference/input-objects#starorder" - } - }, - { - "name": "ownedByViewer", - "description": "

Filters starred repositories to only return repositories owned by the viewer.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - } - ] - }, - { - "name": "status", - "description": "

The user's description of what they're currently doing.

", - "type": "UserStatus", - "id": "userstatus", - "href": "/graphql/reference/objects#userstatus" - }, - { - "name": "suggestedListNames", - "description": "

Suggested names for user lists.

", - "type": "[UserListSuggestion!]!", - "id": "userlistsuggestion", - "href": "/graphql/reference/objects#userlistsuggestion" - }, - { - "name": "suspendedAt", - "description": "

Identifies the date and time when the user was suspended.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "topRepositories", - "description": "

Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created.

", - "type": "RepositoryConnection!", - "id": "repositoryconnection", - "href": "/graphql/reference/objects#repositoryconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for repositories returned from the connection.

", - "type": { - "name": "RepositoryOrder!", - "id": "repositoryorder", - "href": "/graphql/reference/input-objects#repositoryorder" - } - }, - { - "name": "since", - "description": "

How far back in time to fetch contributed repositories.

", - "type": { - "name": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - } - ] - }, - { - "name": "twitterUsername", - "description": "

The user's Twitter username.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this user.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "viewerCanChangePinnedItems", - "description": "

Can the viewer pin repositories and gists to the profile?.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanCreateProjects", - "description": "

Can the current viewer create new projects on this owner.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanFollow", - "description": "

Whether or not the viewer is able to follow the user.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerIsFollowing", - "description": "

Whether or not this user is followed by the viewer. Inverse of isFollowingViewer.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "watching", - "description": "

A list of repositories the given user is watching.

", - "type": "RepositoryConnection!", - "id": "repositoryconnection", - "href": "/graphql/reference/objects#repositoryconnection", - "arguments": [ - { - "name": "affiliations", - "description": "

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.

", - "type": { - "name": "[RepositoryAffiliation]", - "id": "repositoryaffiliation", - "href": "/graphql/reference/enums#repositoryaffiliation" - } - }, - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "hasIssuesEnabled", - "description": "

If non-null, filters repositories according to whether they have issues enabled.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "isLocked", - "description": "

If non-null, filters repositories according to whether they have been locked.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for repositories returned from the connection.

", - "type": { - "name": "RepositoryOrder", - "id": "repositoryorder", - "href": "/graphql/reference/input-objects#repositoryorder" - } - }, - { - "name": "ownerAffiliations", - "description": "

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.

", - "type": { - "name": "[RepositoryAffiliation]", - "id": "repositoryaffiliation", - "href": "/graphql/reference/enums#repositoryaffiliation" - } - }, - { - "name": "privacy", - "description": "

If non-null, filters repositories according to privacy. Internal\nrepositories are considered private; consider using the visibility argument\nif only internal repositories are needed. Cannot be combined with the\nvisibility argument.

", - "type": { - "name": "RepositoryPrivacy", - "id": "repositoryprivacy", - "href": "/graphql/reference/enums#repositoryprivacy" - } - }, - { - "name": "visibility", - "description": "

If non-null, filters repositories according to visibility. Cannot be combined with the privacy argument.

", - "type": { - "name": "RepositoryVisibility", - "id": "repositoryvisibility", - "href": "/graphql/reference/enums#repositoryvisibility" - } - } - ] - }, - { - "name": "websiteUrl", - "description": "

A URL pointing to the user's public website/blog.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "UserBlockedEvent", - "id": "userblockedevent", - "href": "/graphql/reference/objects#userblockedevent", - "description": "

Represents auser_blockedevent on a given user.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "actor", - "description": "

Identifies the actor who performed the event.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "blockDuration", - "description": "

Number of days that the user was blocked for.

", - "type": "UserBlockDuration!", - "id": "userblockduration", - "href": "/graphql/reference/enums#userblockduration" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the UserBlockedEvent object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "subject", - "description": "

The user who was blocked.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "UserConnection", - "id": "userconnection", - "href": "/graphql/reference/objects#userconnection", - "description": "

A list of users.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[UserEdge]", - "id": "useredge", - "href": "/graphql/reference/objects#useredge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[User]", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "UserContentEdit", - "id": "usercontentedit", - "href": "/graphql/reference/objects#usercontentedit", - "description": "

An edit on user content.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "deletedAt", - "description": "

Identifies the date and time when the object was deleted.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "deletedBy", - "description": "

The actor who deleted this content.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "diff", - "description": "

A summary of the changes for this edit.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "editedAt", - "description": "

When this content was edited.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "editor", - "description": "

The actor who edited this content.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "id", - "description": "

The Node ID of the UserContentEdit object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "UserContentEditConnection", - "id": "usercontenteditconnection", - "href": "/graphql/reference/objects#usercontenteditconnection", - "description": "

A list of edits to content.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[UserContentEditEdge]", - "id": "usercontenteditedge", - "href": "/graphql/reference/objects#usercontenteditedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[UserContentEdit]", - "id": "usercontentedit", - "href": "/graphql/reference/objects#usercontentedit" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "UserContentEditEdge", - "id": "usercontenteditedge", - "href": "/graphql/reference/objects#usercontenteditedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "UserContentEdit", - "id": "usercontentedit", - "href": "/graphql/reference/objects#usercontentedit" - } - ] - }, - { - "name": "UserEdge", - "id": "useredge", - "href": "/graphql/reference/objects#useredge", - "description": "

Represents a user.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "UserEmailMetadata", - "id": "useremailmetadata", - "href": "/graphql/reference/objects#useremailmetadata", - "description": "

Email attributes from External Identity.

", - "fields": [ - { - "name": "primary", - "description": "

Boolean to identify primary emails.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "type", - "description": "

Type of email.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "value", - "description": "

Email id.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "UserList", - "id": "userlist", - "href": "/graphql/reference/objects#userlist", - "description": "

A user-curated list of repositories.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "description", - "description": "

The description of this list.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the UserList object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isPrivate", - "description": "

Whether or not this list is private.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "items", - "description": "

The items associated with this list.

", - "type": "UserListItemsConnection!", - "id": "userlistitemsconnection", - "href": "/graphql/reference/objects#userlistitemsconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "lastAddedAt", - "description": "

The date and time at which this list was created or last had items added to it.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "name", - "description": "

The name of this list.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "slug", - "description": "

The slug of this list.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "user", - "description": "

The user to which this list belongs.

", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "UserListConnection", - "id": "userlistconnection", - "href": "/graphql/reference/objects#userlistconnection", - "description": "

The connection type for UserList.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[UserListEdge]", - "id": "userlistedge", - "href": "/graphql/reference/objects#userlistedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[UserList]", - "id": "userlist", - "href": "/graphql/reference/objects#userlist" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "UserListEdge", - "id": "userlistedge", - "href": "/graphql/reference/objects#userlistedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "UserList", - "id": "userlist", - "href": "/graphql/reference/objects#userlist" - } - ] - }, - { - "name": "UserListItemsConnection", - "id": "userlistitemsconnection", - "href": "/graphql/reference/objects#userlistitemsconnection", - "description": "

The connection type for UserListItems.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[UserListItemsEdge]", - "id": "userlistitemsedge", - "href": "/graphql/reference/objects#userlistitemsedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[UserListItems]", - "id": "userlistitems", - "href": "/graphql/reference/unions#userlistitems" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "UserListItemsEdge", - "id": "userlistitemsedge", - "href": "/graphql/reference/objects#userlistitemsedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "UserListItems", - "id": "userlistitems", - "href": "/graphql/reference/unions#userlistitems" - } - ] - }, - { - "name": "UserListSuggestion", - "id": "userlistsuggestion", - "href": "/graphql/reference/objects#userlistsuggestion", - "description": "

Represents a suggested user list.

", - "fields": [ - { - "name": "id", - "description": "

The ID of the suggested user list.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "name", - "description": "

The name of the suggested user list.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "UserStatus", - "id": "userstatus", - "href": "/graphql/reference/objects#userstatus", - "description": "

The user's description of what they're currently doing.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "emoji", - "description": "

An emoji summarizing the user's status.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "emojiHTML", - "description": "

The status emoji as HTML.

", - "type": "HTML", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "expiresAt", - "description": "

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

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "id", - "description": "

The Node ID of the UserStatus object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "indicatesLimitedAvailability", - "description": "

Whether this status indicates the user is not fully available on GitHub.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "message", - "description": "

A brief message describing what the user is doing.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organization", - "description": "

The organization whose members can see this status. If null, this status is publicly visible.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "user", - "description": "

The user who has this status.

", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "UserStatusConnection", - "id": "userstatusconnection", - "href": "/graphql/reference/objects#userstatusconnection", - "description": "

The connection type for UserStatus.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[UserStatusEdge]", - "id": "userstatusedge", - "href": "/graphql/reference/objects#userstatusedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[UserStatus]", - "id": "userstatus", - "href": "/graphql/reference/objects#userstatus" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "UserStatusEdge", - "id": "userstatusedge", - "href": "/graphql/reference/objects#userstatusedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "UserStatus", - "id": "userstatus", - "href": "/graphql/reference/objects#userstatus" - } - ] - }, - { - "name": "VerifiableDomain", - "id": "verifiabledomain", - "href": "/graphql/reference/objects#verifiabledomain", - "description": "

A domain that can be verified or approved for an organization or an enterprise.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "dnsHostName", - "description": "

The DNS host name that should be used for verification.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "domain", - "description": "

The unicode encoded domain.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "hasFoundHostName", - "description": "

Whether a TXT record for verification with the expected host name was found.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "hasFoundVerificationToken", - "description": "

Whether a TXT record for verification with the expected verification token was found.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "id", - "description": "

The Node ID of the VerifiableDomain object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "isApproved", - "description": "

Whether or not the domain is approved.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isRequiredForPolicyEnforcement", - "description": "

Whether this domain is required to exist for an organization or enterprise policy to be enforced.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isVerified", - "description": "

Whether or not the domain is verified.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "owner", - "description": "

The owner of the domain.

", - "type": "VerifiableDomainOwner!", - "id": "verifiabledomainowner", - "href": "/graphql/reference/unions#verifiabledomainowner" - }, - { - "name": "punycodeEncodedDomain", - "description": "

The punycode encoded domain.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "tokenExpirationTime", - "description": "

The time that the current verification token will expire.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "verificationToken", - "description": "

The current verification token for the domain.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "VerifiableDomainConnection", - "id": "verifiabledomainconnection", - "href": "/graphql/reference/objects#verifiabledomainconnection", - "description": "

The connection type for VerifiableDomain.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[VerifiableDomainEdge]", - "id": "verifiabledomainedge", - "href": "/graphql/reference/objects#verifiabledomainedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[VerifiableDomain]", - "id": "verifiabledomain", - "href": "/graphql/reference/objects#verifiabledomain" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "VerifiableDomainEdge", - "id": "verifiabledomainedge", - "href": "/graphql/reference/objects#verifiabledomainedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "VerifiableDomain", - "id": "verifiabledomain", - "href": "/graphql/reference/objects#verifiabledomain" - } - ] - }, - { - "name": "ViewerHovercardContext", - "id": "viewerhovercardcontext", - "href": "/graphql/reference/objects#viewerhovercardcontext", - "description": "

A hovercard context with a message describing how the viewer is related.

", - "implements": [ - { - "name": "HovercardContext", - "id": "hovercardcontext", - "href": "/graphql/reference/interfaces#hovercardcontext" - } - ], - "fields": [ - { - "name": "message", - "description": "

A string describing this context.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "octicon", - "description": "

An octicon to accompany this context.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "viewer", - "description": "

Identifies the user who is related to this context.

", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "Workflow", - "id": "workflow", - "href": "/graphql/reference/objects#workflow", - "description": "

A workflow contains meta information about an Actions workflow file.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the Workflow object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "name", - "description": "

The name of the workflow.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this workflow.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "runs", - "description": "

The runs of the workflow.

", - "type": "WorkflowRunConnection!", - "id": "workflowrunconnection", - "href": "/graphql/reference/objects#workflowrunconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for the connection.

", - "type": { - "name": "WorkflowRunOrder", - "id": "workflowrunorder", - "href": "/graphql/reference/input-objects#workflowrunorder" - } - } - ] - }, - { - "name": "state", - "description": "

The state of the workflow.

", - "type": "WorkflowState!", - "id": "workflowstate", - "href": "/graphql/reference/enums#workflowstate" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this workflow.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "WorkflowFileReference", - "id": "workflowfilereference", - "href": "/graphql/reference/objects#workflowfilereference", - "description": "

A workflow that must run for this rule to pass.

", - "fields": [ - { - "name": "path", - "description": "

The path to the workflow file.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ref", - "description": "

The ref (branch or tag) of the workflow file to use.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryId", - "description": "

The ID of the repository where the workflow is defined.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "sha", - "description": "

The commit SHA of the workflow file to use.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "WorkflowRun", - "id": "workflowrun", - "href": "/graphql/reference/objects#workflowrun", - "description": "

A workflow run.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "checkSuite", - "description": "

The check suite this workflow run belongs to.

", - "type": "CheckSuite!", - "id": "checksuite", - "href": "/graphql/reference/objects#checksuite" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "deploymentReviews", - "description": "

The log of deployment reviews.

", - "type": "DeploymentReviewConnection!", - "id": "deploymentreviewconnection", - "href": "/graphql/reference/objects#deploymentreviewconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "event", - "description": "

The event that triggered the workflow run.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "file", - "description": "

The workflow file.

", - "type": "WorkflowRunFile", - "id": "workflowrunfile", - "href": "/graphql/reference/objects#workflowrunfile" - }, - { - "name": "id", - "description": "

The Node ID of the WorkflowRun object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pendingDeploymentRequests", - "description": "

The pending deployment requests of all check runs in this workflow run.

", - "type": "DeploymentRequestConnection!", - "id": "deploymentrequestconnection", - "href": "/graphql/reference/objects#deploymentrequestconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this workflow run.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "runNumber", - "description": "

A number that uniquely identifies this workflow run in its parent workflow.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this workflow run.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "workflow", - "description": "

The workflow executed in this workflow run.

", - "type": "Workflow!", - "id": "workflow", - "href": "/graphql/reference/objects#workflow" - } - ] - }, - { - "name": "WorkflowRunConnection", - "id": "workflowrunconnection", - "href": "/graphql/reference/objects#workflowrunconnection", - "description": "

The connection type for WorkflowRun.

", - "fields": [ - { - "name": "edges", - "description": "

A list of edges.

", - "type": "[WorkflowRunEdge]", - "id": "workflowrunedge", - "href": "/graphql/reference/objects#workflowrunedge" - }, - { - "name": "nodes", - "description": "

A list of nodes.

", - "type": "[WorkflowRun]", - "id": "workflowrun", - "href": "/graphql/reference/objects#workflowrun" - }, - { - "name": "pageInfo", - "description": "

Information to aid in pagination.

", - "type": "PageInfo!", - "id": "pageinfo", - "href": "/graphql/reference/objects#pageinfo" - }, - { - "name": "totalCount", - "description": "

Identifies the total count of items in the connection.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "WorkflowRunEdge", - "id": "workflowrunedge", - "href": "/graphql/reference/objects#workflowrunedge", - "description": "

An edge in a connection.

", - "fields": [ - { - "name": "cursor", - "description": "

A cursor for use in pagination.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "node", - "description": "

The item at the end of the edge.

", - "type": "WorkflowRun", - "id": "workflowrun", - "href": "/graphql/reference/objects#workflowrun" - } - ] - }, - { - "name": "WorkflowRunFile", - "id": "workflowrunfile", - "href": "/graphql/reference/objects#workflowrunfile", - "description": "

An executed workflow file for a workflow run.

", - "implements": [ - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node" - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable" - } - ], - "fields": [ - { - "name": "id", - "description": "

The Node ID of the WorkflowRunFile object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "path", - "description": "

The path of the workflow file relative to its repository.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryFileUrl", - "description": "

The direct link to the file in the repository which stores the workflow file.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryName", - "description": "

The repository name and owner which stores the workflow file.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this workflow run file.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "run", - "description": "

The parent workflow run execution for this file.

", - "type": "WorkflowRun!", - "id": "workflowrun", - "href": "/graphql/reference/objects#workflowrun" - }, - { - "name": "url", - "description": "

The HTTP URL for this workflow run file.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "viewerCanPushRepository", - "description": "

If the viewer has permissions to push to the repository which stores the workflow.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanReadRepository", - "description": "

If the viewer has permissions to read the repository which stores the workflow.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "WorkflowsParameters", - "id": "workflowsparameters", - "href": "/graphql/reference/objects#workflowsparameters", - "description": "

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

", - "fields": [ - { - "name": "workflows", - "description": "

Workflows that must pass for this rule to pass.

", - "type": "[WorkflowFileReference!]!", - "id": "workflowfilereference", - "href": "/graphql/reference/objects#workflowfilereference" - } - ] - } - ], - "interfaces": [ - { - "name": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor", - "description": "

Represents an object which can take actions on GitHub. Typically a User or Bot.

", - "fields": [ - { - "name": "avatarUrl", - "description": "

A URL pointing to the actor's public avatar.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "arguments": [ - { - "name": "size", - "description": "

The size of the resulting square image.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "login", - "description": "

The username of the actor.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this actor.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The HTTP URL for this actor.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "AnnouncementBanner", - "id": "announcementbanner", - "href": "/graphql/reference/interfaces#announcementbanner", - "description": "

Represents an announcement banner.

", - "fields": [ - { - "name": "announcement", - "description": "

The text of the announcement.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "announcementCreatedAt", - "description": "

The date the announcement was created.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "announcementExpiresAt", - "description": "

The expiration date of the announcement, if any.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "announcementUserDismissible", - "description": "

Whether the announcement can be dismissed by the user.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "Assignable", - "id": "assignable", - "href": "/graphql/reference/interfaces#assignable", - "description": "

An object that can have users assigned to it.

", - "fields": [ - { - "name": "assignees", - "description": "

A list of Users assigned to this object.

", - "type": "UserConnection!", - "id": "userconnection", - "href": "/graphql/reference/objects#userconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - } - ] - }, - { - "name": "AuditEntry", - "id": "auditentry", - "href": "/graphql/reference/interfaces#auditentry", - "description": "

An entry in the audit log.

", - "fields": [ - { - "name": "action", - "description": "

The action name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actor", - "description": "

The user who initiated the action.

", - "type": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor" - }, - { - "name": "actorIp", - "description": "

The IP address of the actor.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorLocation", - "description": "

A readable representation of the actor's location.

", - "type": "ActorLocation", - "id": "actorlocation", - "href": "/graphql/reference/objects#actorlocation" - }, - { - "name": "actorLogin", - "description": "

The username of the user who initiated the action.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorResourcePath", - "description": "

The HTTP path for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "actorUrl", - "description": "

The HTTP URL for the actor.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "createdAt", - "description": "

The time the action was initiated.

", - "type": "PreciseDateTime!", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime" - }, - { - "name": "operationType", - "description": "

The corresponding operation type for the action.

", - "type": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype" - }, - { - "name": "user", - "description": "

The user affected by the action.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "userLogin", - "description": "

For actions involving two users, the actor is the initiator and the user is the affected user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userResourcePath", - "description": "

The HTTP path for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "userUrl", - "description": "

The HTTP URL for the user.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "Closable", - "id": "closable", - "href": "/graphql/reference/interfaces#closable", - "description": "

An object that can be closed.

", - "fields": [ - { - "name": "closed", - "description": "

Indicates if the object is closed (definition of closed may depend on type).

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "closedAt", - "description": "

Identifies the date and time when the object was closed.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "viewerCanClose", - "description": "

Indicates if the object can be closed by the viewer.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerCanReopen", - "description": "

Indicates if the object can be reopened by the viewer.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "Comment", - "id": "comment", - "href": "/graphql/reference/interfaces#comment", - "description": "

Represents a comment.

", - "fields": [ - { - "name": "author", - "description": "

The actor who authored the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "authorAssociation", - "description": "

Author's association with the subject of the comment.

", - "type": "CommentAuthorAssociation!", - "id": "commentauthorassociation", - "href": "/graphql/reference/enums#commentauthorassociation" - }, - { - "name": "body", - "description": "

The body as Markdown.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyHTML", - "description": "

The body rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "bodyText", - "description": "

The body rendered to text.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "createdViaEmail", - "description": "

Check if this comment was created via an email reply.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "editor", - "description": "

The actor who edited the comment.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "id", - "description": "

The Node ID of the Comment object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "includesCreatedEdit", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "lastEditedAt", - "description": "

The moment the editor made the last edit.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "publishedAt", - "description": "

Identifies when the comment was published at.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "userContentEdits", - "description": "

A list of edits to this content.

", - "type": "UserContentEditConnection", - "id": "usercontenteditconnection", - "href": "/graphql/reference/objects#usercontenteditconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "viewerDidAuthor", - "description": "

Did the viewer author this comment.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "Contribution", - "id": "contribution", - "href": "/graphql/reference/interfaces#contribution", - "description": "

Represents a contribution a user made on GitHub, such as opening an issue.

", - "fields": [ - { - "name": "isRestricted", - "description": "

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.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "occurredAt", - "description": "

When this contribution was made.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this contribution.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The HTTP URL for this contribution.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "user", - "description": "

The user who made this contribution.

", - "type": "User!", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "Deletable", - "id": "deletable", - "href": "/graphql/reference/interfaces#deletable", - "description": "

Entities that can be deleted.

", - "fields": [ - { - "name": "viewerCanDelete", - "description": "

Check if the current viewer can delete this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "EnterpriseAuditEntryData", - "id": "enterpriseauditentrydata", - "href": "/graphql/reference/interfaces#enterpriseauditentrydata", - "description": "

Metadata for an audit entry containing enterprise account information.

", - "fields": [ - { - "name": "enterpriseResourcePath", - "description": "

The HTTP path for this enterprise.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "enterpriseSlug", - "description": "

The slug of the enterprise.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseUrl", - "description": "

The HTTP URL for this enterprise.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "GitObject", - "id": "gitobject", - "href": "/graphql/reference/interfaces#gitobject", - "description": "

Represents a Git object.

", - "fields": [ - { - "name": "abbreviatedOid", - "description": "

An abbreviated version of the Git object ID.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "commitResourcePath", - "description": "

The HTTP path for this Git object.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "commitUrl", - "description": "

The HTTP URL for this Git object.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "id", - "description": "

The Node ID of the GitObject object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "oid", - "description": "

The Git object ID.

", - "type": "GitObjectID!", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "repository", - "description": "

The Repository the Git object belongs to.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "GitSignature", - "id": "gitsignature", - "href": "/graphql/reference/interfaces#gitsignature", - "description": "

Information about a signature (GPG or S/MIME) on a Commit or Tag.

", - "fields": [ - { - "name": "email", - "description": "

Email used to sign this object.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "isValid", - "description": "

True if the signature is valid and verified by GitHub.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "payload", - "description": "

Payload for GPG signing object. Raw ODB object without the signature header.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "signature", - "description": "

ASCII-armored signature header from object.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "signer", - "description": "

GitHub user corresponding to the email signing this commit.

", - "type": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - }, - { - "name": "state", - "description": "

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

", - "type": "GitSignatureState!", - "id": "gitsignaturestate", - "href": "/graphql/reference/enums#gitsignaturestate" - }, - { - "name": "wasSignedByGitHub", - "description": "

True if the signature was made with GitHub's signing key.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "HovercardContext", - "id": "hovercardcontext", - "href": "/graphql/reference/interfaces#hovercardcontext", - "description": "

An individual line of a hovercard.

", - "fields": [ - { - "name": "message", - "description": "

A string describing this context.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "octicon", - "description": "

An octicon to accompany this context.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "Labelable", - "id": "labelable", - "href": "/graphql/reference/interfaces#labelable", - "description": "

An object that can have labels assigned to it.

", - "fields": [ - { - "name": "labels", - "description": "

A list of labels associated with the object.

", - "type": "LabelConnection", - "id": "labelconnection", - "href": "/graphql/reference/objects#labelconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for labels returned from the connection.

", - "type": { - "name": "LabelOrder", - "id": "labelorder", - "href": "/graphql/reference/input-objects#labelorder" - } - } - ] - } - ] - }, - { - "name": "Lockable", - "id": "lockable", - "href": "/graphql/reference/interfaces#lockable", - "description": "

An object that can be locked.

", - "fields": [ - { - "name": "activeLockReason", - "description": "

Reason that the conversation was locked.

", - "type": "LockReason", - "id": "lockreason", - "href": "/graphql/reference/enums#lockreason" - }, - { - "name": "locked", - "description": "

true if the object is locked.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "MemberStatusable", - "id": "memberstatusable", - "href": "/graphql/reference/interfaces#memberstatusable", - "description": "

Entities that have members who can set status messages.

", - "fields": [ - { - "name": "memberStatuses", - "description": "

Get the status messages members of this entity have set that are either public or visible only to the organization.

", - "type": "UserStatusConnection!", - "id": "userstatusconnection", - "href": "/graphql/reference/objects#userstatusconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for user statuses returned from the connection.

", - "type": { - "name": "UserStatusOrder", - "id": "userstatusorder", - "href": "/graphql/reference/input-objects#userstatusorder" - } - } - ] - } - ] - }, - { - "name": "Migration", - "id": "migration", - "href": "/graphql/reference/interfaces#migration", - "description": "

Represents a GitHub Enterprise Importer (GEI) migration.

", - "fields": [ - { - "name": "continueOnError", - "description": "

The migration flag to continue on error.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "failureReason", - "description": "

The reason the migration failed.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the Migration object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "migrationLogUrl", - "description": "

The URL for the migration log (expires 1 day after migration completes).

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "migrationSource", - "description": "

The migration source.

", - "type": "MigrationSource!", - "id": "migrationsource", - "href": "/graphql/reference/objects#migrationsource" - }, - { - "name": "repositoryName", - "description": "

The target repository name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "sourceUrl", - "description": "

The migration source URL, for example https://github.com or https://monalisa.ghe.com.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "state", - "description": "

The migration state.

", - "type": "MigrationState!", - "id": "migrationstate", - "href": "/graphql/reference/enums#migrationstate" - }, - { - "name": "warningsCount", - "description": "

The number of warnings encountered for this migration. To review the warnings,\ncheck the Migration Log.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "Minimizable", - "id": "minimizable", - "href": "/graphql/reference/interfaces#minimizable", - "description": "

Entities that can be minimized.

", - "fields": [ - { - "name": "isMinimized", - "description": "

Returns whether or not a comment has been minimized.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "minimizedReason", - "description": "

Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "viewerCanMinimize", - "description": "

Check if the current viewer can minimize this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "Node", - "id": "node", - "href": "/graphql/reference/interfaces#node", - "description": "

An object with an ID.

", - "fields": [ - { - "name": "id", - "description": "

ID of the object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - ] - }, - { - "name": "OauthApplicationAuditEntryData", - "id": "oauthapplicationauditentrydata", - "href": "/graphql/reference/interfaces#oauthapplicationauditentrydata", - "description": "

Metadata for an audit entry with action oauth_application.*.

", - "fields": [ - { - "name": "oauthApplicationName", - "description": "

The name of the OAuth application.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "oauthApplicationResourcePath", - "description": "

The HTTP path for the OAuth application.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "oauthApplicationUrl", - "description": "

The HTTP URL for the OAuth application.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "OrganizationAuditEntryData", - "id": "organizationauditentrydata", - "href": "/graphql/reference/interfaces#organizationauditentrydata", - "description": "

Metadata for an audit entry with action org.*.

", - "fields": [ - { - "name": "organization", - "description": "

The Organization associated with the Audit Entry.

", - "type": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "organizationName", - "description": "

The name of the Organization.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationResourcePath", - "description": "

The HTTP path for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "organizationUrl", - "description": "

The HTTP URL for the organization.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "PackageOwner", - "id": "packageowner", - "href": "/graphql/reference/interfaces#packageowner", - "description": "

Represents an owner of a package.

", - "fields": [ - { - "name": "id", - "description": "

The Node ID of the PackageOwner object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "packages", - "description": "

A list of packages under the owner.

", - "type": "PackageConnection!", - "id": "packageconnection", - "href": "/graphql/reference/objects#packageconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "names", - "description": "

Find packages by their names.

", - "type": { - "name": "[String]", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "orderBy", - "description": "

Ordering of the returned packages.

", - "type": { - "name": "PackageOrder", - "id": "packageorder", - "href": "/graphql/reference/input-objects#packageorder" - } - }, - { - "name": "packageType", - "description": "

Filter registry package by type.

", - "type": { - "name": "PackageType", - "id": "packagetype", - "href": "/graphql/reference/enums#packagetype" - } - }, - { - "name": "repositoryId", - "description": "

Find packages in a repository by ID.

", - "type": { - "name": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - } - ] - } - ] - }, - { - "name": "ProfileOwner", - "id": "profileowner", - "href": "/graphql/reference/interfaces#profileowner", - "description": "

Represents any entity on GitHub that has a profile page.

", - "fields": [ - { - "name": "anyPinnableItems", - "description": "

Determine if this repository owner has any items that can be pinned to their profile.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "arguments": [ - { - "name": "type", - "description": "

Filter to only a particular kind of pinnable item.

", - "type": { - "name": "PinnableItemType", - "id": "pinnableitemtype", - "href": "/graphql/reference/enums#pinnableitemtype" - } - } - ] - }, - { - "name": "email", - "description": "

The public profile email.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the ProfileOwner object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "itemShowcase", - "description": "

Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

", - "type": "ProfileItemShowcase!", - "id": "profileitemshowcase", - "href": "/graphql/reference/objects#profileitemshowcase" - }, - { - "name": "location", - "description": "

The public profile location.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "login", - "description": "

The username used to login.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The public profile name.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pinnableItems", - "description": "

A list of repositories and gists this profile owner can pin to their profile.

", - "type": "PinnableItemConnection!", - "id": "pinnableitemconnection", - "href": "/graphql/reference/objects#pinnableitemconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "types", - "description": "

Filter the types of pinnable items that are returned.

", - "type": { - "name": "[PinnableItemType!]", - "id": "pinnableitemtype", - "href": "/graphql/reference/enums#pinnableitemtype" - } - } - ] - }, - { - "name": "pinnedItems", - "description": "

A list of repositories and gists this profile owner has pinned to their profile.

", - "type": "PinnableItemConnection!", - "id": "pinnableitemconnection", - "href": "/graphql/reference/objects#pinnableitemconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "types", - "description": "

Filter the types of pinned items that are returned.

", - "type": { - "name": "[PinnableItemType!]", - "id": "pinnableitemtype", - "href": "/graphql/reference/enums#pinnableitemtype" - } - } - ] - }, - { - "name": "pinnedItemsRemaining", - "description": "

Returns how many more items this profile owner can pin to their profile.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "viewerCanChangePinnedItems", - "description": "

Can the viewer pin repositories and gists to the profile?.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "websiteUrl", - "description": "

The public profile website URL.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "ProjectOwner", - "id": "projectowner", - "href": "/graphql/reference/interfaces#projectowner", - "description": "

Represents an owner of a Project.

", - "fields": [ - { - "name": "id", - "description": "

The Node ID of the ProjectOwner object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "project", - "description": "

Find project by number.

", - "type": "Project", - "id": "project", - "href": "/graphql/reference/objects#project", - "arguments": [ - { - "name": "number", - "description": "

The project number to find.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "projects", - "description": "

A list of projects under the owner.

", - "type": "ProjectConnection!", - "id": "projectconnection", - "href": "/graphql/reference/objects#projectconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for projects returned from the connection.

", - "type": { - "name": "ProjectOrder", - "id": "projectorder", - "href": "/graphql/reference/input-objects#projectorder" - } - }, - { - "name": "search", - "description": "

Query to search projects by, currently only searching by name.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "states", - "description": "

A list of states to filter the projects by.

", - "type": { - "name": "[ProjectState!]", - "id": "projectstate", - "href": "/graphql/reference/enums#projectstate" - } - } - ] - }, - { - "name": "projectsResourcePath", - "description": "

The HTTP path listing owners projects.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "projectsUrl", - "description": "

The HTTP URL listing owners projects.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "viewerCanCreateProjects", - "description": "

Can the current viewer create new projects on this owner.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "ProjectV2FieldCommon", - "id": "projectv2fieldcommon", - "href": "/graphql/reference/interfaces#projectv2fieldcommon", - "description": "

Common fields across different project field types.

", - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "dataType", - "description": "

The field's type.

", - "type": "ProjectV2FieldType!", - "id": "projectv2fieldtype", - "href": "/graphql/reference/enums#projectv2fieldtype" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the ProjectV2FieldCommon object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "name", - "description": "

The project field's name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "project", - "description": "

The project that contains this field.

", - "type": "ProjectV2!", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "ProjectV2ItemFieldValueCommon", - "id": "projectv2itemfieldvaluecommon", - "href": "/graphql/reference/interfaces#projectv2itemfieldvaluecommon", - "description": "

Common fields across different project field value types.

", - "fields": [ - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "creator", - "description": "

The actor who created the item.

", - "type": "Actor", - "id": "actor", - "href": "/graphql/reference/interfaces#actor" - }, - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "field", - "description": "

The project field that contains this value.

", - "type": "ProjectV2FieldConfiguration!", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration" - }, - { - "name": "id", - "description": "

The Node ID of the ProjectV2ItemFieldValueCommon object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "item", - "description": "

The project item that contains this value.

", - "type": "ProjectV2Item!", - "id": "projectv2item", - "href": "/graphql/reference/objects#projectv2item" - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - } - ] - }, - { - "name": "ProjectV2Owner", - "id": "projectv2owner", - "href": "/graphql/reference/interfaces#projectv2owner", - "description": "

Represents an owner of a project.

", - "fields": [ - { - "name": "id", - "description": "

The Node ID of the ProjectV2Owner object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "projectV2", - "description": "

Find a project by number.

", - "type": "ProjectV2", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2", - "arguments": [ - { - "name": "number", - "description": "

The project number.

", - "type": { - "name": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "projectsV2", - "description": "

A list of projects under the owner.

", - "type": "ProjectV2Connection!", - "id": "projectv2connection", - "href": "/graphql/reference/objects#projectv2connection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

How to order the returned projects.

", - "type": { - "name": "ProjectV2Order", - "id": "projectv2order", - "href": "/graphql/reference/input-objects#projectv2order" - } - }, - { - "name": "query", - "description": "

A project to search for under the the owner.

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - } - ] - }, - { - "name": "ProjectV2Recent", - "id": "projectv2recent", - "href": "/graphql/reference/interfaces#projectv2recent", - "description": "

Recent projects for the owner.

", - "fields": [ - { - "name": "recentProjects", - "description": "

Recent projects that this user has modified in the context of the owner.

", - "type": "ProjectV2Connection!", - "id": "projectv2connection", - "href": "/graphql/reference/objects#projectv2connection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - } - ] - }, - { - "name": "Reactable", - "id": "reactable", - "href": "/graphql/reference/interfaces#reactable", - "description": "

Represents a subject that can be reacted on.

", - "fields": [ - { - "name": "databaseId", - "description": "

Identifies the primary key from the database.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "id", - "description": "

The Node ID of the Reactable object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "reactionGroups", - "description": "

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

", - "type": "[ReactionGroup!]", - "id": "reactiongroup", - "href": "/graphql/reference/objects#reactiongroup" - }, - { - "name": "reactions", - "description": "

A list of Reactions left on the Issue.

", - "type": "ReactionConnection!", - "id": "reactionconnection", - "href": "/graphql/reference/objects#reactionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "content", - "description": "

Allows filtering Reactions by emoji.

", - "type": { - "name": "ReactionContent", - "id": "reactioncontent", - "href": "/graphql/reference/enums#reactioncontent" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Allows specifying the order in which reactions are returned.

", - "type": { - "name": "ReactionOrder", - "id": "reactionorder", - "href": "/graphql/reference/input-objects#reactionorder" - } - } - ] - }, - { - "name": "viewerCanReact", - "description": "

Can user react to this subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "RepositoryAuditEntryData", - "id": "repositoryauditentrydata", - "href": "/graphql/reference/interfaces#repositoryauditentrydata", - "description": "

Metadata for an audit entry with action repo.*.

", - "fields": [ - { - "name": "repository", - "description": "

The repository associated with the action.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "repositoryName", - "description": "

The name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryResourcePath", - "description": "

The HTTP path for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "repositoryUrl", - "description": "

The HTTP URL for the repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "RepositoryDiscussionAuthor", - "id": "repositorydiscussionauthor", - "href": "/graphql/reference/interfaces#repositorydiscussionauthor", - "description": "

Represents an author of discussions in repositories.

", - "fields": [ - { - "name": "repositoryDiscussions", - "description": "

Discussions this user has started.

", - "type": "DiscussionConnection!", - "id": "discussionconnection", - "href": "/graphql/reference/objects#discussionconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "answered", - "description": "

Filter discussions to only those that have been answered or not. Defaults to\nincluding both answered and unanswered discussions.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for discussions returned from the connection.

", - "type": { - "name": "DiscussionOrder", - "id": "discussionorder", - "href": "/graphql/reference/input-objects#discussionorder" - } - }, - { - "name": "repositoryId", - "description": "

Filter discussions to only those in a specific repository.

", - "type": { - "name": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - }, - { - "name": "states", - "description": "

A list of states to filter the discussions by.

", - "type": { - "name": "[DiscussionState!]", - "id": "discussionstate", - "href": "/graphql/reference/enums#discussionstate" - } - } - ] - } - ] - }, - { - "name": "RepositoryDiscussionCommentAuthor", - "id": "repositorydiscussioncommentauthor", - "href": "/graphql/reference/interfaces#repositorydiscussioncommentauthor", - "description": "

Represents an author of discussion comments in repositories.

", - "fields": [ - { - "name": "repositoryDiscussionComments", - "description": "

Discussion comments this user has authored.

", - "type": "DiscussionCommentConnection!", - "id": "discussioncommentconnection", - "href": "/graphql/reference/objects#discussioncommentconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "onlyAnswers", - "defaultValue": false, - "description": "

Filter discussion comments to only those that were marked as the answer.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "repositoryId", - "description": "

Filter discussion comments to only those in a specific repository.

", - "type": { - "name": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - } - ] - } - ] - }, - { - "name": "RepositoryInfo", - "id": "repositoryinfo", - "href": "/graphql/reference/interfaces#repositoryinfo", - "description": "

A subset of repository info.

", - "fields": [ - { - "name": "archivedAt", - "description": "

Identifies the date and time when the repository was archived.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "createdAt", - "description": "

Identifies the date and time when the object was created.

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "description", - "description": "

The description of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "descriptionHTML", - "description": "

The description of the repository rendered to HTML.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html" - }, - { - "name": "forkCount", - "description": "

Returns how many forks there are of this repository in the whole network.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "hasAnonymousAccessEnabled", - "description": "

Indicates if the repository has anonymous Git read access feature enabled.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "hasDiscussionsEnabled", - "description": "

Indicates if the repository has the Discussions feature enabled.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "hasIssuesEnabled", - "description": "

Indicates if the repository has issues feature enabled.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "hasProjectsEnabled", - "description": "

Indicates if the repository has the Projects feature enabled.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "hasWikiEnabled", - "description": "

Indicates if the repository has wiki feature enabled.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "homepageUrl", - "description": "

The repository's URL.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "isArchived", - "description": "

Indicates if the repository is unmaintained.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isFork", - "description": "

Identifies if the repository is a fork.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isInOrganization", - "description": "

Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isLocked", - "description": "

Indicates if the repository has been locked or not.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isMirror", - "description": "

Identifies if the repository is a mirror.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isPrivate", - "description": "

Identifies if the repository is private or internal.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isTemplate", - "description": "

Identifies if the repository is a template that can be used to generate new repositories.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "licenseInfo", - "description": "

The license associated with the repository.

", - "type": "License", - "id": "license", - "href": "/graphql/reference/objects#license" - }, - { - "name": "lockReason", - "description": "

The reason the repository has been locked.

", - "type": "RepositoryLockReason", - "id": "repositorylockreason", - "href": "/graphql/reference/enums#repositorylockreason" - }, - { - "name": "mirrorUrl", - "description": "

The repository's original mirror URL.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "name", - "description": "

The name of the repository.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "nameWithOwner", - "description": "

The repository's name with owner.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "openGraphImageUrl", - "description": "

The image used to represent this repository in Open Graph data.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "owner", - "description": "

The User owner of the repository.

", - "type": "RepositoryOwner!", - "id": "repositoryowner", - "href": "/graphql/reference/interfaces#repositoryowner" - }, - { - "name": "pushedAt", - "description": "

Identifies the date and time when the repository was last pushed to.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "resourcePath", - "description": "

The HTTP path for this repository.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "shortDescriptionHTML", - "description": "

A description of the repository, rendered to HTML without any links in it.

", - "type": "HTML!", - "id": "html", - "href": "/graphql/reference/scalars#html", - "arguments": [ - { - "name": "limit", - "defaultValue": "200", - "description": "

How many characters to return.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "updatedAt", - "description": "

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

", - "type": "DateTime!", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "url", - "description": "

The HTTP URL for this repository.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "usesCustomOpenGraphImage", - "description": "

Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "visibility", - "description": "

Indicates the repository's visibility level.

", - "type": "RepositoryVisibility!", - "id": "repositoryvisibility", - "href": "/graphql/reference/enums#repositoryvisibility" - } - ] - }, - { - "name": "RepositoryNode", - "id": "repositorynode", - "href": "/graphql/reference/interfaces#repositorynode", - "description": "

Represents a object that belongs to a repository.

", - "fields": [ - { - "name": "repository", - "description": "

The repository associated with this node.

", - "type": "Repository!", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "RepositoryOwner", - "id": "repositoryowner", - "href": "/graphql/reference/interfaces#repositoryowner", - "description": "

Represents an owner of a Repository.

", - "fields": [ - { - "name": "avatarUrl", - "description": "

A URL pointing to the owner's public avatar.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "arguments": [ - { - "name": "size", - "description": "

The size of the resulting square image.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - }, - { - "name": "id", - "description": "

The Node ID of the RepositoryOwner object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "login", - "description": "

The username used to login.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositories", - "description": "

A list of repositories that the user owns.

", - "type": "RepositoryConnection!", - "id": "repositoryconnection", - "href": "/graphql/reference/objects#repositoryconnection", - "arguments": [ - { - "name": "affiliations", - "description": "

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

", - "type": { - "name": "[RepositoryAffiliation]", - "id": "repositoryaffiliation", - "href": "/graphql/reference/enums#repositoryaffiliation" - } - }, - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "hasIssuesEnabled", - "description": "

If non-null, filters repositories according to whether they have issues enabled.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "isArchived", - "description": "

If non-null, filters repositories according to whether they are archived and not maintained.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "isFork", - "description": "

If non-null, filters repositories according to whether they are forks of another repository.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "isLocked", - "description": "

If non-null, filters repositories according to whether they have been locked.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Ordering options for repositories returned from the connection.

", - "type": { - "name": "RepositoryOrder", - "id": "repositoryorder", - "href": "/graphql/reference/input-objects#repositoryorder" - } - }, - { - "name": "ownerAffiliations", - "description": "

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.

", - "type": { - "name": "[RepositoryAffiliation]", - "id": "repositoryaffiliation", - "href": "/graphql/reference/enums#repositoryaffiliation" - } - }, - { - "name": "privacy", - "description": "

If non-null, filters repositories according to privacy. Internal\nrepositories are considered private; consider using the visibility argument\nif only internal repositories are needed. Cannot be combined with the\nvisibility argument.

", - "type": { - "name": "RepositoryPrivacy", - "id": "repositoryprivacy", - "href": "/graphql/reference/enums#repositoryprivacy" - } - }, - { - "name": "visibility", - "description": "

If non-null, filters repositories according to visibility. Cannot be combined with the privacy argument.

", - "type": { - "name": "RepositoryVisibility", - "id": "repositoryvisibility", - "href": "/graphql/reference/enums#repositoryvisibility" - } - } - ] - }, - { - "name": "repository", - "description": "

Find Repository.

", - "type": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository", - "arguments": [ - { - "name": "followRenames", - "defaultValue": true, - "description": "

Follow repository renames. If disabled, a repository referenced by its old name will return an error.

", - "type": { - "name": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - }, - { - "name": "name", - "description": "

Name of Repository to find.

", - "type": { - "name": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - } - ] - }, - { - "name": "resourcePath", - "description": "

The HTTP URL for the owner.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The HTTP URL for the owner.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "RequirableByPullRequest", - "id": "requirablebypullrequest", - "href": "/graphql/reference/interfaces#requirablebypullrequest", - "description": "

Represents a type that can be required by a pull request for merging.

", - "fields": [ - { - "name": "isRequired", - "description": "

Whether this is required to pass before merging for a specific pull request.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean", - "arguments": [ - { - "name": "pullRequestId", - "description": "

The id of the pull request this is required for.

", - "type": { - "name": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - }, - { - "name": "pullRequestNumber", - "description": "

The number of the pull request this is required for.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - } - ] - } - ] - }, - { - "name": "Starrable", - "id": "starrable", - "href": "/graphql/reference/interfaces#starrable", - "description": "

Things that can be starred.

", - "fields": [ - { - "name": "id", - "description": "

The Node ID of the Starrable object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "stargazerCount", - "description": "

Returns a count of how many stargazers there are on this object.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "stargazers", - "description": "

A list of users who have starred this starrable.

", - "type": "StargazerConnection!", - "id": "stargazerconnection", - "href": "/graphql/reference/objects#stargazerconnection", - "arguments": [ - { - "name": "after", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "before", - "description": "

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

", - "type": { - "name": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - }, - { - "name": "first", - "description": "

Returns the first n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "last", - "description": "

Returns the last n elements from the list.

", - "type": { - "name": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - }, - { - "name": "orderBy", - "description": "

Order for connection.

", - "type": { - "name": "StarOrder", - "id": "starorder", - "href": "/graphql/reference/input-objects#starorder" - } - } - ] - }, - { - "name": "viewerHasStarred", - "description": "

Returns a boolean indicating whether the viewing user has starred this starrable.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "Subscribable", - "id": "subscribable", - "href": "/graphql/reference/interfaces#subscribable", - "description": "

Entities that can be subscribed to for web and email notifications.

", - "fields": [ - { - "name": "id", - "description": "

The Node ID of the Subscribable object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "viewerCanSubscribe", - "description": "

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

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerSubscription", - "description": "

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

", - "type": "SubscriptionState", - "id": "subscriptionstate", - "href": "/graphql/reference/enums#subscriptionstate" - } - ] - }, - { - "name": "SubscribableThread", - "id": "subscribablethread", - "href": "/graphql/reference/interfaces#subscribablethread", - "description": "

Entities that can be subscribed to for web and email notifications.

", - "fields": [ - { - "name": "id", - "description": "

The Node ID of the SubscribableThread object.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "viewerThreadSubscriptionFormAction", - "description": "

Identifies the viewer's thread subscription form action.

", - "type": "ThreadSubscriptionFormAction", - "id": "threadsubscriptionformaction", - "href": "/graphql/reference/enums#threadsubscriptionformaction" - }, - { - "name": "viewerThreadSubscriptionStatus", - "description": "

Identifies the viewer's thread subscription status.

", - "type": "ThreadSubscriptionState", - "id": "threadsubscriptionstate", - "href": "/graphql/reference/enums#threadsubscriptionstate" - } - ] - }, - { - "name": "TeamAuditEntryData", - "id": "teamauditentrydata", - "href": "/graphql/reference/interfaces#teamauditentrydata", - "description": "

Metadata for an audit entry with action team.*.

", - "fields": [ - { - "name": "team", - "description": "

The team associated with the action.

", - "type": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - }, - { - "name": "teamName", - "description": "

The name of the team.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "teamResourcePath", - "description": "

The HTTP path for this team.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "teamUrl", - "description": "

The HTTP URL for this team.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "TopicAuditEntryData", - "id": "topicauditentrydata", - "href": "/graphql/reference/interfaces#topicauditentrydata", - "description": "

Metadata for an audit entry with a topic.

", - "fields": [ - { - "name": "topic", - "description": "

The name of the topic added to the repository.

", - "type": "Topic", - "id": "topic", - "href": "/graphql/reference/objects#topic" - }, - { - "name": "topicName", - "description": "

The name of the topic added to the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "UniformResourceLocatable", - "id": "uniformresourcelocatable", - "href": "/graphql/reference/interfaces#uniformresourcelocatable", - "description": "

Represents a type that can be retrieved by a URL.

", - "fields": [ - { - "name": "resourcePath", - "description": "

The HTML path to this resource.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "url", - "description": "

The URL to this resource.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "Updatable", - "id": "updatable", - "href": "/graphql/reference/interfaces#updatable", - "description": "

Entities that can be updated.

", - "fields": [ - { - "name": "viewerCanUpdate", - "description": "

Check if the current viewer can update this object.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "UpdatableComment", - "id": "updatablecomment", - "href": "/graphql/reference/interfaces#updatablecomment", - "description": "

Comments that can be updated.

", - "fields": [ - { - "name": "viewerCannotUpdateReasons", - "description": "

Reasons why the current viewer can not update this comment.

", - "type": "[CommentCannotUpdateReason!]!", - "id": "commentcannotupdatereason", - "href": "/graphql/reference/enums#commentcannotupdatereason" - } - ] - }, - { - "name": "Votable", - "id": "votable", - "href": "/graphql/reference/interfaces#votable", - "description": "

A subject that may be upvoted.

", - "fields": [ - { - "name": "upvoteCount", - "description": "

Number of upvotes that this subject has received.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "viewerCanUpvote", - "description": "

Whether or not the current user can add or remove an upvote on this subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "viewerHasUpvoted", - "description": "

Whether or not the current user has already upvoted this subject.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - } - ], - "enums": [ - { - "name": "ActorType", - "id": "actortype", - "href": "/graphql/reference/enums#actortype", - "description": "

The actor's type.

", - "values": [ - { - "name": "TEAM", - "description": "

Indicates a team actor.

" - }, - { - "name": "USER", - "description": "

Indicates a user actor.

" - } - ] - }, - { - "name": "AuditLogOrderField", - "id": "auditlogorderfield", - "href": "/graphql/reference/enums#auditlogorderfield", - "description": "

Properties by which Audit Log connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order audit log entries by timestamp.

" - } - ] - }, - { - "name": "CheckAnnotationLevel", - "id": "checkannotationlevel", - "href": "/graphql/reference/enums#checkannotationlevel", - "description": "

Represents an annotation's information level.

", - "values": [ - { - "name": "FAILURE", - "description": "

An annotation indicating an inescapable error.

" - }, - { - "name": "NOTICE", - "description": "

An annotation indicating some information.

" - }, - { - "name": "WARNING", - "description": "

An annotation indicating an ignorable error.

" - } - ] - }, - { - "name": "CheckConclusionState", - "id": "checkconclusionstate", - "href": "/graphql/reference/enums#checkconclusionstate", - "description": "

The possible states for a check suite or run conclusion.

", - "values": [ - { - "name": "ACTION_REQUIRED", - "description": "

The check suite or run requires action.

" - }, - { - "name": "CANCELLED", - "description": "

The check suite or run has been cancelled.

" - }, - { - "name": "FAILURE", - "description": "

The check suite or run has failed.

" - }, - { - "name": "NEUTRAL", - "description": "

The check suite or run was neutral.

" - }, - { - "name": "SKIPPED", - "description": "

The check suite or run was skipped.

" - }, - { - "name": "STALE", - "description": "

The check suite or run was marked stale by GitHub. Only GitHub can use this conclusion.

" - }, - { - "name": "STARTUP_FAILURE", - "description": "

The check suite or run has failed at startup.

" - }, - { - "name": "SUCCESS", - "description": "

The check suite or run has succeeded.

" - }, - { - "name": "TIMED_OUT", - "description": "

The check suite or run has timed out.

" - } - ] - }, - { - "name": "CheckRunState", - "id": "checkrunstate", - "href": "/graphql/reference/enums#checkrunstate", - "description": "

The possible states of a check run in a status rollup.

", - "values": [ - { - "name": "ACTION_REQUIRED", - "description": "

The check run requires action.

" - }, - { - "name": "CANCELLED", - "description": "

The check run has been cancelled.

" - }, - { - "name": "COMPLETED", - "description": "

The check run has been completed.

" - }, - { - "name": "FAILURE", - "description": "

The check run has failed.

" - }, - { - "name": "IN_PROGRESS", - "description": "

The check run is in progress.

" - }, - { - "name": "NEUTRAL", - "description": "

The check run was neutral.

" - }, - { - "name": "PENDING", - "description": "

The check run is in pending state.

" - }, - { - "name": "QUEUED", - "description": "

The check run has been queued.

" - }, - { - "name": "SKIPPED", - "description": "

The check run was skipped.

" - }, - { - "name": "STALE", - "description": "

The check run was marked stale by GitHub. Only GitHub can use this conclusion.

" - }, - { - "name": "STARTUP_FAILURE", - "description": "

The check run has failed at startup.

" - }, - { - "name": "SUCCESS", - "description": "

The check run has succeeded.

" - }, - { - "name": "TIMED_OUT", - "description": "

The check run has timed out.

" - }, - { - "name": "WAITING", - "description": "

The check run is in waiting state.

" - } - ] - }, - { - "name": "CheckRunType", - "id": "checkruntype", - "href": "/graphql/reference/enums#checkruntype", - "description": "

The possible types of check runs.

", - "values": [ - { - "name": "ALL", - "description": "

Every check run available.

" - }, - { - "name": "LATEST", - "description": "

The latest check run.

" - } - ] - }, - { - "name": "CheckStatusState", - "id": "checkstatusstate", - "href": "/graphql/reference/enums#checkstatusstate", - "description": "

The possible states for a check suite or run status.

", - "values": [ - { - "name": "COMPLETED", - "description": "

The check suite or run has been completed.

" - }, - { - "name": "IN_PROGRESS", - "description": "

The check suite or run is in progress.

" - }, - { - "name": "PENDING", - "description": "

The check suite or run is in pending state.

" - }, - { - "name": "QUEUED", - "description": "

The check suite or run has been queued.

" - }, - { - "name": "REQUESTED", - "description": "

The check suite or run has been requested.

" - }, - { - "name": "WAITING", - "description": "

The check suite or run is in waiting state.

" - } - ] - }, - { - "name": "CollaboratorAffiliation", - "id": "collaboratoraffiliation", - "href": "/graphql/reference/enums#collaboratoraffiliation", - "description": "

Collaborators affiliation level with a subject.

", - "values": [ - { - "name": "ALL", - "description": "

All collaborators the authenticated user can see.

" - }, - { - "name": "DIRECT", - "description": "

All collaborators with permissions to an organization-owned subject, regardless of organization membership status.

" - }, - { - "name": "OUTSIDE", - "description": "

All outside collaborators of an organization-owned subject.

" - } - ] - }, - { - "name": "CommentAuthorAssociation", - "id": "commentauthorassociation", - "href": "/graphql/reference/enums#commentauthorassociation", - "description": "

A comment author association with repository.

", - "values": [ - { - "name": "COLLABORATOR", - "description": "

Author has been invited to collaborate on the repository.

" - }, - { - "name": "CONTRIBUTOR", - "description": "

Author has previously committed to the repository.

" - }, - { - "name": "FIRST_TIMER", - "description": "

Author has not previously committed to GitHub.

" - }, - { - "name": "FIRST_TIME_CONTRIBUTOR", - "description": "

Author has not previously committed to the repository.

" - }, - { - "name": "MANNEQUIN", - "description": "

Author is a placeholder for an unclaimed user.

" - }, - { - "name": "MEMBER", - "description": "

Author is a member of the organization that owns the repository.

" - }, - { - "name": "NONE", - "description": "

Author has no association with the repository.

" - }, - { - "name": "OWNER", - "description": "

Author is the owner of the repository.

" - } - ] - }, - { - "name": "CommentCannotUpdateReason", - "id": "commentcannotupdatereason", - "href": "/graphql/reference/enums#commentcannotupdatereason", - "description": "

The possible errors that will prevent a user from updating a comment.

", - "values": [ - { - "name": "ARCHIVED", - "description": "

Unable to create comment because repository is archived.

" - }, - { - "name": "DENIED", - "description": "

You cannot update this comment.

" - }, - { - "name": "INSUFFICIENT_ACCESS", - "description": "

You must be the author or have write access to this repository to update this comment.

" - }, - { - "name": "LOCKED", - "description": "

Unable to create comment because issue is locked.

" - }, - { - "name": "LOGIN_REQUIRED", - "description": "

You must be logged in to update this comment.

" - }, - { - "name": "MAINTENANCE", - "description": "

Repository is under maintenance.

" - }, - { - "name": "VERIFIED_EMAIL_REQUIRED", - "description": "

At least one email address must be verified to update this comment.

" - } - ] - }, - { - "name": "CommitContributionOrderField", - "id": "commitcontributionorderfield", - "href": "/graphql/reference/enums#commitcontributionorderfield", - "description": "

Properties by which commit contribution connections can be ordered.

", - "values": [ - { - "name": "COMMIT_COUNT", - "description": "

Order commit contributions by how many commits they represent.

" - }, - { - "name": "OCCURRED_AT", - "description": "

Order commit contributions by when they were made.

" - } - ] - }, - { - "name": "ComparisonStatus", - "id": "comparisonstatus", - "href": "/graphql/reference/enums#comparisonstatus", - "description": "

The status of a git comparison between two refs.

", - "values": [ - { - "name": "AHEAD", - "description": "

The head ref is ahead of the base ref.

" - }, - { - "name": "BEHIND", - "description": "

The head ref is behind the base ref.

" - }, - { - "name": "DIVERGED", - "description": "

The head ref is both ahead and behind of the base ref, indicating git history has diverged.

" - }, - { - "name": "IDENTICAL", - "description": "

The head ref and base ref are identical.

" - } - ] - }, - { - "name": "ContributionLevel", - "id": "contributionlevel", - "href": "/graphql/reference/enums#contributionlevel", - "description": "

Varying levels of contributions from none to many.

", - "values": [ - { - "name": "FIRST_QUARTILE", - "description": "

Lowest 25% of days of contributions.

" - }, - { - "name": "FOURTH_QUARTILE", - "description": "

Highest 25% of days of contributions. More contributions than the third quartile.

" - }, - { - "name": "NONE", - "description": "

No contributions occurred.

" - }, - { - "name": "SECOND_QUARTILE", - "description": "

Second lowest 25% of days of contributions. More contributions than the first quartile.

" - }, - { - "name": "THIRD_QUARTILE", - "description": "

Second highest 25% of days of contributions. More contributions than second quartile, less than the fourth quartile.

" - } - ] - }, - { - "name": "DefaultRepositoryPermissionField", - "id": "defaultrepositorypermissionfield", - "href": "/graphql/reference/enums#defaultrepositorypermissionfield", - "description": "

The possible base permissions for repositories.

", - "values": [ - { - "name": "ADMIN", - "description": "

Can read, write, and administrate repos by default.

" - }, - { - "name": "NONE", - "description": "

No access.

" - }, - { - "name": "READ", - "description": "

Can read repos by default.

" - }, - { - "name": "WRITE", - "description": "

Can read and write repos by default.

" - } - ] - }, - { - "name": "DeploymentOrderField", - "id": "deploymentorderfield", - "href": "/graphql/reference/enums#deploymentorderfield", - "description": "

Properties by which deployment connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order collection by creation time.

" - } - ] - }, - { - "name": "DeploymentProtectionRuleType", - "id": "deploymentprotectionruletype", - "href": "/graphql/reference/enums#deploymentprotectionruletype", - "description": "

The possible protection rule types.

", - "values": [ - { - "name": "BRANCH_POLICY", - "description": "

Branch policy.

" - }, - { - "name": "REQUIRED_REVIEWERS", - "description": "

Required reviewers.

" - }, - { - "name": "WAIT_TIMER", - "description": "

Wait timer.

" - } - ] - }, - { - "name": "DeploymentReviewState", - "id": "deploymentreviewstate", - "href": "/graphql/reference/enums#deploymentreviewstate", - "description": "

The possible states for a deployment review.

", - "values": [ - { - "name": "APPROVED", - "description": "

The deployment was approved.

" - }, - { - "name": "REJECTED", - "description": "

The deployment was rejected.

" - } - ] - }, - { - "name": "DeploymentState", - "id": "deploymentstate", - "href": "/graphql/reference/enums#deploymentstate", - "description": "

The possible states in which a deployment can be.

", - "values": [ - { - "name": "ABANDONED", - "description": "

The pending deployment was not updated after 30 minutes.

" - }, - { - "name": "ACTIVE", - "description": "

The deployment is currently active.

" - }, - { - "name": "DESTROYED", - "description": "

An inactive transient deployment.

" - }, - { - "name": "ERROR", - "description": "

The deployment experienced an error.

" - }, - { - "name": "FAILURE", - "description": "

The deployment has failed.

" - }, - { - "name": "INACTIVE", - "description": "

The deployment is inactive.

" - }, - { - "name": "IN_PROGRESS", - "description": "

The deployment is in progress.

" - }, - { - "name": "PENDING", - "description": "

The deployment is pending.

" - }, - { - "name": "QUEUED", - "description": "

The deployment has queued.

" - }, - { - "name": "SUCCESS", - "description": "

The deployment was successful.

" - }, - { - "name": "WAITING", - "description": "

The deployment is waiting.

" - } - ] - }, - { - "name": "DeploymentStatusState", - "id": "deploymentstatusstate", - "href": "/graphql/reference/enums#deploymentstatusstate", - "description": "

The possible states for a deployment status.

", - "values": [ - { - "name": "ERROR", - "description": "

The deployment experienced an error.

" - }, - { - "name": "FAILURE", - "description": "

The deployment has failed.

" - }, - { - "name": "INACTIVE", - "description": "

The deployment is inactive.

" - }, - { - "name": "IN_PROGRESS", - "description": "

The deployment is in progress.

" - }, - { - "name": "PENDING", - "description": "

The deployment is pending.

" - }, - { - "name": "QUEUED", - "description": "

The deployment is queued.

" - }, - { - "name": "SUCCESS", - "description": "

The deployment was successful.

" - }, - { - "name": "WAITING", - "description": "

The deployment is waiting.

" - } - ] - }, - { - "name": "DiffSide", - "id": "diffside", - "href": "/graphql/reference/enums#diffside", - "description": "

The possible sides of a diff.

", - "values": [ - { - "name": "LEFT", - "description": "

The left side of the diff.

" - }, - { - "name": "RIGHT", - "description": "

The right side of the diff.

" - } - ] - }, - { - "name": "DiscussionCloseReason", - "id": "discussionclosereason", - "href": "/graphql/reference/enums#discussionclosereason", - "description": "

The possible reasons for closing a discussion.

", - "values": [ - { - "name": "DUPLICATE", - "description": "

The discussion is a duplicate of another.

" - }, - { - "name": "OUTDATED", - "description": "

The discussion is no longer relevant.

" - }, - { - "name": "RESOLVED", - "description": "

The discussion has been resolved.

" - } - ] - }, - { - "name": "DiscussionOrderField", - "id": "discussionorderfield", - "href": "/graphql/reference/enums#discussionorderfield", - "description": "

Properties by which discussion connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order discussions by creation time.

" - }, - { - "name": "UPDATED_AT", - "description": "

Order discussions by most recent modification time.

" - } - ] - }, - { - "name": "DiscussionPollOptionOrderField", - "id": "discussionpolloptionorderfield", - "href": "/graphql/reference/enums#discussionpolloptionorderfield", - "description": "

Properties by which discussion poll option connections can be ordered.

", - "values": [ - { - "name": "AUTHORED_ORDER", - "description": "

Order poll options by the order that the poll author specified when creating the poll.

" - }, - { - "name": "VOTE_COUNT", - "description": "

Order poll options by the number of votes it has.

" - } - ] - }, - { - "name": "DiscussionState", - "id": "discussionstate", - "href": "/graphql/reference/enums#discussionstate", - "description": "

The possible states of a discussion.

", - "values": [ - { - "name": "CLOSED", - "description": "

A discussion that has been closed.

" - }, - { - "name": "OPEN", - "description": "

A discussion that is open.

" - } - ] - }, - { - "name": "DiscussionStateReason", - "id": "discussionstatereason", - "href": "/graphql/reference/enums#discussionstatereason", - "description": "

The possible state reasons of a discussion.

", - "values": [ - { - "name": "DUPLICATE", - "description": "

The discussion is a duplicate of another.

" - }, - { - "name": "OUTDATED", - "description": "

The discussion is no longer relevant.

" - }, - { - "name": "REOPENED", - "description": "

The discussion was reopened.

" - }, - { - "name": "RESOLVED", - "description": "

The discussion has been resolved.

" - } - ] - }, - { - "name": "DismissReason", - "id": "dismissreason", - "href": "/graphql/reference/enums#dismissreason", - "description": "

The possible reasons that a Dependabot alert was dismissed.

", - "values": [ - { - "name": "FIX_STARTED", - "description": "

A fix has already been started.

" - }, - { - "name": "INACCURATE", - "description": "

This alert is inaccurate or incorrect.

" - }, - { - "name": "NOT_USED", - "description": "

Vulnerable code is not actually used.

" - }, - { - "name": "NO_BANDWIDTH", - "description": "

No bandwidth to fix this.

" - }, - { - "name": "TOLERABLE_RISK", - "description": "

Risk is tolerable to this project.

" - } - ] - }, - { - "name": "EnterpriseAdministratorInvitationOrderField", - "id": "enterpriseadministratorinvitationorderfield", - "href": "/graphql/reference/enums#enterpriseadministratorinvitationorderfield", - "description": "

Properties by which enterprise administrator invitation connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order enterprise administrator member invitations by creation time.

" - } - ] - }, - { - "name": "EnterpriseAdministratorRole", - "id": "enterpriseadministratorrole", - "href": "/graphql/reference/enums#enterpriseadministratorrole", - "description": "

The possible administrator roles in an enterprise account.

", - "values": [ - { - "name": "BILLING_MANAGER", - "description": "

Represents a billing manager of the enterprise account.

" - }, - { - "name": "OWNER", - "description": "

Represents an owner of the enterprise account.

" - } - ] - }, - { - "name": "EnterpriseAllowPrivateRepositoryForkingPolicyValue", - "id": "enterpriseallowprivaterepositoryforkingpolicyvalue", - "href": "/graphql/reference/enums#enterpriseallowprivaterepositoryforkingpolicyvalue", - "description": "

The possible values for the enterprise allow private repository forking policy value.

", - "values": [ - { - "name": "ENTERPRISE_ORGANIZATIONS", - "description": "

Members can fork a repository to an organization within this enterprise.

" - }, - { - "name": "ENTERPRISE_ORGANIZATIONS_USER_ACCOUNTS", - "description": "

Members can fork a repository to their enterprise-managed user account or an organization inside this enterprise.

" - }, - { - "name": "EVERYWHERE", - "description": "

Members can fork a repository to their user account or an organization, either inside or outside of this enterprise.

" - }, - { - "name": "SAME_ORGANIZATION", - "description": "

Members can fork a repository only within the same organization (intra-org).

" - }, - { - "name": "SAME_ORGANIZATION_USER_ACCOUNTS", - "description": "

Members can fork a repository to their user account or within the same organization.

" - }, - { - "name": "USER_ACCOUNTS", - "description": "

Members can fork a repository to their user account.

" - } - ] - }, - { - "name": "EnterpriseDefaultRepositoryPermissionSettingValue", - "id": "enterprisedefaultrepositorypermissionsettingvalue", - "href": "/graphql/reference/enums#enterprisedefaultrepositorypermissionsettingvalue", - "description": "

The possible values for the enterprise base repository permission setting.

", - "values": [ - { - "name": "ADMIN", - "description": "

Organization members will be able to clone, pull, push, and add new collaborators to all organization repositories.

" - }, - { - "name": "NONE", - "description": "

Organization members will only be able to clone and pull public repositories.

" - }, - { - "name": "NO_POLICY", - "description": "

Organizations in the enterprise choose base repository permissions for their members.

" - }, - { - "name": "READ", - "description": "

Organization members will be able to clone and pull all organization repositories.

" - }, - { - "name": "WRITE", - "description": "

Organization members will be able to clone, pull, and push all organization repositories.

" - } - ] - }, - { - "name": "EnterpriseEnabledDisabledSettingValue", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue", - "description": "

The possible values for an enabled/disabled enterprise setting.

", - "values": [ - { - "name": "DISABLED", - "description": "

The setting is disabled for organizations in the enterprise.

" - }, - { - "name": "ENABLED", - "description": "

The setting is enabled for organizations in the enterprise.

" - }, - { - "name": "NO_POLICY", - "description": "

There is no policy set for organizations in the enterprise.

" - } - ] - }, - { - "name": "EnterpriseEnabledSettingValue", - "id": "enterpriseenabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenabledsettingvalue", - "description": "

The possible values for an enabled/no policy enterprise setting.

", - "values": [ - { - "name": "ENABLED", - "description": "

The setting is enabled for organizations in the enterprise.

" - }, - { - "name": "NO_POLICY", - "description": "

There is no policy set for organizations in the enterprise.

" - } - ] - }, - { - "name": "EnterpriseMemberOrderField", - "id": "enterprisememberorderfield", - "href": "/graphql/reference/enums#enterprisememberorderfield", - "description": "

Properties by which enterprise member connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order enterprise members by creation time.

" - }, - { - "name": "LOGIN", - "description": "

Order enterprise members by login.

" - } - ] - }, - { - "name": "EnterpriseMembersCanCreateRepositoriesSettingValue", - "id": "enterprisememberscancreaterepositoriessettingvalue", - "href": "/graphql/reference/enums#enterprisememberscancreaterepositoriessettingvalue", - "description": "

The possible values for the enterprise members can create repositories setting.

", - "values": [ - { - "name": "ALL", - "description": "

Members will be able to create public and private repositories.

" - }, - { - "name": "DISABLED", - "description": "

Members will not be able to create public or private repositories.

" - }, - { - "name": "NO_POLICY", - "description": "

Organization owners choose whether to allow members to create repositories.

" - }, - { - "name": "PRIVATE", - "description": "

Members will be able to create only private repositories.

" - }, - { - "name": "PUBLIC", - "description": "

Members will be able to create only public repositories.

" - } - ] - }, - { - "name": "EnterpriseMembersCanMakePurchasesSettingValue", - "id": "enterprisememberscanmakepurchasessettingvalue", - "href": "/graphql/reference/enums#enterprisememberscanmakepurchasessettingvalue", - "description": "

The possible values for the members can make purchases setting.

", - "values": [ - { - "name": "DISABLED", - "description": "

The setting is disabled for organizations in the enterprise.

" - }, - { - "name": "ENABLED", - "description": "

The setting is enabled for organizations in the enterprise.

" - } - ] - }, - { - "name": "EnterpriseMembershipType", - "id": "enterprisemembershiptype", - "href": "/graphql/reference/enums#enterprisemembershiptype", - "description": "

The possible values we have for filtering Platform::Objects::User#enterprises.

", - "values": [ - { - "name": "ADMIN", - "description": "

Returns all enterprises in which the user is an admin.

" - }, - { - "name": "ALL", - "description": "

Returns all enterprises in which the user is a member, admin, or billing manager.

" - }, - { - "name": "BILLING_MANAGER", - "description": "

Returns all enterprises in which the user is a billing manager.

" - }, - { - "name": "ORG_MEMBERSHIP", - "description": "

Returns all enterprises in which the user is a member of an org that is owned by the enterprise.

" - } - ] - }, - { - "name": "EnterpriseOrderField", - "id": "enterpriseorderfield", - "href": "/graphql/reference/enums#enterpriseorderfield", - "description": "

Properties by which enterprise connections can be ordered.

", - "values": [ - { - "name": "NAME", - "description": "

Order enterprises by name.

" - } - ] - }, - { - "name": "EnterpriseServerInstallationOrderField", - "id": "enterpriseserverinstallationorderfield", - "href": "/graphql/reference/enums#enterpriseserverinstallationorderfield", - "description": "

Properties by which Enterprise Server installation connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order Enterprise Server installations by creation time.

" - }, - { - "name": "CUSTOMER_NAME", - "description": "

Order Enterprise Server installations by customer name.

" - }, - { - "name": "HOST_NAME", - "description": "

Order Enterprise Server installations by host name.

" - } - ] - }, - { - "name": "EnterpriseServerUserAccountEmailOrderField", - "id": "enterpriseserveruseraccountemailorderfield", - "href": "/graphql/reference/enums#enterpriseserveruseraccountemailorderfield", - "description": "

Properties by which Enterprise Server user account email connections can be ordered.

", - "values": [ - { - "name": "EMAIL", - "description": "

Order emails by email.

" - } - ] - }, - { - "name": "EnterpriseServerUserAccountOrderField", - "id": "enterpriseserveruseraccountorderfield", - "href": "/graphql/reference/enums#enterpriseserveruseraccountorderfield", - "description": "

Properties by which Enterprise Server user account connections can be ordered.

", - "values": [ - { - "name": "LOGIN", - "description": "

Order user accounts by login.

" - }, - { - "name": "REMOTE_CREATED_AT", - "description": "

Order user accounts by creation time on the Enterprise Server installation.

" - } - ] - }, - { - "name": "EnterpriseServerUserAccountsUploadOrderField", - "id": "enterpriseserveruseraccountsuploadorderfield", - "href": "/graphql/reference/enums#enterpriseserveruseraccountsuploadorderfield", - "description": "

Properties by which Enterprise Server user accounts upload connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order user accounts uploads by creation time.

" - } - ] - }, - { - "name": "EnterpriseServerUserAccountsUploadSyncState", - "id": "enterpriseserveruseraccountsuploadsyncstate", - "href": "/graphql/reference/enums#enterpriseserveruseraccountsuploadsyncstate", - "description": "

Synchronization state of the Enterprise Server user accounts upload.

", - "values": [ - { - "name": "FAILURE", - "description": "

The synchronization of the upload failed.

" - }, - { - "name": "PENDING", - "description": "

The synchronization of the upload is pending.

" - }, - { - "name": "SUCCESS", - "description": "

The synchronization of the upload succeeded.

" - } - ] - }, - { - "name": "EnterpriseUserAccountMembershipRole", - "id": "enterpriseuseraccountmembershiprole", - "href": "/graphql/reference/enums#enterpriseuseraccountmembershiprole", - "description": "

The possible roles for enterprise membership.

", - "values": [ - { - "name": "MEMBER", - "description": "

The user is a member of an organization in the enterprise.

" - }, - { - "name": "OWNER", - "description": "

The user is an owner of an organization in the enterprise.

" - } - ] - }, - { - "name": "EnterpriseUserDeployment", - "id": "enterpriseuserdeployment", - "href": "/graphql/reference/enums#enterpriseuserdeployment", - "description": "

The possible GitHub Enterprise deployments where this user can exist.

", - "values": [ - { - "name": "CLOUD", - "description": "

The user is part of a GitHub Enterprise Cloud deployment.

" - }, - { - "name": "SERVER", - "description": "

The user is part of a GitHub Enterprise Server deployment.

" - } - ] - }, - { - "name": "EnvironmentOrderField", - "id": "environmentorderfield", - "href": "/graphql/reference/enums#environmentorderfield", - "description": "

Properties by which environments connections can be ordered.

", - "values": [ - { - "name": "NAME", - "description": "

Order environments by name.

" - } - ] - }, - { - "name": "EnvironmentPinnedFilterField", - "id": "environmentpinnedfilterfield", - "href": "/graphql/reference/enums#environmentpinnedfilterfield", - "description": "

Properties by which environments connections can be ordered.

", - "values": [ - { - "name": "ALL", - "description": "

All environments will be returned.

" - }, - { - "name": "NONE", - "description": "

Environments exclude pinned will be returned.

" - }, - { - "name": "ONLY", - "description": "

Only pinned environment will be returned.

" - } - ] - }, - { - "name": "FileViewedState", - "id": "fileviewedstate", - "href": "/graphql/reference/enums#fileviewedstate", - "description": "

The possible viewed states of a file .

", - "values": [ - { - "name": "DISMISSED", - "description": "

The file has new changes since last viewed.

" - }, - { - "name": "UNVIEWED", - "description": "

The file has not been marked as viewed.

" - }, - { - "name": "VIEWED", - "description": "

The file has been marked as viewed.

" - } - ] - }, - { - "name": "GistOrderField", - "id": "gistorderfield", - "href": "/graphql/reference/enums#gistorderfield", - "description": "

Properties by which gist connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order gists by creation time.

" - }, - { - "name": "PUSHED_AT", - "description": "

Order gists by push time.

" - }, - { - "name": "UPDATED_AT", - "description": "

Order gists by update time.

" - } - ] - }, - { - "name": "GistPrivacy", - "id": "gistprivacy", - "href": "/graphql/reference/enums#gistprivacy", - "description": "

The privacy of a Gist.

", - "values": [ - { - "name": "ALL", - "description": "

Gists that are public and secret.

" - }, - { - "name": "PUBLIC", - "description": "

Public.

" - }, - { - "name": "SECRET", - "description": "

Secret.

" - } - ] - }, - { - "name": "GitSignatureState", - "id": "gitsignaturestate", - "href": "/graphql/reference/enums#gitsignaturestate", - "description": "

The state of a Git signature.

", - "values": [ - { - "name": "BAD_CERT", - "description": "

The signing certificate or its chain could not be verified.

" - }, - { - "name": "BAD_EMAIL", - "description": "

Invalid email used for signing.

" - }, - { - "name": "EXPIRED_KEY", - "description": "

Signing key expired.

" - }, - { - "name": "GPGVERIFY_ERROR", - "description": "

Internal error - the GPG verification service misbehaved.

" - }, - { - "name": "GPGVERIFY_UNAVAILABLE", - "description": "

Internal error - the GPG verification service is unavailable at the moment.

" - }, - { - "name": "INVALID", - "description": "

Invalid signature.

" - }, - { - "name": "MALFORMED_SIG", - "description": "

Malformed signature.

" - }, - { - "name": "NOT_SIGNING_KEY", - "description": "

The usage flags for the key that signed this don't allow signing.

" - }, - { - "name": "NO_USER", - "description": "

Email used for signing not known to GitHub.

" - }, - { - "name": "OCSP_ERROR", - "description": "

Valid signature, though certificate revocation check failed.

" - }, - { - "name": "OCSP_PENDING", - "description": "

Valid signature, pending certificate revocation checking.

" - }, - { - "name": "OCSP_REVOKED", - "description": "

One or more certificates in chain has been revoked.

" - }, - { - "name": "UNKNOWN_KEY", - "description": "

Key used for signing not known to GitHub.

" - }, - { - "name": "UNKNOWN_SIG_TYPE", - "description": "

Unknown signature type.

" - }, - { - "name": "UNSIGNED", - "description": "

Unsigned.

" - }, - { - "name": "UNVERIFIED_EMAIL", - "description": "

Email used for signing unverified on GitHub.

" - }, - { - "name": "VALID", - "description": "

Valid signature and verified by GitHub.

" - } - ] - }, - { - "name": "IdentityProviderConfigurationState", - "id": "identityproviderconfigurationstate", - "href": "/graphql/reference/enums#identityproviderconfigurationstate", - "description": "

The possible states in which authentication can be configured with an identity provider.

", - "values": [ - { - "name": "CONFIGURED", - "description": "

Authentication with an identity provider is configured but not enforced.

" - }, - { - "name": "ENFORCED", - "description": "

Authentication with an identity provider is configured and enforced.

" - }, - { - "name": "UNCONFIGURED", - "description": "

Authentication with an identity provider is not configured.

" - } - ] - }, - { - "name": "IpAllowListEnabledSettingValue", - "id": "ipallowlistenabledsettingvalue", - "href": "/graphql/reference/enums#ipallowlistenabledsettingvalue", - "description": "

The possible values for the IP allow list enabled setting.

", - "values": [ - { - "name": "DISABLED", - "description": "

The setting is disabled for the owner.

" - }, - { - "name": "ENABLED", - "description": "

The setting is enabled for the owner.

" - } - ] - }, - { - "name": "IpAllowListEntryOrderField", - "id": "ipallowlistentryorderfield", - "href": "/graphql/reference/enums#ipallowlistentryorderfield", - "description": "

Properties by which IP allow list entry connections can be ordered.

", - "values": [ - { - "name": "ALLOW_LIST_VALUE", - "description": "

Order IP allow list entries by the allow list value.

" - }, - { - "name": "CREATED_AT", - "description": "

Order IP allow list entries by creation time.

" - } - ] - }, - { - "name": "IpAllowListForInstalledAppsEnabledSettingValue", - "id": "ipallowlistforinstalledappsenabledsettingvalue", - "href": "/graphql/reference/enums#ipallowlistforinstalledappsenabledsettingvalue", - "description": "

The possible values for the IP allow list configuration for installed GitHub Apps setting.

", - "values": [ - { - "name": "DISABLED", - "description": "

The setting is disabled for the owner.

" - }, - { - "name": "ENABLED", - "description": "

The setting is enabled for the owner.

" - } - ] - }, - { - "name": "IssueClosedStateReason", - "id": "issueclosedstatereason", - "href": "/graphql/reference/enums#issueclosedstatereason", - "description": "

The possible state reasons of a closed issue.

", - "values": [ - { - "name": "COMPLETED", - "description": "

An issue that has been closed as completed.

" - }, - { - "name": "NOT_PLANNED", - "description": "

An issue that has been closed as not planned.

" - } - ] - }, - { - "name": "IssueCommentOrderField", - "id": "issuecommentorderfield", - "href": "/graphql/reference/enums#issuecommentorderfield", - "description": "

Properties by which issue comment connections can be ordered.

", - "values": [ - { - "name": "UPDATED_AT", - "description": "

Order issue comments by update time.

" - } - ] - }, - { - "name": "IssueOrderField", - "id": "issueorderfield", - "href": "/graphql/reference/enums#issueorderfield", - "description": "

Properties by which issue connections can be ordered.

", - "values": [ - { - "name": "COMMENTS", - "description": "

Order issues by comment count.

" - }, - { - "name": "CREATED_AT", - "description": "

Order issues by creation time.

" - }, - { - "name": "UPDATED_AT", - "description": "

Order issues by update time.

" - } - ] - }, - { - "name": "IssueState", - "id": "issuestate", - "href": "/graphql/reference/enums#issuestate", - "description": "

The possible states of an issue.

", - "values": [ - { - "name": "CLOSED", - "description": "

An issue that has been closed.

" - }, - { - "name": "OPEN", - "description": "

An issue that is still open.

" - } - ] - }, - { - "name": "IssueStateReason", - "id": "issuestatereason", - "href": "/graphql/reference/enums#issuestatereason", - "description": "

The possible state reasons of an issue.

", - "values": [ - { - "name": "COMPLETED", - "description": "

An issue that has been closed as completed.

" - }, - { - "name": "NOT_PLANNED", - "description": "

An issue that has been closed as not planned.

" - }, - { - "name": "REOPENED", - "description": "

An issue that has been reopened.

" - } - ] - }, - { - "name": "IssueTimelineItemsItemType", - "id": "issuetimelineitemsitemtype", - "href": "/graphql/reference/enums#issuetimelineitemsitemtype", - "description": "

The possible item types found in a timeline.

", - "values": [ - { - "name": "ADDED_TO_PROJECT_EVENT", - "description": "

Represents aadded_to_projectevent on a given issue or pull request.

" - }, - { - "name": "ASSIGNED_EVENT", - "description": "

Represents anassignedevent on any assignable object.

" - }, - { - "name": "CLOSED_EVENT", - "description": "

Represents aclosedevent on any Closable.

" - }, - { - "name": "COMMENT_DELETED_EVENT", - "description": "

Represents acomment_deletedevent on a given issue or pull request.

" - }, - { - "name": "CONNECTED_EVENT", - "description": "

Represents aconnectedevent on a given issue or pull request.

" - }, - { - "name": "CONVERTED_NOTE_TO_ISSUE_EVENT", - "description": "

Represents aconverted_note_to_issueevent on a given issue or pull request.

" - }, - { - "name": "CONVERTED_TO_DISCUSSION_EVENT", - "description": "

Represents aconverted_to_discussionevent on a given issue.

" - }, - { - "name": "CROSS_REFERENCED_EVENT", - "description": "

Represents a mention made by one issue or pull request to another.

" - }, - { - "name": "DEMILESTONED_EVENT", - "description": "

Represents ademilestonedevent on a given issue or pull request.

" - }, - { - "name": "DISCONNECTED_EVENT", - "description": "

Represents adisconnectedevent on a given issue or pull request.

" - }, - { - "name": "ISSUE_COMMENT", - "description": "

Represents a comment on an Issue.

" - }, - { - "name": "LABELED_EVENT", - "description": "

Represents alabeledevent on a given issue or pull request.

" - }, - { - "name": "LOCKED_EVENT", - "description": "

Represents alockedevent on a given issue or pull request.

" - }, - { - "name": "MARKED_AS_DUPLICATE_EVENT", - "description": "

Represents amarked_as_duplicateevent on a given issue or pull request.

" - }, - { - "name": "MENTIONED_EVENT", - "description": "

Represents amentionedevent on a given issue or pull request.

" - }, - { - "name": "MILESTONED_EVENT", - "description": "

Represents amilestonedevent on a given issue or pull request.

" - }, - { - "name": "MOVED_COLUMNS_IN_PROJECT_EVENT", - "description": "

Represents amoved_columns_in_projectevent on a given issue or pull request.

" - }, - { - "name": "PINNED_EVENT", - "description": "

Represents apinnedevent on a given issue or pull request.

" - }, - { - "name": "REFERENCED_EVENT", - "description": "

Represents areferencedevent on a given ReferencedSubject.

" - }, - { - "name": "REMOVED_FROM_PROJECT_EVENT", - "description": "

Represents aremoved_from_projectevent on a given issue or pull request.

" - }, - { - "name": "RENAMED_TITLE_EVENT", - "description": "

Represents arenamedevent on a given issue or pull request.

" - }, - { - "name": "REOPENED_EVENT", - "description": "

Represents areopenedevent on any Closable.

" - }, - { - "name": "SUBSCRIBED_EVENT", - "description": "

Represents asubscribedevent on a given Subscribable.

" - }, - { - "name": "TRANSFERRED_EVENT", - "description": "

Represents atransferredevent on a given issue or pull request.

" - }, - { - "name": "UNASSIGNED_EVENT", - "description": "

Represents anunassignedevent on any assignable object.

" - }, - { - "name": "UNLABELED_EVENT", - "description": "

Represents anunlabeledevent on a given issue or pull request.

" - }, - { - "name": "UNLOCKED_EVENT", - "description": "

Represents anunlockedevent on a given issue or pull request.

" - }, - { - "name": "UNMARKED_AS_DUPLICATE_EVENT", - "description": "

Represents anunmarked_as_duplicateevent on a given issue or pull request.

" - }, - { - "name": "UNPINNED_EVENT", - "description": "

Represents anunpinnedevent on a given issue or pull request.

" - }, - { - "name": "UNSUBSCRIBED_EVENT", - "description": "

Represents anunsubscribedevent on a given Subscribable.

" - }, - { - "name": "USER_BLOCKED_EVENT", - "description": "

Represents auser_blockedevent on a given user.

" - } - ] - }, - { - "name": "LabelOrderField", - "id": "labelorderfield", - "href": "/graphql/reference/enums#labelorderfield", - "description": "

Properties by which label connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order labels by creation time.

" - }, - { - "name": "NAME", - "description": "

Order labels by name.

" - } - ] - }, - { - "name": "LanguageOrderField", - "id": "languageorderfield", - "href": "/graphql/reference/enums#languageorderfield", - "description": "

Properties by which language connections can be ordered.

", - "values": [ - { - "name": "SIZE", - "description": "

Order languages by the size of all files containing the language.

" - } - ] - }, - { - "name": "LockReason", - "id": "lockreason", - "href": "/graphql/reference/enums#lockreason", - "description": "

The possible reasons that an issue or pull request was locked.

", - "values": [ - { - "name": "OFF_TOPIC", - "description": "

The issue or pull request was locked because the conversation was off-topic.

" - }, - { - "name": "RESOLVED", - "description": "

The issue or pull request was locked because the conversation was resolved.

" - }, - { - "name": "SPAM", - "description": "

The issue or pull request was locked because the conversation was spam.

" - }, - { - "name": "TOO_HEATED", - "description": "

The issue or pull request was locked because the conversation was too heated.

" - } - ] - }, - { - "name": "MannequinOrderField", - "id": "mannequinorderfield", - "href": "/graphql/reference/enums#mannequinorderfield", - "description": "

Properties by which mannequins can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order mannequins why when they were created.

" - }, - { - "name": "LOGIN", - "description": "

Order mannequins alphabetically by their source login.

" - } - ] - }, - { - "name": "MergeCommitMessage", - "id": "mergecommitmessage", - "href": "/graphql/reference/enums#mergecommitmessage", - "description": "

The possible default commit messages for merges.

", - "values": [ - { - "name": "BLANK", - "description": "

Default to a blank commit message.

" - }, - { - "name": "PR_BODY", - "description": "

Default to the pull request's body.

" - }, - { - "name": "PR_TITLE", - "description": "

Default to the pull request's title.

" - } - ] - }, - { - "name": "MergeCommitTitle", - "id": "mergecommittitle", - "href": "/graphql/reference/enums#mergecommittitle", - "description": "

The possible default commit titles for merges.

", - "values": [ - { - "name": "MERGE_MESSAGE", - "description": "

Default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).

" - }, - { - "name": "PR_TITLE", - "description": "

Default to the pull request's title.

" - } - ] - }, - { - "name": "MergeQueueEntryState", - "id": "mergequeueentrystate", - "href": "/graphql/reference/enums#mergequeueentrystate", - "description": "

The possible states for a merge queue entry.

", - "values": [ - { - "name": "AWAITING_CHECKS", - "description": "

The entry is currently waiting for checks to pass.

" - }, - { - "name": "LOCKED", - "description": "

The entry is currently locked.

" - }, - { - "name": "MERGEABLE", - "description": "

The entry is currently mergeable.

" - }, - { - "name": "QUEUED", - "description": "

The entry is currently queued.

" - }, - { - "name": "UNMERGEABLE", - "description": "

The entry is currently unmergeable.

" - } - ] - }, - { - "name": "MergeQueueMergingStrategy", - "id": "mergequeuemergingstrategy", - "href": "/graphql/reference/enums#mergequeuemergingstrategy", - "description": "

The possible merging strategies for a merge queue.

", - "values": [ - { - "name": "ALLGREEN", - "description": "

Entries only allowed to merge if they are passing.

" - }, - { - "name": "HEADGREEN", - "description": "

Failing Entires are allowed to merge if they are with a passing entry.

" - } - ] - }, - { - "name": "MergeStateStatus", - "id": "mergestatestatus", - "href": "/graphql/reference/enums#mergestatestatus", - "description": "

Detailed status information about a pull request merge.

", - "values": [ - { - "name": "BEHIND", - "description": "

The head ref is out of date.

" - }, - { - "name": "BLOCKED", - "description": "

The merge is blocked.

" - }, - { - "name": "CLEAN", - "description": "

Mergeable and passing commit status.

" - }, - { - "name": "DIRTY", - "description": "

The merge commit cannot be cleanly created.

" - }, - { - "name": "DRAFT", - "description": "

The merge is blocked due to the pull request being a draft.

" - }, - { - "name": "HAS_HOOKS", - "description": "

Mergeable with passing commit status and pre-receive hooks.

" - }, - { - "name": "UNKNOWN", - "description": "

The state cannot currently be determined.

" - }, - { - "name": "UNSTABLE", - "description": "

Mergeable with non-passing commit status.

" - } - ] - }, - { - "name": "MergeableState", - "id": "mergeablestate", - "href": "/graphql/reference/enums#mergeablestate", - "description": "

Whether or not a PullRequest can be merged.

", - "values": [ - { - "name": "CONFLICTING", - "description": "

The pull request cannot be merged due to merge conflicts.

" - }, - { - "name": "MERGEABLE", - "description": "

The pull request can be merged.

" - }, - { - "name": "UNKNOWN", - "description": "

The mergeability of the pull request is still being calculated.

" - } - ] - }, - { - "name": "MigrationSourceType", - "id": "migrationsourcetype", - "href": "/graphql/reference/enums#migrationsourcetype", - "description": "

Represents the different GitHub Enterprise Importer (GEI) migration sources.

", - "values": [ - { - "name": "AZURE_DEVOPS", - "description": "

An Azure DevOps migration source.

" - }, - { - "name": "BITBUCKET_SERVER", - "description": "

A Bitbucket Server migration source.

" - }, - { - "name": "GITHUB_ARCHIVE", - "description": "

A GitHub Migration API source.

" - } - ] - }, - { - "name": "MigrationState", - "id": "migrationstate", - "href": "/graphql/reference/enums#migrationstate", - "description": "

The GitHub Enterprise Importer (GEI) migration state.

", - "values": [ - { - "name": "FAILED", - "description": "

The migration has failed.

" - }, - { - "name": "FAILED_VALIDATION", - "description": "

The migration has invalid credentials.

" - }, - { - "name": "IN_PROGRESS", - "description": "

The migration is in progress.

" - }, - { - "name": "NOT_STARTED", - "description": "

The migration has not started.

" - }, - { - "name": "PENDING_VALIDATION", - "description": "

The migration needs to have its credentials validated.

" - }, - { - "name": "QUEUED", - "description": "

The migration has been queued.

" - }, - { - "name": "SUCCEEDED", - "description": "

The migration has succeeded.

" - } - ] - }, - { - "name": "MilestoneOrderField", - "id": "milestoneorderfield", - "href": "/graphql/reference/enums#milestoneorderfield", - "description": "

Properties by which milestone connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order milestones by when they were created.

" - }, - { - "name": "DUE_DATE", - "description": "

Order milestones by when they are due.

" - }, - { - "name": "NUMBER", - "description": "

Order milestones by their number.

" - }, - { - "name": "UPDATED_AT", - "description": "

Order milestones by when they were last updated.

" - } - ] - }, - { - "name": "MilestoneState", - "id": "milestonestate", - "href": "/graphql/reference/enums#milestonestate", - "description": "

The possible states of a milestone.

", - "values": [ - { - "name": "CLOSED", - "description": "

A milestone that has been closed.

" - }, - { - "name": "OPEN", - "description": "

A milestone that is still open.

" - } - ] - }, - { - "name": "NotificationRestrictionSettingValue", - "id": "notificationrestrictionsettingvalue", - "href": "/graphql/reference/enums#notificationrestrictionsettingvalue", - "description": "

The possible values for the notification restriction setting.

", - "values": [ - { - "name": "DISABLED", - "description": "

The setting is disabled for the owner.

" - }, - { - "name": "ENABLED", - "description": "

The setting is enabled for the owner.

" - } - ] - }, - { - "name": "OauthApplicationCreateAuditEntryState", - "id": "oauthapplicationcreateauditentrystate", - "href": "/graphql/reference/enums#oauthapplicationcreateauditentrystate", - "description": "

The state of an OAuth application when it was created.

", - "values": [ - { - "name": "ACTIVE", - "description": "

The OAuth application was active and allowed to have OAuth Accesses.

" - }, - { - "name": "PENDING_DELETION", - "description": "

The OAuth application was in the process of being deleted.

" - }, - { - "name": "SUSPENDED", - "description": "

The OAuth application was suspended from generating OAuth Accesses due to abuse or security concerns.

" - } - ] - }, - { - "name": "OperationType", - "id": "operationtype", - "href": "/graphql/reference/enums#operationtype", - "description": "

The corresponding operation type for the action.

", - "values": [ - { - "name": "ACCESS", - "description": "

An existing resource was accessed.

" - }, - { - "name": "AUTHENTICATION", - "description": "

A resource performed an authentication event.

" - }, - { - "name": "CREATE", - "description": "

A new resource was created.

" - }, - { - "name": "MODIFY", - "description": "

An existing resource was modified.

" - }, - { - "name": "REMOVE", - "description": "

An existing resource was removed.

" - }, - { - "name": "RESTORE", - "description": "

An existing resource was restored.

" - }, - { - "name": "TRANSFER", - "description": "

An existing resource was transferred between multiple resources.

" - } - ] - }, - { - "name": "OrderDirection", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection", - "description": "

Possible directions in which to order a list of items when provided an orderBy argument.

", - "values": [ - { - "name": "ASC", - "description": "

Specifies an ascending order for a given orderBy argument.

" - }, - { - "name": "DESC", - "description": "

Specifies a descending order for a given orderBy argument.

" - } - ] - }, - { - "name": "OrgAddMemberAuditEntryPermission", - "id": "orgaddmemberauditentrypermission", - "href": "/graphql/reference/enums#orgaddmemberauditentrypermission", - "description": "

The permissions available to members on an Organization.

", - "values": [ - { - "name": "ADMIN", - "description": "

Can read, clone, push, and add collaborators to repositories.

" - }, - { - "name": "READ", - "description": "

Can read and clone repositories.

" - } - ] - }, - { - "name": "OrgCreateAuditEntryBillingPlan", - "id": "orgcreateauditentrybillingplan", - "href": "/graphql/reference/enums#orgcreateauditentrybillingplan", - "description": "

The billing plans available for organizations.

", - "values": [ - { - "name": "BUSINESS", - "description": "

Team Plan.

" - }, - { - "name": "BUSINESS_PLUS", - "description": "

Enterprise Cloud Plan.

" - }, - { - "name": "FREE", - "description": "

Free Plan.

" - }, - { - "name": "TIERED_PER_SEAT", - "description": "

Tiered Per Seat Plan.

" - }, - { - "name": "UNLIMITED", - "description": "

Legacy Unlimited Plan.

" - } - ] - }, - { - "name": "OrgEnterpriseOwnerOrderField", - "id": "orgenterpriseownerorderfield", - "href": "/graphql/reference/enums#orgenterpriseownerorderfield", - "description": "

Properties by which enterprise owners can be ordered.

", - "values": [ - { - "name": "LOGIN", - "description": "

Order enterprise owners by login.

" - } - ] - }, - { - "name": "OrgRemoveBillingManagerAuditEntryReason", - "id": "orgremovebillingmanagerauditentryreason", - "href": "/graphql/reference/enums#orgremovebillingmanagerauditentryreason", - "description": "

The reason a billing manager was removed from an Organization.

", - "values": [ - { - "name": "SAML_EXTERNAL_IDENTITY_MISSING", - "description": "

SAML external identity missing.

" - }, - { - "name": "SAML_SSO_ENFORCEMENT_REQUIRES_EXTERNAL_IDENTITY", - "description": "

SAML SSO enforcement requires an external identity.

" - }, - { - "name": "TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE", - "description": "

The organization required 2FA of its billing managers and this user did not have 2FA enabled.

" - } - ] - }, - { - "name": "OrgRemoveMemberAuditEntryMembershipType", - "id": "orgremovememberauditentrymembershiptype", - "href": "/graphql/reference/enums#orgremovememberauditentrymembershiptype", - "description": "

The type of membership a user has with an Organization.

", - "values": [ - { - "name": "ADMIN", - "description": "

Organization owners have full access and can change several settings,\nincluding the names of repositories that belong to the Organization and Owners\nteam membership. In addition, organization owners can delete the organization\nand all of its repositories.

" - }, - { - "name": "BILLING_MANAGER", - "description": "

A billing manager is a user who manages the billing settings for the Organization, such as updating payment information.

" - }, - { - "name": "DIRECT_MEMBER", - "description": "

A direct member is a user that is a member of the Organization.

" - }, - { - "name": "OUTSIDE_COLLABORATOR", - "description": "

An outside collaborator is a person who isn't explicitly a member of the\nOrganization, but who has Read, Write, or Admin permissions to one or more\nrepositories in the organization.

" - }, - { - "name": "SUSPENDED", - "description": "

A suspended member.

" - }, - { - "name": "UNAFFILIATED", - "description": "

An unaffiliated collaborator is a person who is not a member of the\nOrganization and does not have access to any repositories in the Organization.

" - } - ] - }, - { - "name": "OrgRemoveMemberAuditEntryReason", - "id": "orgremovememberauditentryreason", - "href": "/graphql/reference/enums#orgremovememberauditentryreason", - "description": "

The reason a member was removed from an Organization.

", - "values": [ - { - "name": "SAML_EXTERNAL_IDENTITY_MISSING", - "description": "

SAML external identity missing.

" - }, - { - "name": "SAML_SSO_ENFORCEMENT_REQUIRES_EXTERNAL_IDENTITY", - "description": "

SAML SSO enforcement requires an external identity.

" - }, - { - "name": "TWO_FACTOR_ACCOUNT_RECOVERY", - "description": "

User was removed from organization during account recovery.

" - }, - { - "name": "TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE", - "description": "

The organization required 2FA of its billing managers and this user did not have 2FA enabled.

" - }, - { - "name": "USER_ACCOUNT_DELETED", - "description": "

User account has been deleted.

" - } - ] - }, - { - "name": "OrgRemoveOutsideCollaboratorAuditEntryMembershipType", - "id": "orgremoveoutsidecollaboratorauditentrymembershiptype", - "href": "/graphql/reference/enums#orgremoveoutsidecollaboratorauditentrymembershiptype", - "description": "

The type of membership a user has with an Organization.

", - "values": [ - { - "name": "BILLING_MANAGER", - "description": "

A billing manager is a user who manages the billing settings for the Organization, such as updating payment information.

" - }, - { - "name": "OUTSIDE_COLLABORATOR", - "description": "

An outside collaborator is a person who isn't explicitly a member of the\nOrganization, but who has Read, Write, or Admin permissions to one or more\nrepositories in the organization.

" - }, - { - "name": "UNAFFILIATED", - "description": "

An unaffiliated collaborator is a person who is not a member of the\nOrganization and does not have access to any repositories in the organization.

" - } - ] - }, - { - "name": "OrgRemoveOutsideCollaboratorAuditEntryReason", - "id": "orgremoveoutsidecollaboratorauditentryreason", - "href": "/graphql/reference/enums#orgremoveoutsidecollaboratorauditentryreason", - "description": "

The reason an outside collaborator was removed from an Organization.

", - "values": [ - { - "name": "SAML_EXTERNAL_IDENTITY_MISSING", - "description": "

SAML external identity missing.

" - }, - { - "name": "TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE", - "description": "

The organization required 2FA of its billing managers and this user did not have 2FA enabled.

" - } - ] - }, - { - "name": "OrgUpdateDefaultRepositoryPermissionAuditEntryPermission", - "id": "orgupdatedefaultrepositorypermissionauditentrypermission", - "href": "/graphql/reference/enums#orgupdatedefaultrepositorypermissionauditentrypermission", - "description": "

The default permission a repository can have in an Organization.

", - "values": [ - { - "name": "ADMIN", - "description": "

Can read, clone, push, and add collaborators to repositories.

" - }, - { - "name": "NONE", - "description": "

No default permission value.

" - }, - { - "name": "READ", - "description": "

Can read and clone repositories.

" - }, - { - "name": "WRITE", - "description": "

Can read, clone and push to repositories.

" - } - ] - }, - { - "name": "OrgUpdateMemberAuditEntryPermission", - "id": "orgupdatememberauditentrypermission", - "href": "/graphql/reference/enums#orgupdatememberauditentrypermission", - "description": "

The permissions available to members on an Organization.

", - "values": [ - { - "name": "ADMIN", - "description": "

Can read, clone, push, and add collaborators to repositories.

" - }, - { - "name": "READ", - "description": "

Can read and clone repositories.

" - } - ] - }, - { - "name": "OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility", - "id": "orgupdatememberrepositorycreationpermissionauditentryvisibility", - "href": "/graphql/reference/enums#orgupdatememberrepositorycreationpermissionauditentryvisibility", - "description": "

The permissions available for repository creation on an Organization.

", - "values": [ - { - "name": "ALL", - "description": "

All organization members are restricted from creating any repositories.

" - }, - { - "name": "INTERNAL", - "description": "

All organization members are restricted from creating internal repositories.

" - }, - { - "name": "NONE", - "description": "

All organization members are allowed to create any repositories.

" - }, - { - "name": "PRIVATE", - "description": "

All organization members are restricted from creating private repositories.

" - }, - { - "name": "PRIVATE_INTERNAL", - "description": "

All organization members are restricted from creating private or internal repositories.

" - }, - { - "name": "PUBLIC", - "description": "

All organization members are restricted from creating public repositories.

" - }, - { - "name": "PUBLIC_INTERNAL", - "description": "

All organization members are restricted from creating public or internal repositories.

" - }, - { - "name": "PUBLIC_PRIVATE", - "description": "

All organization members are restricted from creating public or private repositories.

" - } - ] - }, - { - "name": "OrganizationInvitationRole", - "id": "organizationinvitationrole", - "href": "/graphql/reference/enums#organizationinvitationrole", - "description": "

The possible organization invitation roles.

", - "values": [ - { - "name": "ADMIN", - "description": "

The user is invited to be an admin of the organization.

" - }, - { - "name": "BILLING_MANAGER", - "description": "

The user is invited to be a billing manager of the organization.

" - }, - { - "name": "DIRECT_MEMBER", - "description": "

The user is invited to be a direct member of the organization.

" - }, - { - "name": "REINSTATE", - "description": "

The user's previous role will be reinstated.

" - } - ] - }, - { - "name": "OrganizationInvitationSource", - "id": "organizationinvitationsource", - "href": "/graphql/reference/enums#organizationinvitationsource", - "description": "

The possible organization invitation sources.

", - "values": [ - { - "name": "MEMBER", - "description": "

The invitation was created from the web interface or from API.

" - }, - { - "name": "SCIM", - "description": "

The invitation was created from SCIM.

" - }, - { - "name": "UNKNOWN", - "description": "

The invitation was sent before this feature was added.

" - } - ] - }, - { - "name": "OrganizationInvitationType", - "id": "organizationinvitationtype", - "href": "/graphql/reference/enums#organizationinvitationtype", - "description": "

The possible organization invitation types.

", - "values": [ - { - "name": "EMAIL", - "description": "

The invitation was to an email address.

" - }, - { - "name": "USER", - "description": "

The invitation was to an existing user.

" - } - ] - }, - { - "name": "OrganizationMemberRole", - "id": "organizationmemberrole", - "href": "/graphql/reference/enums#organizationmemberrole", - "description": "

The possible roles within an organization for its members.

", - "values": [ - { - "name": "ADMIN", - "description": "

The user is an administrator of the organization.

" - }, - { - "name": "MEMBER", - "description": "

The user is a member of the organization.

" - } - ] - }, - { - "name": "OrganizationMembersCanCreateRepositoriesSettingValue", - "id": "organizationmemberscancreaterepositoriessettingvalue", - "href": "/graphql/reference/enums#organizationmemberscancreaterepositoriessettingvalue", - "description": "

The possible values for the members can create repositories setting on an organization.

", - "values": [ - { - "name": "ALL", - "description": "

Members will be able to create public and private repositories.

" - }, - { - "name": "DISABLED", - "description": "

Members will not be able to create public or private repositories.

" - }, - { - "name": "INTERNAL", - "description": "

Members will be able to create only internal repositories.

" - }, - { - "name": "PRIVATE", - "description": "

Members will be able to create only private repositories.

" - } - ] - }, - { - "name": "OrganizationMigrationState", - "id": "organizationmigrationstate", - "href": "/graphql/reference/enums#organizationmigrationstate", - "description": "

The Octoshift Organization migration state.

", - "values": [ - { - "name": "FAILED", - "description": "

The Octoshift migration has failed.

" - }, - { - "name": "FAILED_VALIDATION", - "description": "

The Octoshift migration has invalid credentials.

" - }, - { - "name": "IN_PROGRESS", - "description": "

The Octoshift migration is in progress.

" - }, - { - "name": "NOT_STARTED", - "description": "

The Octoshift migration has not started.

" - }, - { - "name": "PENDING_VALIDATION", - "description": "

The Octoshift migration needs to have its credentials validated.

" - }, - { - "name": "POST_REPO_MIGRATION", - "description": "

The Octoshift migration is performing post repository migrations.

" - }, - { - "name": "PRE_REPO_MIGRATION", - "description": "

The Octoshift migration is performing pre repository migrations.

" - }, - { - "name": "QUEUED", - "description": "

The Octoshift migration has been queued.

" - }, - { - "name": "REPO_MIGRATION", - "description": "

The Octoshift org migration is performing repository migrations.

" - }, - { - "name": "SUCCEEDED", - "description": "

The Octoshift migration has succeeded.

" - } - ] - }, - { - "name": "OrganizationOrderField", - "id": "organizationorderfield", - "href": "/graphql/reference/enums#organizationorderfield", - "description": "

Properties by which organization connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order organizations by creation time.

" - }, - { - "name": "LOGIN", - "description": "

Order organizations by login.

" - } - ] - }, - { - "name": "PackageFileOrderField", - "id": "packagefileorderfield", - "href": "/graphql/reference/enums#packagefileorderfield", - "description": "

Properties by which package file connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order package files by creation time.

" - } - ] - }, - { - "name": "PackageOrderField", - "id": "packageorderfield", - "href": "/graphql/reference/enums#packageorderfield", - "description": "

Properties by which package connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order packages by creation time.

" - } - ] - }, - { - "name": "PackageType", - "id": "packagetype", - "href": "/graphql/reference/enums#packagetype", - "description": "

The possible types of a package.

", - "values": [ - { - "name": "DEBIAN", - "description": "

A debian package.

" - }, - { - "name": "DOCKER", - "description": "

A docker image.

" - }, - { - "name": "MAVEN", - "description": "

A maven package.

" - }, - { - "name": "NPM", - "description": "

An npm package.

" - }, - { - "name": "NUGET", - "description": "

A nuget package.

" - }, - { - "name": "PYPI", - "description": "

A python package.

" - }, - { - "name": "RUBYGEMS", - "description": "

A rubygems package.

" - } - ] - }, - { - "name": "PackageVersionOrderField", - "id": "packageversionorderfield", - "href": "/graphql/reference/enums#packageversionorderfield", - "description": "

Properties by which package version connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order package versions by creation time.

" - } - ] - }, - { - "name": "PatchStatus", - "id": "patchstatus", - "href": "/graphql/reference/enums#patchstatus", - "description": "

The possible types of patch statuses.

", - "values": [ - { - "name": "ADDED", - "description": "

The file was added. Git status 'A'.

" - }, - { - "name": "CHANGED", - "description": "

The file's type was changed. Git status 'T'.

" - }, - { - "name": "COPIED", - "description": "

The file was copied. Git status 'C'.

" - }, - { - "name": "DELETED", - "description": "

The file was deleted. Git status 'D'.

" - }, - { - "name": "MODIFIED", - "description": "

The file's contents were changed. Git status 'M'.

" - }, - { - "name": "RENAMED", - "description": "

The file was renamed. Git status 'R'.

" - } - ] - }, - { - "name": "PinnableItemType", - "id": "pinnableitemtype", - "href": "/graphql/reference/enums#pinnableitemtype", - "description": "

Represents items that can be pinned to a profile page or dashboard.

", - "values": [ - { - "name": "GIST", - "description": "

A gist.

" - }, - { - "name": "ISSUE", - "description": "

An issue.

" - }, - { - "name": "ORGANIZATION", - "description": "

An organization.

" - }, - { - "name": "PROJECT", - "description": "

A project.

" - }, - { - "name": "PULL_REQUEST", - "description": "

A pull request.

" - }, - { - "name": "REPOSITORY", - "description": "

A repository.

" - }, - { - "name": "TEAM", - "description": "

A team.

" - }, - { - "name": "USER", - "description": "

A user.

" - } - ] - }, - { - "name": "PinnedDiscussionGradient", - "id": "pinneddiscussiongradient", - "href": "/graphql/reference/enums#pinneddiscussiongradient", - "description": "

Preconfigured gradients that may be used to style discussions pinned within a repository.

", - "values": [ - { - "name": "BLUE_MINT", - "description": "

A gradient of blue to mint.

" - }, - { - "name": "BLUE_PURPLE", - "description": "

A gradient of blue to purple.

" - }, - { - "name": "PINK_BLUE", - "description": "

A gradient of pink to blue.

" - }, - { - "name": "PURPLE_CORAL", - "description": "

A gradient of purple to coral.

" - }, - { - "name": "RED_ORANGE", - "description": "

A gradient of red to orange.

" - } - ] - }, - { - "name": "PinnedDiscussionPattern", - "id": "pinneddiscussionpattern", - "href": "/graphql/reference/enums#pinneddiscussionpattern", - "description": "

Preconfigured background patterns that may be used to style discussions pinned within a repository.

", - "values": [ - { - "name": "CHEVRON_UP", - "description": "

An upward-facing chevron pattern.

" - }, - { - "name": "DOT", - "description": "

A hollow dot pattern.

" - }, - { - "name": "DOT_FILL", - "description": "

A solid dot pattern.

" - }, - { - "name": "HEART_FILL", - "description": "

A heart pattern.

" - }, - { - "name": "PLUS", - "description": "

A plus sign pattern.

" - }, - { - "name": "ZAP", - "description": "

A lightning bolt pattern.

" - } - ] - }, - { - "name": "PinnedEnvironmentOrderField", - "id": "pinnedenvironmentorderfield", - "href": "/graphql/reference/enums#pinnedenvironmentorderfield", - "description": "

Properties by which pinned environments connections can be ordered.

", - "values": [ - { - "name": "POSITION", - "description": "

Order pinned environments by position.

" - } - ] - }, - { - "name": "ProjectCardArchivedState", - "id": "projectcardarchivedstate", - "href": "/graphql/reference/enums#projectcardarchivedstate", - "description": "

The possible archived states of a project card.

", - "values": [ - { - "name": "ARCHIVED", - "description": "

A project card that is archived.

" - }, - { - "name": "NOT_ARCHIVED", - "description": "

A project card that is not archived.

" - } - ] - }, - { - "name": "ProjectCardState", - "id": "projectcardstate", - "href": "/graphql/reference/enums#projectcardstate", - "description": "

Various content states of a ProjectCard.

", - "values": [ - { - "name": "CONTENT_ONLY", - "description": "

The card has content only.

" - }, - { - "name": "NOTE_ONLY", - "description": "

The card has a note only.

" - }, - { - "name": "REDACTED", - "description": "

The card is redacted.

" - } - ] - }, - { - "name": "ProjectColumnPurpose", - "id": "projectcolumnpurpose", - "href": "/graphql/reference/enums#projectcolumnpurpose", - "description": "

The semantic purpose of the column - todo, in progress, or done.

", - "values": [ - { - "name": "DONE", - "description": "

The column contains cards which are complete.

" - }, - { - "name": "IN_PROGRESS", - "description": "

The column contains cards which are currently being worked on.

" - }, - { - "name": "TODO", - "description": "

The column contains cards still to be worked on.

" - } - ] - }, - { - "name": "ProjectOrderField", - "id": "projectorderfield", - "href": "/graphql/reference/enums#projectorderfield", - "description": "

Properties by which project connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order projects by creation time.

" - }, - { - "name": "NAME", - "description": "

Order projects by name.

" - }, - { - "name": "UPDATED_AT", - "description": "

Order projects by update time.

" - } - ] - }, - { - "name": "ProjectState", - "id": "projectstate", - "href": "/graphql/reference/enums#projectstate", - "description": "

State of the project; eitheropenor 'closed'.

", - "values": [ - { - "name": "CLOSED", - "description": "

The project is closed.

" - }, - { - "name": "OPEN", - "description": "

The project is open.

" - } - ] - }, - { - "name": "ProjectTemplate", - "id": "projecttemplate", - "href": "/graphql/reference/enums#projecttemplate", - "description": "

GitHub-provided templates for Projects.

", - "values": [ - { - "name": "AUTOMATED_KANBAN_V2", - "description": "

Create a board with v2 triggers to automatically move cards across To do, In progress and Done columns.

" - }, - { - "name": "AUTOMATED_REVIEWS_KANBAN", - "description": "

Create a board with triggers to automatically move cards across columns with review automation.

" - }, - { - "name": "BASIC_KANBAN", - "description": "

Create a board with columns for To do, In progress and Done.

" - }, - { - "name": "BUG_TRIAGE", - "description": "

Create a board to triage and prioritize bugs with To do, priority, and Done columns.

" - } - ] - }, - { - "name": "ProjectV2CustomFieldType", - "id": "projectv2customfieldtype", - "href": "/graphql/reference/enums#projectv2customfieldtype", - "description": "

The type of a project field.

", - "values": [ - { - "name": "DATE", - "description": "

Date.

" - }, - { - "name": "NUMBER", - "description": "

Number.

" - }, - { - "name": "SINGLE_SELECT", - "description": "

Single Select.

" - }, - { - "name": "TEXT", - "description": "

Text.

" - } - ] - }, - { - "name": "ProjectV2FieldOrderField", - "id": "projectv2fieldorderfield", - "href": "/graphql/reference/enums#projectv2fieldorderfield", - "description": "

Properties by which project v2 field connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order project v2 fields by creation time.

" - }, - { - "name": "NAME", - "description": "

Order project v2 fields by name.

" - }, - { - "name": "POSITION", - "description": "

Order project v2 fields by position.

" - } - ] - }, - { - "name": "ProjectV2FieldType", - "id": "projectv2fieldtype", - "href": "/graphql/reference/enums#projectv2fieldtype", - "description": "

The type of a project field.

", - "values": [ - { - "name": "ASSIGNEES", - "description": "

Assignees.

" - }, - { - "name": "DATE", - "description": "

Date.

" - }, - { - "name": "ITERATION", - "description": "

Iteration.

" - }, - { - "name": "LABELS", - "description": "

Labels.

" - }, - { - "name": "LINKED_PULL_REQUESTS", - "description": "

Linked Pull Requests.

" - }, - { - "name": "MILESTONE", - "description": "

Milestone.

" - }, - { - "name": "NUMBER", - "description": "

Number.

" - }, - { - "name": "REPOSITORY", - "description": "

Repository.

" - }, - { - "name": "REVIEWERS", - "description": "

Reviewers.

" - }, - { - "name": "SINGLE_SELECT", - "description": "

Single Select.

" - }, - { - "name": "TEXT", - "description": "

Text.

" - }, - { - "name": "TITLE", - "description": "

Title.

" - }, - { - "name": "TRACKED_BY", - "description": "

Tracked by.

" - }, - { - "name": "TRACKS", - "description": "

Tracks.

" - } - ] - }, - { - "name": "ProjectV2ItemFieldValueOrderField", - "id": "projectv2itemfieldvalueorderfield", - "href": "/graphql/reference/enums#projectv2itemfieldvalueorderfield", - "description": "

Properties by which project v2 item field value connections can be ordered.

", - "values": [ - { - "name": "POSITION", - "description": "

Order project v2 item field values by the their position in the project.

" - } - ] - }, - { - "name": "ProjectV2ItemOrderField", - "id": "projectv2itemorderfield", - "href": "/graphql/reference/enums#projectv2itemorderfield", - "description": "

Properties by which project v2 item connections can be ordered.

", - "values": [ - { - "name": "POSITION", - "description": "

Order project v2 items by the their position in the project.

" - } - ] - }, - { - "name": "ProjectV2ItemType", - "id": "projectv2itemtype", - "href": "/graphql/reference/enums#projectv2itemtype", - "description": "

The type of a project item.

", - "values": [ - { - "name": "DRAFT_ISSUE", - "description": "

Draft Issue.

" - }, - { - "name": "ISSUE", - "description": "

Issue.

" - }, - { - "name": "PULL_REQUEST", - "description": "

Pull Request.

" - }, - { - "name": "REDACTED", - "description": "

Redacted Item.

" - } - ] - }, - { - "name": "ProjectV2OrderField", - "id": "projectv2orderfield", - "href": "/graphql/reference/enums#projectv2orderfield", - "description": "

Properties by which projects can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

The project's date and time of creation.

" - }, - { - "name": "NUMBER", - "description": "

The project's number.

" - }, - { - "name": "TITLE", - "description": "

The project's title.

" - }, - { - "name": "UPDATED_AT", - "description": "

The project's date and time of update.

" - } - ] - }, - { - "name": "ProjectV2Roles", - "id": "projectv2roles", - "href": "/graphql/reference/enums#projectv2roles", - "description": "

The possible roles of a collaborator on a project.

", - "values": [ - { - "name": "ADMIN", - "description": "

The collaborator can view, edit, and maange the settings of the project.

" - }, - { - "name": "NONE", - "description": "

The collaborator has no direct access to the project.

" - }, - { - "name": "READER", - "description": "

The collaborator can view the project.

" - }, - { - "name": "WRITER", - "description": "

The collaborator can view and edit the project.

" - } - ] - }, - { - "name": "ProjectV2SingleSelectFieldOptionColor", - "id": "projectv2singleselectfieldoptioncolor", - "href": "/graphql/reference/enums#projectv2singleselectfieldoptioncolor", - "description": "

The display color of a single-select field option.

", - "values": [ - { - "name": "BLUE", - "description": "

BLUE.

" - }, - { - "name": "GRAY", - "description": "

GRAY.

" - }, - { - "name": "GREEN", - "description": "

GREEN.

" - }, - { - "name": "ORANGE", - "description": "

ORANGE.

" - }, - { - "name": "PINK", - "description": "

PINK.

" - }, - { - "name": "PURPLE", - "description": "

PURPLE.

" - }, - { - "name": "RED", - "description": "

RED.

" - }, - { - "name": "YELLOW", - "description": "

YELLOW.

" - } - ] - }, - { - "name": "ProjectV2ViewLayout", - "id": "projectv2viewlayout", - "href": "/graphql/reference/enums#projectv2viewlayout", - "description": "

The layout of a project v2 view.

", - "values": [ - { - "name": "BOARD_LAYOUT", - "description": "

Board layout.

" - }, - { - "name": "ROADMAP_LAYOUT", - "description": "

Roadmap layout.

" - }, - { - "name": "TABLE_LAYOUT", - "description": "

Table layout.

" - } - ] - }, - { - "name": "ProjectV2ViewOrderField", - "id": "projectv2vieworderfield", - "href": "/graphql/reference/enums#projectv2vieworderfield", - "description": "

Properties by which project v2 view connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order project v2 views by creation time.

" - }, - { - "name": "NAME", - "description": "

Order project v2 views by name.

" - }, - { - "name": "POSITION", - "description": "

Order project v2 views by position.

" - } - ] - }, - { - "name": "ProjectV2WorkflowsOrderField", - "id": "projectv2workflowsorderfield", - "href": "/graphql/reference/enums#projectv2workflowsorderfield", - "description": "

Properties by which project workflows can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

The date and time of the workflow creation.

" - }, - { - "name": "NAME", - "description": "

The name of the workflow.

" - }, - { - "name": "NUMBER", - "description": "

The number of the workflow.

" - }, - { - "name": "UPDATED_AT", - "description": "

The date and time of the workflow update.

" - } - ] - }, - { - "name": "PullRequestBranchUpdateMethod", - "id": "pullrequestbranchupdatemethod", - "href": "/graphql/reference/enums#pullrequestbranchupdatemethod", - "description": "

The possible methods for updating a pull request's head branch with the base branch.

", - "values": [ - { - "name": "MERGE", - "description": "

Update branch via merge.

" - }, - { - "name": "REBASE", - "description": "

Update branch via rebase.

" - } - ] - }, - { - "name": "PullRequestMergeMethod", - "id": "pullrequestmergemethod", - "href": "/graphql/reference/enums#pullrequestmergemethod", - "description": "

Represents available types of methods to use when merging a pull request.

", - "values": [ - { - "name": "MERGE", - "description": "

Add all commits from the head branch to the base branch with a merge commit.

" - }, - { - "name": "REBASE", - "description": "

Add all commits from the head branch onto the base branch individually.

" - }, - { - "name": "SQUASH", - "description": "

Combine all commits from the head branch into a single commit in the base branch.

" - } - ] - }, - { - "name": "PullRequestOrderField", - "id": "pullrequestorderfield", - "href": "/graphql/reference/enums#pullrequestorderfield", - "description": "

Properties by which pull_requests connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order pull_requests by creation time.

" - }, - { - "name": "UPDATED_AT", - "description": "

Order pull_requests by update time.

" - } - ] - }, - { - "name": "PullRequestReviewCommentState", - "id": "pullrequestreviewcommentstate", - "href": "/graphql/reference/enums#pullrequestreviewcommentstate", - "description": "

The possible states of a pull request review comment.

", - "values": [ - { - "name": "PENDING", - "description": "

A comment that is part of a pending review.

" - }, - { - "name": "SUBMITTED", - "description": "

A comment that is part of a submitted review.

" - } - ] - }, - { - "name": "PullRequestReviewDecision", - "id": "pullrequestreviewdecision", - "href": "/graphql/reference/enums#pullrequestreviewdecision", - "description": "

The review status of a pull request.

", - "values": [ - { - "name": "APPROVED", - "description": "

The pull request has received an approving review.

" - }, - { - "name": "CHANGES_REQUESTED", - "description": "

Changes have been requested on the pull request.

" - }, - { - "name": "REVIEW_REQUIRED", - "description": "

A review is required before the pull request can be merged.

" - } - ] - }, - { - "name": "PullRequestReviewEvent", - "id": "pullrequestreviewevent", - "href": "/graphql/reference/enums#pullrequestreviewevent", - "description": "

The possible events to perform on a pull request review.

", - "values": [ - { - "name": "APPROVE", - "description": "

Submit feedback and approve merging these changes.

" - }, - { - "name": "COMMENT", - "description": "

Submit general feedback without explicit approval.

" - }, - { - "name": "DISMISS", - "description": "

Dismiss review so it now longer effects merging.

" - }, - { - "name": "REQUEST_CHANGES", - "description": "

Submit feedback that must be addressed before merging.

" - } - ] - }, - { - "name": "PullRequestReviewState", - "id": "pullrequestreviewstate", - "href": "/graphql/reference/enums#pullrequestreviewstate", - "description": "

The possible states of a pull request review.

", - "values": [ - { - "name": "APPROVED", - "description": "

A review allowing the pull request to merge.

" - }, - { - "name": "CHANGES_REQUESTED", - "description": "

A review blocking the pull request from merging.

" - }, - { - "name": "COMMENTED", - "description": "

An informational review.

" - }, - { - "name": "DISMISSED", - "description": "

A review that has been dismissed.

" - }, - { - "name": "PENDING", - "description": "

A review that has not yet been submitted.

" - } - ] - }, - { - "name": "PullRequestReviewThreadSubjectType", - "id": "pullrequestreviewthreadsubjecttype", - "href": "/graphql/reference/enums#pullrequestreviewthreadsubjecttype", - "description": "

The possible subject types of a pull request review comment.

", - "values": [ - { - "name": "FILE", - "description": "

A comment that has been made against the file of a pull request.

" - }, - { - "name": "LINE", - "description": "

A comment that has been made against the line of a pull request.

" - } - ] - }, - { - "name": "PullRequestState", - "id": "pullrequeststate", - "href": "/graphql/reference/enums#pullrequeststate", - "description": "

The possible states of a pull request.

", - "values": [ - { - "name": "CLOSED", - "description": "

A pull request that has been closed without being merged.

" - }, - { - "name": "MERGED", - "description": "

A pull request that has been closed by being merged.

" - }, - { - "name": "OPEN", - "description": "

A pull request that is still open.

" - } - ] - }, - { - "name": "PullRequestTimelineItemsItemType", - "id": "pullrequesttimelineitemsitemtype", - "href": "/graphql/reference/enums#pullrequesttimelineitemsitemtype", - "description": "

The possible item types found in a timeline.

", - "values": [ - { - "name": "ADDED_TO_MERGE_QUEUE_EVENT", - "description": "

Represents anadded_to_merge_queueevent on a given pull request.

" - }, - { - "name": "ADDED_TO_PROJECT_EVENT", - "description": "

Represents aadded_to_projectevent on a given issue or pull request.

" - }, - { - "name": "ASSIGNED_EVENT", - "description": "

Represents anassignedevent on any assignable object.

" - }, - { - "name": "AUTOMATIC_BASE_CHANGE_FAILED_EVENT", - "description": "

Represents aautomatic_base_change_failedevent on a given pull request.

" - }, - { - "name": "AUTOMATIC_BASE_CHANGE_SUCCEEDED_EVENT", - "description": "

Represents aautomatic_base_change_succeededevent on a given pull request.

" - }, - { - "name": "AUTO_MERGE_DISABLED_EVENT", - "description": "

Represents aauto_merge_disabledevent on a given pull request.

" - }, - { - "name": "AUTO_MERGE_ENABLED_EVENT", - "description": "

Represents aauto_merge_enabledevent on a given pull request.

" - }, - { - "name": "AUTO_REBASE_ENABLED_EVENT", - "description": "

Represents aauto_rebase_enabledevent on a given pull request.

" - }, - { - "name": "AUTO_SQUASH_ENABLED_EVENT", - "description": "

Represents aauto_squash_enabledevent on a given pull request.

" - }, - { - "name": "BASE_REF_CHANGED_EVENT", - "description": "

Represents abase_ref_changedevent on a given issue or pull request.

" - }, - { - "name": "BASE_REF_DELETED_EVENT", - "description": "

Represents abase_ref_deletedevent on a given pull request.

" - }, - { - "name": "BASE_REF_FORCE_PUSHED_EVENT", - "description": "

Represents abase_ref_force_pushedevent on a given pull request.

" - }, - { - "name": "CLOSED_EVENT", - "description": "

Represents aclosedevent on any Closable.

" - }, - { - "name": "COMMENT_DELETED_EVENT", - "description": "

Represents acomment_deletedevent on a given issue or pull request.

" - }, - { - "name": "CONNECTED_EVENT", - "description": "

Represents aconnectedevent on a given issue or pull request.

" - }, - { - "name": "CONVERTED_NOTE_TO_ISSUE_EVENT", - "description": "

Represents aconverted_note_to_issueevent on a given issue or pull request.

" - }, - { - "name": "CONVERTED_TO_DISCUSSION_EVENT", - "description": "

Represents aconverted_to_discussionevent on a given issue.

" - }, - { - "name": "CONVERT_TO_DRAFT_EVENT", - "description": "

Represents aconvert_to_draftevent on a given pull request.

" - }, - { - "name": "CROSS_REFERENCED_EVENT", - "description": "

Represents a mention made by one issue or pull request to another.

" - }, - { - "name": "DEMILESTONED_EVENT", - "description": "

Represents ademilestonedevent on a given issue or pull request.

" - }, - { - "name": "DEPLOYED_EVENT", - "description": "

Represents adeployedevent on a given pull request.

" - }, - { - "name": "DEPLOYMENT_ENVIRONMENT_CHANGED_EVENT", - "description": "

Represents adeployment_environment_changedevent on a given pull request.

" - }, - { - "name": "DISCONNECTED_EVENT", - "description": "

Represents adisconnectedevent on a given issue or pull request.

" - }, - { - "name": "HEAD_REF_DELETED_EVENT", - "description": "

Represents ahead_ref_deletedevent on a given pull request.

" - }, - { - "name": "HEAD_REF_FORCE_PUSHED_EVENT", - "description": "

Represents ahead_ref_force_pushedevent on a given pull request.

" - }, - { - "name": "HEAD_REF_RESTORED_EVENT", - "description": "

Represents ahead_ref_restoredevent on a given pull request.

" - }, - { - "name": "ISSUE_COMMENT", - "description": "

Represents a comment on an Issue.

" - }, - { - "name": "LABELED_EVENT", - "description": "

Represents alabeledevent on a given issue or pull request.

" - }, - { - "name": "LOCKED_EVENT", - "description": "

Represents alockedevent on a given issue or pull request.

" - }, - { - "name": "MARKED_AS_DUPLICATE_EVENT", - "description": "

Represents amarked_as_duplicateevent on a given issue or pull request.

" - }, - { - "name": "MENTIONED_EVENT", - "description": "

Represents amentionedevent on a given issue or pull request.

" - }, - { - "name": "MERGED_EVENT", - "description": "

Represents amergedevent on a given pull request.

" - }, - { - "name": "MILESTONED_EVENT", - "description": "

Represents amilestonedevent on a given issue or pull request.

" - }, - { - "name": "MOVED_COLUMNS_IN_PROJECT_EVENT", - "description": "

Represents amoved_columns_in_projectevent on a given issue or pull request.

" - }, - { - "name": "PINNED_EVENT", - "description": "

Represents apinnedevent on a given issue or pull request.

" - }, - { - "name": "PULL_REQUEST_COMMIT", - "description": "

Represents a Git commit part of a pull request.

" - }, - { - "name": "PULL_REQUEST_COMMIT_COMMENT_THREAD", - "description": "

Represents a commit comment thread part of a pull request.

" - }, - { - "name": "PULL_REQUEST_REVIEW", - "description": "

A review object for a given pull request.

" - }, - { - "name": "PULL_REQUEST_REVIEW_THREAD", - "description": "

A threaded list of comments for a given pull request.

" - }, - { - "name": "PULL_REQUEST_REVISION_MARKER", - "description": "

Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.

" - }, - { - "name": "READY_FOR_REVIEW_EVENT", - "description": "

Represents aready_for_reviewevent on a given pull request.

" - }, - { - "name": "REFERENCED_EVENT", - "description": "

Represents areferencedevent on a given ReferencedSubject.

" - }, - { - "name": "REMOVED_FROM_MERGE_QUEUE_EVENT", - "description": "

Represents aremoved_from_merge_queueevent on a given pull request.

" - }, - { - "name": "REMOVED_FROM_PROJECT_EVENT", - "description": "

Represents aremoved_from_projectevent on a given issue or pull request.

" - }, - { - "name": "RENAMED_TITLE_EVENT", - "description": "

Represents arenamedevent on a given issue or pull request.

" - }, - { - "name": "REOPENED_EVENT", - "description": "

Represents areopenedevent on any Closable.

" - }, - { - "name": "REVIEW_DISMISSED_EVENT", - "description": "

Represents areview_dismissedevent on a given issue or pull request.

" - }, - { - "name": "REVIEW_REQUESTED_EVENT", - "description": "

Represents anreview_requestedevent on a given pull request.

" - }, - { - "name": "REVIEW_REQUEST_REMOVED_EVENT", - "description": "

Represents anreview_request_removedevent on a given pull request.

" - }, - { - "name": "SUBSCRIBED_EVENT", - "description": "

Represents asubscribedevent on a given Subscribable.

" - }, - { - "name": "TRANSFERRED_EVENT", - "description": "

Represents atransferredevent on a given issue or pull request.

" - }, - { - "name": "UNASSIGNED_EVENT", - "description": "

Represents anunassignedevent on any assignable object.

" - }, - { - "name": "UNLABELED_EVENT", - "description": "

Represents anunlabeledevent on a given issue or pull request.

" - }, - { - "name": "UNLOCKED_EVENT", - "description": "

Represents anunlockedevent on a given issue or pull request.

" - }, - { - "name": "UNMARKED_AS_DUPLICATE_EVENT", - "description": "

Represents anunmarked_as_duplicateevent on a given issue or pull request.

" - }, - { - "name": "UNPINNED_EVENT", - "description": "

Represents anunpinnedevent on a given issue or pull request.

" - }, - { - "name": "UNSUBSCRIBED_EVENT", - "description": "

Represents anunsubscribedevent on a given Subscribable.

" - }, - { - "name": "USER_BLOCKED_EVENT", - "description": "

Represents auser_blockedevent on a given user.

" - } - ] - }, - { - "name": "PullRequestUpdateState", - "id": "pullrequestupdatestate", - "href": "/graphql/reference/enums#pullrequestupdatestate", - "description": "

The possible target states when updating a pull request.

", - "values": [ - { - "name": "CLOSED", - "description": "

A pull request that has been closed without being merged.

" - }, - { - "name": "OPEN", - "description": "

A pull request that is still open.

" - } - ] - }, - { - "name": "ReactionContent", - "id": "reactioncontent", - "href": "/graphql/reference/enums#reactioncontent", - "description": "

Emojis that can be attached to Issues, Pull Requests and Comments.

", - "values": [ - { - "name": "CONFUSED", - "description": "

Represents the :confused: emoji.

" - }, - { - "name": "EYES", - "description": "

Represents the :eyes: emoji.

" - }, - { - "name": "HEART", - "description": "

Represents the :heart: emoji.

" - }, - { - "name": "HOORAY", - "description": "

Represents the :hooray: emoji.

" - }, - { - "name": "LAUGH", - "description": "

Represents the :laugh: emoji.

" - }, - { - "name": "ROCKET", - "description": "

Represents the :rocket: emoji.

" - }, - { - "name": "THUMBS_DOWN", - "description": "

Represents the :-1: emoji.

" - }, - { - "name": "THUMBS_UP", - "description": "

Represents the :+1: emoji.

" - } - ] - }, - { - "name": "ReactionOrderField", - "id": "reactionorderfield", - "href": "/graphql/reference/enums#reactionorderfield", - "description": "

A list of fields that reactions can be ordered by.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Allows ordering a list of reactions by when they were created.

" - } - ] - }, - { - "name": "RefOrderField", - "id": "reforderfield", - "href": "/graphql/reference/enums#reforderfield", - "description": "

Properties by which ref connections can be ordered.

", - "values": [ - { - "name": "ALPHABETICAL", - "description": "

Order refs by their alphanumeric name.

" - }, - { - "name": "TAG_COMMIT_DATE", - "description": "

Order refs by underlying commit date if the ref prefix is refs/tags/.

" - } - ] - }, - { - "name": "ReleaseOrderField", - "id": "releaseorderfield", - "href": "/graphql/reference/enums#releaseorderfield", - "description": "

Properties by which release connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order releases by creation time.

" - }, - { - "name": "NAME", - "description": "

Order releases alphabetically by name.

" - } - ] - }, - { - "name": "RepoAccessAuditEntryVisibility", - "id": "repoaccessauditentryvisibility", - "href": "/graphql/reference/enums#repoaccessauditentryvisibility", - "description": "

The privacy of a repository.

", - "values": [ - { - "name": "INTERNAL", - "description": "

The repository is visible only to users in the same business.

" - }, - { - "name": "PRIVATE", - "description": "

The repository is visible only to those with explicit access.

" - }, - { - "name": "PUBLIC", - "description": "

The repository is visible to everyone.

" - } - ] - }, - { - "name": "RepoAddMemberAuditEntryVisibility", - "id": "repoaddmemberauditentryvisibility", - "href": "/graphql/reference/enums#repoaddmemberauditentryvisibility", - "description": "

The privacy of a repository.

", - "values": [ - { - "name": "INTERNAL", - "description": "

The repository is visible only to users in the same business.

" - }, - { - "name": "PRIVATE", - "description": "

The repository is visible only to those with explicit access.

" - }, - { - "name": "PUBLIC", - "description": "

The repository is visible to everyone.

" - } - ] - }, - { - "name": "RepoArchivedAuditEntryVisibility", - "id": "repoarchivedauditentryvisibility", - "href": "/graphql/reference/enums#repoarchivedauditentryvisibility", - "description": "

The privacy of a repository.

", - "values": [ - { - "name": "INTERNAL", - "description": "

The repository is visible only to users in the same business.

" - }, - { - "name": "PRIVATE", - "description": "

The repository is visible only to those with explicit access.

" - }, - { - "name": "PUBLIC", - "description": "

The repository is visible to everyone.

" - } - ] - }, - { - "name": "RepoChangeMergeSettingAuditEntryMergeType", - "id": "repochangemergesettingauditentrymergetype", - "href": "/graphql/reference/enums#repochangemergesettingauditentrymergetype", - "description": "

The merge options available for pull requests to this repository.

", - "values": [ - { - "name": "MERGE", - "description": "

The pull request is added to the base branch in a merge commit.

" - }, - { - "name": "REBASE", - "description": "

Commits from the pull request are added onto the base branch individually without a merge commit.

" - }, - { - "name": "SQUASH", - "description": "

The pull request's commits are squashed into a single commit before they are merged to the base branch.

" - } - ] - }, - { - "name": "RepoCreateAuditEntryVisibility", - "id": "repocreateauditentryvisibility", - "href": "/graphql/reference/enums#repocreateauditentryvisibility", - "description": "

The privacy of a repository.

", - "values": [ - { - "name": "INTERNAL", - "description": "

The repository is visible only to users in the same business.

" - }, - { - "name": "PRIVATE", - "description": "

The repository is visible only to those with explicit access.

" - }, - { - "name": "PUBLIC", - "description": "

The repository is visible to everyone.

" - } - ] - }, - { - "name": "RepoDestroyAuditEntryVisibility", - "id": "repodestroyauditentryvisibility", - "href": "/graphql/reference/enums#repodestroyauditentryvisibility", - "description": "

The privacy of a repository.

", - "values": [ - { - "name": "INTERNAL", - "description": "

The repository is visible only to users in the same business.

" - }, - { - "name": "PRIVATE", - "description": "

The repository is visible only to those with explicit access.

" - }, - { - "name": "PUBLIC", - "description": "

The repository is visible to everyone.

" - } - ] - }, - { - "name": "RepoRemoveMemberAuditEntryVisibility", - "id": "reporemovememberauditentryvisibility", - "href": "/graphql/reference/enums#reporemovememberauditentryvisibility", - "description": "

The privacy of a repository.

", - "values": [ - { - "name": "INTERNAL", - "description": "

The repository is visible only to users in the same business.

" - }, - { - "name": "PRIVATE", - "description": "

The repository is visible only to those with explicit access.

" - }, - { - "name": "PUBLIC", - "description": "

The repository is visible to everyone.

" - } - ] - }, - { - "name": "ReportedContentClassifiers", - "id": "reportedcontentclassifiers", - "href": "/graphql/reference/enums#reportedcontentclassifiers", - "description": "

The reasons a piece of content can be reported or minimized.

", - "values": [ - { - "name": "DUPLICATE", - "description": "

A duplicated piece of content.

" - }, - { - "name": "OFF_TOPIC", - "description": "

An irrelevant piece of content.

" - }, - { - "name": "OUTDATED", - "description": "

An outdated piece of content.

" - }, - { - "name": "RESOLVED", - "description": "

The content has been resolved.

" - } - ] - }, - { - "name": "RepositoryAffiliation", - "id": "repositoryaffiliation", - "href": "/graphql/reference/enums#repositoryaffiliation", - "description": "

The affiliation of a user to a repository.

", - "values": [ - { - "name": "COLLABORATOR", - "description": "

Repositories that the user has been added to as a collaborator.

" - }, - { - "name": "ORGANIZATION_MEMBER", - "description": "

Repositories that the user has access to through being a member of an\norganization. This includes every repository on every team that the user is on.

" - }, - { - "name": "OWNER", - "description": "

Repositories that are owned by the authenticated user.

" - } - ] - }, - { - "name": "RepositoryContributionType", - "id": "repositorycontributiontype", - "href": "/graphql/reference/enums#repositorycontributiontype", - "description": "

The reason a repository is listed as 'contributed'.

", - "values": [ - { - "name": "COMMIT", - "description": "

Created a commit.

" - }, - { - "name": "ISSUE", - "description": "

Created an issue.

" - }, - { - "name": "PULL_REQUEST", - "description": "

Created a pull request.

" - }, - { - "name": "PULL_REQUEST_REVIEW", - "description": "

Reviewed a pull request.

" - }, - { - "name": "REPOSITORY", - "description": "

Created the repository.

" - } - ] - }, - { - "name": "RepositoryInvitationOrderField", - "id": "repositoryinvitationorderfield", - "href": "/graphql/reference/enums#repositoryinvitationorderfield", - "description": "

Properties by which repository invitation connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order repository invitations by creation time.

" - } - ] - }, - { - "name": "RepositoryLockReason", - "id": "repositorylockreason", - "href": "/graphql/reference/enums#repositorylockreason", - "description": "

The possible reasons a given repository could be in a locked state.

", - "values": [ - { - "name": "BILLING", - "description": "

The repository is locked due to a billing related reason.

" - }, - { - "name": "MIGRATING", - "description": "

The repository is locked due to a migration.

" - }, - { - "name": "MOVING", - "description": "

The repository is locked due to a move.

" - }, - { - "name": "RENAME", - "description": "

The repository is locked due to a rename.

" - }, - { - "name": "TRADE_RESTRICTION", - "description": "

The repository is locked due to a trade controls related reason.

" - }, - { - "name": "TRANSFERRING_OWNERSHIP", - "description": "

The repository is locked due to an ownership transfer.

" - } - ] - }, - { - "name": "RepositoryMigrationOrderDirection", - "id": "repositorymigrationorderdirection", - "href": "/graphql/reference/enums#repositorymigrationorderdirection", - "description": "

Possible directions in which to order a list of repository migrations when provided an orderBy argument.

", - "values": [ - { - "name": "ASC", - "description": "

Specifies an ascending order for a given orderBy argument.

" - }, - { - "name": "DESC", - "description": "

Specifies a descending order for a given orderBy argument.

" - } - ] - }, - { - "name": "RepositoryMigrationOrderField", - "id": "repositorymigrationorderfield", - "href": "/graphql/reference/enums#repositorymigrationorderfield", - "description": "

Properties by which repository migrations can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order mannequins why when they were created.

" - } - ] - }, - { - "name": "RepositoryOrderField", - "id": "repositoryorderfield", - "href": "/graphql/reference/enums#repositoryorderfield", - "description": "

Properties by which repository connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order repositories by creation time.

" - }, - { - "name": "NAME", - "description": "

Order repositories by name.

" - }, - { - "name": "PUSHED_AT", - "description": "

Order repositories by push time.

" - }, - { - "name": "STARGAZERS", - "description": "

Order repositories by number of stargazers.

" - }, - { - "name": "UPDATED_AT", - "description": "

Order repositories by update time.

" - } - ] - }, - { - "name": "RepositoryPermission", - "id": "repositorypermission", - "href": "/graphql/reference/enums#repositorypermission", - "description": "

The access level to a repository.

", - "values": [ - { - "name": "ADMIN", - "description": "

Can read, clone, and push to this repository. Can also manage issues, pull\nrequests, and repository settings, including adding collaborators.

" - }, - { - "name": "MAINTAIN", - "description": "

Can read, clone, and push to this repository. They can also manage issues, pull requests, and some repository settings.

" - }, - { - "name": "READ", - "description": "

Can read and clone this repository. Can also open and comment on issues and pull requests.

" - }, - { - "name": "TRIAGE", - "description": "

Can read and clone this repository. Can also manage issues and pull requests.

" - }, - { - "name": "WRITE", - "description": "

Can read, clone, and push to this repository. Can also manage issues and pull requests.

" - } - ] - }, - { - "name": "RepositoryPrivacy", - "id": "repositoryprivacy", - "href": "/graphql/reference/enums#repositoryprivacy", - "description": "

The privacy of a repository.

", - "values": [ - { - "name": "PRIVATE", - "description": "

Private.

" - }, - { - "name": "PUBLIC", - "description": "

Public.

" - } - ] - }, - { - "name": "RepositoryRuleOrderField", - "id": "repositoryruleorderfield", - "href": "/graphql/reference/enums#repositoryruleorderfield", - "description": "

Properties by which repository rule connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order repository rules by created time.

" - }, - { - "name": "TYPE", - "description": "

Order repository rules by type.

" - }, - { - "name": "UPDATED_AT", - "description": "

Order repository rules by updated time.

" - } - ] - }, - { - "name": "RepositoryRuleType", - "id": "repositoryruletype", - "href": "/graphql/reference/enums#repositoryruletype", - "description": "

The rule types supported in rulesets.

", - "values": [ - { - "name": "AUTHORIZATION", - "description": "

Authorization.

" - }, - { - "name": "BRANCH_NAME_PATTERN", - "description": "

Branch name pattern.

" - }, - { - "name": "CODE_SCANNING", - "description": "

Choose which tools must provide code scanning results before the reference is\nupdated. When configured, code scanning must be enabled and have results for\nboth the commit and the reference being updated.

" - }, - { - "name": "COMMITTER_EMAIL_PATTERN", - "description": "

Committer email pattern.

" - }, - { - "name": "COMMIT_AUTHOR_EMAIL_PATTERN", - "description": "

Commit author email pattern.

" - }, - { - "name": "COMMIT_MESSAGE_PATTERN", - "description": "

Commit message pattern.

" - }, - { - "name": "CREATION", - "description": "

Only allow users with bypass permission to create matching refs.

" - }, - { - "name": "DELETION", - "description": "

Only allow users with bypass permissions to delete matching refs.

" - }, - { - "name": "FILE_EXTENSION_RESTRICTION", - "description": "

Prevent commits that include files with specified file extensions from being\npushed to the commit graph. NOTE: Thie rule is in beta and subject to change.

" - }, - { - "name": "FILE_PATH_RESTRICTION", - "description": "

Prevent commits that include changes in specified file paths from being pushed\nto the commit graph. NOTE: Thie rule is in beta and subject to change.

" - }, - { - "name": "LOCK_BRANCH", - "description": "

Branch is read-only. Users cannot push to the branch.

" - }, - { - "name": "MAX_FILE_PATH_LENGTH", - "description": "

Prevent commits that include file paths that exceed a specified character\nlimit from being pushed to the commit graph. NOTE: Thie rule is in beta and\nsubject to change.

" - }, - { - "name": "MAX_FILE_SIZE", - "description": "

Prevent commits that exceed a specified file size limit from being pushed to\nthe commit. NOTE: Thie rule is in beta and subject to change.

" - }, - { - "name": "MAX_REF_UPDATES", - "description": "

Max ref updates.

" - }, - { - "name": "MERGE_QUEUE", - "description": "

Merges must be performed via a merge queue.

" - }, - { - "name": "MERGE_QUEUE_LOCKED_REF", - "description": "

Merge queue locked ref.

" - }, - { - "name": "NON_FAST_FORWARD", - "description": "

Prevent users with push access from force pushing to refs.

" - }, - { - "name": "PULL_REQUEST", - "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

" - }, - { - "name": "REQUIRED_DEPLOYMENTS", - "description": "

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

" - }, - { - "name": "REQUIRED_LINEAR_HISTORY", - "description": "

Prevent merge commits from being pushed to matching refs.

" - }, - { - "name": "REQUIRED_REVIEW_THREAD_RESOLUTION", - "description": "

When enabled, all conversations on code must be resolved before a pull request\ncan be merged into a branch that matches this rule.

" - }, - { - "name": "REQUIRED_SIGNATURES", - "description": "

Commits pushed to matching refs must have verified signatures.

" - }, - { - "name": "REQUIRED_STATUS_CHECKS", - "description": "

Choose which status checks must pass before the ref is updated. When enabled,\ncommits must first be pushed to another ref where the checks pass.

" - }, - { - "name": "REQUIRED_WORKFLOW_STATUS_CHECKS", - "description": "

Require all commits be made to a non-target branch and submitted via a pull\nrequest and required workflow checks to pass before they can be merged.

" - }, - { - "name": "SECRET_SCANNING", - "description": "

Secret scanning.

" - }, - { - "name": "TAG", - "description": "

Tag.

" - }, - { - "name": "TAG_NAME_PATTERN", - "description": "

Tag name pattern.

" - }, - { - "name": "UPDATE", - "description": "

Only allow users with bypass permission to update matching refs.

" - }, - { - "name": "WORKFLOWS", - "description": "

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

" - }, - { - "name": "WORKFLOW_UPDATES", - "description": "

Workflow files cannot be modified.

" - } - ] - }, - { - "name": "RepositoryRulesetBypassActorBypassMode", - "id": "repositoryrulesetbypassactorbypassmode", - "href": "/graphql/reference/enums#repositoryrulesetbypassactorbypassmode", - "description": "

The bypass mode for a specific actor on a ruleset.

", - "values": [ - { - "name": "ALWAYS", - "description": "

The actor can always bypass rules.

" - }, - { - "name": "PULL_REQUEST", - "description": "

The actor can only bypass rules via a pull request.

" - } - ] - }, - { - "name": "RepositoryRulesetTarget", - "id": "repositoryrulesettarget", - "href": "/graphql/reference/enums#repositoryrulesettarget", - "description": "

The targets supported for rulesets. NOTE: The push target is in beta and subject to change.

", - "values": [ - { - "name": "BRANCH", - "description": "

Branch.

" - }, - { - "name": "PUSH", - "description": "

Push.

" - }, - { - "name": "TAG", - "description": "

Tag.

" - } - ] - }, - { - "name": "RepositoryVisibility", - "id": "repositoryvisibility", - "href": "/graphql/reference/enums#repositoryvisibility", - "description": "

The repository's visibility level.

", - "values": [ - { - "name": "INTERNAL", - "description": "

The repository is visible only to users in the same business.

" - }, - { - "name": "PRIVATE", - "description": "

The repository is visible only to those with explicit access.

" - }, - { - "name": "PUBLIC", - "description": "

The repository is visible to everyone.

" - } - ] - }, - { - "name": "RepositoryVulnerabilityAlertDependencyScope", - "id": "repositoryvulnerabilityalertdependencyscope", - "href": "/graphql/reference/enums#repositoryvulnerabilityalertdependencyscope", - "description": "

The possible scopes of an alert's dependency.

", - "values": [ - { - "name": "DEVELOPMENT", - "description": "

A dependency that is only used in development.

" - }, - { - "name": "RUNTIME", - "description": "

A dependency that is leveraged during application runtime.

" - } - ] - }, - { - "name": "RepositoryVulnerabilityAlertState", - "id": "repositoryvulnerabilityalertstate", - "href": "/graphql/reference/enums#repositoryvulnerabilityalertstate", - "description": "

The possible states of an alert.

", - "values": [ - { - "name": "AUTO_DISMISSED", - "description": "

An alert that has been automatically closed by Dependabot.

" - }, - { - "name": "DISMISSED", - "description": "

An alert that has been manually closed by a user.

" - }, - { - "name": "FIXED", - "description": "

An alert that has been resolved by a code change.

" - }, - { - "name": "OPEN", - "description": "

An alert that is still open.

" - } - ] - }, - { - "name": "RequestableCheckStatusState", - "id": "requestablecheckstatusstate", - "href": "/graphql/reference/enums#requestablecheckstatusstate", - "description": "

The possible states that can be requested when creating a check run.

", - "values": [ - { - "name": "COMPLETED", - "description": "

The check suite or run has been completed.

" - }, - { - "name": "IN_PROGRESS", - "description": "

The check suite or run is in progress.

" - }, - { - "name": "PENDING", - "description": "

The check suite or run is in pending state.

" - }, - { - "name": "QUEUED", - "description": "

The check suite or run has been queued.

" - }, - { - "name": "WAITING", - "description": "

The check suite or run is in waiting state.

" - } - ] - }, - { - "name": "RoleInOrganization", - "id": "roleinorganization", - "href": "/graphql/reference/enums#roleinorganization", - "description": "

Possible roles a user may have in relation to an organization.

", - "values": [ - { - "name": "DIRECT_MEMBER", - "description": "

A user who is a direct member of the organization.

" - }, - { - "name": "OWNER", - "description": "

A user with full administrative access to the organization.

" - }, - { - "name": "UNAFFILIATED", - "description": "

A user who is unaffiliated with the organization.

" - } - ] - }, - { - "name": "RuleEnforcement", - "id": "ruleenforcement", - "href": "/graphql/reference/enums#ruleenforcement", - "description": "

The level of enforcement for a rule or ruleset.

", - "values": [ - { - "name": "ACTIVE", - "description": "

Rules will be enforced.

" - }, - { - "name": "DISABLED", - "description": "

Do not evaluate or enforce rules.

" - }, - { - "name": "EVALUATE", - "description": "

Allow admins to test rules before enforcing them. Admins can view insights on\nthe Rule Insights page (evaluate is only available with GitHub Enterprise).

" - } - ] - }, - { - "name": "SamlDigestAlgorithm", - "id": "samldigestalgorithm", - "href": "/graphql/reference/enums#samldigestalgorithm", - "description": "

The possible digest algorithms used to sign SAML requests for an identity provider.

", - "values": [ - { - "name": "SHA1", - "description": "

SHA1.

" - }, - { - "name": "SHA256", - "description": "

SHA256.

" - }, - { - "name": "SHA384", - "description": "

SHA384.

" - }, - { - "name": "SHA512", - "description": "

SHA512.

" - } - ] - }, - { - "name": "SamlSignatureAlgorithm", - "id": "samlsignaturealgorithm", - "href": "/graphql/reference/enums#samlsignaturealgorithm", - "description": "

The possible signature algorithms used to sign SAML requests for a Identity Provider.

", - "values": [ - { - "name": "RSA_SHA1", - "description": "

RSA-SHA1.

" - }, - { - "name": "RSA_SHA256", - "description": "

RSA-SHA256.

" - }, - { - "name": "RSA_SHA384", - "description": "

RSA-SHA384.

" - }, - { - "name": "RSA_SHA512", - "description": "

RSA-SHA512.

" - } - ] - }, - { - "name": "SavedReplyOrderField", - "id": "savedreplyorderfield", - "href": "/graphql/reference/enums#savedreplyorderfield", - "description": "

Properties by which saved reply connections can be ordered.

", - "values": [ - { - "name": "UPDATED_AT", - "description": "

Order saved reply by when they were updated.

" - } - ] - }, - { - "name": "SearchType", - "id": "searchtype", - "href": "/graphql/reference/enums#searchtype", - "description": "

Represents the individual results of a search.

", - "values": [ - { - "name": "DISCUSSION", - "description": "

Returns matching discussions in repositories.

" - }, - { - "name": "ISSUE", - "description": "

Returns results matching issues in repositories.

" - }, - { - "name": "REPOSITORY", - "description": "

Returns results matching repositories.

" - }, - { - "name": "USER", - "description": "

Returns results matching users and organizations on GitHub.

" - } - ] - }, - { - "name": "SecurityAdvisoryClassification", - "id": "securityadvisoryclassification", - "href": "/graphql/reference/enums#securityadvisoryclassification", - "description": "

Classification of the advisory.

", - "values": [ - { - "name": "GENERAL", - "description": "

Classification of general advisories.

" - }, - { - "name": "MALWARE", - "description": "

Classification of malware advisories.

" - } - ] - }, - { - "name": "SecurityAdvisoryEcosystem", - "id": "securityadvisoryecosystem", - "href": "/graphql/reference/enums#securityadvisoryecosystem", - "description": "

The possible ecosystems of a security vulnerability's package.

", - "values": [ - { - "name": "ACTIONS", - "description": "

GitHub Actions.

" - }, - { - "name": "COMPOSER", - "description": "

PHP packages hosted at packagist.org.

" - }, - { - "name": "ERLANG", - "description": "

Erlang/Elixir packages hosted at hex.pm.

" - }, - { - "name": "GO", - "description": "

Go modules.

" - }, - { - "name": "MAVEN", - "description": "

Java artifacts hosted at the Maven central repository.

" - }, - { - "name": "NPM", - "description": "

JavaScript packages hosted at npmjs.com.

" - }, - { - "name": "NUGET", - "description": "

.NET packages hosted at the NuGet Gallery.

" - }, - { - "name": "PIP", - "description": "

Python packages hosted at PyPI.org.

" - }, - { - "name": "PUB", - "description": "

Dart packages hosted at pub.dev.

" - }, - { - "name": "RUBYGEMS", - "description": "

Ruby gems hosted at RubyGems.org.

" - }, - { - "name": "RUST", - "description": "

Rust crates.

" - }, - { - "name": "SWIFT", - "description": "

Swift packages.

" - } - ] - }, - { - "name": "SecurityAdvisorySeverity", - "id": "securityadvisoryseverity", - "href": "/graphql/reference/enums#securityadvisoryseverity", - "description": "

Severity of the vulnerability.

", - "values": [ - { - "name": "CRITICAL", - "description": "

Critical.

" - }, - { - "name": "HIGH", - "description": "

High.

" - }, - { - "name": "LOW", - "description": "

Low.

" - }, - { - "name": "MODERATE", - "description": "

Moderate.

" - } - ] - }, - { - "name": "SocialAccountProvider", - "id": "socialaccountprovider", - "href": "/graphql/reference/enums#socialaccountprovider", - "description": "

Software or company that hosts social media accounts.

", - "values": [ - { - "name": "FACEBOOK", - "description": "

Social media and networking website.

" - }, - { - "name": "GENERIC", - "description": "

Catch-all for social media providers that do not yet have specific handling.

" - }, - { - "name": "HOMETOWN", - "description": "

Fork of Mastodon with a greater focus on local posting.

" - }, - { - "name": "INSTAGRAM", - "description": "

Social media website with a focus on photo and video sharing.

" - }, - { - "name": "LINKEDIN", - "description": "

Professional networking website.

" - }, - { - "name": "MASTODON", - "description": "

Open-source federated microblogging service.

" - }, - { - "name": "NPM", - "description": "

JavaScript package registry.

" - }, - { - "name": "REDDIT", - "description": "

Social news aggregation and discussion website.

" - }, - { - "name": "TWITCH", - "description": "

Live-streaming service.

" - }, - { - "name": "TWITTER", - "description": "

Microblogging website.

" - }, - { - "name": "YOUTUBE", - "description": "

Online video platform.

" - } - ] - }, - { - "name": "SquashMergeCommitMessage", - "id": "squashmergecommitmessage", - "href": "/graphql/reference/enums#squashmergecommitmessage", - "description": "

The possible default commit messages for squash merges.

", - "values": [ - { - "name": "BLANK", - "description": "

Default to a blank commit message.

" - }, - { - "name": "COMMIT_MESSAGES", - "description": "

Default to the branch's commit messages.

" - }, - { - "name": "PR_BODY", - "description": "

Default to the pull request's body.

" - } - ] - }, - { - "name": "SquashMergeCommitTitle", - "id": "squashmergecommittitle", - "href": "/graphql/reference/enums#squashmergecommittitle", - "description": "

The possible default commit titles for squash merges.

", - "values": [ - { - "name": "COMMIT_OR_PR_TITLE", - "description": "

Default to the commit's title (if only one commit) or the pull request's title (when more than one commit).

" - }, - { - "name": "PR_TITLE", - "description": "

Default to the pull request's title.

" - } - ] - }, - { - "name": "StarOrderField", - "id": "starorderfield", - "href": "/graphql/reference/enums#starorderfield", - "description": "

Properties by which star connections can be ordered.

", - "values": [ - { - "name": "STARRED_AT", - "description": "

Allows ordering a list of stars by when they were created.

" - } - ] - }, - { - "name": "StatusState", - "id": "statusstate", - "href": "/graphql/reference/enums#statusstate", - "description": "

The possible commit status states.

", - "values": [ - { - "name": "ERROR", - "description": "

Status is errored.

" - }, - { - "name": "EXPECTED", - "description": "

Status is expected.

" - }, - { - "name": "FAILURE", - "description": "

Status is failing.

" - }, - { - "name": "PENDING", - "description": "

Status is pending.

" - }, - { - "name": "SUCCESS", - "description": "

Status is successful.

" - } - ] - }, - { - "name": "SubscriptionState", - "id": "subscriptionstate", - "href": "/graphql/reference/enums#subscriptionstate", - "description": "

The possible states of a subscription.

", - "values": [ - { - "name": "IGNORED", - "description": "

The User is never notified.

" - }, - { - "name": "SUBSCRIBED", - "description": "

The User is notified of all conversations.

" - }, - { - "name": "UNSUBSCRIBED", - "description": "

The User is only notified when participating or @mentioned.

" - } - ] - }, - { - "name": "TeamDiscussionCommentOrderField", - "id": "teamdiscussioncommentorderfield", - "href": "/graphql/reference/enums#teamdiscussioncommentorderfield", - "description": "

Properties by which team discussion comment connections can be ordered.

", - "values": [ - { - "name": "NUMBER", - "description": "

Allows sequential ordering of team discussion comments (which is equivalent to chronological ordering).

" - } - ] - }, - { - "name": "TeamDiscussionOrderField", - "id": "teamdiscussionorderfield", - "href": "/graphql/reference/enums#teamdiscussionorderfield", - "description": "

Properties by which team discussion connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Allows chronological ordering of team discussions.

" - } - ] - }, - { - "name": "TeamMemberOrderField", - "id": "teammemberorderfield", - "href": "/graphql/reference/enums#teammemberorderfield", - "description": "

Properties by which team member connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order team members by creation time.

" - }, - { - "name": "LOGIN", - "description": "

Order team members by login.

" - } - ] - }, - { - "name": "TeamMemberRole", - "id": "teammemberrole", - "href": "/graphql/reference/enums#teammemberrole", - "description": "

The possible team member roles; eithermaintaineror 'member'.

", - "values": [ - { - "name": "MAINTAINER", - "description": "

A team maintainer has permission to add and remove team members.

" - }, - { - "name": "MEMBER", - "description": "

A team member has no administrative permissions on the team.

" - } - ] - }, - { - "name": "TeamMembershipType", - "id": "teammembershiptype", - "href": "/graphql/reference/enums#teammembershiptype", - "description": "

Defines which types of team members are included in the returned list. Can be one of IMMEDIATE, CHILD_TEAM or ALL.

", - "values": [ - { - "name": "ALL", - "description": "

Includes immediate and child team members for the team.

" - }, - { - "name": "CHILD_TEAM", - "description": "

Includes only child team members for the team.

" - }, - { - "name": "IMMEDIATE", - "description": "

Includes only immediate members of the team.

" - } - ] - }, - { - "name": "TeamNotificationSetting", - "id": "teamnotificationsetting", - "href": "/graphql/reference/enums#teamnotificationsetting", - "description": "

The possible team notification values.

", - "values": [ - { - "name": "NOTIFICATIONS_DISABLED", - "description": "

No one will receive notifications.

" - }, - { - "name": "NOTIFICATIONS_ENABLED", - "description": "

Everyone will receive notifications when the team is @mentioned.

" - } - ] - }, - { - "name": "TeamOrderField", - "id": "teamorderfield", - "href": "/graphql/reference/enums#teamorderfield", - "description": "

Properties by which team connections can be ordered.

", - "values": [ - { - "name": "NAME", - "description": "

Allows ordering a list of teams by name.

" - } - ] - }, - { - "name": "TeamPrivacy", - "id": "teamprivacy", - "href": "/graphql/reference/enums#teamprivacy", - "description": "

The possible team privacy values.

", - "values": [ - { - "name": "SECRET", - "description": "

A secret team can only be seen by its members.

" - }, - { - "name": "VISIBLE", - "description": "

A visible team can be seen and @mentioned by every member of the organization.

" - } - ] - }, - { - "name": "TeamRepositoryOrderField", - "id": "teamrepositoryorderfield", - "href": "/graphql/reference/enums#teamrepositoryorderfield", - "description": "

Properties by which team repository connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order repositories by creation time.

" - }, - { - "name": "NAME", - "description": "

Order repositories by name.

" - }, - { - "name": "PERMISSION", - "description": "

Order repositories by permission.

" - }, - { - "name": "PUSHED_AT", - "description": "

Order repositories by push time.

" - }, - { - "name": "STARGAZERS", - "description": "

Order repositories by number of stargazers.

" - }, - { - "name": "UPDATED_AT", - "description": "

Order repositories by update time.

" - } - ] - }, - { - "name": "TeamReviewAssignmentAlgorithm", - "id": "teamreviewassignmentalgorithm", - "href": "/graphql/reference/enums#teamreviewassignmentalgorithm", - "description": "

The possible team review assignment algorithms.

", - "values": [ - { - "name": "LOAD_BALANCE", - "description": "

Balance review load across the entire team.

" - }, - { - "name": "ROUND_ROBIN", - "description": "

Alternate reviews between each team member.

" - } - ] - }, - { - "name": "TeamRole", - "id": "teamrole", - "href": "/graphql/reference/enums#teamrole", - "description": "

The role of a user on a team.

", - "values": [ - { - "name": "ADMIN", - "description": "

User has admin rights on the team.

" - }, - { - "name": "MEMBER", - "description": "

User is a member of the team.

" - } - ] - }, - { - "name": "ThreadSubscriptionFormAction", - "id": "threadsubscriptionformaction", - "href": "/graphql/reference/enums#threadsubscriptionformaction", - "description": "

The possible states of a thread subscription form action.

", - "values": [ - { - "name": "NONE", - "description": "

The User cannot subscribe or unsubscribe to the thread.

" - }, - { - "name": "SUBSCRIBE", - "description": "

The User can subscribe to the thread.

" - }, - { - "name": "UNSUBSCRIBE", - "description": "

The User can unsubscribe to the thread.

" - } - ] - }, - { - "name": "ThreadSubscriptionState", - "id": "threadsubscriptionstate", - "href": "/graphql/reference/enums#threadsubscriptionstate", - "description": "

The possible states of a subscription.

", - "values": [ - { - "name": "DISABLED", - "description": "

The subscription status is currently disabled.

" - }, - { - "name": "IGNORING_LIST", - "description": "

The User is never notified because they are ignoring the list.

" - }, - { - "name": "IGNORING_THREAD", - "description": "

The User is never notified because they are ignoring the thread.

" - }, - { - "name": "NONE", - "description": "

The User is not recieving notifications from this thread.

" - }, - { - "name": "SUBSCRIBED_TO_LIST", - "description": "

The User is notified becuase they are watching the list.

" - }, - { - "name": "SUBSCRIBED_TO_THREAD", - "description": "

The User is notified because they are subscribed to the thread.

" - }, - { - "name": "SUBSCRIBED_TO_THREAD_EVENTS", - "description": "

The User is notified because they chose custom settings for this thread.

" - }, - { - "name": "SUBSCRIBED_TO_THREAD_TYPE", - "description": "

The User is notified because they chose custom settings for this thread.

" - }, - { - "name": "UNAVAILABLE", - "description": "

The subscription status is currently unavailable.

" - } - ] - }, - { - "name": "UserBlockDuration", - "id": "userblockduration", - "href": "/graphql/reference/enums#userblockduration", - "description": "

The possible durations that a user can be blocked for.

", - "values": [ - { - "name": "ONE_DAY", - "description": "

The user was blocked for 1 day.

" - }, - { - "name": "ONE_MONTH", - "description": "

The user was blocked for 30 days.

" - }, - { - "name": "ONE_WEEK", - "description": "

The user was blocked for 7 days.

" - }, - { - "name": "PERMANENT", - "description": "

The user was blocked permanently.

" - }, - { - "name": "THREE_DAYS", - "description": "

The user was blocked for 3 days.

" - } - ] - }, - { - "name": "UserStatusOrderField", - "id": "userstatusorderfield", - "href": "/graphql/reference/enums#userstatusorderfield", - "description": "

Properties by which user status connections can be ordered.

", - "values": [ - { - "name": "UPDATED_AT", - "description": "

Order user statuses by when they were updated.

" - } - ] - }, - { - "name": "VerifiableDomainOrderField", - "id": "verifiabledomainorderfield", - "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.

" - } - ] - }, - { - "name": "WorkflowRunOrderField", - "id": "workflowrunorderfield", - "href": "/graphql/reference/enums#workflowrunorderfield", - "description": "

Properties by which workflow run connections can be ordered.

", - "values": [ - { - "name": "CREATED_AT", - "description": "

Order workflow runs by most recently created.

" - } - ] - }, - { - "name": "WorkflowState", - "id": "workflowstate", - "href": "/graphql/reference/enums#workflowstate", - "description": "

The possible states for a workflow.

", - "values": [ - { - "name": "ACTIVE", - "description": "

The workflow is active.

" - }, - { - "name": "DELETED", - "description": "

The workflow was deleted from the git repository.

" - }, - { - "name": "DISABLED_FORK", - "description": "

The workflow was disabled by default on a fork.

" - }, - { - "name": "DISABLED_INACTIVITY", - "description": "

The workflow was disabled for inactivity in the repository.

" - }, - { - "name": "DISABLED_MANUALLY", - "description": "

The workflow was disabled manually.

" - } - ] - } - ], - "unions": [ - { - "name": "Assignee", - "id": "assignee", - "href": "/graphql/reference/unions#assignee", - "description": "

Types that can be assigned to issues.

", - "possibleTypes": [ - { - "name": "Bot", - "id": "bot", - "href": "/graphql/reference/objects#bot" - }, - { - "name": "Mannequin", - "id": "mannequin", - "href": "/graphql/reference/objects#mannequin" - }, - { - "name": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "AuditEntryActor", - "id": "auditentryactor", - "href": "/graphql/reference/unions#auditentryactor", - "description": "

Types that can initiate an audit log event.

", - "possibleTypes": [ - { - "name": "Bot", - "id": "bot", - "href": "/graphql/reference/objects#bot" - }, - { - "name": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "BranchActorAllowanceActor", - "id": "branchactorallowanceactor", - "href": "/graphql/reference/unions#branchactorallowanceactor", - "description": "

Types which can be actors for BranchActorAllowance objects.

", - "possibleTypes": [ - { - "name": "App", - "id": "app", - "href": "/graphql/reference/objects#app" - }, - { - "name": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - }, - { - "name": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "BypassActor", - "id": "bypassactor", - "href": "/graphql/reference/unions#bypassactor", - "description": "

Types that can represent a repository ruleset bypass actor.

", - "possibleTypes": [ - { - "name": "App", - "id": "app", - "href": "/graphql/reference/objects#app" - }, - { - "name": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - } - ] - }, - { - "name": "Claimable", - "id": "claimable", - "href": "/graphql/reference/unions#claimable", - "description": "

An object which can have its data claimed or claim data from another.

", - "possibleTypes": [ - { - "name": "Mannequin", - "id": "mannequin", - "href": "/graphql/reference/objects#mannequin" - }, - { - "name": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "Closer", - "id": "closer", - "href": "/graphql/reference/unions#closer", - "description": "

The object which triggered a ClosedEvent.

", - "possibleTypes": [ - { - "name": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "ProjectV2", - "id": "projectv2", - "href": "/graphql/reference/objects#projectv2" - }, - { - "name": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "CreatedIssueOrRestrictedContribution", - "id": "createdissueorrestrictedcontribution", - "href": "/graphql/reference/unions#createdissueorrestrictedcontribution", - "description": "

Represents either a issue the viewer can access or a restricted contribution.

", - "possibleTypes": [ - { - "name": "CreatedIssueContribution", - "id": "createdissuecontribution", - "href": "/graphql/reference/objects#createdissuecontribution" - }, - { - "name": "RestrictedContribution", - "id": "restrictedcontribution", - "href": "/graphql/reference/objects#restrictedcontribution" - } - ] - }, - { - "name": "CreatedPullRequestOrRestrictedContribution", - "id": "createdpullrequestorrestrictedcontribution", - "href": "/graphql/reference/unions#createdpullrequestorrestrictedcontribution", - "description": "

Represents either a pull request the viewer can access or a restricted contribution.

", - "possibleTypes": [ - { - "name": "CreatedPullRequestContribution", - "id": "createdpullrequestcontribution", - "href": "/graphql/reference/objects#createdpullrequestcontribution" - }, - { - "name": "RestrictedContribution", - "id": "restrictedcontribution", - "href": "/graphql/reference/objects#restrictedcontribution" - } - ] - }, - { - "name": "CreatedRepositoryOrRestrictedContribution", - "id": "createdrepositoryorrestrictedcontribution", - "href": "/graphql/reference/unions#createdrepositoryorrestrictedcontribution", - "description": "

Represents either a repository the viewer can access or a restricted contribution.

", - "possibleTypes": [ - { - "name": "CreatedRepositoryContribution", - "id": "createdrepositorycontribution", - "href": "/graphql/reference/objects#createdrepositorycontribution" - }, - { - "name": "RestrictedContribution", - "id": "restrictedcontribution", - "href": "/graphql/reference/objects#restrictedcontribution" - } - ] - }, - { - "name": "DeploymentReviewer", - "id": "deploymentreviewer", - "href": "/graphql/reference/unions#deploymentreviewer", - "description": "

Users and teams.

", - "possibleTypes": [ - { - "name": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - }, - { - "name": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "EnterpriseMember", - "id": "enterprisemember", - "href": "/graphql/reference/unions#enterprisemember", - "description": "

An object that is a member of an enterprise.

", - "possibleTypes": [ - { - "name": "EnterpriseUserAccount", - "id": "enterpriseuseraccount", - "href": "/graphql/reference/objects#enterpriseuseraccount" - }, - { - "name": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "IpAllowListOwner", - "id": "ipallowlistowner", - "href": "/graphql/reference/unions#ipallowlistowner", - "description": "

Types that can own an IP allow list.

", - "possibleTypes": [ - { - "name": "App", - "id": "app", - "href": "/graphql/reference/objects#app" - }, - { - "name": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise" - }, - { - "name": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - } - ] - }, - { - "name": "IssueOrPullRequest", - "id": "issueorpullrequest", - "href": "/graphql/reference/unions#issueorpullrequest", - "description": "

Used for return value of Repository.issueOrPullRequest.

", - "possibleTypes": [ - { - "name": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue" - }, - { - "name": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "IssueTimelineItem", - "id": "issuetimelineitem", - "href": "/graphql/reference/unions#issuetimelineitem", - "description": "

An item in an issue timeline.

", - "possibleTypes": [ - { - "name": "AssignedEvent", - "id": "assignedevent", - "href": "/graphql/reference/objects#assignedevent" - }, - { - "name": "ClosedEvent", - "id": "closedevent", - "href": "/graphql/reference/objects#closedevent" - }, - { - "name": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "CrossReferencedEvent", - "id": "crossreferencedevent", - "href": "/graphql/reference/objects#crossreferencedevent" - }, - { - "name": "DemilestonedEvent", - "id": "demilestonedevent", - "href": "/graphql/reference/objects#demilestonedevent" - }, - { - "name": "IssueComment", - "id": "issuecomment", - "href": "/graphql/reference/objects#issuecomment" - }, - { - "name": "LabeledEvent", - "id": "labeledevent", - "href": "/graphql/reference/objects#labeledevent" - }, - { - "name": "LockedEvent", - "id": "lockedevent", - "href": "/graphql/reference/objects#lockedevent" - }, - { - "name": "MilestonedEvent", - "id": "milestonedevent", - "href": "/graphql/reference/objects#milestonedevent" - }, - { - "name": "ReferencedEvent", - "id": "referencedevent", - "href": "/graphql/reference/objects#referencedevent" - }, - { - "name": "RenamedTitleEvent", - "id": "renamedtitleevent", - "href": "/graphql/reference/objects#renamedtitleevent" - }, - { - "name": "ReopenedEvent", - "id": "reopenedevent", - "href": "/graphql/reference/objects#reopenedevent" - }, - { - "name": "SubscribedEvent", - "id": "subscribedevent", - "href": "/graphql/reference/objects#subscribedevent" - }, - { - "name": "TransferredEvent", - "id": "transferredevent", - "href": "/graphql/reference/objects#transferredevent" - }, - { - "name": "UnassignedEvent", - "id": "unassignedevent", - "href": "/graphql/reference/objects#unassignedevent" - }, - { - "name": "UnlabeledEvent", - "id": "unlabeledevent", - "href": "/graphql/reference/objects#unlabeledevent" - }, - { - "name": "UnlockedEvent", - "id": "unlockedevent", - "href": "/graphql/reference/objects#unlockedevent" - }, - { - "name": "UnsubscribedEvent", - "id": "unsubscribedevent", - "href": "/graphql/reference/objects#unsubscribedevent" - }, - { - "name": "UserBlockedEvent", - "id": "userblockedevent", - "href": "/graphql/reference/objects#userblockedevent" - } - ] - }, - { - "name": "IssueTimelineItems", - "id": "issuetimelineitems", - "href": "/graphql/reference/unions#issuetimelineitems", - "description": "

An item in an issue timeline.

", - "possibleTypes": [ - { - "name": "AddedToProjectEvent", - "id": "addedtoprojectevent", - "href": "/graphql/reference/objects#addedtoprojectevent" - }, - { - "name": "AssignedEvent", - "id": "assignedevent", - "href": "/graphql/reference/objects#assignedevent" - }, - { - "name": "ClosedEvent", - "id": "closedevent", - "href": "/graphql/reference/objects#closedevent" - }, - { - "name": "CommentDeletedEvent", - "id": "commentdeletedevent", - "href": "/graphql/reference/objects#commentdeletedevent" - }, - { - "name": "ConnectedEvent", - "id": "connectedevent", - "href": "/graphql/reference/objects#connectedevent" - }, - { - "name": "ConvertedNoteToIssueEvent", - "id": "convertednotetoissueevent", - "href": "/graphql/reference/objects#convertednotetoissueevent" - }, - { - "name": "ConvertedToDiscussionEvent", - "id": "convertedtodiscussionevent", - "href": "/graphql/reference/objects#convertedtodiscussionevent" - }, - { - "name": "CrossReferencedEvent", - "id": "crossreferencedevent", - "href": "/graphql/reference/objects#crossreferencedevent" - }, - { - "name": "DemilestonedEvent", - "id": "demilestonedevent", - "href": "/graphql/reference/objects#demilestonedevent" - }, - { - "name": "DisconnectedEvent", - "id": "disconnectedevent", - "href": "/graphql/reference/objects#disconnectedevent" - }, - { - "name": "IssueComment", - "id": "issuecomment", - "href": "/graphql/reference/objects#issuecomment" - }, - { - "name": "LabeledEvent", - "id": "labeledevent", - "href": "/graphql/reference/objects#labeledevent" - }, - { - "name": "LockedEvent", - "id": "lockedevent", - "href": "/graphql/reference/objects#lockedevent" - }, - { - "name": "MarkedAsDuplicateEvent", - "id": "markedasduplicateevent", - "href": "/graphql/reference/objects#markedasduplicateevent" - }, - { - "name": "MentionedEvent", - "id": "mentionedevent", - "href": "/graphql/reference/objects#mentionedevent" - }, - { - "name": "MilestonedEvent", - "id": "milestonedevent", - "href": "/graphql/reference/objects#milestonedevent" - }, - { - "name": "MovedColumnsInProjectEvent", - "id": "movedcolumnsinprojectevent", - "href": "/graphql/reference/objects#movedcolumnsinprojectevent" - }, - { - "name": "PinnedEvent", - "id": "pinnedevent", - "href": "/graphql/reference/objects#pinnedevent" - }, - { - "name": "ReferencedEvent", - "id": "referencedevent", - "href": "/graphql/reference/objects#referencedevent" - }, - { - "name": "RemovedFromProjectEvent", - "id": "removedfromprojectevent", - "href": "/graphql/reference/objects#removedfromprojectevent" - }, - { - "name": "RenamedTitleEvent", - "id": "renamedtitleevent", - "href": "/graphql/reference/objects#renamedtitleevent" - }, - { - "name": "ReopenedEvent", - "id": "reopenedevent", - "href": "/graphql/reference/objects#reopenedevent" - }, - { - "name": "SubscribedEvent", - "id": "subscribedevent", - "href": "/graphql/reference/objects#subscribedevent" - }, - { - "name": "TransferredEvent", - "id": "transferredevent", - "href": "/graphql/reference/objects#transferredevent" - }, - { - "name": "UnassignedEvent", - "id": "unassignedevent", - "href": "/graphql/reference/objects#unassignedevent" - }, - { - "name": "UnlabeledEvent", - "id": "unlabeledevent", - "href": "/graphql/reference/objects#unlabeledevent" - }, - { - "name": "UnlockedEvent", - "id": "unlockedevent", - "href": "/graphql/reference/objects#unlockedevent" - }, - { - "name": "UnmarkedAsDuplicateEvent", - "id": "unmarkedasduplicateevent", - "href": "/graphql/reference/objects#unmarkedasduplicateevent" - }, - { - "name": "UnpinnedEvent", - "id": "unpinnedevent", - "href": "/graphql/reference/objects#unpinnedevent" - }, - { - "name": "UnsubscribedEvent", - "id": "unsubscribedevent", - "href": "/graphql/reference/objects#unsubscribedevent" - }, - { - "name": "UserBlockedEvent", - "id": "userblockedevent", - "href": "/graphql/reference/objects#userblockedevent" - } - ] - }, - { - "name": "MilestoneItem", - "id": "milestoneitem", - "href": "/graphql/reference/unions#milestoneitem", - "description": "

Types that can be inside a Milestone.

", - "possibleTypes": [ - { - "name": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue" - }, - { - "name": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "OrgRestoreMemberAuditEntryMembership", - "id": "orgrestorememberauditentrymembership", - "href": "/graphql/reference/unions#orgrestorememberauditentrymembership", - "description": "

Types of memberships that can be restored for an Organization member.

", - "possibleTypes": [ - { - "name": "OrgRestoreMemberMembershipOrganizationAuditEntryData", - "id": "orgrestoremembermembershiporganizationauditentrydata", - "href": "/graphql/reference/objects#orgrestoremembermembershiporganizationauditentrydata" - }, - { - "name": "OrgRestoreMemberMembershipRepositoryAuditEntryData", - "id": "orgrestoremembermembershiprepositoryauditentrydata", - "href": "/graphql/reference/objects#orgrestoremembermembershiprepositoryauditentrydata" - }, - { - "name": "OrgRestoreMemberMembershipTeamAuditEntryData", - "id": "orgrestoremembermembershipteamauditentrydata", - "href": "/graphql/reference/objects#orgrestoremembermembershipteamauditentrydata" - } - ] - }, - { - "name": "OrganizationAuditEntry", - "id": "organizationauditentry", - "href": "/graphql/reference/unions#organizationauditentry", - "description": "

An audit entry in an organization audit log.

", - "possibleTypes": [ - { - "name": "MembersCanDeleteReposClearAuditEntry", - "id": "memberscandeletereposclearauditentry", - "href": "/graphql/reference/objects#memberscandeletereposclearauditentry" - }, - { - "name": "MembersCanDeleteReposDisableAuditEntry", - "id": "memberscandeletereposdisableauditentry", - "href": "/graphql/reference/objects#memberscandeletereposdisableauditentry" - }, - { - "name": "MembersCanDeleteReposEnableAuditEntry", - "id": "memberscandeletereposenableauditentry", - "href": "/graphql/reference/objects#memberscandeletereposenableauditentry" - }, - { - "name": "OauthApplicationCreateAuditEntry", - "id": "oauthapplicationcreateauditentry", - "href": "/graphql/reference/objects#oauthapplicationcreateauditentry" - }, - { - "name": "OrgAddBillingManagerAuditEntry", - "id": "orgaddbillingmanagerauditentry", - "href": "/graphql/reference/objects#orgaddbillingmanagerauditentry" - }, - { - "name": "OrgAddMemberAuditEntry", - "id": "orgaddmemberauditentry", - "href": "/graphql/reference/objects#orgaddmemberauditentry" - }, - { - "name": "OrgBlockUserAuditEntry", - "id": "orgblockuserauditentry", - "href": "/graphql/reference/objects#orgblockuserauditentry" - }, - { - "name": "OrgConfigDisableCollaboratorsOnlyAuditEntry", - "id": "orgconfigdisablecollaboratorsonlyauditentry", - "href": "/graphql/reference/objects#orgconfigdisablecollaboratorsonlyauditentry" - }, - { - "name": "OrgConfigEnableCollaboratorsOnlyAuditEntry", - "id": "orgconfigenablecollaboratorsonlyauditentry", - "href": "/graphql/reference/objects#orgconfigenablecollaboratorsonlyauditentry" - }, - { - "name": "OrgCreateAuditEntry", - "id": "orgcreateauditentry", - "href": "/graphql/reference/objects#orgcreateauditentry" - }, - { - "name": "OrgDisableOauthAppRestrictionsAuditEntry", - "id": "orgdisableoauthapprestrictionsauditentry", - "href": "/graphql/reference/objects#orgdisableoauthapprestrictionsauditentry" - }, - { - "name": "OrgDisableSamlAuditEntry", - "id": "orgdisablesamlauditentry", - "href": "/graphql/reference/objects#orgdisablesamlauditentry" - }, - { - "name": "OrgDisableTwoFactorRequirementAuditEntry", - "id": "orgdisabletwofactorrequirementauditentry", - "href": "/graphql/reference/objects#orgdisabletwofactorrequirementauditentry" - }, - { - "name": "OrgEnableOauthAppRestrictionsAuditEntry", - "id": "orgenableoauthapprestrictionsauditentry", - "href": "/graphql/reference/objects#orgenableoauthapprestrictionsauditentry" - }, - { - "name": "OrgEnableSamlAuditEntry", - "id": "orgenablesamlauditentry", - "href": "/graphql/reference/objects#orgenablesamlauditentry" - }, - { - "name": "OrgEnableTwoFactorRequirementAuditEntry", - "id": "orgenabletwofactorrequirementauditentry", - "href": "/graphql/reference/objects#orgenabletwofactorrequirementauditentry" - }, - { - "name": "OrgInviteMemberAuditEntry", - "id": "orginvitememberauditentry", - "href": "/graphql/reference/objects#orginvitememberauditentry" - }, - { - "name": "OrgInviteToBusinessAuditEntry", - "id": "orginvitetobusinessauditentry", - "href": "/graphql/reference/objects#orginvitetobusinessauditentry" - }, - { - "name": "OrgOauthAppAccessApprovedAuditEntry", - "id": "orgoauthappaccessapprovedauditentry", - "href": "/graphql/reference/objects#orgoauthappaccessapprovedauditentry" - }, - { - "name": "OrgOauthAppAccessBlockedAuditEntry", - "id": "orgoauthappaccessblockedauditentry", - "href": "/graphql/reference/objects#orgoauthappaccessblockedauditentry" - }, - { - "name": "OrgOauthAppAccessDeniedAuditEntry", - "id": "orgoauthappaccessdeniedauditentry", - "href": "/graphql/reference/objects#orgoauthappaccessdeniedauditentry" - }, - { - "name": "OrgOauthAppAccessRequestedAuditEntry", - "id": "orgoauthappaccessrequestedauditentry", - "href": "/graphql/reference/objects#orgoauthappaccessrequestedauditentry" - }, - { - "name": "OrgOauthAppAccessUnblockedAuditEntry", - "id": "orgoauthappaccessunblockedauditentry", - "href": "/graphql/reference/objects#orgoauthappaccessunblockedauditentry" - }, - { - "name": "OrgRemoveBillingManagerAuditEntry", - "id": "orgremovebillingmanagerauditentry", - "href": "/graphql/reference/objects#orgremovebillingmanagerauditentry" - }, - { - "name": "OrgRemoveMemberAuditEntry", - "id": "orgremovememberauditentry", - "href": "/graphql/reference/objects#orgremovememberauditentry" - }, - { - "name": "OrgRemoveOutsideCollaboratorAuditEntry", - "id": "orgremoveoutsidecollaboratorauditentry", - "href": "/graphql/reference/objects#orgremoveoutsidecollaboratorauditentry" - }, - { - "name": "OrgRestoreMemberAuditEntry", - "id": "orgrestorememberauditentry", - "href": "/graphql/reference/objects#orgrestorememberauditentry" - }, - { - "name": "OrgUnblockUserAuditEntry", - "id": "orgunblockuserauditentry", - "href": "/graphql/reference/objects#orgunblockuserauditentry" - }, - { - "name": "OrgUpdateDefaultRepositoryPermissionAuditEntry", - "id": "orgupdatedefaultrepositorypermissionauditentry", - "href": "/graphql/reference/objects#orgupdatedefaultrepositorypermissionauditentry" - }, - { - "name": "OrgUpdateMemberAuditEntry", - "id": "orgupdatememberauditentry", - "href": "/graphql/reference/objects#orgupdatememberauditentry" - }, - { - "name": "OrgUpdateMemberRepositoryCreationPermissionAuditEntry", - "id": "orgupdatememberrepositorycreationpermissionauditentry", - "href": "/graphql/reference/objects#orgupdatememberrepositorycreationpermissionauditentry" - }, - { - "name": "OrgUpdateMemberRepositoryInvitationPermissionAuditEntry", - "id": "orgupdatememberrepositoryinvitationpermissionauditentry", - "href": "/graphql/reference/objects#orgupdatememberrepositoryinvitationpermissionauditentry" - }, - { - "name": "PrivateRepositoryForkingDisableAuditEntry", - "id": "privaterepositoryforkingdisableauditentry", - "href": "/graphql/reference/objects#privaterepositoryforkingdisableauditentry" - }, - { - "name": "PrivateRepositoryForkingEnableAuditEntry", - "id": "privaterepositoryforkingenableauditentry", - "href": "/graphql/reference/objects#privaterepositoryforkingenableauditentry" - }, - { - "name": "RepoAccessAuditEntry", - "id": "repoaccessauditentry", - "href": "/graphql/reference/objects#repoaccessauditentry" - }, - { - "name": "RepoAddMemberAuditEntry", - "id": "repoaddmemberauditentry", - "href": "/graphql/reference/objects#repoaddmemberauditentry" - }, - { - "name": "RepoAddTopicAuditEntry", - "id": "repoaddtopicauditentry", - "href": "/graphql/reference/objects#repoaddtopicauditentry" - }, - { - "name": "RepoArchivedAuditEntry", - "id": "repoarchivedauditentry", - "href": "/graphql/reference/objects#repoarchivedauditentry" - }, - { - "name": "RepoChangeMergeSettingAuditEntry", - "id": "repochangemergesettingauditentry", - "href": "/graphql/reference/objects#repochangemergesettingauditentry" - }, - { - "name": "RepoConfigDisableAnonymousGitAccessAuditEntry", - "id": "repoconfigdisableanonymousgitaccessauditentry", - "href": "/graphql/reference/objects#repoconfigdisableanonymousgitaccessauditentry" - }, - { - "name": "RepoConfigDisableCollaboratorsOnlyAuditEntry", - "id": "repoconfigdisablecollaboratorsonlyauditentry", - "href": "/graphql/reference/objects#repoconfigdisablecollaboratorsonlyauditentry" - }, - { - "name": "RepoConfigDisableContributorsOnlyAuditEntry", - "id": "repoconfigdisablecontributorsonlyauditentry", - "href": "/graphql/reference/objects#repoconfigdisablecontributorsonlyauditentry" - }, - { - "name": "RepoConfigDisableSockpuppetDisallowedAuditEntry", - "id": "repoconfigdisablesockpuppetdisallowedauditentry", - "href": "/graphql/reference/objects#repoconfigdisablesockpuppetdisallowedauditentry" - }, - { - "name": "RepoConfigEnableAnonymousGitAccessAuditEntry", - "id": "repoconfigenableanonymousgitaccessauditentry", - "href": "/graphql/reference/objects#repoconfigenableanonymousgitaccessauditentry" - }, - { - "name": "RepoConfigEnableCollaboratorsOnlyAuditEntry", - "id": "repoconfigenablecollaboratorsonlyauditentry", - "href": "/graphql/reference/objects#repoconfigenablecollaboratorsonlyauditentry" - }, - { - "name": "RepoConfigEnableContributorsOnlyAuditEntry", - "id": "repoconfigenablecontributorsonlyauditentry", - "href": "/graphql/reference/objects#repoconfigenablecontributorsonlyauditentry" - }, - { - "name": "RepoConfigEnableSockpuppetDisallowedAuditEntry", - "id": "repoconfigenablesockpuppetdisallowedauditentry", - "href": "/graphql/reference/objects#repoconfigenablesockpuppetdisallowedauditentry" - }, - { - "name": "RepoConfigLockAnonymousGitAccessAuditEntry", - "id": "repoconfiglockanonymousgitaccessauditentry", - "href": "/graphql/reference/objects#repoconfiglockanonymousgitaccessauditentry" - }, - { - "name": "RepoConfigUnlockAnonymousGitAccessAuditEntry", - "id": "repoconfigunlockanonymousgitaccessauditentry", - "href": "/graphql/reference/objects#repoconfigunlockanonymousgitaccessauditentry" - }, - { - "name": "RepoCreateAuditEntry", - "id": "repocreateauditentry", - "href": "/graphql/reference/objects#repocreateauditentry" - }, - { - "name": "RepoDestroyAuditEntry", - "id": "repodestroyauditentry", - "href": "/graphql/reference/objects#repodestroyauditentry" - }, - { - "name": "RepoRemoveMemberAuditEntry", - "id": "reporemovememberauditentry", - "href": "/graphql/reference/objects#reporemovememberauditentry" - }, - { - "name": "RepoRemoveTopicAuditEntry", - "id": "reporemovetopicauditentry", - "href": "/graphql/reference/objects#reporemovetopicauditentry" - }, - { - "name": "RepositoryVisibilityChangeDisableAuditEntry", - "id": "repositoryvisibilitychangedisableauditentry", - "href": "/graphql/reference/objects#repositoryvisibilitychangedisableauditentry" - }, - { - "name": "RepositoryVisibilityChangeEnableAuditEntry", - "id": "repositoryvisibilitychangeenableauditentry", - "href": "/graphql/reference/objects#repositoryvisibilitychangeenableauditentry" - }, - { - "name": "TeamAddMemberAuditEntry", - "id": "teamaddmemberauditentry", - "href": "/graphql/reference/objects#teamaddmemberauditentry" - }, - { - "name": "TeamAddRepositoryAuditEntry", - "id": "teamaddrepositoryauditentry", - "href": "/graphql/reference/objects#teamaddrepositoryauditentry" - }, - { - "name": "TeamChangeParentTeamAuditEntry", - "id": "teamchangeparentteamauditentry", - "href": "/graphql/reference/objects#teamchangeparentteamauditentry" - }, - { - "name": "TeamRemoveMemberAuditEntry", - "id": "teamremovememberauditentry", - "href": "/graphql/reference/objects#teamremovememberauditentry" - }, - { - "name": "TeamRemoveRepositoryAuditEntry", - "id": "teamremoverepositoryauditentry", - "href": "/graphql/reference/objects#teamremoverepositoryauditentry" - } - ] - }, - { - "name": "OrganizationOrUser", - "id": "organizationoruser", - "href": "/graphql/reference/unions#organizationoruser", - "description": "

Used for argument of CreateProjectV2 mutation.

", - "possibleTypes": [ - { - "name": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "PermissionGranter", - "id": "permissiongranter", - "href": "/graphql/reference/unions#permissiongranter", - "description": "

Types that can grant permissions on a repository to a user.

", - "possibleTypes": [ - { - "name": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - } - ] - }, - { - "name": "PinnableItem", - "id": "pinnableitem", - "href": "/graphql/reference/unions#pinnableitem", - "description": "

Types that can be pinned to a profile page.

", - "possibleTypes": [ - { - "name": "Gist", - "id": "gist", - "href": "/graphql/reference/objects#gist" - }, - { - "name": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "ProjectCardItem", - "id": "projectcarditem", - "href": "/graphql/reference/unions#projectcarditem", - "description": "

Types that can be inside Project Cards.

", - "possibleTypes": [ - { - "name": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue" - }, - { - "name": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "ProjectV2Actor", - "id": "projectv2actor", - "href": "/graphql/reference/unions#projectv2actor", - "description": "

Possible collaborators for a project.

", - "possibleTypes": [ - { - "name": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - }, - { - "name": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "ProjectV2FieldConfiguration", - "id": "projectv2fieldconfiguration", - "href": "/graphql/reference/unions#projectv2fieldconfiguration", - "description": "

Configurations for project fields.

", - "possibleTypes": [ - { - "name": "ProjectV2Field", - "id": "projectv2field", - "href": "/graphql/reference/objects#projectv2field" - }, - { - "name": "ProjectV2IterationField", - "id": "projectv2iterationfield", - "href": "/graphql/reference/objects#projectv2iterationfield" - }, - { - "name": "ProjectV2SingleSelectField", - "id": "projectv2singleselectfield", - "href": "/graphql/reference/objects#projectv2singleselectfield" - } - ] - }, - { - "name": "ProjectV2ItemContent", - "id": "projectv2itemcontent", - "href": "/graphql/reference/unions#projectv2itemcontent", - "description": "

Types that can be inside Project Items.

", - "possibleTypes": [ - { - "name": "DraftIssue", - "id": "draftissue", - "href": "/graphql/reference/objects#draftissue" - }, - { - "name": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue" - }, - { - "name": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "ProjectV2ItemFieldValue", - "id": "projectv2itemfieldvalue", - "href": "/graphql/reference/unions#projectv2itemfieldvalue", - "description": "

Project field values.

", - "possibleTypes": [ - { - "name": "ProjectV2ItemFieldDateValue", - "id": "projectv2itemfielddatevalue", - "href": "/graphql/reference/objects#projectv2itemfielddatevalue" - }, - { - "name": "ProjectV2ItemFieldIterationValue", - "id": "projectv2itemfielditerationvalue", - "href": "/graphql/reference/objects#projectv2itemfielditerationvalue" - }, - { - "name": "ProjectV2ItemFieldLabelValue", - "id": "projectv2itemfieldlabelvalue", - "href": "/graphql/reference/objects#projectv2itemfieldlabelvalue" - }, - { - "name": "ProjectV2ItemFieldMilestoneValue", - "id": "projectv2itemfieldmilestonevalue", - "href": "/graphql/reference/objects#projectv2itemfieldmilestonevalue" - }, - { - "name": "ProjectV2ItemFieldNumberValue", - "id": "projectv2itemfieldnumbervalue", - "href": "/graphql/reference/objects#projectv2itemfieldnumbervalue" - }, - { - "name": "ProjectV2ItemFieldPullRequestValue", - "id": "projectv2itemfieldpullrequestvalue", - "href": "/graphql/reference/objects#projectv2itemfieldpullrequestvalue" - }, - { - "name": "ProjectV2ItemFieldRepositoryValue", - "id": "projectv2itemfieldrepositoryvalue", - "href": "/graphql/reference/objects#projectv2itemfieldrepositoryvalue" - }, - { - "name": "ProjectV2ItemFieldReviewerValue", - "id": "projectv2itemfieldreviewervalue", - "href": "/graphql/reference/objects#projectv2itemfieldreviewervalue" - }, - { - "name": "ProjectV2ItemFieldSingleSelectValue", - "id": "projectv2itemfieldsingleselectvalue", - "href": "/graphql/reference/objects#projectv2itemfieldsingleselectvalue" - }, - { - "name": "ProjectV2ItemFieldTextValue", - "id": "projectv2itemfieldtextvalue", - "href": "/graphql/reference/objects#projectv2itemfieldtextvalue" - }, - { - "name": "ProjectV2ItemFieldUserValue", - "id": "projectv2itemfielduservalue", - "href": "/graphql/reference/objects#projectv2itemfielduservalue" - } - ] - }, - { - "name": "PullRequestTimelineItem", - "id": "pullrequesttimelineitem", - "href": "/graphql/reference/unions#pullrequesttimelineitem", - "description": "

An item in a pull request timeline.

", - "possibleTypes": [ - { - "name": "AssignedEvent", - "id": "assignedevent", - "href": "/graphql/reference/objects#assignedevent" - }, - { - "name": "BaseRefDeletedEvent", - "id": "baserefdeletedevent", - "href": "/graphql/reference/objects#baserefdeletedevent" - }, - { - "name": "BaseRefForcePushedEvent", - "id": "baserefforcepushedevent", - "href": "/graphql/reference/objects#baserefforcepushedevent" - }, - { - "name": "ClosedEvent", - "id": "closedevent", - "href": "/graphql/reference/objects#closedevent" - }, - { - "name": "Commit", - "id": "commit", - "href": "/graphql/reference/objects#commit" - }, - { - "name": "CommitCommentThread", - "id": "commitcommentthread", - "href": "/graphql/reference/objects#commitcommentthread" - }, - { - "name": "CrossReferencedEvent", - "id": "crossreferencedevent", - "href": "/graphql/reference/objects#crossreferencedevent" - }, - { - "name": "DemilestonedEvent", - "id": "demilestonedevent", - "href": "/graphql/reference/objects#demilestonedevent" - }, - { - "name": "DeployedEvent", - "id": "deployedevent", - "href": "/graphql/reference/objects#deployedevent" - }, - { - "name": "DeploymentEnvironmentChangedEvent", - "id": "deploymentenvironmentchangedevent", - "href": "/graphql/reference/objects#deploymentenvironmentchangedevent" - }, - { - "name": "HeadRefDeletedEvent", - "id": "headrefdeletedevent", - "href": "/graphql/reference/objects#headrefdeletedevent" - }, - { - "name": "HeadRefForcePushedEvent", - "id": "headrefforcepushedevent", - "href": "/graphql/reference/objects#headrefforcepushedevent" - }, - { - "name": "HeadRefRestoredEvent", - "id": "headrefrestoredevent", - "href": "/graphql/reference/objects#headrefrestoredevent" - }, - { - "name": "IssueComment", - "id": "issuecomment", - "href": "/graphql/reference/objects#issuecomment" - }, - { - "name": "LabeledEvent", - "id": "labeledevent", - "href": "/graphql/reference/objects#labeledevent" - }, - { - "name": "LockedEvent", - "id": "lockedevent", - "href": "/graphql/reference/objects#lockedevent" - }, - { - "name": "MergedEvent", - "id": "mergedevent", - "href": "/graphql/reference/objects#mergedevent" - }, - { - "name": "MilestonedEvent", - "id": "milestonedevent", - "href": "/graphql/reference/objects#milestonedevent" - }, - { - "name": "PullRequestReview", - "id": "pullrequestreview", - "href": "/graphql/reference/objects#pullrequestreview" - }, - { - "name": "PullRequestReviewComment", - "id": "pullrequestreviewcomment", - "href": "/graphql/reference/objects#pullrequestreviewcomment" - }, - { - "name": "PullRequestReviewThread", - "id": "pullrequestreviewthread", - "href": "/graphql/reference/objects#pullrequestreviewthread" - }, - { - "name": "ReferencedEvent", - "id": "referencedevent", - "href": "/graphql/reference/objects#referencedevent" - }, - { - "name": "RenamedTitleEvent", - "id": "renamedtitleevent", - "href": "/graphql/reference/objects#renamedtitleevent" - }, - { - "name": "ReopenedEvent", - "id": "reopenedevent", - "href": "/graphql/reference/objects#reopenedevent" - }, - { - "name": "ReviewDismissedEvent", - "id": "reviewdismissedevent", - "href": "/graphql/reference/objects#reviewdismissedevent" - }, - { - "name": "ReviewRequestRemovedEvent", - "id": "reviewrequestremovedevent", - "href": "/graphql/reference/objects#reviewrequestremovedevent" - }, - { - "name": "ReviewRequestedEvent", - "id": "reviewrequestedevent", - "href": "/graphql/reference/objects#reviewrequestedevent" - }, - { - "name": "SubscribedEvent", - "id": "subscribedevent", - "href": "/graphql/reference/objects#subscribedevent" - }, - { - "name": "UnassignedEvent", - "id": "unassignedevent", - "href": "/graphql/reference/objects#unassignedevent" - }, - { - "name": "UnlabeledEvent", - "id": "unlabeledevent", - "href": "/graphql/reference/objects#unlabeledevent" - }, - { - "name": "UnlockedEvent", - "id": "unlockedevent", - "href": "/graphql/reference/objects#unlockedevent" - }, - { - "name": "UnsubscribedEvent", - "id": "unsubscribedevent", - "href": "/graphql/reference/objects#unsubscribedevent" - }, - { - "name": "UserBlockedEvent", - "id": "userblockedevent", - "href": "/graphql/reference/objects#userblockedevent" - } - ] - }, - { - "name": "PullRequestTimelineItems", - "id": "pullrequesttimelineitems", - "href": "/graphql/reference/unions#pullrequesttimelineitems", - "description": "

An item in a pull request timeline.

", - "possibleTypes": [ - { - "name": "AddedToMergeQueueEvent", - "id": "addedtomergequeueevent", - "href": "/graphql/reference/objects#addedtomergequeueevent" - }, - { - "name": "AddedToProjectEvent", - "id": "addedtoprojectevent", - "href": "/graphql/reference/objects#addedtoprojectevent" - }, - { - "name": "AssignedEvent", - "id": "assignedevent", - "href": "/graphql/reference/objects#assignedevent" - }, - { - "name": "AutoMergeDisabledEvent", - "id": "automergedisabledevent", - "href": "/graphql/reference/objects#automergedisabledevent" - }, - { - "name": "AutoMergeEnabledEvent", - "id": "automergeenabledevent", - "href": "/graphql/reference/objects#automergeenabledevent" - }, - { - "name": "AutoRebaseEnabledEvent", - "id": "autorebaseenabledevent", - "href": "/graphql/reference/objects#autorebaseenabledevent" - }, - { - "name": "AutoSquashEnabledEvent", - "id": "autosquashenabledevent", - "href": "/graphql/reference/objects#autosquashenabledevent" - }, - { - "name": "AutomaticBaseChangeFailedEvent", - "id": "automaticbasechangefailedevent", - "href": "/graphql/reference/objects#automaticbasechangefailedevent" - }, - { - "name": "AutomaticBaseChangeSucceededEvent", - "id": "automaticbasechangesucceededevent", - "href": "/graphql/reference/objects#automaticbasechangesucceededevent" - }, - { - "name": "BaseRefChangedEvent", - "id": "baserefchangedevent", - "href": "/graphql/reference/objects#baserefchangedevent" - }, - { - "name": "BaseRefDeletedEvent", - "id": "baserefdeletedevent", - "href": "/graphql/reference/objects#baserefdeletedevent" - }, - { - "name": "BaseRefForcePushedEvent", - "id": "baserefforcepushedevent", - "href": "/graphql/reference/objects#baserefforcepushedevent" - }, - { - "name": "ClosedEvent", - "id": "closedevent", - "href": "/graphql/reference/objects#closedevent" - }, - { - "name": "CommentDeletedEvent", - "id": "commentdeletedevent", - "href": "/graphql/reference/objects#commentdeletedevent" - }, - { - "name": "ConnectedEvent", - "id": "connectedevent", - "href": "/graphql/reference/objects#connectedevent" - }, - { - "name": "ConvertToDraftEvent", - "id": "converttodraftevent", - "href": "/graphql/reference/objects#converttodraftevent" - }, - { - "name": "ConvertedNoteToIssueEvent", - "id": "convertednotetoissueevent", - "href": "/graphql/reference/objects#convertednotetoissueevent" - }, - { - "name": "ConvertedToDiscussionEvent", - "id": "convertedtodiscussionevent", - "href": "/graphql/reference/objects#convertedtodiscussionevent" - }, - { - "name": "CrossReferencedEvent", - "id": "crossreferencedevent", - "href": "/graphql/reference/objects#crossreferencedevent" - }, - { - "name": "DemilestonedEvent", - "id": "demilestonedevent", - "href": "/graphql/reference/objects#demilestonedevent" - }, - { - "name": "DeployedEvent", - "id": "deployedevent", - "href": "/graphql/reference/objects#deployedevent" - }, - { - "name": "DeploymentEnvironmentChangedEvent", - "id": "deploymentenvironmentchangedevent", - "href": "/graphql/reference/objects#deploymentenvironmentchangedevent" - }, - { - "name": "DisconnectedEvent", - "id": "disconnectedevent", - "href": "/graphql/reference/objects#disconnectedevent" - }, - { - "name": "HeadRefDeletedEvent", - "id": "headrefdeletedevent", - "href": "/graphql/reference/objects#headrefdeletedevent" - }, - { - "name": "HeadRefForcePushedEvent", - "id": "headrefforcepushedevent", - "href": "/graphql/reference/objects#headrefforcepushedevent" - }, - { - "name": "HeadRefRestoredEvent", - "id": "headrefrestoredevent", - "href": "/graphql/reference/objects#headrefrestoredevent" - }, - { - "name": "IssueComment", - "id": "issuecomment", - "href": "/graphql/reference/objects#issuecomment" - }, - { - "name": "LabeledEvent", - "id": "labeledevent", - "href": "/graphql/reference/objects#labeledevent" - }, - { - "name": "LockedEvent", - "id": "lockedevent", - "href": "/graphql/reference/objects#lockedevent" - }, - { - "name": "MarkedAsDuplicateEvent", - "id": "markedasduplicateevent", - "href": "/graphql/reference/objects#markedasduplicateevent" - }, - { - "name": "MentionedEvent", - "id": "mentionedevent", - "href": "/graphql/reference/objects#mentionedevent" - }, - { - "name": "MergedEvent", - "id": "mergedevent", - "href": "/graphql/reference/objects#mergedevent" - }, - { - "name": "MilestonedEvent", - "id": "milestonedevent", - "href": "/graphql/reference/objects#milestonedevent" - }, - { - "name": "MovedColumnsInProjectEvent", - "id": "movedcolumnsinprojectevent", - "href": "/graphql/reference/objects#movedcolumnsinprojectevent" - }, - { - "name": "PinnedEvent", - "id": "pinnedevent", - "href": "/graphql/reference/objects#pinnedevent" - }, - { - "name": "PullRequestCommit", - "id": "pullrequestcommit", - "href": "/graphql/reference/objects#pullrequestcommit" - }, - { - "name": "PullRequestCommitCommentThread", - "id": "pullrequestcommitcommentthread", - "href": "/graphql/reference/objects#pullrequestcommitcommentthread" - }, - { - "name": "PullRequestReview", - "id": "pullrequestreview", - "href": "/graphql/reference/objects#pullrequestreview" - }, - { - "name": "PullRequestReviewThread", - "id": "pullrequestreviewthread", - "href": "/graphql/reference/objects#pullrequestreviewthread" - }, - { - "name": "PullRequestRevisionMarker", - "id": "pullrequestrevisionmarker", - "href": "/graphql/reference/objects#pullrequestrevisionmarker" - }, - { - "name": "ReadyForReviewEvent", - "id": "readyforreviewevent", - "href": "/graphql/reference/objects#readyforreviewevent" - }, - { - "name": "ReferencedEvent", - "id": "referencedevent", - "href": "/graphql/reference/objects#referencedevent" - }, - { - "name": "RemovedFromMergeQueueEvent", - "id": "removedfrommergequeueevent", - "href": "/graphql/reference/objects#removedfrommergequeueevent" - }, - { - "name": "RemovedFromProjectEvent", - "id": "removedfromprojectevent", - "href": "/graphql/reference/objects#removedfromprojectevent" - }, - { - "name": "RenamedTitleEvent", - "id": "renamedtitleevent", - "href": "/graphql/reference/objects#renamedtitleevent" - }, - { - "name": "ReopenedEvent", - "id": "reopenedevent", - "href": "/graphql/reference/objects#reopenedevent" - }, - { - "name": "ReviewDismissedEvent", - "id": "reviewdismissedevent", - "href": "/graphql/reference/objects#reviewdismissedevent" - }, - { - "name": "ReviewRequestRemovedEvent", - "id": "reviewrequestremovedevent", - "href": "/graphql/reference/objects#reviewrequestremovedevent" - }, - { - "name": "ReviewRequestedEvent", - "id": "reviewrequestedevent", - "href": "/graphql/reference/objects#reviewrequestedevent" - }, - { - "name": "SubscribedEvent", - "id": "subscribedevent", - "href": "/graphql/reference/objects#subscribedevent" - }, - { - "name": "TransferredEvent", - "id": "transferredevent", - "href": "/graphql/reference/objects#transferredevent" - }, - { - "name": "UnassignedEvent", - "id": "unassignedevent", - "href": "/graphql/reference/objects#unassignedevent" - }, - { - "name": "UnlabeledEvent", - "id": "unlabeledevent", - "href": "/graphql/reference/objects#unlabeledevent" - }, - { - "name": "UnlockedEvent", - "id": "unlockedevent", - "href": "/graphql/reference/objects#unlockedevent" - }, - { - "name": "UnmarkedAsDuplicateEvent", - "id": "unmarkedasduplicateevent", - "href": "/graphql/reference/objects#unmarkedasduplicateevent" - }, - { - "name": "UnpinnedEvent", - "id": "unpinnedevent", - "href": "/graphql/reference/objects#unpinnedevent" - }, - { - "name": "UnsubscribedEvent", - "id": "unsubscribedevent", - "href": "/graphql/reference/objects#unsubscribedevent" - }, - { - "name": "UserBlockedEvent", - "id": "userblockedevent", - "href": "/graphql/reference/objects#userblockedevent" - } - ] - }, - { - "name": "PushAllowanceActor", - "id": "pushallowanceactor", - "href": "/graphql/reference/unions#pushallowanceactor", - "description": "

Types that can be an actor.

", - "possibleTypes": [ - { - "name": "App", - "id": "app", - "href": "/graphql/reference/objects#app" - }, - { - "name": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - }, - { - "name": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "Reactor", - "id": "reactor", - "href": "/graphql/reference/unions#reactor", - "description": "

Types that can be assigned to reactions.

", - "possibleTypes": [ - { - "name": "Bot", - "id": "bot", - "href": "/graphql/reference/objects#bot" - }, - { - "name": "Mannequin", - "id": "mannequin", - "href": "/graphql/reference/objects#mannequin" - }, - { - "name": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "ReferencedSubject", - "id": "referencedsubject", - "href": "/graphql/reference/unions#referencedsubject", - "description": "

Any referencable object.

", - "possibleTypes": [ - { - "name": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue" - }, - { - "name": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "RenamedTitleSubject", - "id": "renamedtitlesubject", - "href": "/graphql/reference/unions#renamedtitlesubject", - "description": "

An object which has a renamable title.

", - "possibleTypes": [ - { - "name": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue" - }, - { - "name": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - } - ] - }, - { - "name": "RequestedReviewer", - "id": "requestedreviewer", - "href": "/graphql/reference/unions#requestedreviewer", - "description": "

Types that can be requested reviewers.

", - "possibleTypes": [ - { - "name": "Bot", - "id": "bot", - "href": "/graphql/reference/objects#bot" - }, - { - "name": "Mannequin", - "id": "mannequin", - "href": "/graphql/reference/objects#mannequin" - }, - { - "name": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - }, - { - "name": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "ReviewDismissalAllowanceActor", - "id": "reviewdismissalallowanceactor", - "href": "/graphql/reference/unions#reviewdismissalallowanceactor", - "description": "

Types that can be an actor.

", - "possibleTypes": [ - { - "name": "App", - "id": "app", - "href": "/graphql/reference/objects#app" - }, - { - "name": "Team", - "id": "team", - "href": "/graphql/reference/objects#team" - }, - { - "name": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "RuleParameters", - "id": "ruleparameters", - "href": "/graphql/reference/unions#ruleparameters", - "description": "

Types which can be parameters for RepositoryRule objects.

", - "possibleTypes": [ - { - "name": "BranchNamePatternParameters", - "id": "branchnamepatternparameters", - "href": "/graphql/reference/objects#branchnamepatternparameters" - }, - { - "name": "CodeScanningParameters", - "id": "codescanningparameters", - "href": "/graphql/reference/objects#codescanningparameters" - }, - { - "name": "CommitAuthorEmailPatternParameters", - "id": "commitauthoremailpatternparameters", - "href": "/graphql/reference/objects#commitauthoremailpatternparameters" - }, - { - "name": "CommitMessagePatternParameters", - "id": "commitmessagepatternparameters", - "href": "/graphql/reference/objects#commitmessagepatternparameters" - }, - { - "name": "CommitterEmailPatternParameters", - "id": "committeremailpatternparameters", - "href": "/graphql/reference/objects#committeremailpatternparameters" - }, - { - "name": "FileExtensionRestrictionParameters", - "id": "fileextensionrestrictionparameters", - "href": "/graphql/reference/objects#fileextensionrestrictionparameters" - }, - { - "name": "FilePathRestrictionParameters", - "id": "filepathrestrictionparameters", - "href": "/graphql/reference/objects#filepathrestrictionparameters" - }, - { - "name": "MaxFilePathLengthParameters", - "id": "maxfilepathlengthparameters", - "href": "/graphql/reference/objects#maxfilepathlengthparameters" - }, - { - "name": "MaxFileSizeParameters", - "id": "maxfilesizeparameters", - "href": "/graphql/reference/objects#maxfilesizeparameters" - }, - { - "name": "PullRequestParameters", - "id": "pullrequestparameters", - "href": "/graphql/reference/objects#pullrequestparameters" - }, - { - "name": "RequiredDeploymentsParameters", - "id": "requireddeploymentsparameters", - "href": "/graphql/reference/objects#requireddeploymentsparameters" - }, - { - "name": "RequiredStatusChecksParameters", - "id": "requiredstatuschecksparameters", - "href": "/graphql/reference/objects#requiredstatuschecksparameters" - }, - { - "name": "TagNamePatternParameters", - "id": "tagnamepatternparameters", - "href": "/graphql/reference/objects#tagnamepatternparameters" - }, - { - "name": "UpdateParameters", - "id": "updateparameters", - "href": "/graphql/reference/objects#updateparameters" - }, - { - "name": "WorkflowsParameters", - "id": "workflowsparameters", - "href": "/graphql/reference/objects#workflowsparameters" - } - ] - }, - { - "name": "RuleSource", - "id": "rulesource", - "href": "/graphql/reference/unions#rulesource", - "description": "

Types which can have RepositoryRule objects.

", - "possibleTypes": [ - { - "name": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "SearchResultItem", - "id": "searchresultitem", - "href": "/graphql/reference/unions#searchresultitem", - "description": "

The results of a search.

", - "possibleTypes": [ - { - "name": "App", - "id": "app", - "href": "/graphql/reference/objects#app" - }, - { - "name": "Discussion", - "id": "discussion", - "href": "/graphql/reference/objects#discussion" - }, - { - "name": "Issue", - "id": "issue", - "href": "/graphql/reference/objects#issue" - }, - { - "name": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - }, - { - "name": "PullRequest", - "id": "pullrequest", - "href": "/graphql/reference/objects#pullrequest" - }, - { - "name": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - }, - { - "name": "User", - "id": "user", - "href": "/graphql/reference/objects#user" - } - ] - }, - { - "name": "StatusCheckRollupContext", - "id": "statuscheckrollupcontext", - "href": "/graphql/reference/unions#statuscheckrollupcontext", - "description": "

Types that can be inside a StatusCheckRollup context.

", - "possibleTypes": [ - { - "name": "CheckRun", - "id": "checkrun", - "href": "/graphql/reference/objects#checkrun" - }, - { - "name": "StatusContext", - "id": "statuscontext", - "href": "/graphql/reference/objects#statuscontext" - } - ] - }, - { - "name": "UserListItems", - "id": "userlistitems", - "href": "/graphql/reference/unions#userlistitems", - "description": "

Types that can be added to a user list.

", - "possibleTypes": [ - { - "name": "Repository", - "id": "repository", - "href": "/graphql/reference/objects#repository" - } - ] - }, - { - "name": "VerifiableDomainOwner", - "id": "verifiabledomainowner", - "href": "/graphql/reference/unions#verifiabledomainowner", - "description": "

Types that can own a verifiable domain.

", - "possibleTypes": [ - { - "name": "Enterprise", - "id": "enterprise", - "href": "/graphql/reference/objects#enterprise" - }, - { - "name": "Organization", - "id": "organization", - "href": "/graphql/reference/objects#organization" - } - ] - } - ], - "inputObjects": [ - { - "name": "AbortQueuedMigrationsInput", - "id": "abortqueuedmigrationsinput", - "href": "/graphql/reference/input-objects#abortqueuedmigrationsinput", - "description": "

Autogenerated input type of AbortQueuedMigrations.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ownerId", - "description": "

The ID of the organization that is running the migrations.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "AbortRepositoryMigrationInput", - "id": "abortrepositorymigrationinput", - "href": "/graphql/reference/input-objects#abortrepositorymigrationinput", - "description": "

Autogenerated input type of AbortRepositoryMigration.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "migrationId", - "description": "

The ID of the migration to be aborted.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "AddAssigneesToAssignableInput", - "id": "addassigneestoassignableinput", - "href": "/graphql/reference/input-objects#addassigneestoassignableinput", - "description": "

Autogenerated input type of AddAssigneesToAssignable.

", - "inputFields": [ - { - "name": "assignableId", - "description": "

The id of the assignable object to add assignees to.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "assigneeIds", - "description": "

The id of users to add as assignees.

", - "type": "[ID!]!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "AddCommentInput", - "id": "addcommentinput", - "href": "/graphql/reference/input-objects#addcommentinput", - "description": "

Autogenerated input type of AddComment.

", - "inputFields": [ - { - "name": "body", - "description": "

The contents of the comment.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "subjectId", - "description": "

The Node ID of the subject to modify.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "AddDiscussionCommentInput", - "id": "adddiscussioncommentinput", - "href": "/graphql/reference/input-objects#adddiscussioncommentinput", - "description": "

Autogenerated input type of AddDiscussionComment.

", - "inputFields": [ - { - "name": "body", - "description": "

The contents of the comment.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "discussionId", - "description": "

The Node ID of the discussion to comment on.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "replyToId", - "description": "

The Node ID of the discussion comment within this discussion to reply to.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "AddDiscussionPollVoteInput", - "id": "adddiscussionpollvoteinput", - "href": "/graphql/reference/input-objects#adddiscussionpollvoteinput", - "description": "

Autogenerated input type of AddDiscussionPollVote.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pollOptionId", - "description": "

The Node ID of the discussion poll option to vote for.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "AddEnterpriseAdminInput", - "id": "addenterpriseadmininput", - "href": "/graphql/reference/input-objects#addenterpriseadmininput", - "description": "

Autogenerated input type of AddEnterpriseAdmin.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise account to which the administrator should be added.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "login", - "description": "

The login of the user to add as an administrator.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "AddEnterpriseOrganizationMemberInput", - "id": "addenterpriseorganizationmemberinput", - "href": "/graphql/reference/input-objects#addenterpriseorganizationmemberinput", - "description": "

Autogenerated input type of AddEnterpriseOrganizationMember.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise which owns the organization.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "organizationId", - "description": "

The ID of the organization the users will be added to.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "role", - "description": "

The role to assign the users in the organization.

", - "type": "OrganizationMemberRole", - "id": "organizationmemberrole", - "href": "/graphql/reference/enums#organizationmemberrole" - }, - { - "name": "userIds", - "description": "

The IDs of the enterprise members to add.

", - "type": "[ID!]!", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - ] - }, - { - "name": "AddLabelsToLabelableInput", - "id": "addlabelstolabelableinput", - "href": "/graphql/reference/input-objects#addlabelstolabelableinput", - "description": "

Autogenerated input type of AddLabelsToLabelable.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "labelIds", - "description": "

The ids of the labels to add.

", - "type": "[ID!]!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "labelableId", - "description": "

The id of the labelable object to add labels to.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "AddProjectCardInput", - "id": "addprojectcardinput", - "href": "/graphql/reference/input-objects#addprojectcardinput", - "description": "

Autogenerated input type of AddProjectCard.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "contentId", - "description": "

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

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "note", - "description": "

The note on the card.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "projectColumnId", - "description": "

The Node ID of the ProjectColumn.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "AddProjectColumnInput", - "id": "addprojectcolumninput", - "href": "/graphql/reference/input-objects#addprojectcolumninput", - "description": "

Autogenerated input type of AddProjectColumn.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The name of the column.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "projectId", - "description": "

The Node ID of the project.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "AddProjectV2DraftIssueInput", - "id": "addprojectv2draftissueinput", - "href": "/graphql/reference/input-objects#addprojectv2draftissueinput", - "description": "

Autogenerated input type of AddProjectV2DraftIssue.

", - "inputFields": [ - { - "name": "assigneeIds", - "description": "

The IDs of the assignees of the draft issue.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "body", - "description": "

The body of the draft issue.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "projectId", - "description": "

The ID of the Project to add the draft issue to.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "title", - "description": "

The title of the draft issue. A project item can also be created by providing\nthe URL of an Issue or Pull Request if you have access.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "AddProjectV2ItemByIdInput", - "id": "addprojectv2itembyidinput", - "href": "/graphql/reference/input-objects#addprojectv2itembyidinput", - "description": "

Autogenerated input type of AddProjectV2ItemById.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "contentId", - "description": "

The id of the Issue or Pull Request to add.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "projectId", - "description": "

The ID of the Project to add the item to.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "AddPullRequestReviewCommentInput", - "id": "addpullrequestreviewcommentinput", - "href": "/graphql/reference/input-objects#addpullrequestreviewcommentinput", - "description": "

Autogenerated input type of AddPullRequestReviewComment.

", - "inputFields": [ - { - "name": "body", - "description": "

The text of the comment. This field is required

\n

Upcoming Change on 2023-10-01 UTC\nDescription: body will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead\nReason: We are deprecating the addPullRequestReviewComment mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "commitOID", - "description": "

The SHA of the commit to comment on.

\n

Upcoming Change on 2023-10-01 UTC\nDescription: commitOID will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead\nReason: We are deprecating the addPullRequestReviewComment mutation.

", - "type": "GitObjectID", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "inReplyTo", - "description": "

The comment id to reply to.

\n

Upcoming Change on 2023-10-01 UTC\nDescription: inReplyTo will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead\nReason: We are deprecating the addPullRequestReviewComment mutation.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "path", - "description": "

The relative path of the file to comment on.

\n

Upcoming Change on 2023-10-01 UTC\nDescription: path will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead\nReason: We are deprecating the addPullRequestReviewComment mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "position", - "description": "

The line index in the diff to comment on.

\n

Upcoming Change on 2023-10-01 UTC\nDescription: position will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead\nReason: We are deprecating the addPullRequestReviewComment mutation.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "pullRequestId", - "description": "

The node ID of the pull request reviewing

\n

Upcoming Change on 2023-10-01 UTC\nDescription: pullRequestId will be removed. use\naddPullRequestReviewThread or addPullRequestReviewThreadReply instead\nReason: We are deprecating the addPullRequestReviewComment mutation.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "pullRequestReviewId", - "description": "

The Node ID of the review to modify.

\n

Upcoming Change on 2023-10-01 UTC\nDescription: pullRequestReviewId will be removed. use\naddPullRequestReviewThread or addPullRequestReviewThreadReply instead\nReason: We are deprecating the addPullRequestReviewComment mutation.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "AddPullRequestReviewInput", - "id": "addpullrequestreviewinput", - "href": "/graphql/reference/input-objects#addpullrequestreviewinput", - "description": "

Autogenerated input type of AddPullRequestReview.

", - "inputFields": [ - { - "name": "body", - "description": "

The contents of the review body comment.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "comments", - "description": "

The review line comments.

\n

Upcoming Change on 2023-10-01 UTC\nDescription: comments will be removed. use the threads argument instead\nReason: We are deprecating comment fields that use diff-relative positioning.

", - "type": "[DraftPullRequestReviewComment]", - "id": "draftpullrequestreviewcomment", - "href": "/graphql/reference/input-objects#draftpullrequestreviewcomment" - }, - { - "name": "commitOID", - "description": "

The commit OID the review pertains to.

", - "type": "GitObjectID", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "event", - "description": "

The event to perform on the pull request review.

", - "type": "PullRequestReviewEvent", - "id": "pullrequestreviewevent", - "href": "/graphql/reference/enums#pullrequestreviewevent" - }, - { - "name": "pullRequestId", - "description": "

The Node ID of the pull request to modify.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "threads", - "description": "

The review line comment threads.

", - "type": "[DraftPullRequestReviewThread]", - "id": "draftpullrequestreviewthread", - "href": "/graphql/reference/input-objects#draftpullrequestreviewthread" - } - ] - }, - { - "name": "AddPullRequestReviewThreadInput", - "id": "addpullrequestreviewthreadinput", - "href": "/graphql/reference/input-objects#addpullrequestreviewthreadinput", - "description": "

Autogenerated input type of AddPullRequestReviewThread.

", - "inputFields": [ - { - "name": "body", - "description": "

Body of the thread's first comment.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "line", - "description": "

The line of the blob to which the thread refers, required for line-level\nthreads. The end of the line range for multi-line comments.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "path", - "description": "

Path to the file being commented on.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequestId", - "description": "

The node ID of the pull request reviewing.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "pullRequestReviewId", - "description": "

The Node ID of the review to modify.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "side", - "description": "

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

", - "type": "DiffSide", - "id": "diffside", - "href": "/graphql/reference/enums#diffside" - }, - { - "name": "startLine", - "description": "

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

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "startSide", - "description": "

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

", - "type": "DiffSide", - "id": "diffside", - "href": "/graphql/reference/enums#diffside" - }, - { - "name": "subjectType", - "description": "

The level at which the comments in the corresponding thread are targeted, can be a diff line or a file.

", - "type": "PullRequestReviewThreadSubjectType", - "id": "pullrequestreviewthreadsubjecttype", - "href": "/graphql/reference/enums#pullrequestreviewthreadsubjecttype" - } - ] - }, - { - "name": "AddPullRequestReviewThreadReplyInput", - "id": "addpullrequestreviewthreadreplyinput", - "href": "/graphql/reference/input-objects#addpullrequestreviewthreadreplyinput", - "description": "

Autogenerated input type of AddPullRequestReviewThreadReply.

", - "inputFields": [ - { - "name": "body", - "description": "

The text of the reply.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequestReviewId", - "description": "

The Node ID of the pending review to which the reply will belong.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "pullRequestReviewThreadId", - "description": "

The Node ID of the thread to which this reply is being written.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "AddReactionInput", - "id": "addreactioninput", - "href": "/graphql/reference/input-objects#addreactioninput", - "description": "

Autogenerated input type of AddReaction.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "content", - "description": "

The name of the emoji to react with.

", - "type": "ReactionContent!", - "id": "reactioncontent", - "href": "/graphql/reference/enums#reactioncontent" - }, - { - "name": "subjectId", - "description": "

The Node ID of the subject to modify.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "AddStarInput", - "id": "addstarinput", - "href": "/graphql/reference/input-objects#addstarinput", - "description": "

Autogenerated input type of AddStar.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "starrableId", - "description": "

The Starrable ID to star.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "AddUpvoteInput", - "id": "addupvoteinput", - "href": "/graphql/reference/input-objects#addupvoteinput", - "description": "

Autogenerated input type of AddUpvote.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "subjectId", - "description": "

The Node ID of the discussion or comment to upvote.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "AddVerifiableDomainInput", - "id": "addverifiabledomaininput", - "href": "/graphql/reference/input-objects#addverifiabledomaininput", - "description": "

Autogenerated input type of AddVerifiableDomain.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "domain", - "description": "

The URL of the domain.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "ownerId", - "description": "

The ID of the owner to add the domain to.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "ApproveDeploymentsInput", - "id": "approvedeploymentsinput", - "href": "/graphql/reference/input-objects#approvedeploymentsinput", - "description": "

Autogenerated input type of ApproveDeployments.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "comment", - "description": "

Optional comment for approving deployments.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "environmentIds", - "description": "

The ids of environments to reject deployments.

", - "type": "[ID!]!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "workflowRunId", - "description": "

The node ID of the workflow run containing the pending deployments.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "ApproveVerifiableDomainInput", - "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", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The ID of the verifiable domain to approve.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "ArchiveProjectV2ItemInput", - "id": "archiveprojectv2iteminput", - "href": "/graphql/reference/input-objects#archiveprojectv2iteminput", - "description": "

Autogenerated input type of ArchiveProjectV2Item.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "itemId", - "description": "

The ID of the ProjectV2Item to archive.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "projectId", - "description": "

The ID of the Project to archive the item from.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "ArchiveRepositoryInput", - "id": "archiverepositoryinput", - "href": "/graphql/reference/input-objects#archiverepositoryinput", - "description": "

Autogenerated input type of ArchiveRepository.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryId", - "description": "

The ID of the repository to mark as archived.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "AuditLogOrder", - "id": "auditlogorder", - "href": "/graphql/reference/input-objects#auditlogorder", - "description": "

Ordering options for Audit Log connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order Audit Logs by.

", - "type": "AuditLogOrderField", - "id": "auditlogorderfield", - "href": "/graphql/reference/enums#auditlogorderfield" - } - ] - }, - { - "name": "BranchNamePatternParametersInput", - "id": "branchnamepatternparametersinput", - "href": "/graphql/reference/input-objects#branchnamepatternparametersinput", - "description": "

Parameters to be used for the branch_name_pattern rule.

", - "inputFields": [ - { - "name": "name", - "description": "

How this rule will appear to users.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "operator", - "description": "

The operator to use for matching.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pattern", - "description": "

The pattern to match with.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "ChangeUserStatusInput", - "id": "changeuserstatusinput", - "href": "/graphql/reference/input-objects#changeuserstatusinput", - "description": "

Autogenerated input type of ChangeUserStatus.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "emoji", - "description": "

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

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "expiresAt", - "description": "

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

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "limitedAvailability", - "description": "

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

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "message", - "description": "

A short description of your current status.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationId", - "description": "

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

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "CheckAnnotationData", - "id": "checkannotationdata", - "href": "/graphql/reference/input-objects#checkannotationdata", - "description": "

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

", - "inputFields": [ - { - "name": "annotationLevel", - "description": "

Represents an annotation's information level.

", - "type": "CheckAnnotationLevel!", - "id": "checkannotationlevel", - "href": "/graphql/reference/enums#checkannotationlevel" - }, - { - "name": "location", - "description": "

The location of the annotation.

", - "type": "CheckAnnotationRange!", - "id": "checkannotationrange", - "href": "/graphql/reference/input-objects#checkannotationrange" - }, - { - "name": "message", - "description": "

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

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "path", - "description": "

The path of the file to add an annotation to.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "rawDetails", - "description": "

Details about this annotation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "title", - "description": "

The title that represents the annotation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CheckAnnotationRange", - "id": "checkannotationrange", - "href": "/graphql/reference/input-objects#checkannotationrange", - "description": "

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

", - "inputFields": [ - { - "name": "endColumn", - "description": "

The ending column of the range.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "endLine", - "description": "

The ending line of the range.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "startColumn", - "description": "

The starting column of the range.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "startLine", - "description": "

The starting line of the range.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "CheckRunAction", - "id": "checkrunaction", - "href": "/graphql/reference/input-objects#checkrunaction", - "description": "

Possible further actions the integrator can perform.

", - "inputFields": [ - { - "name": "description", - "description": "

A short explanation of what this action would do.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "identifier", - "description": "

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

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "label", - "description": "

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

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CheckRunFilter", - "id": "checkrunfilter", - "href": "/graphql/reference/input-objects#checkrunfilter", - "description": "

The filters that are available when fetching check runs.

", - "inputFields": [ - { - "name": "appId", - "description": "

Filters the check runs created by this application ID.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "checkName", - "description": "

Filters the check runs by this name.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "checkType", - "description": "

Filters the check runs by this type.

", - "type": "CheckRunType", - "id": "checkruntype", - "href": "/graphql/reference/enums#checkruntype" - }, - { - "name": "conclusions", - "description": "

Filters the check runs by these conclusions.

", - "type": "[CheckConclusionState!]", - "id": "checkconclusionstate", - "href": "/graphql/reference/enums#checkconclusionstate" - }, - { - "name": "status", - "description": "

Filters the check runs by this status. Superceded by statuses.

", - "type": "CheckStatusState", - "id": "checkstatusstate", - "href": "/graphql/reference/enums#checkstatusstate" - }, - { - "name": "statuses", - "description": "

Filters the check runs by this status. Overrides status.

", - "type": "[CheckStatusState!]", - "id": "checkstatusstate", - "href": "/graphql/reference/enums#checkstatusstate" - } - ] - }, - { - "name": "CheckRunOutput", - "id": "checkrunoutput", - "href": "/graphql/reference/input-objects#checkrunoutput", - "description": "

Descriptive details about the check run.

", - "inputFields": [ - { - "name": "annotations", - "description": "

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

", - "type": "[CheckAnnotationData!]", - "id": "checkannotationdata", - "href": "/graphql/reference/input-objects#checkannotationdata" - }, - { - "name": "images", - "description": "

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

", - "type": "[CheckRunOutputImage!]", - "id": "checkrunoutputimage", - "href": "/graphql/reference/input-objects#checkrunoutputimage" - }, - { - "name": "summary", - "description": "

The summary of the check run (supports Commonmark).

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "text", - "description": "

The details of the check run (supports Commonmark).

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "title", - "description": "

A title to provide for this check run.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CheckRunOutputImage", - "id": "checkrunoutputimage", - "href": "/graphql/reference/input-objects#checkrunoutputimage", - "description": "

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

", - "inputFields": [ - { - "name": "alt", - "description": "

The alternative text for the image.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "caption", - "description": "

A short image description.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "imageUrl", - "description": "

The full URL of the image.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - } - ] - }, - { - "name": "CheckSuiteAutoTriggerPreference", - "id": "checksuiteautotriggerpreference", - "href": "/graphql/reference/input-objects#checksuiteautotriggerpreference", - "description": "

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

", - "inputFields": [ - { - "name": "appId", - "description": "

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

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "setting", - "description": "

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "CheckSuiteFilter", - "id": "checksuitefilter", - "href": "/graphql/reference/input-objects#checksuitefilter", - "description": "

The filters that are available when fetching check suites.

", - "inputFields": [ - { - "name": "appId", - "description": "

Filters the check suites created by this application ID.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "checkName", - "description": "

Filters the check suites by this name.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "ClearLabelsFromLabelableInput", - "id": "clearlabelsfromlabelableinput", - "href": "/graphql/reference/input-objects#clearlabelsfromlabelableinput", - "description": "

Autogenerated input type of ClearLabelsFromLabelable.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "labelableId", - "description": "

The id of the labelable object to clear the labels from.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "ClearProjectV2ItemFieldValueInput", - "id": "clearprojectv2itemfieldvalueinput", - "href": "/graphql/reference/input-objects#clearprojectv2itemfieldvalueinput", - "description": "

Autogenerated input type of ClearProjectV2ItemFieldValue.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "fieldId", - "description": "

The ID of the field to be cleared.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "itemId", - "description": "

The ID of the item to be cleared.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "projectId", - "description": "

The ID of the Project.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "CloneProjectInput", - "id": "cloneprojectinput", - "href": "/graphql/reference/input-objects#cloneprojectinput", - "description": "

Autogenerated input type of CloneProject.

", - "inputFields": [ - { - "name": "body", - "description": "

The description of the project.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "includeWorkflows", - "description": "

Whether or not to clone the source project's workflows.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "name", - "description": "

The name of the project.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "public", - "description": "

The visibility of the project, defaults to false (private).

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "sourceId", - "description": "

The source project to clone.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "targetOwnerId", - "description": "

The owner ID to create the project under.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "CloneTemplateRepositoryInput", - "id": "clonetemplaterepositoryinput", - "href": "/graphql/reference/input-objects#clonetemplaterepositoryinput", - "description": "

Autogenerated input type of CloneTemplateRepository.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "description", - "description": "

A short description of the new repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "includeAllBranches", - "description": "

Whether to copy all branches from the template to the new repository. Defaults\nto copying only the default branch of the template.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "name", - "description": "

The name of the new repository.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ownerId", - "description": "

The ID of the owner for the new repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "repositoryId", - "description": "

The Node ID of the template repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "visibility", - "description": "

Indicates the repository's visibility level.

", - "type": "RepositoryVisibility!", - "id": "repositoryvisibility", - "href": "/graphql/reference/enums#repositoryvisibility" - } - ] - }, - { - "name": "CloseDiscussionInput", - "id": "closediscussioninput", - "href": "/graphql/reference/input-objects#closediscussioninput", - "description": "

Autogenerated input type of CloseDiscussion.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "discussionId", - "description": "

ID of the discussion to be closed.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "reason", - "description": "

The reason why the discussion is being closed.

", - "type": "DiscussionCloseReason", - "id": "discussionclosereason", - "href": "/graphql/reference/enums#discussionclosereason" - } - ] - }, - { - "name": "CloseIssueInput", - "id": "closeissueinput", - "href": "/graphql/reference/input-objects#closeissueinput", - "description": "

Autogenerated input type of CloseIssue.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "issueId", - "description": "

ID of the issue to be closed.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "stateReason", - "description": "

The reason the issue is to be closed.

", - "type": "IssueClosedStateReason", - "id": "issueclosedstatereason", - "href": "/graphql/reference/enums#issueclosedstatereason" - } - ] - }, - { - "name": "ClosePullRequestInput", - "id": "closepullrequestinput", - "href": "/graphql/reference/input-objects#closepullrequestinput", - "description": "

Autogenerated input type of ClosePullRequest.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequestId", - "description": "

ID of the pull request to be closed.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "CodeScanningParametersInput", - "id": "codescanningparametersinput", - "href": "/graphql/reference/input-objects#codescanningparametersinput", - "description": "

Choose which tools must provide code scanning results before the reference is\nupdated. When configured, code scanning must be enabled and have results for\nboth the commit and the reference being updated.

", - "inputFields": [ - { - "name": "codeScanningTools", - "description": "

Tools that must provide code scanning results for this rule to pass.

", - "type": "[CodeScanningToolInput!]!", - "id": "codescanningtoolinput", - "href": "/graphql/reference/input-objects#codescanningtoolinput" - } - ] - }, - { - "name": "CodeScanningToolInput", - "id": "codescanningtoolinput", - "href": "/graphql/reference/input-objects#codescanningtoolinput", - "description": "

A tool that must provide code scanning results for this rule to pass.

", - "inputFields": [ - { - "name": "alertsThreshold", - "description": "

The severity level at which code scanning results that raise alerts block a\nreference update. For more information on alert severity levels, see \"About code scanning alerts.\".

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "securityAlertsThreshold", - "description": "

The severity level at which code scanning results that raise security alerts\nblock a reference update. For more information on security severity levels,\nsee \"About code scanning alerts.\".

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "tool", - "description": "

The name of a code scanning tool.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CommitAuthor", - "id": "commitauthor", - "href": "/graphql/reference/input-objects#commitauthor", - "description": "

Specifies an author for filtering Git commits.

", - "inputFields": [ - { - "name": "emails", - "description": "

Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.

", - "type": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

ID of a User to filter by. If non-null, only commits authored by this user\nwill be returned. This field takes precedence over emails.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - ] - }, - { - "name": "CommitAuthorEmailPatternParametersInput", - "id": "commitauthoremailpatternparametersinput", - "href": "/graphql/reference/input-objects#commitauthoremailpatternparametersinput", - "description": "

Parameters to be used for the commit_author_email_pattern rule.

", - "inputFields": [ - { - "name": "name", - "description": "

How this rule will appear to users.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "operator", - "description": "

The operator to use for matching.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pattern", - "description": "

The pattern to match with.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CommitContributionOrder", - "id": "commitcontributionorder", - "href": "/graphql/reference/input-objects#commitcontributionorder", - "description": "

Ordering options for commit contribution connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field by which to order commit contributions.

", - "type": "CommitContributionOrderField!", - "id": "commitcontributionorderfield", - "href": "/graphql/reference/enums#commitcontributionorderfield" - } - ] - }, - { - "name": "CommitMessage", - "id": "commitmessage", - "href": "/graphql/reference/input-objects#commitmessage", - "description": "

A message to include with a new commit.

", - "inputFields": [ - { - "name": "body", - "description": "

The body of the message.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "headline", - "description": "

The headline of the message.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CommitMessagePatternParametersInput", - "id": "commitmessagepatternparametersinput", - "href": "/graphql/reference/input-objects#commitmessagepatternparametersinput", - "description": "

Parameters to be used for the commit_message_pattern rule.

", - "inputFields": [ - { - "name": "name", - "description": "

How this rule will appear to users.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "operator", - "description": "

The operator to use for matching.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pattern", - "description": "

The pattern to match with.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CommittableBranch", - "id": "committablebranch", - "href": "/graphql/reference/input-objects#committablebranch", - "description": "

A git ref for a commit to be appended to.

\n

The ref must be a branch, i.e. its fully qualified name must start\nwith refs/heads/ (although the input is not required to be fully\nqualified).

\n

The Ref may be specified by its global node ID or by the\nrepositoryNameWithOwner and branchName.

\n

Examples

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using repositoryNameWithOwner and branchName:

\n
{\n  \"repositoryNameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", - "inputFields": [ - { - "name": "branchName", - "description": "

The unqualified name of the branch to append the commit to.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the Ref to be updated.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "repositoryNameWithOwner", - "description": "

The nameWithOwner of the repository to commit to.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CommitterEmailPatternParametersInput", - "id": "committeremailpatternparametersinput", - "href": "/graphql/reference/input-objects#committeremailpatternparametersinput", - "description": "

Parameters to be used for the committer_email_pattern rule.

", - "inputFields": [ - { - "name": "name", - "description": "

How this rule will appear to users.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "operator", - "description": "

The operator to use for matching.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pattern", - "description": "

The pattern to match with.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "ContributionOrder", - "id": "contributionorder", - "href": "/graphql/reference/input-objects#contributionorder", - "description": "

Ordering options for contribution connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - } - ] - }, - { - "name": "ConvertProjectCardNoteToIssueInput", - "id": "convertprojectcardnotetoissueinput", - "href": "/graphql/reference/input-objects#convertprojectcardnotetoissueinput", - "description": "

Autogenerated input type of ConvertProjectCardNoteToIssue.

", - "inputFields": [ - { - "name": "body", - "description": "

The body of the newly created issue.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "projectCardId", - "description": "

The ProjectCard ID to convert.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "repositoryId", - "description": "

The ID of the repository to create the issue in.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "title", - "description": "

The title of the newly created issue. Defaults to the card's note text.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "ConvertPullRequestToDraftInput", - "id": "convertpullrequesttodraftinput", - "href": "/graphql/reference/input-objects#convertpullrequesttodraftinput", - "description": "

Autogenerated input type of ConvertPullRequestToDraft.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequestId", - "description": "

ID of the pull request to convert to draft.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "CopyProjectV2Input", - "id": "copyprojectv2input", - "href": "/graphql/reference/input-objects#copyprojectv2input", - "description": "

Autogenerated input type of CopyProjectV2.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "includeDraftIssues", - "description": "

Include draft issues in the new project.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "ownerId", - "description": "

The owner ID of the new project.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "projectId", - "description": "

The ID of the source Project to copy.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "title", - "description": "

The title of the project.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CreateAttributionInvitationInput", - "id": "createattributioninvitationinput", - "href": "/graphql/reference/input-objects#createattributioninvitationinput", - "description": "

Autogenerated input type of CreateAttributionInvitation.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ownerId", - "description": "

The Node ID of the owner scoping the reattributable data.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "sourceId", - "description": "

The Node ID of the account owning the data to reattribute.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "targetId", - "description": "

The Node ID of the account which may claim the data.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "CreateBranchProtectionRuleInput", - "id": "createbranchprotectionruleinput", - "href": "/graphql/reference/input-objects#createbranchprotectionruleinput", - "description": "

Autogenerated input type of CreateBranchProtectionRule.

", - "inputFields": [ - { - "name": "allowsDeletions", - "description": "

Can this branch be deleted.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "allowsForcePushes", - "description": "

Are force pushes allowed on this branch.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "blocksCreations", - "description": "

Is branch creation a protected operation.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "bypassForcePushActorIds", - "description": "

A list of User, Team, or App IDs allowed to bypass force push targeting matching branches.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "bypassPullRequestActorIds", - "description": "

A list of User, Team, or App IDs allowed to bypass pull requests targeting matching branches.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "dismissesStaleReviews", - "description": "

Will new commits pushed to matching branches dismiss pull request review approvals.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isAdminEnforced", - "description": "

Can admins override branch protection.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "lockAllowsFetchAndMerge", - "description": "

Whether users can pull changes from upstream when the branch is locked. Set to\ntrue to allow fork syncing. Set to false to prevent fork syncing.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "lockBranch", - "description": "

Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "pattern", - "description": "

The glob-like pattern used to determine matching branches.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pushActorIds", - "description": "

A list of User, Team, or App IDs allowed to push to matching branches.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "repositoryId", - "description": "

The global relay id of the repository in which a new branch protection rule should be created in.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "requireLastPushApproval", - "description": "

Whether the most recent push must be approved by someone other than the person who pushed it.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiredApprovingReviewCount", - "description": "

Number of approving reviews required to update matching branches.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "requiredDeploymentEnvironments", - "description": "

The list of required deployment environments.

", - "type": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "requiredStatusCheckContexts", - "description": "

List of required status check contexts that must pass for commits to be accepted to matching branches.

", - "type": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "requiredStatusChecks", - "description": "

The list of required status checks.

", - "type": "[RequiredStatusCheckInput!]", - "id": "requiredstatuscheckinput", - "href": "/graphql/reference/input-objects#requiredstatuscheckinput" - }, - { - "name": "requiresApprovingReviews", - "description": "

Are approving reviews required to update matching branches.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresCodeOwnerReviews", - "description": "

Are reviews from code owners required to update matching branches.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresCommitSignatures", - "description": "

Are commits required to be signed.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresConversationResolution", - "description": "

Are conversations required to be resolved before merging.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresDeployments", - "description": "

Are successful deployments required before merging.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresLinearHistory", - "description": "

Are merge commits prohibited from being pushed to this branch.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresStatusChecks", - "description": "

Are status checks required to update matching branches.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresStrictStatusChecks", - "description": "

Are branches required to be up to date before merging.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "restrictsPushes", - "description": "

Is pushing to matching branches restricted.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "restrictsReviewDismissals", - "description": "

Is dismissal of pull request reviews restricted.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "reviewDismissalActorIds", - "description": "

A list of User, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - ] - }, - { - "name": "CreateCheckRunInput", - "id": "createcheckruninput", - "href": "/graphql/reference/input-objects#createcheckruninput", - "description": "

Autogenerated input type of CreateCheckRun.

", - "inputFields": [ - { - "name": "actions", - "description": "

Possible further actions the integrator can perform, which a user may trigger.

", - "type": "[CheckRunAction!]", - "id": "checkrunaction", - "href": "/graphql/reference/input-objects#checkrunaction" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "completedAt", - "description": "

The time that the check run finished.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "conclusion", - "description": "

The final conclusion of the check.

", - "type": "CheckConclusionState", - "id": "checkconclusionstate", - "href": "/graphql/reference/enums#checkconclusionstate" - }, - { - "name": "detailsUrl", - "description": "

The URL of the integrator's site that has the full details of the check.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "externalId", - "description": "

A reference for the run on the integrator's system.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "headSha", - "description": "

The SHA of the head commit.

", - "type": "GitObjectID!", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "name", - "description": "

The name of the check.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "output", - "description": "

Descriptive details about the run.

", - "type": "CheckRunOutput", - "id": "checkrunoutput", - "href": "/graphql/reference/input-objects#checkrunoutput" - }, - { - "name": "repositoryId", - "description": "

The node ID of the repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "startedAt", - "description": "

The time that the check run began.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "status", - "description": "

The current status.

", - "type": "RequestableCheckStatusState", - "id": "requestablecheckstatusstate", - "href": "/graphql/reference/enums#requestablecheckstatusstate" - } - ] - }, - { - "name": "CreateCheckSuiteInput", - "id": "createchecksuiteinput", - "href": "/graphql/reference/input-objects#createchecksuiteinput", - "description": "

Autogenerated input type of CreateCheckSuite.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "headSha", - "description": "

The SHA of the head commit.

", - "type": "GitObjectID!", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "repositoryId", - "description": "

The Node ID of the repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "CreateCommitOnBranchInput", - "id": "createcommitonbranchinput", - "href": "/graphql/reference/input-objects#createcommitonbranchinput", - "description": "

Autogenerated input type of CreateCommitOnBranch.

", - "inputFields": [ - { - "name": "branch", - "description": "

The Ref to be updated. Must be a branch.

", - "type": "CommittableBranch!", - "id": "committablebranch", - "href": "/graphql/reference/input-objects#committablebranch" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "expectedHeadOid", - "description": "

The git commit oid expected at the head of the branch prior to the commit.

", - "type": "GitObjectID!", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "fileChanges", - "description": "

A description of changes to files in this commit.

", - "type": "FileChanges", - "id": "filechanges", - "href": "/graphql/reference/input-objects#filechanges" - }, - { - "name": "message", - "description": "

The commit message the be included with the commit.

", - "type": "CommitMessage!", - "id": "commitmessage", - "href": "/graphql/reference/input-objects#commitmessage" - } - ] - }, - { - "name": "CreateDeploymentInput", - "id": "createdeploymentinput", - "href": "/graphql/reference/input-objects#createdeploymentinput", - "description": "

Autogenerated input type of CreateDeployment.

", - "inputFields": [ - { - "name": "autoMerge", - "description": "

Attempt to automatically merge the default branch into the requested ref, defaults to true.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "description", - "description": "

Short description of the deployment.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "environment", - "description": "

Name for the target deployment environment.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "payload", - "description": "

JSON payload with extra information about the deployment.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "refId", - "description": "

The node ID of the ref to be deployed.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "repositoryId", - "description": "

The node ID of the repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "requiredContexts", - "description": "

The status contexts to verify against commit status checks. To bypass required\ncontexts, pass an empty array. Defaults to all unique contexts.

", - "type": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "task", - "description": "

Specifies a task to execute.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CreateDeploymentStatusInput", - "id": "createdeploymentstatusinput", - "href": "/graphql/reference/input-objects#createdeploymentstatusinput", - "description": "

Autogenerated input type of CreateDeploymentStatus.

", - "inputFields": [ - { - "name": "autoInactive", - "description": "

Adds a new inactive status to all non-transient, non-production environment\ndeployments with the same repository and environment name as the created\nstatus's deployment.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "deploymentId", - "description": "

The node ID of the deployment.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "description", - "description": "

A short description of the status. Maximum length of 140 characters.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "environment", - "description": "

If provided, updates the environment of the deploy. Otherwise, does not modify the environment.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "environmentUrl", - "description": "

Sets the URL for accessing your environment.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "logUrl", - "description": "

The log URL to associate with this status. This URL should contain\noutput to keep the user updated while the task is running or serve as\nhistorical information for what happened in the deployment.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "state", - "description": "

The state of the deployment.

", - "type": "DeploymentStatusState!", - "id": "deploymentstatusstate", - "href": "/graphql/reference/enums#deploymentstatusstate" - } - ] - }, - { - "name": "CreateDiscussionInput", - "id": "creatediscussioninput", - "href": "/graphql/reference/input-objects#creatediscussioninput", - "description": "

Autogenerated input type of CreateDiscussion.

", - "inputFields": [ - { - "name": "body", - "description": "

The body of the discussion.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "categoryId", - "description": "

The id of the discussion category to associate with this discussion.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryId", - "description": "

The id of the repository on which to create the discussion.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "title", - "description": "

The title of the discussion.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CreateEnterpriseOrganizationInput", - "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", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "billingEmail", - "description": "

The email used for sending billing receipts.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise owning the new organization.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "login", - "description": "

The login of the new organization.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "profileName", - "description": "

The profile name of the new organization.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CreateEnvironmentInput", - "id": "createenvironmentinput", - "href": "/graphql/reference/input-objects#createenvironmentinput", - "description": "

Autogenerated input type of CreateEnvironment.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The name of the environment.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryId", - "description": "

The node ID of the repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "CreateIpAllowListEntryInput", - "id": "createipallowlistentryinput", - "href": "/graphql/reference/input-objects#createipallowlistentryinput", - "description": "

Autogenerated input type of CreateIpAllowListEntry.

", - "inputFields": [ - { - "name": "allowListValue", - "description": "

An IP address or range of addresses in CIDR notation.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "isActive", - "description": "

Whether the IP allow list entry is active when an IP allow list is enabled.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "name", - "description": "

An optional name for the IP allow list entry.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ownerId", - "description": "

The ID of the owner for which to create the new IP allow list entry.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "CreateIssueInput", - "id": "createissueinput", - "href": "/graphql/reference/input-objects#createissueinput", - "description": "

Autogenerated input type of CreateIssue.

", - "inputFields": [ - { - "name": "assigneeIds", - "description": "

The Node ID for the user assignee for this issue.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "body", - "description": "

The body for the issue description.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "issueTemplate", - "description": "

The name of an issue template in the repository, assigns labels and assignees from the template to the issue.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "labelIds", - "description": "

An array of Node IDs of labels for this issue.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "milestoneId", - "description": "

The Node ID of the milestone for this issue.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "projectIds", - "description": "

An array of Node IDs for projects associated with this issue.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "repositoryId", - "description": "

The Node ID of the repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "title", - "description": "

The title for the issue.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CreateLabelInput", - "id": "createlabelinput", - "href": "/graphql/reference/input-objects#createlabelinput", - "description": "

Autogenerated input type of CreateLabel.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "color", - "description": "

A 6 character hex code, without the leading #, identifying the color of the label.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "description", - "description": "

A brief description of the label, such as its purpose.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The name of the label.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryId", - "description": "

The Node ID of the repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "CreateLinkedBranchInput", - "id": "createlinkedbranchinput", - "href": "/graphql/reference/input-objects#createlinkedbranchinput", - "description": "

Autogenerated input type of CreateLinkedBranch.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "issueId", - "description": "

ID of the issue to link to.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "name", - "description": "

The name of the new branch. Defaults to issue number and title.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "oid", - "description": "

The commit SHA to base the new branch on.

", - "type": "GitObjectID!", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "repositoryId", - "description": "

ID of the repository to create the branch in. Defaults to the issue repository.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "CreateMigrationSourceInput", - "id": "createmigrationsourceinput", - "href": "/graphql/reference/input-objects#createmigrationsourceinput", - "description": "

Autogenerated input type of CreateMigrationSource.

", - "inputFields": [ - { - "name": "accessToken", - "description": "

The migration source access token.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "githubPat", - "description": "

The GitHub personal access token of the user importing to the target repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The migration source name.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ownerId", - "description": "

The ID of the organization that will own the migration source.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "type", - "description": "

The migration source type.

", - "type": "MigrationSourceType!", - "id": "migrationsourcetype", - "href": "/graphql/reference/enums#migrationsourcetype" - }, - { - "name": "url", - "description": "

The migration source URL, for example https://github.com or https://monalisa.ghe.com.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CreateProjectInput", - "id": "createprojectinput", - "href": "/graphql/reference/input-objects#createprojectinput", - "description": "

Autogenerated input type of CreateProject.

", - "inputFields": [ - { - "name": "body", - "description": "

The description of project.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The name of project.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ownerId", - "description": "

The owner ID to create the project under.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "repositoryIds", - "description": "

A list of repository IDs to create as linked repositories for the project.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "template", - "description": "

The name of the GitHub-provided template.

", - "type": "ProjectTemplate", - "id": "projecttemplate", - "href": "/graphql/reference/enums#projecttemplate" - } - ] - }, - { - "name": "CreateProjectV2FieldInput", - "id": "createprojectv2fieldinput", - "href": "/graphql/reference/input-objects#createprojectv2fieldinput", - "description": "

Autogenerated input type of CreateProjectV2Field.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "dataType", - "description": "

The data type of the field.

", - "type": "ProjectV2CustomFieldType!", - "id": "projectv2customfieldtype", - "href": "/graphql/reference/enums#projectv2customfieldtype" - }, - { - "name": "name", - "description": "

The name of the field.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "projectId", - "description": "

The ID of the Project to create the field in.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "singleSelectOptions", - "description": "

Options for a single select field. At least one value is required if data_type is SINGLE_SELECT.

", - "type": "[ProjectV2SingleSelectFieldOptionInput!]", - "id": "projectv2singleselectfieldoptioninput", - "href": "/graphql/reference/input-objects#projectv2singleselectfieldoptioninput" - } - ] - }, - { - "name": "CreateProjectV2Input", - "id": "createprojectv2input", - "href": "/graphql/reference/input-objects#createprojectv2input", - "description": "

Autogenerated input type of CreateProjectV2.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ownerId", - "description": "

The owner ID to create the project under.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "repositoryId", - "description": "

The repository to link the project to.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "teamId", - "description": "

The team to link the project to. The team will be granted read permissions.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "title", - "description": "

The title of the project.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CreatePullRequestInput", - "id": "createpullrequestinput", - "href": "/graphql/reference/input-objects#createpullrequestinput", - "description": "

Autogenerated input type of CreatePullRequest.

", - "inputFields": [ - { - "name": "baseRefName", - "description": "

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository. You cannot update the base branch on a pull request to point\nto another repository.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "body", - "description": "

The contents of the pull request.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "draft", - "description": "

Indicates whether this pull request should be a draft.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "headRefName", - "description": "

The name of the branch where your changes are implemented. For cross-repository pull requests\nin the same network, namespace head_ref_name with a user like this: username:branch.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "headRepositoryId", - "description": "

The Node ID of the head repository.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "maintainerCanModify", - "description": "

Indicates whether maintainers can modify the pull request.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "repositoryId", - "description": "

The Node ID of the repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "title", - "description": "

The title of the pull request.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CreateRefInput", - "id": "createrefinput", - "href": "/graphql/reference/input-objects#createrefinput", - "description": "

Autogenerated input type of CreateRef.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The fully qualified name of the new Ref (ie: refs/heads/my_new_branch).

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "oid", - "description": "

The GitObjectID that the new Ref shall target. Must point to a commit.

", - "type": "GitObjectID!", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "repositoryId", - "description": "

The Node ID of the Repository to create the Ref in.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "CreateRepositoryInput", - "id": "createrepositoryinput", - "href": "/graphql/reference/input-objects#createrepositoryinput", - "description": "

Autogenerated input type of CreateRepository.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "description", - "description": "

A short description of the new repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "hasIssuesEnabled", - "description": "

Indicates if the repository should have the issues feature enabled.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "hasWikiEnabled", - "description": "

Indicates if the repository should have the wiki feature enabled.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "homepageUrl", - "description": "

The URL for a web page about this repository.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "name", - "description": "

The name of the new repository.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ownerId", - "description": "

The ID of the owner for the new repository.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "teamId", - "description": "

When an organization is specified as the owner, this ID identifies the team\nthat should be granted access to the new repository.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "template", - "description": "

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "visibility", - "description": "

Indicates the repository's visibility level.

", - "type": "RepositoryVisibility!", - "id": "repositoryvisibility", - "href": "/graphql/reference/enums#repositoryvisibility" - } - ] - }, - { - "name": "CreateRepositoryRulesetInput", - "id": "createrepositoryrulesetinput", - "href": "/graphql/reference/input-objects#createrepositoryrulesetinput", - "description": "

Autogenerated input type of CreateRepositoryRuleset.

", - "inputFields": [ - { - "name": "bypassActors", - "description": "

A list of actors that are allowed to bypass rules in this ruleset.

", - "type": "[RepositoryRulesetBypassActorInput!]", - "id": "repositoryrulesetbypassactorinput", - "href": "/graphql/reference/input-objects#repositoryrulesetbypassactorinput" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "conditions", - "description": "

The set of conditions for this ruleset.

", - "type": "RepositoryRuleConditionsInput!", - "id": "repositoryruleconditionsinput", - "href": "/graphql/reference/input-objects#repositoryruleconditionsinput" - }, - { - "name": "enforcement", - "description": "

The enforcement level for this ruleset.

", - "type": "RuleEnforcement!", - "id": "ruleenforcement", - "href": "/graphql/reference/enums#ruleenforcement" - }, - { - "name": "name", - "description": "

The name of the ruleset.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "rules", - "description": "

The list of rules for this ruleset.

", - "type": "[RepositoryRuleInput!]", - "id": "repositoryruleinput", - "href": "/graphql/reference/input-objects#repositoryruleinput" - }, - { - "name": "sourceId", - "description": "

The global relay id of the source in which a new ruleset should be created in.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "target", - "description": "

The target of the ruleset.

", - "type": "RepositoryRulesetTarget", - "id": "repositoryrulesettarget", - "href": "/graphql/reference/enums#repositoryrulesettarget" - } - ] - }, - { - "name": "CreateTeamDiscussionCommentInput", - "id": "createteamdiscussioncommentinput", - "href": "/graphql/reference/input-objects#createteamdiscussioncommentinput", - "description": "

Autogenerated input type of CreateTeamDiscussionComment.

", - "inputFields": [ - { - "name": "body", - "description": "

The content of the comment. This field is required.

\n

Upcoming Change on 2024-07-01 UTC\nDescription: body will be removed. Follow the guide at\nhttps://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to\nfind a suitable replacement.\nReason: The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "discussionId", - "description": "

The ID of the discussion to which the comment belongs. This field is required.

\n

Upcoming Change on 2024-07-01 UTC\nDescription: discussionId will be removed. Follow the guide at\nhttps://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to\nfind a suitable replacement.\nReason: The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "CreateTeamDiscussionInput", - "id": "createteamdiscussioninput", - "href": "/graphql/reference/input-objects#createteamdiscussioninput", - "description": "

Autogenerated input type of CreateTeamDiscussion.

", - "inputFields": [ - { - "name": "body", - "description": "

The content of the discussion. This field is required.

\n

Upcoming Change on 2024-07-01 UTC\nDescription: body will be removed. Follow the guide at\nhttps://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to\nfind a suitable replacement.\nReason: The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "private", - "description": "

If true, restricts the visibility of this discussion to team members and\norganization owners. If false or not specified, allows any organization member\nto view this discussion.

\n

Upcoming Change on 2024-07-01 UTC\nDescription: private will be removed. Follow the guide at\nhttps://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to\nfind a suitable replacement.\nReason: The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "teamId", - "description": "

The ID of the team to which the discussion belongs. This field is required.

\n

Upcoming Change on 2024-07-01 UTC\nDescription: teamId will be removed. Follow the guide at\nhttps://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to\nfind a suitable replacement.\nReason: The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "title", - "description": "

The title of the discussion. This field is required.

\n

Upcoming Change on 2024-07-01 UTC\nDescription: title will be removed. Follow the guide at\nhttps://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to\nfind a suitable replacement.\nReason: The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "CreateUserListInput", - "id": "createuserlistinput", - "href": "/graphql/reference/input-objects#createuserlistinput", - "description": "

Autogenerated input type of CreateUserList.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "description", - "description": "

A description of the list.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "isPrivate", - "description": "

Whether or not the list is private.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "name", - "description": "

The name of the new list.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "DeleteBranchProtectionRuleInput", - "id": "deletebranchprotectionruleinput", - "href": "/graphql/reference/input-objects#deletebranchprotectionruleinput", - "description": "

Autogenerated input type of DeleteBranchProtectionRule.

", - "inputFields": [ - { - "name": "branchProtectionRuleId", - "description": "

The global relay id of the branch protection rule to be deleted.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "DeleteDeploymentInput", - "id": "deletedeploymentinput", - "href": "/graphql/reference/input-objects#deletedeploymentinput", - "description": "

Autogenerated input type of DeleteDeployment.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the deployment to be deleted.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteDiscussionCommentInput", - "id": "deletediscussioncommentinput", - "href": "/graphql/reference/input-objects#deletediscussioncommentinput", - "description": "

Autogenerated input type of DeleteDiscussionComment.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node id of the discussion comment to delete.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteDiscussionInput", - "id": "deletediscussioninput", - "href": "/graphql/reference/input-objects#deletediscussioninput", - "description": "

Autogenerated input type of DeleteDiscussion.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The id of the discussion to delete.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteEnvironmentInput", - "id": "deleteenvironmentinput", - "href": "/graphql/reference/input-objects#deleteenvironmentinput", - "description": "

Autogenerated input type of DeleteEnvironment.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the environment to be deleted.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteIpAllowListEntryInput", - "id": "deleteipallowlistentryinput", - "href": "/graphql/reference/input-objects#deleteipallowlistentryinput", - "description": "

Autogenerated input type of DeleteIpAllowListEntry.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ipAllowListEntryId", - "description": "

The ID of the IP allow list entry to delete.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteIssueCommentInput", - "id": "deleteissuecommentinput", - "href": "/graphql/reference/input-objects#deleteissuecommentinput", - "description": "

Autogenerated input type of DeleteIssueComment.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The ID of the comment to delete.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteIssueInput", - "id": "deleteissueinput", - "href": "/graphql/reference/input-objects#deleteissueinput", - "description": "

Autogenerated input type of DeleteIssue.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "issueId", - "description": "

The ID of the issue to delete.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteLabelInput", - "id": "deletelabelinput", - "href": "/graphql/reference/input-objects#deletelabelinput", - "description": "

Autogenerated input type of DeleteLabel.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the label to be deleted.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteLinkedBranchInput", - "id": "deletelinkedbranchinput", - "href": "/graphql/reference/input-objects#deletelinkedbranchinput", - "description": "

Autogenerated input type of DeleteLinkedBranch.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "linkedBranchId", - "description": "

The ID of the linked branch.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeletePackageVersionInput", - "id": "deletepackageversioninput", - "href": "/graphql/reference/input-objects#deletepackageversioninput", - "description": "

Autogenerated input type of DeletePackageVersion.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "packageVersionId", - "description": "

The ID of the package version to be deleted.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteProjectCardInput", - "id": "deleteprojectcardinput", - "href": "/graphql/reference/input-objects#deleteprojectcardinput", - "description": "

Autogenerated input type of DeleteProjectCard.

", - "inputFields": [ - { - "name": "cardId", - "description": "

The id of the card to delete.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "DeleteProjectColumnInput", - "id": "deleteprojectcolumninput", - "href": "/graphql/reference/input-objects#deleteprojectcolumninput", - "description": "

Autogenerated input type of DeleteProjectColumn.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "columnId", - "description": "

The id of the column to delete.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteProjectInput", - "id": "deleteprojectinput", - "href": "/graphql/reference/input-objects#deleteprojectinput", - "description": "

Autogenerated input type of DeleteProject.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "projectId", - "description": "

The Project ID to update.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteProjectV2FieldInput", - "id": "deleteprojectv2fieldinput", - "href": "/graphql/reference/input-objects#deleteprojectv2fieldinput", - "description": "

Autogenerated input type of DeleteProjectV2Field.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "fieldId", - "description": "

The ID of the field to delete.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteProjectV2Input", - "id": "deleteprojectv2input", - "href": "/graphql/reference/input-objects#deleteprojectv2input", - "description": "

Autogenerated input type of DeleteProjectV2.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "projectId", - "description": "

The ID of the Project to delete.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteProjectV2ItemInput", - "id": "deleteprojectv2iteminput", - "href": "/graphql/reference/input-objects#deleteprojectv2iteminput", - "description": "

Autogenerated input type of DeleteProjectV2Item.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "itemId", - "description": "

The ID of the item to be removed.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "projectId", - "description": "

The ID of the Project from which the item should be removed.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteProjectV2WorkflowInput", - "id": "deleteprojectv2workflowinput", - "href": "/graphql/reference/input-objects#deleteprojectv2workflowinput", - "description": "

Autogenerated input type of DeleteProjectV2Workflow.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "workflowId", - "description": "

The ID of the workflow to be removed.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeletePullRequestReviewCommentInput", - "id": "deletepullrequestreviewcommentinput", - "href": "/graphql/reference/input-objects#deletepullrequestreviewcommentinput", - "description": "

Autogenerated input type of DeletePullRequestReviewComment.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The ID of the comment to delete.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeletePullRequestReviewInput", - "id": "deletepullrequestreviewinput", - "href": "/graphql/reference/input-objects#deletepullrequestreviewinput", - "description": "

Autogenerated input type of DeletePullRequestReview.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequestReviewId", - "description": "

The Node ID of the pull request review to delete.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteRefInput", - "id": "deleterefinput", - "href": "/graphql/reference/input-objects#deleterefinput", - "description": "

Autogenerated input type of DeleteRef.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "refId", - "description": "

The Node ID of the Ref to be deleted.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteRepositoryRulesetInput", - "id": "deleterepositoryrulesetinput", - "href": "/graphql/reference/input-objects#deleterepositoryrulesetinput", - "description": "

Autogenerated input type of DeleteRepositoryRuleset.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryRulesetId", - "description": "

The global relay id of the repository ruleset to be deleted.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteTeamDiscussionCommentInput", - "id": "deleteteamdiscussioncommentinput", - "href": "/graphql/reference/input-objects#deleteteamdiscussioncommentinput", - "description": "

Autogenerated input type of DeleteTeamDiscussionComment.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The ID of the comment to delete.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteTeamDiscussionInput", - "id": "deleteteamdiscussioninput", - "href": "/graphql/reference/input-objects#deleteteamdiscussioninput", - "description": "

Autogenerated input type of DeleteTeamDiscussion.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The discussion ID to delete.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteUserListInput", - "id": "deleteuserlistinput", - "href": "/graphql/reference/input-objects#deleteuserlistinput", - "description": "

Autogenerated input type of DeleteUserList.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "listId", - "description": "

The ID of the list to delete.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeleteVerifiableDomainInput", - "id": "deleteverifiabledomaininput", - "href": "/graphql/reference/input-objects#deleteverifiabledomaininput", - "description": "

Autogenerated input type of DeleteVerifiableDomain.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The ID of the verifiable domain to delete.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DeploymentOrder", - "id": "deploymentorder", - "href": "/graphql/reference/input-objects#deploymentorder", - "description": "

Ordering options for deployment connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order deployments by.

", - "type": "DeploymentOrderField!", - "id": "deploymentorderfield", - "href": "/graphql/reference/enums#deploymentorderfield" - } - ] - }, - { - "name": "DequeuePullRequestInput", - "id": "dequeuepullrequestinput", - "href": "/graphql/reference/input-objects#dequeuepullrequestinput", - "description": "

Autogenerated input type of DequeuePullRequest.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The ID of the pull request to be dequeued.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DisablePullRequestAutoMergeInput", - "id": "disablepullrequestautomergeinput", - "href": "/graphql/reference/input-objects#disablepullrequestautomergeinput", - "description": "

Autogenerated input type of DisablePullRequestAutoMerge.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequestId", - "description": "

ID of the pull request to disable auto merge on.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DiscussionOrder", - "id": "discussionorder", - "href": "/graphql/reference/input-objects#discussionorder", - "description": "

Ways in which lists of discussions can be ordered upon return.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order discussions by the specified field.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field by which to order discussions.

", - "type": "DiscussionOrderField!", - "id": "discussionorderfield", - "href": "/graphql/reference/enums#discussionorderfield" - } - ] - }, - { - "name": "DiscussionPollOptionOrder", - "id": "discussionpolloptionorder", - "href": "/graphql/reference/input-objects#discussionpolloptionorder", - "description": "

Ordering options for discussion poll option connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order poll options by.

", - "type": "DiscussionPollOptionOrderField!", - "id": "discussionpolloptionorderfield", - "href": "/graphql/reference/enums#discussionpolloptionorderfield" - } - ] - }, - { - "name": "DismissPullRequestReviewInput", - "id": "dismisspullrequestreviewinput", - "href": "/graphql/reference/input-objects#dismisspullrequestreviewinput", - "description": "

Autogenerated input type of DismissPullRequestReview.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "message", - "description": "

The contents of the pull request review dismissal message.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequestReviewId", - "description": "

The Node ID of the pull request review to modify.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DismissRepositoryVulnerabilityAlertInput", - "id": "dismissrepositoryvulnerabilityalertinput", - "href": "/graphql/reference/input-objects#dismissrepositoryvulnerabilityalertinput", - "description": "

Autogenerated input type of DismissRepositoryVulnerabilityAlert.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "dismissReason", - "description": "

The reason the Dependabot alert is being dismissed.

", - "type": "DismissReason!", - "id": "dismissreason", - "href": "/graphql/reference/enums#dismissreason" - }, - { - "name": "repositoryVulnerabilityAlertId", - "description": "

The Dependabot alert ID to dismiss.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "DraftPullRequestReviewComment", - "id": "draftpullrequestreviewcomment", - "href": "/graphql/reference/input-objects#draftpullrequestreviewcomment", - "description": "

Specifies a review comment to be left with a Pull Request Review.

", - "inputFields": [ - { - "name": "body", - "description": "

Body of the comment to leave.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "path", - "description": "

Path to the file being commented on.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "position", - "description": "

Position in the file to leave a comment on.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "DraftPullRequestReviewThread", - "id": "draftpullrequestreviewthread", - "href": "/graphql/reference/input-objects#draftpullrequestreviewthread", - "description": "

Specifies a review comment thread to be left with a Pull Request Review.

", - "inputFields": [ - { - "name": "body", - "description": "

Body of the comment to leave.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "line", - "description": "

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "path", - "description": "

Path to the file being commented on.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "side", - "description": "

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

", - "type": "DiffSide", - "id": "diffside", - "href": "/graphql/reference/enums#diffside" - }, - { - "name": "startLine", - "description": "

The first line of the range to which the comment refers.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "startSide", - "description": "

The side of the diff on which the start line resides.

", - "type": "DiffSide", - "id": "diffside", - "href": "/graphql/reference/enums#diffside" - } - ] - }, - { - "name": "EnablePullRequestAutoMergeInput", - "id": "enablepullrequestautomergeinput", - "href": "/graphql/reference/input-objects#enablepullrequestautomergeinput", - "description": "

Autogenerated input type of EnablePullRequestAutoMerge.

", - "inputFields": [ - { - "name": "authorEmail", - "description": "

The email address to associate with this merge.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "commitBody", - "description": "

Commit body to use for the commit when the PR is mergable; if omitted, a\ndefault message will be used. NOTE: when merging with a merge queue any input\nvalue for commit message is ignored.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "commitHeadline", - "description": "

Commit headline to use for the commit when the PR is mergable; if omitted, a\ndefault message will be used. NOTE: when merging with a merge queue any input\nvalue for commit headline is ignored.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "expectedHeadOid", - "description": "

The expected head OID of the pull request.

", - "type": "GitObjectID", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "mergeMethod", - "description": "

The merge method to use. If omitted, defaults to MERGE. NOTE: when merging\nwith a merge queue any input value for merge method is ignored.

", - "type": "PullRequestMergeMethod", - "id": "pullrequestmergemethod", - "href": "/graphql/reference/enums#pullrequestmergemethod" - }, - { - "name": "pullRequestId", - "description": "

ID of the pull request to enable auto-merge on.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "EnqueuePullRequestInput", - "id": "enqueuepullrequestinput", - "href": "/graphql/reference/input-objects#enqueuepullrequestinput", - "description": "

Autogenerated input type of EnqueuePullRequest.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "expectedHeadOid", - "description": "

The expected head OID of the pull request.

", - "type": "GitObjectID", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "jump", - "description": "

Add the pull request to the front of the queue.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "pullRequestId", - "description": "

The ID of the pull request to enqueue.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "EnterpriseAdministratorInvitationOrder", - "id": "enterpriseadministratorinvitationorder", - "href": "/graphql/reference/input-objects#enterpriseadministratorinvitationorder", - "description": "

Ordering options for enterprise administrator invitation connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order enterprise administrator invitations by.

", - "type": "EnterpriseAdministratorInvitationOrderField!", - "id": "enterpriseadministratorinvitationorderfield", - "href": "/graphql/reference/enums#enterpriseadministratorinvitationorderfield" - } - ] - }, - { - "name": "EnterpriseMemberOrder", - "id": "enterprisememberorder", - "href": "/graphql/reference/input-objects#enterprisememberorder", - "description": "

Ordering options for enterprise member connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order enterprise members by.

", - "type": "EnterpriseMemberOrderField!", - "id": "enterprisememberorderfield", - "href": "/graphql/reference/enums#enterprisememberorderfield" - } - ] - }, - { - "name": "EnterpriseOrder", - "id": "enterpriseorder", - "href": "/graphql/reference/input-objects#enterpriseorder", - "description": "

Ordering options for enterprises.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order enterprises by.

", - "type": "EnterpriseOrderField!", - "id": "enterpriseorderfield", - "href": "/graphql/reference/enums#enterpriseorderfield" - } - ] - }, - { - "name": "EnterpriseServerInstallationOrder", - "id": "enterpriseserverinstallationorder", - "href": "/graphql/reference/input-objects#enterpriseserverinstallationorder", - "description": "

Ordering options for Enterprise Server installation connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order Enterprise Server installations by.

", - "type": "EnterpriseServerInstallationOrderField!", - "id": "enterpriseserverinstallationorderfield", - "href": "/graphql/reference/enums#enterpriseserverinstallationorderfield" - } - ] - }, - { - "name": "EnterpriseServerUserAccountEmailOrder", - "id": "enterpriseserveruseraccountemailorder", - "href": "/graphql/reference/input-objects#enterpriseserveruseraccountemailorder", - "description": "

Ordering options for Enterprise Server user account email connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order emails by.

", - "type": "EnterpriseServerUserAccountEmailOrderField!", - "id": "enterpriseserveruseraccountemailorderfield", - "href": "/graphql/reference/enums#enterpriseserveruseraccountemailorderfield" - } - ] - }, - { - "name": "EnterpriseServerUserAccountOrder", - "id": "enterpriseserveruseraccountorder", - "href": "/graphql/reference/input-objects#enterpriseserveruseraccountorder", - "description": "

Ordering options for Enterprise Server user account connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order user accounts by.

", - "type": "EnterpriseServerUserAccountOrderField!", - "id": "enterpriseserveruseraccountorderfield", - "href": "/graphql/reference/enums#enterpriseserveruseraccountorderfield" - } - ] - }, - { - "name": "EnterpriseServerUserAccountsUploadOrder", - "id": "enterpriseserveruseraccountsuploadorder", - "href": "/graphql/reference/input-objects#enterpriseserveruseraccountsuploadorder", - "description": "

Ordering options for Enterprise Server user accounts upload connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order user accounts uploads by.

", - "type": "EnterpriseServerUserAccountsUploadOrderField!", - "id": "enterpriseserveruseraccountsuploadorderfield", - "href": "/graphql/reference/enums#enterpriseserveruseraccountsuploadorderfield" - } - ] - }, - { - "name": "Environments", - "id": "environments", - "href": "/graphql/reference/input-objects#environments", - "description": "

Ordering options for environments.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order environments by the specified field.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order environments by.

", - "type": "EnvironmentOrderField!", - "id": "environmentorderfield", - "href": "/graphql/reference/enums#environmentorderfield" - } - ] - }, - { - "name": "FileAddition", - "id": "fileaddition", - "href": "/graphql/reference/input-objects#fileaddition", - "description": "

A command to add a file at the given path with the given contents as part of a\ncommit. Any existing file at that that path will be replaced.

", - "inputFields": [ - { - "name": "contents", - "description": "

The base64 encoded contents of the file.

", - "type": "Base64String!", - "id": "base64string", - "href": "/graphql/reference/scalars#base64string" - }, - { - "name": "path", - "description": "

The path in the repository where the file will be located.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "FileChanges", - "id": "filechanges", - "href": "/graphql/reference/input-objects#filechanges", - "description": "

A description of a set of changes to a file tree to be made as part of\na git commit, modeled as zero or more file additions and zero or more\nfile deletions.

\n

Both fields are optional; omitting both will produce a commit with no\nfile changes.

\n

deletions and additions describe changes to files identified\nby their path in the git tree using unix-style path separators, i.e.\n/. The root of a git tree is an empty string, so paths are not\nslash-prefixed.

\n

path values must be unique across all additions and deletions\nprovided. Any duplication will result in a validation error.

\n

Encoding

\n

File contents must be provided in full for each FileAddition.

\n

The contents of a FileAddition must be encoded using RFC 4648\ncompliant base64, i.e. correct padding is required and no characters\noutside the standard alphabet may be used. Invalid base64\nencoding will be rejected with a validation error.

\n

The encoded contents may be binary.

\n

For text files, no assumptions are made about the character encoding of\nthe file contents (after base64 decoding). No charset transcoding or\nline-ending normalization will be performed; it is the client's\nresponsibility to manage the character encoding of files they provide.\nHowever, for maximum compatibility we recommend using UTF-8 encoding\nand ensuring that all files in a repository use a consistent\nline-ending convention (\\n or \\r\\n), and that all files end\nwith a newline.

\n

Modeling file changes

\n

Each of the the five types of conceptual changes that can be made in a\ngit commit can be described using the FileChanges type as follows:

\n
    \n
  1. \n

    New file addition: create file hello world\\n at path docs/README.txt:

    \n
    {\n  \"additions\" [\n    {\n      \"path\": \"docs/README.txt\",\n      \"contents\": base64encode(\"hello world\\n\")\n    }\n  ]\n}\n
    \n
    2. \n
  2. \n

    Existing file modification: change existing docs/README.txt to have new\ncontent new content here\\n:

    \n
    {\n  \"additions\" [\n    {\n      \"path\": \"docs/README.txt\",\n      \"contents\": base64encode(\"new content here\\n\")\n    }\n  ]\n}\n
    \n
    3. \n
  3. \n

    Existing file deletion: remove existing file docs/README.txt.\nNote that the path is required to exist -- specifying a\npath that does not exist on the given branch will abort the\ncommit and return an error.

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\"\n    }\n  ]\n}\n
    \n
    4. \n
  4. \n

    File rename with no changes: rename docs/README.txt with\nprevious content hello world\\n to the same content at\nnewdocs/README.txt:

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\",\n    }\n  ],\n  \"additions\" [\n    {\n      \"path\": \"newdocs/README.txt\",\n      \"contents\": base64encode(\"hello world\\n\")\n    }\n  ]\n}\n
    \n
    5. \n
  5. \n

    File rename with changes: rename docs/README.txt with\nprevious content hello world\\n to a file at path\nnewdocs/README.txt with content new contents\\n:

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\",\n    }\n  ],\n  \"additions\" [\n    {\n      \"path\": \"newdocs/README.txt\",\n      \"contents\": base64encode(\"new contents\\n\")\n    }\n  ]\n}.\n
    \n
    6. \n
", - "inputFields": [ - { - "name": "additions", - "description": "

File to add or change.

", - "type": "[FileAddition!]", - "id": "fileaddition", - "href": "/graphql/reference/input-objects#fileaddition" - }, - { - "name": "deletions", - "description": "

Files to delete.

", - "type": "[FileDeletion!]", - "id": "filedeletion", - "href": "/graphql/reference/input-objects#filedeletion" - } - ] - }, - { - "name": "FileDeletion", - "id": "filedeletion", - "href": "/graphql/reference/input-objects#filedeletion", - "description": "

A command to delete the file at the given path as part of a commit.

", - "inputFields": [ - { - "name": "path", - "description": "

The path to delete.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "FileExtensionRestrictionParametersInput", - "id": "fileextensionrestrictionparametersinput", - "href": "/graphql/reference/input-objects#fileextensionrestrictionparametersinput", - "description": "

Prevent commits that include files with specified file extensions from being\npushed to the commit graph. NOTE: This rule is in beta and subject to change.

", - "inputFields": [ - { - "name": "restrictedFileExtensions", - "description": "

The file extensions that are restricted from being pushed to the commit graph.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "FilePathRestrictionParametersInput", - "id": "filepathrestrictionparametersinput", - "href": "/graphql/reference/input-objects#filepathrestrictionparametersinput", - "description": "

Prevent commits that include changes in specified file paths from being pushed\nto the commit graph. NOTE: This rule is in beta and subject to change.

", - "inputFields": [ - { - "name": "restrictedFilePaths", - "description": "

The file paths that are restricted from being pushed to the commit graph.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "FollowOrganizationInput", - "id": "followorganizationinput", - "href": "/graphql/reference/input-objects#followorganizationinput", - "description": "

Autogenerated input type of FollowOrganization.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationId", - "description": "

ID of the organization to follow.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "FollowUserInput", - "id": "followuserinput", - "href": "/graphql/reference/input-objects#followuserinput", - "description": "

Autogenerated input type of FollowUser.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userId", - "description": "

ID of the user to follow.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "GistOrder", - "id": "gistorder", - "href": "/graphql/reference/input-objects#gistorder", - "description": "

Ordering options for gist connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order repositories by.

", - "type": "GistOrderField!", - "id": "gistorderfield", - "href": "/graphql/reference/enums#gistorderfield" - } - ] - }, - { - "name": "GrantEnterpriseOrganizationsMigratorRoleInput", - "id": "grantenterpriseorganizationsmigratorroleinput", - "href": "/graphql/reference/input-objects#grantenterpriseorganizationsmigratorroleinput", - "description": "

Autogenerated input type of GrantEnterpriseOrganizationsMigratorRole.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise to which all organizations managed by it will be granted the migrator role.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "login", - "description": "

The login of the user to grant the migrator role.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "GrantMigratorRoleInput", - "id": "grantmigratorroleinput", - "href": "/graphql/reference/input-objects#grantmigratorroleinput", - "description": "

Autogenerated input type of GrantMigratorRole.

", - "inputFields": [ - { - "name": "actor", - "description": "

The user login or Team slug to grant the migrator role.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorType", - "description": "

Specifies the type of the actor, can be either USER or TEAM.

", - "type": "ActorType!", - "id": "actortype", - "href": "/graphql/reference/enums#actortype" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationId", - "description": "

The ID of the organization that the user/team belongs to.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "ImportProjectInput", - "id": "importprojectinput", - "href": "/graphql/reference/input-objects#importprojectinput", - "description": "

Autogenerated input type of ImportProject.

", - "inputFields": [ - { - "name": "body", - "description": "

The description of Project.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "columnImports", - "description": "

A list of columns containing issues and pull requests.

", - "type": "[ProjectColumnImport!]!", - "id": "projectcolumnimport", - "href": "/graphql/reference/input-objects#projectcolumnimport" - }, - { - "name": "name", - "description": "

The name of Project.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ownerName", - "description": "

The name of the Organization or User to create the Project under.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "public", - "description": "

Whether the Project is public or not.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "IpAllowListEntryOrder", - "id": "ipallowlistentryorder", - "href": "/graphql/reference/input-objects#ipallowlistentryorder", - "description": "

Ordering options for IP allow list entry connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order IP allow list entries by.

", - "type": "IpAllowListEntryOrderField!", - "id": "ipallowlistentryorderfield", - "href": "/graphql/reference/enums#ipallowlistentryorderfield" - } - ] - }, - { - "name": "IssueCommentOrder", - "id": "issuecommentorder", - "href": "/graphql/reference/input-objects#issuecommentorder", - "description": "

Ways in which lists of issue comments can be ordered upon return.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order issue comments by the specified field.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field in which to order issue comments by.

", - "type": "IssueCommentOrderField!", - "id": "issuecommentorderfield", - "href": "/graphql/reference/enums#issuecommentorderfield" - } - ] - }, - { - "name": "IssueFilters", - "id": "issuefilters", - "href": "/graphql/reference/input-objects#issuefilters", - "description": "

Ways in which to filter lists of issues.

", - "inputFields": [ - { - "name": "assignee", - "description": "

List issues assigned to given name. Pass in null for issues with no assigned\nuser, and * for issues assigned to any user.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "createdBy", - "description": "

List issues created by given name.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "labels", - "description": "

List issues where the list of label names exist on the issue.

", - "type": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "mentioned", - "description": "

List issues where the given name is mentioned in the issue.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "milestone", - "description": "

List issues by given milestone argument. If an string representation of an\ninteger is passed, it should refer to a milestone by its database ID. Pass in\nnull for issues with no milestone, and * for issues that are assigned to any milestone.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "milestoneNumber", - "description": "

List issues by given milestone argument. If an string representation of an\ninteger is passed, it should refer to a milestone by its number field. Pass in\nnull for issues with no milestone, and * for issues that are assigned to any milestone.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "since", - "description": "

List issues that have been updated at or after the given date.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "states", - "description": "

List issues filtered by the list of states given.

", - "type": "[IssueState!]", - "id": "issuestate", - "href": "/graphql/reference/enums#issuestate" - }, - { - "name": "viewerSubscribed", - "description": "

List issues subscribed to by viewer.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "IssueOrder", - "id": "issueorder", - "href": "/graphql/reference/input-objects#issueorder", - "description": "

Ways in which lists of issues can be ordered upon return.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order issues by the specified field.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field in which to order issues by.

", - "type": "IssueOrderField!", - "id": "issueorderfield", - "href": "/graphql/reference/enums#issueorderfield" - } - ] - }, - { - "name": "LabelOrder", - "id": "labelorder", - "href": "/graphql/reference/input-objects#labelorder", - "description": "

Ways in which lists of labels can be ordered upon return.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order labels by the specified field.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field in which to order labels by.

", - "type": "LabelOrderField!", - "id": "labelorderfield", - "href": "/graphql/reference/enums#labelorderfield" - } - ] - }, - { - "name": "LanguageOrder", - "id": "languageorder", - "href": "/graphql/reference/input-objects#languageorder", - "description": "

Ordering options for language connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order languages by.

", - "type": "LanguageOrderField!", - "id": "languageorderfield", - "href": "/graphql/reference/enums#languageorderfield" - } - ] - }, - { - "name": "LinkProjectV2ToRepositoryInput", - "id": "linkprojectv2torepositoryinput", - "href": "/graphql/reference/input-objects#linkprojectv2torepositoryinput", - "description": "

Autogenerated input type of LinkProjectV2ToRepository.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "projectId", - "description": "

The ID of the project to link to the repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "repositoryId", - "description": "

The ID of the repository to link to the project.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "LinkProjectV2ToTeamInput", - "id": "linkprojectv2toteaminput", - "href": "/graphql/reference/input-objects#linkprojectv2toteaminput", - "description": "

Autogenerated input type of LinkProjectV2ToTeam.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "projectId", - "description": "

The ID of the project to link to the team.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "teamId", - "description": "

The ID of the team to link to the project.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "LinkRepositoryToProjectInput", - "id": "linkrepositorytoprojectinput", - "href": "/graphql/reference/input-objects#linkrepositorytoprojectinput", - "description": "

Autogenerated input type of LinkRepositoryToProject.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "projectId", - "description": "

The ID of the Project to link to a Repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "repositoryId", - "description": "

The ID of the Repository to link to a Project.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "LockLockableInput", - "id": "locklockableinput", - "href": "/graphql/reference/input-objects#locklockableinput", - "description": "

Autogenerated input type of LockLockable.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "lockReason", - "description": "

A reason for why the item will be locked.

", - "type": "LockReason", - "id": "lockreason", - "href": "/graphql/reference/enums#lockreason" - }, - { - "name": "lockableId", - "description": "

ID of the item to be locked.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "MannequinOrder", - "id": "mannequinorder", - "href": "/graphql/reference/input-objects#mannequinorder", - "description": "

Ordering options for mannequins.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order mannequins by.

", - "type": "MannequinOrderField!", - "id": "mannequinorderfield", - "href": "/graphql/reference/enums#mannequinorderfield" - } - ] - }, - { - "name": "MarkDiscussionCommentAsAnswerInput", - "id": "markdiscussioncommentasanswerinput", - "href": "/graphql/reference/input-objects#markdiscussioncommentasanswerinput", - "description": "

Autogenerated input type of MarkDiscussionCommentAsAnswer.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the discussion comment to mark as an answer.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "MarkFileAsViewedInput", - "id": "markfileasviewedinput", - "href": "/graphql/reference/input-objects#markfileasviewedinput", - "description": "

Autogenerated input type of MarkFileAsViewed.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "path", - "description": "

The path of the file to mark as viewed.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequestId", - "description": "

The Node ID of the pull request.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "MarkNotificationAsDoneInput", - "id": "marknotificationasdoneinput", - "href": "/graphql/reference/input-objects#marknotificationasdoneinput", - "description": "

Autogenerated input type of MarkNotificationAsDone.

", - "isDeprecated": false, - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The NotificationThread id.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - ] - }, - { - "name": "MarkProjectV2AsTemplateInput", - "id": "markprojectv2astemplateinput", - "href": "/graphql/reference/input-objects#markprojectv2astemplateinput", - "description": "

Autogenerated input type of MarkProjectV2AsTemplate.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "projectId", - "description": "

The ID of the Project to mark as a template.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "MarkPullRequestReadyForReviewInput", - "id": "markpullrequestreadyforreviewinput", - "href": "/graphql/reference/input-objects#markpullrequestreadyforreviewinput", - "description": "

Autogenerated input type of MarkPullRequestReadyForReview.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequestId", - "description": "

ID of the pull request to be marked as ready for review.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "MaxFilePathLengthParametersInput", - "id": "maxfilepathlengthparametersinput", - "href": "/graphql/reference/input-objects#maxfilepathlengthparametersinput", - "description": "

Prevent commits that include file paths that exceed a specified character limit\nfrom being pushed to the commit graph. NOTE: This rule is in beta and subject to change.

", - "inputFields": [ - { - "name": "maxFilePathLength", - "description": "

The maximum amount of characters allowed in file paths.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "MaxFileSizeParametersInput", - "id": "maxfilesizeparametersinput", - "href": "/graphql/reference/input-objects#maxfilesizeparametersinput", - "description": "

Prevent commits that exceed a specified file size limit from being pushed to the\ncommit. NOTE: This rule is in beta and subject to change.

", - "inputFields": [ - { - "name": "maxFileSize", - "description": "

The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "MergeBranchInput", - "id": "mergebranchinput", - "href": "/graphql/reference/input-objects#mergebranchinput", - "description": "

Autogenerated input type of MergeBranch.

", - "inputFields": [ - { - "name": "base", - "description": "

The name of the base branch that the provided head will be merged into.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "commitMessage", - "description": "

Message to use for the merge commit. If omitted, a default will be used.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "head", - "description": "

The head to merge into the base branch. This can be a branch name or a commit GitObjectID.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryId", - "description": "

The Node ID of the Repository containing the base branch that will be modified.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "MergePullRequestInput", - "id": "mergepullrequestinput", - "href": "/graphql/reference/input-objects#mergepullrequestinput", - "description": "

Autogenerated input type of MergePullRequest.

", - "inputFields": [ - { - "name": "authorEmail", - "description": "

The email address to associate with this merge.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "commitBody", - "description": "

Commit body to use for the merge commit; if omitted, a default message will be used.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "commitHeadline", - "description": "

Commit headline to use for the merge commit; if omitted, a default message will be used.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "expectedHeadOid", - "description": "

OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

", - "type": "GitObjectID", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "mergeMethod", - "description": "

The merge method to use. If omitted, defaults to 'MERGE'.

", - "type": "PullRequestMergeMethod", - "id": "pullrequestmergemethod", - "href": "/graphql/reference/enums#pullrequestmergemethod" - }, - { - "name": "pullRequestId", - "description": "

ID of the pull request to be merged.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "MilestoneOrder", - "id": "milestoneorder", - "href": "/graphql/reference/input-objects#milestoneorder", - "description": "

Ordering options for milestone connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order milestones by.

", - "type": "MilestoneOrderField!", - "id": "milestoneorderfield", - "href": "/graphql/reference/enums#milestoneorderfield" - } - ] - }, - { - "name": "MinimizeCommentInput", - "id": "minimizecommentinput", - "href": "/graphql/reference/input-objects#minimizecommentinput", - "description": "

Autogenerated input type of MinimizeComment.

", - "inputFields": [ - { - "name": "classifier", - "description": "

The classification of comment.

", - "type": "ReportedContentClassifiers!", - "id": "reportedcontentclassifiers", - "href": "/graphql/reference/enums#reportedcontentclassifiers" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "subjectId", - "description": "

The Node ID of the subject to modify.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "MoveProjectCardInput", - "id": "moveprojectcardinput", - "href": "/graphql/reference/input-objects#moveprojectcardinput", - "description": "

Autogenerated input type of MoveProjectCard.

", - "inputFields": [ - { - "name": "afterCardId", - "description": "

Place the new card after the card with this id. Pass null to place it at the top.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "cardId", - "description": "

The id of the card to move.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "columnId", - "description": "

The id of the column to move it into.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "MoveProjectColumnInput", - "id": "moveprojectcolumninput", - "href": "/graphql/reference/input-objects#moveprojectcolumninput", - "description": "

Autogenerated input type of MoveProjectColumn.

", - "inputFields": [ - { - "name": "afterColumnId", - "description": "

Place the new column after the column with this id. Pass null to place it at the front.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "columnId", - "description": "

The id of the column to move.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "OrgEnterpriseOwnerOrder", - "id": "orgenterpriseownerorder", - "href": "/graphql/reference/input-objects#orgenterpriseownerorder", - "description": "

Ordering options for an organization's enterprise owner connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order enterprise owners by.

", - "type": "OrgEnterpriseOwnerOrderField!", - "id": "orgenterpriseownerorderfield", - "href": "/graphql/reference/enums#orgenterpriseownerorderfield" - } - ] - }, - { - "name": "OrganizationOrder", - "id": "organizationorder", - "href": "/graphql/reference/input-objects#organizationorder", - "description": "

Ordering options for organization connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order organizations by.

", - "type": "OrganizationOrderField!", - "id": "organizationorderfield", - "href": "/graphql/reference/enums#organizationorderfield" - } - ] - }, - { - "name": "PackageFileOrder", - "id": "packagefileorder", - "href": "/graphql/reference/input-objects#packagefileorder", - "description": "

Ways in which lists of package files can be ordered upon return.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order package files by the specified field.

", - "type": "OrderDirection", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field in which to order package files by.

", - "type": "PackageFileOrderField", - "id": "packagefileorderfield", - "href": "/graphql/reference/enums#packagefileorderfield" - } - ] - }, - { - "name": "PackageOrder", - "id": "packageorder", - "href": "/graphql/reference/input-objects#packageorder", - "description": "

Ways in which lists of packages can be ordered upon return.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order packages by the specified field.

", - "type": "OrderDirection", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field in which to order packages by.

", - "type": "PackageOrderField", - "id": "packageorderfield", - "href": "/graphql/reference/enums#packageorderfield" - } - ] - }, - { - "name": "PackageVersionOrder", - "id": "packageversionorder", - "href": "/graphql/reference/input-objects#packageversionorder", - "description": "

Ways in which lists of package versions can be ordered upon return.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order package versions by the specified field.

", - "type": "OrderDirection", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field in which to order package versions by.

", - "type": "PackageVersionOrderField", - "id": "packageversionorderfield", - "href": "/graphql/reference/enums#packageversionorderfield" - } - ] - }, - { - "name": "PinEnvironmentInput", - "id": "pinenvironmentinput", - "href": "/graphql/reference/input-objects#pinenvironmentinput", - "description": "

Autogenerated input type of PinEnvironment.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "environmentId", - "description": "

The ID of the environment to modify.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "pinned", - "description": "

The desired state of the environment. If true, environment will be pinned. If false, it will be unpinned.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "PinIssueInput", - "id": "pinissueinput", - "href": "/graphql/reference/input-objects#pinissueinput", - "description": "

Autogenerated input type of PinIssue.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "issueId", - "description": "

The ID of the issue to be pinned.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "PinnedEnvironmentOrder", - "id": "pinnedenvironmentorder", - "href": "/graphql/reference/input-objects#pinnedenvironmentorder", - "description": "

Ordering options for pinned environments.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order pinned environments by the specified field.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order pinned environments by.

", - "type": "PinnedEnvironmentOrderField!", - "id": "pinnedenvironmentorderfield", - "href": "/graphql/reference/enums#pinnedenvironmentorderfield" - } - ] - }, - { - "name": "ProjectCardImport", - "id": "projectcardimport", - "href": "/graphql/reference/input-objects#projectcardimport", - "description": "

An issue or PR and its owning repository to be used in a project card.

", - "inputFields": [ - { - "name": "number", - "description": "

The issue or pull request number.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "repository", - "description": "

Repository name with owner (owner/repository).

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "ProjectColumnImport", - "id": "projectcolumnimport", - "href": "/graphql/reference/input-objects#projectcolumnimport", - "description": "

A project column and a list of its issues and PRs.

", - "inputFields": [ - { - "name": "columnName", - "description": "

The name of the column.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "issues", - "description": "

A list of issues and pull requests in the column.

", - "type": "[ProjectCardImport!]", - "id": "projectcardimport", - "href": "/graphql/reference/input-objects#projectcardimport" - }, - { - "name": "position", - "description": "

The position of the column, starting from 0.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "ProjectOrder", - "id": "projectorder", - "href": "/graphql/reference/input-objects#projectorder", - "description": "

Ways in which lists of projects can be ordered upon return.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order projects by the specified field.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field in which to order projects by.

", - "type": "ProjectOrderField!", - "id": "projectorderfield", - "href": "/graphql/reference/enums#projectorderfield" - } - ] - }, - { - "name": "ProjectV2Collaborator", - "id": "projectv2collaborator", - "href": "/graphql/reference/input-objects#projectv2collaborator", - "description": "

A collaborator to update on a project. Only one of the userId or teamId should be provided.

", - "inputFields": [ - { - "name": "role", - "description": "

The role to grant the collaborator.

", - "type": "ProjectV2Roles!", - "id": "projectv2roles", - "href": "/graphql/reference/enums#projectv2roles" - }, - { - "name": "teamId", - "description": "

The ID of the team as a collaborator.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "userId", - "description": "

The ID of the user as a collaborator.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "ProjectV2FieldOrder", - "id": "projectv2fieldorder", - "href": "/graphql/reference/input-objects#projectv2fieldorder", - "description": "

Ordering options for project v2 field connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order the project v2 fields by.

", - "type": "ProjectV2FieldOrderField!", - "id": "projectv2fieldorderfield", - "href": "/graphql/reference/enums#projectv2fieldorderfield" - } - ] - }, - { - "name": "ProjectV2FieldValue", - "id": "projectv2fieldvalue", - "href": "/graphql/reference/input-objects#projectv2fieldvalue", - "description": "

The values that can be used to update a field of an item inside a Project. Only 1 value can be updated at a time.

", - "inputFields": [ - { - "name": "date", - "description": "

The ISO 8601 date to set on the field.

", - "type": "Date", - "id": "date", - "href": "/graphql/reference/scalars#date" - }, - { - "name": "iterationId", - "description": "

The id of the iteration to set on the field.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "number", - "description": "

The number to set on the field.

", - "type": "Float", - "id": "float", - "href": "/graphql/reference/scalars#float" - }, - { - "name": "singleSelectOptionId", - "description": "

The id of the single select option to set on the field.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "text", - "description": "

The text to set on the field.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "ProjectV2ItemFieldValueOrder", - "id": "projectv2itemfieldvalueorder", - "href": "/graphql/reference/input-objects#projectv2itemfieldvalueorder", - "description": "

Ordering options for project v2 item field value connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order the project v2 item field values by.

", - "type": "ProjectV2ItemFieldValueOrderField!", - "id": "projectv2itemfieldvalueorderfield", - "href": "/graphql/reference/enums#projectv2itemfieldvalueorderfield" - } - ] - }, - { - "name": "ProjectV2ItemOrder", - "id": "projectv2itemorder", - "href": "/graphql/reference/input-objects#projectv2itemorder", - "description": "

Ordering options for project v2 item connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order the project v2 items by.

", - "type": "ProjectV2ItemOrderField!", - "id": "projectv2itemorderfield", - "href": "/graphql/reference/enums#projectv2itemorderfield" - } - ] - }, - { - "name": "ProjectV2Order", - "id": "projectv2order", - "href": "/graphql/reference/input-objects#projectv2order", - "description": "

Ways in which lists of projects can be ordered upon return.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order projects by the specified field.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field in which to order projects by.

", - "type": "ProjectV2OrderField!", - "id": "projectv2orderfield", - "href": "/graphql/reference/enums#projectv2orderfield" - } - ] - }, - { - "name": "ProjectV2SingleSelectFieldOptionInput", - "id": "projectv2singleselectfieldoptioninput", - "href": "/graphql/reference/input-objects#projectv2singleselectfieldoptioninput", - "description": "

Represents a single select field option.

", - "inputFields": [ - { - "name": "color", - "description": "

The display color of the option.

", - "type": "ProjectV2SingleSelectFieldOptionColor!", - "id": "projectv2singleselectfieldoptioncolor", - "href": "/graphql/reference/enums#projectv2singleselectfieldoptioncolor" - }, - { - "name": "description", - "description": "

The description text of the option.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The name of the option.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "ProjectV2ViewOrder", - "id": "projectv2vieworder", - "href": "/graphql/reference/input-objects#projectv2vieworder", - "description": "

Ordering options for project v2 view connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order the project v2 views by.

", - "type": "ProjectV2ViewOrderField!", - "id": "projectv2vieworderfield", - "href": "/graphql/reference/enums#projectv2vieworderfield" - } - ] - }, - { - "name": "ProjectV2WorkflowOrder", - "id": "projectv2workfloworder", - "href": "/graphql/reference/input-objects#projectv2workfloworder", - "description": "

Ordering options for project v2 workflows connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order the project v2 workflows by.

", - "type": "ProjectV2WorkflowsOrderField!", - "id": "projectv2workflowsorderfield", - "href": "/graphql/reference/enums#projectv2workflowsorderfield" - } - ] - }, - { - "name": "PropertyTargetDefinitionInput", - "id": "propertytargetdefinitioninput", - "href": "/graphql/reference/input-objects#propertytargetdefinitioninput", - "description": "

A property that must match.

", - "inputFields": [ - { - "name": "name", - "description": "

The name of the property.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "propertyValues", - "description": "

The values to match for.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "PullRequestOrder", - "id": "pullrequestorder", - "href": "/graphql/reference/input-objects#pullrequestorder", - "description": "

Ways in which lists of issues can be ordered upon return.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order pull requests by the specified field.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field in which to order pull requests by.

", - "type": "PullRequestOrderField!", - "id": "pullrequestorderfield", - "href": "/graphql/reference/enums#pullrequestorderfield" - } - ] - }, - { - "name": "PullRequestParametersInput", - "id": "pullrequestparametersinput", - "href": "/graphql/reference/input-objects#pullrequestparametersinput", - "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", - "inputFields": [ - { - "name": "dismissStaleReviewsOnPush", - "description": "

New, reviewable commits pushed will dismiss previous pull request review approvals.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requireCodeOwnerReview", - "description": "

Require an approving review in pull requests that modify files that have a designated code owner.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requireLastPushApproval", - "description": "

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiredApprovingReviewCount", - "description": "

The number of approving reviews that are required before a pull request can be merged.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "requiredReviewThreadResolution", - "description": "

All conversations on code must be resolved before a pull request can be merged.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "ReactionOrder", - "id": "reactionorder", - "href": "/graphql/reference/input-objects#reactionorder", - "description": "

Ways in which lists of reactions can be ordered upon return.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order reactions by the specified field.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field in which to order reactions by.

", - "type": "ReactionOrderField!", - "id": "reactionorderfield", - "href": "/graphql/reference/enums#reactionorderfield" - } - ] - }, - { - "name": "RefNameConditionTargetInput", - "id": "refnameconditiontargetinput", - "href": "/graphql/reference/input-objects#refnameconditiontargetinput", - "description": "

Parameters to be used for the ref_name condition.

", - "inputFields": [ - { - "name": "exclude", - "description": "

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "include", - "description": "

Array of ref names or patterns to include. One of these patterns must match\nfor the condition to pass. Also accepts ~DEFAULT_BRANCH to include the\ndefault branch or ~ALL to include all branches.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "RefOrder", - "id": "reforder", - "href": "/graphql/reference/input-objects#reforder", - "description": "

Ways in which lists of git refs can be ordered upon return.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order refs by the specified field.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field in which to order refs by.

", - "type": "RefOrderField!", - "id": "reforderfield", - "href": "/graphql/reference/enums#reforderfield" - } - ] - }, - { - "name": "RefUpdate", - "id": "refupdate", - "href": "/graphql/reference/input-objects#refupdate", - "description": "

A ref update.

", - "inputFields": [ - { - "name": "afterOid", - "description": "

The value this ref should be updated to.

", - "type": "GitObjectID!", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "beforeOid", - "description": "

The value this ref needs to point to before the update.

", - "type": "GitObjectID", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "force", - "description": "

Force a non fast-forward update.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "name", - "description": "

The fully qualified name of the ref to be update. For example refs/heads/branch-name.

", - "type": "GitRefname!", - "id": "gitrefname", - "href": "/graphql/reference/scalars#gitrefname" - } - ] - }, - { - "name": "RegenerateVerifiableDomainTokenInput", - "id": "regenerateverifiabledomaintokeninput", - "href": "/graphql/reference/input-objects#regenerateverifiabledomaintokeninput", - "description": "

Autogenerated input type of RegenerateVerifiableDomainToken.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The ID of the verifiable domain to regenerate the verification token of.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "RejectDeploymentsInput", - "id": "rejectdeploymentsinput", - "href": "/graphql/reference/input-objects#rejectdeploymentsinput", - "description": "

Autogenerated input type of RejectDeployments.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "comment", - "description": "

Optional comment for rejecting deployments.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "environmentIds", - "description": "

The ids of environments to reject deployments.

", - "type": "[ID!]!", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "workflowRunId", - "description": "

The node ID of the workflow run containing the pending deployments.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "ReleaseOrder", - "id": "releaseorder", - "href": "/graphql/reference/input-objects#releaseorder", - "description": "

Ways in which lists of releases can be ordered upon return.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order releases by the specified field.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field in which to order releases by.

", - "type": "ReleaseOrderField!", - "id": "releaseorderfield", - "href": "/graphql/reference/enums#releaseorderfield" - } - ] - }, - { - "name": "RemoveAssigneesFromAssignableInput", - "id": "removeassigneesfromassignableinput", - "href": "/graphql/reference/input-objects#removeassigneesfromassignableinput", - "description": "

Autogenerated input type of RemoveAssigneesFromAssignable.

", - "inputFields": [ - { - "name": "assignableId", - "description": "

The id of the assignable object to remove assignees from.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "assigneeIds", - "description": "

The id of users to remove as assignees.

", - "type": "[ID!]!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "RemoveEnterpriseAdminInput", - "id": "removeenterpriseadmininput", - "href": "/graphql/reference/input-objects#removeenterpriseadmininput", - "description": "

Autogenerated input type of RemoveEnterpriseAdmin.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The Enterprise ID from which to remove the administrator.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "login", - "description": "

The login of the user to remove as an administrator.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "RemoveLabelsFromLabelableInput", - "id": "removelabelsfromlabelableinput", - "href": "/graphql/reference/input-objects#removelabelsfromlabelableinput", - "description": "

Autogenerated input type of RemoveLabelsFromLabelable.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "labelIds", - "description": "

The ids of labels to remove.

", - "type": "[ID!]!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "labelableId", - "description": "

The id of the Labelable to remove labels from.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "RemoveOutsideCollaboratorInput", - "id": "removeoutsidecollaboratorinput", - "href": "/graphql/reference/input-objects#removeoutsidecollaboratorinput", - "description": "

Autogenerated input type of RemoveOutsideCollaborator.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationId", - "description": "

The ID of the organization to remove the outside collaborator from.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "userId", - "description": "

The ID of the outside collaborator to remove.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "RemoveReactionInput", - "id": "removereactioninput", - "href": "/graphql/reference/input-objects#removereactioninput", - "description": "

Autogenerated input type of RemoveReaction.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "content", - "description": "

The name of the emoji reaction to remove.

", - "type": "ReactionContent!", - "id": "reactioncontent", - "href": "/graphql/reference/enums#reactioncontent" - }, - { - "name": "subjectId", - "description": "

The Node ID of the subject to modify.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "RemoveStarInput", - "id": "removestarinput", - "href": "/graphql/reference/input-objects#removestarinput", - "description": "

Autogenerated input type of RemoveStar.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "starrableId", - "description": "

The Starrable ID to unstar.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "RemoveUpvoteInput", - "id": "removeupvoteinput", - "href": "/graphql/reference/input-objects#removeupvoteinput", - "description": "

Autogenerated input type of RemoveUpvote.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "subjectId", - "description": "

The Node ID of the discussion or comment to remove upvote.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "ReopenDiscussionInput", - "id": "reopendiscussioninput", - "href": "/graphql/reference/input-objects#reopendiscussioninput", - "description": "

Autogenerated input type of ReopenDiscussion.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "discussionId", - "description": "

ID of the discussion to be reopened.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "ReopenIssueInput", - "id": "reopenissueinput", - "href": "/graphql/reference/input-objects#reopenissueinput", - "description": "

Autogenerated input type of ReopenIssue.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "issueId", - "description": "

ID of the issue to be opened.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "ReopenPullRequestInput", - "id": "reopenpullrequestinput", - "href": "/graphql/reference/input-objects#reopenpullrequestinput", - "description": "

Autogenerated input type of ReopenPullRequest.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequestId", - "description": "

ID of the pull request to be reopened.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "ReorderEnvironmentInput", - "id": "reorderenvironmentinput", - "href": "/graphql/reference/input-objects#reorderenvironmentinput", - "description": "

Autogenerated input type of ReorderEnvironment.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "environmentId", - "description": "

The ID of the environment to modify.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "position", - "description": "

The desired position of the environment.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "RepositoryIdConditionTargetInput", - "id": "repositoryidconditiontargetinput", - "href": "/graphql/reference/input-objects#repositoryidconditiontargetinput", - "description": "

Parameters to be used for the repository_id condition.

", - "inputFields": [ - { - "name": "repositoryIds", - "description": "

One of these repo IDs must match the repo.

", - "type": "[ID!]!", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - ] - }, - { - "name": "RepositoryInvitationOrder", - "id": "repositoryinvitationorder", - "href": "/graphql/reference/input-objects#repositoryinvitationorder", - "description": "

Ordering options for repository invitation connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order repository invitations by.

", - "type": "RepositoryInvitationOrderField!", - "id": "repositoryinvitationorderfield", - "href": "/graphql/reference/enums#repositoryinvitationorderfield" - } - ] - }, - { - "name": "RepositoryMigrationOrder", - "id": "repositorymigrationorder", - "href": "/graphql/reference/input-objects#repositorymigrationorder", - "description": "

Ordering options for repository migrations.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "RepositoryMigrationOrderDirection!", - "id": "repositorymigrationorderdirection", - "href": "/graphql/reference/enums#repositorymigrationorderdirection" - }, - { - "name": "field", - "description": "

The field to order repository migrations by.

", - "type": "RepositoryMigrationOrderField!", - "id": "repositorymigrationorderfield", - "href": "/graphql/reference/enums#repositorymigrationorderfield" - } - ] - }, - { - "name": "RepositoryNameConditionTargetInput", - "id": "repositorynameconditiontargetinput", - "href": "/graphql/reference/input-objects#repositorynameconditiontargetinput", - "description": "

Parameters to be used for the repository_name condition.

", - "inputFields": [ - { - "name": "exclude", - "description": "

Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "include", - "description": "

Array of repository names or patterns to include. One of these patterns must\nmatch for the condition to pass. Also accepts ~ALL to include all repositories.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "protected", - "description": "

Target changes that match these patterns will be prevented except by those with bypass permissions.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "RepositoryOrder", - "id": "repositoryorder", - "href": "/graphql/reference/input-objects#repositoryorder", - "description": "

Ordering options for repository connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order repositories by.

", - "type": "RepositoryOrderField!", - "id": "repositoryorderfield", - "href": "/graphql/reference/enums#repositoryorderfield" - } - ] - }, - { - "name": "RepositoryPropertyConditionTargetInput", - "id": "repositorypropertyconditiontargetinput", - "href": "/graphql/reference/input-objects#repositorypropertyconditiontargetinput", - "description": "

Parameters to be used for the repository_property condition.

", - "inputFields": [ - { - "name": "exclude", - "description": "

Array of repository properties that must not match.

", - "type": "[PropertyTargetDefinitionInput!]!", - "id": "propertytargetdefinitioninput", - "href": "/graphql/reference/input-objects#propertytargetdefinitioninput" - }, - { - "name": "include", - "description": "

Array of repository properties that must match.

", - "type": "[PropertyTargetDefinitionInput!]!", - "id": "propertytargetdefinitioninput", - "href": "/graphql/reference/input-objects#propertytargetdefinitioninput" - } - ] - }, - { - "name": "RepositoryRuleConditionsInput", - "id": "repositoryruleconditionsinput", - "href": "/graphql/reference/input-objects#repositoryruleconditionsinput", - "description": "

Specifies the conditions required for a ruleset to evaluate.

", - "inputFields": [ - { - "name": "refName", - "description": "

Configuration for the ref_name condition.

", - "type": "RefNameConditionTargetInput", - "id": "refnameconditiontargetinput", - "href": "/graphql/reference/input-objects#refnameconditiontargetinput" - }, - { - "name": "repositoryId", - "description": "

Configuration for the repository_id condition.

", - "type": "RepositoryIdConditionTargetInput", - "id": "repositoryidconditiontargetinput", - "href": "/graphql/reference/input-objects#repositoryidconditiontargetinput" - }, - { - "name": "repositoryName", - "description": "

Configuration for the repository_name condition.

", - "type": "RepositoryNameConditionTargetInput", - "id": "repositorynameconditiontargetinput", - "href": "/graphql/reference/input-objects#repositorynameconditiontargetinput" - }, - { - "name": "repositoryProperty", - "description": "

Configuration for the repository_property condition.

", - "type": "RepositoryPropertyConditionTargetInput", - "id": "repositorypropertyconditiontargetinput", - "href": "/graphql/reference/input-objects#repositorypropertyconditiontargetinput" - } - ] - }, - { - "name": "RepositoryRuleInput", - "id": "repositoryruleinput", - "href": "/graphql/reference/input-objects#repositoryruleinput", - "description": "

Specifies the attributes for a new or updated rule.

", - "inputFields": [ - { - "name": "id", - "description": "

Optional ID of this rule when updating.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "parameters", - "description": "

The parameters for the rule.

", - "type": "RuleParametersInput", - "id": "ruleparametersinput", - "href": "/graphql/reference/input-objects#ruleparametersinput" - }, - { - "name": "type", - "description": "

The type of rule to create.

", - "type": "RepositoryRuleType!", - "id": "repositoryruletype", - "href": "/graphql/reference/enums#repositoryruletype" - } - ] - }, - { - "name": "RepositoryRuleOrder", - "id": "repositoryruleorder", - "href": "/graphql/reference/input-objects#repositoryruleorder", - "description": "

Ordering options for repository rules.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order repository rules by.

", - "type": "RepositoryRuleOrderField!", - "id": "repositoryruleorderfield", - "href": "/graphql/reference/enums#repositoryruleorderfield" - } - ] - }, - { - "name": "RepositoryRulesetBypassActorInput", - "id": "repositoryrulesetbypassactorinput", - "href": "/graphql/reference/input-objects#repositoryrulesetbypassactorinput", - "description": "

Specifies the attributes for a new or updated ruleset bypass actor. Only one of\nactor_id, repository_role_database_id, organization_admin, or deploy_key\nshould be specified.

", - "inputFields": [ - { - "name": "actorId", - "description": "

For Team and Integration bypasses, the Team or Integration ID.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "bypassMode", - "description": "

The bypass mode for this actor.

", - "type": "RepositoryRulesetBypassActorBypassMode!", - "id": "repositoryrulesetbypassactorbypassmode", - "href": "/graphql/reference/enums#repositoryrulesetbypassactorbypassmode" - }, - { - "name": "deployKey", - "description": "

For deploy key bypasses, true. Can only use ALWAYS as the bypass mode.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "organizationAdmin", - "description": "

For organization owner bypasses, true.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "repositoryRoleDatabaseId", - "description": "

For role bypasses, the role database ID.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "RequestReviewsInput", - "id": "requestreviewsinput", - "href": "/graphql/reference/input-objects#requestreviewsinput", - "description": "

Autogenerated input type of RequestReviews.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequestId", - "description": "

The Node ID of the pull request to modify.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "teamIds", - "description": "

The Node IDs of the team to request.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "union", - "description": "

Add users to the set rather than replace.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "userIds", - "description": "

The Node IDs of the user to request.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "RequiredDeploymentsParametersInput", - "id": "requireddeploymentsparametersinput", - "href": "/graphql/reference/input-objects#requireddeploymentsparametersinput", - "description": "

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

", - "inputFields": [ - { - "name": "requiredDeploymentEnvironments", - "description": "

The environments that must be successfully deployed to before branches can be merged.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "RequiredStatusCheckInput", - "id": "requiredstatuscheckinput", - "href": "/graphql/reference/input-objects#requiredstatuscheckinput", - "description": "

Specifies the attributes for a new or updated required status check.

", - "inputFields": [ - { - "name": "appId", - "description": "

The ID of the App that must set the status in order for it to be accepted.\nOmit this value to use whichever app has recently been setting this status, or\nuse \"any\" to allow any app to set the status.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "context", - "description": "

Status check context that must pass for commits to be accepted to the matching branch.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "RequiredStatusChecksParametersInput", - "id": "requiredstatuschecksparametersinput", - "href": "/graphql/reference/input-objects#requiredstatuschecksparametersinput", - "description": "

Choose which status checks must pass before the ref is updated. When enabled,\ncommits must first be pushed to another ref where the checks pass.

", - "inputFields": [ - { - "name": "requiredStatusChecks", - "description": "

Status checks that are required.

", - "type": "[StatusCheckConfigurationInput!]!", - "id": "statuscheckconfigurationinput", - "href": "/graphql/reference/input-objects#statuscheckconfigurationinput" - }, - { - "name": "strictRequiredStatusChecksPolicy", - "description": "

Whether pull requests targeting a matching branch must be tested with the\nlatest code. This setting will not take effect unless at least one status\ncheck is enabled.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "RerequestCheckSuiteInput", - "id": "rerequestchecksuiteinput", - "href": "/graphql/reference/input-objects#rerequestchecksuiteinput", - "description": "

Autogenerated input type of RerequestCheckSuite.

", - "inputFields": [ - { - "name": "checkSuiteId", - "description": "

The Node ID of the check suite.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryId", - "description": "

The Node ID of the repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "ResolveReviewThreadInput", - "id": "resolvereviewthreadinput", - "href": "/graphql/reference/input-objects#resolvereviewthreadinput", - "description": "

Autogenerated input type of ResolveReviewThread.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "threadId", - "description": "

The ID of the thread to resolve.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "RevertPullRequestInput", - "id": "revertpullrequestinput", - "href": "/graphql/reference/input-objects#revertpullrequestinput", - "description": "

Autogenerated input type of RevertPullRequest.

", - "inputFields": [ - { - "name": "body", - "description": "

The description of the revert pull request.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "draft", - "description": "

Indicates whether the revert pull request should be a draft.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "pullRequestId", - "description": "

The ID of the pull request to revert.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "title", - "description": "

The title of the revert pull request.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "RevokeEnterpriseOrganizationsMigratorRoleInput", - "id": "revokeenterpriseorganizationsmigratorroleinput", - "href": "/graphql/reference/input-objects#revokeenterpriseorganizationsmigratorroleinput", - "description": "

Autogenerated input type of RevokeEnterpriseOrganizationsMigratorRole.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise to which all organizations managed by it will be granted the migrator role.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "login", - "description": "

The login of the user to revoke the migrator role.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "RevokeMigratorRoleInput", - "id": "revokemigratorroleinput", - "href": "/graphql/reference/input-objects#revokemigratorroleinput", - "description": "

Autogenerated input type of RevokeMigratorRole.

", - "inputFields": [ - { - "name": "actor", - "description": "

The user login or Team slug to revoke the migrator role from.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "actorType", - "description": "

Specifies the type of the actor, can be either USER or TEAM.

", - "type": "ActorType!", - "id": "actortype", - "href": "/graphql/reference/enums#actortype" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationId", - "description": "

The ID of the organization that the user/team belongs to.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "RuleParametersInput", - "id": "ruleparametersinput", - "href": "/graphql/reference/input-objects#ruleparametersinput", - "description": "

Specifies the parameters for a RepositoryRule object. Only one of the fields should be specified.

", - "inputFields": [ - { - "name": "branchNamePattern", - "description": "

Parameters used for the branch_name_pattern rule type.

", - "type": "BranchNamePatternParametersInput", - "id": "branchnamepatternparametersinput", - "href": "/graphql/reference/input-objects#branchnamepatternparametersinput" - }, - { - "name": "codeScanning", - "description": "

Parameters used for the code_scanning rule type.

", - "type": "CodeScanningParametersInput", - "id": "codescanningparametersinput", - "href": "/graphql/reference/input-objects#codescanningparametersinput" - }, - { - "name": "commitAuthorEmailPattern", - "description": "

Parameters used for the commit_author_email_pattern rule type.

", - "type": "CommitAuthorEmailPatternParametersInput", - "id": "commitauthoremailpatternparametersinput", - "href": "/graphql/reference/input-objects#commitauthoremailpatternparametersinput" - }, - { - "name": "commitMessagePattern", - "description": "

Parameters used for the commit_message_pattern rule type.

", - "type": "CommitMessagePatternParametersInput", - "id": "commitmessagepatternparametersinput", - "href": "/graphql/reference/input-objects#commitmessagepatternparametersinput" - }, - { - "name": "committerEmailPattern", - "description": "

Parameters used for the committer_email_pattern rule type.

", - "type": "CommitterEmailPatternParametersInput", - "id": "committeremailpatternparametersinput", - "href": "/graphql/reference/input-objects#committeremailpatternparametersinput" - }, - { - "name": "fileExtensionRestriction", - "description": "

Parameters used for the file_extension_restriction rule type.

", - "type": "FileExtensionRestrictionParametersInput", - "id": "fileextensionrestrictionparametersinput", - "href": "/graphql/reference/input-objects#fileextensionrestrictionparametersinput" - }, - { - "name": "filePathRestriction", - "description": "

Parameters used for the file_path_restriction rule type.

", - "type": "FilePathRestrictionParametersInput", - "id": "filepathrestrictionparametersinput", - "href": "/graphql/reference/input-objects#filepathrestrictionparametersinput" - }, - { - "name": "maxFilePathLength", - "description": "

Parameters used for the max_file_path_length rule type.

", - "type": "MaxFilePathLengthParametersInput", - "id": "maxfilepathlengthparametersinput", - "href": "/graphql/reference/input-objects#maxfilepathlengthparametersinput" - }, - { - "name": "maxFileSize", - "description": "

Parameters used for the max_file_size rule type.

", - "type": "MaxFileSizeParametersInput", - "id": "maxfilesizeparametersinput", - "href": "/graphql/reference/input-objects#maxfilesizeparametersinput" - }, - { - "name": "pullRequest", - "description": "

Parameters used for the pull_request rule type.

", - "type": "PullRequestParametersInput", - "id": "pullrequestparametersinput", - "href": "/graphql/reference/input-objects#pullrequestparametersinput" - }, - { - "name": "requiredDeployments", - "description": "

Parameters used for the required_deployments rule type.

", - "type": "RequiredDeploymentsParametersInput", - "id": "requireddeploymentsparametersinput", - "href": "/graphql/reference/input-objects#requireddeploymentsparametersinput" - }, - { - "name": "requiredStatusChecks", - "description": "

Parameters used for the required_status_checks rule type.

", - "type": "RequiredStatusChecksParametersInput", - "id": "requiredstatuschecksparametersinput", - "href": "/graphql/reference/input-objects#requiredstatuschecksparametersinput" - }, - { - "name": "tagNamePattern", - "description": "

Parameters used for the tag_name_pattern rule type.

", - "type": "TagNamePatternParametersInput", - "id": "tagnamepatternparametersinput", - "href": "/graphql/reference/input-objects#tagnamepatternparametersinput" - }, - { - "name": "update", - "description": "

Parameters used for the update rule type.

", - "type": "UpdateParametersInput", - "id": "updateparametersinput", - "href": "/graphql/reference/input-objects#updateparametersinput" - }, - { - "name": "workflows", - "description": "

Parameters used for the workflows rule type.

", - "type": "WorkflowsParametersInput", - "id": "workflowsparametersinput", - "href": "/graphql/reference/input-objects#workflowsparametersinput" - } - ] - }, - { - "name": "SavedReplyOrder", - "id": "savedreplyorder", - "href": "/graphql/reference/input-objects#savedreplyorder", - "description": "

Ordering options for saved reply connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order saved replies by.

", - "type": "SavedReplyOrderField!", - "id": "savedreplyorderfield", - "href": "/graphql/reference/enums#savedreplyorderfield" - } - ] - }, - { - "name": "StarOrder", - "id": "starorder", - "href": "/graphql/reference/input-objects#starorder", - "description": "

Ways in which star connections can be ordered.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order nodes.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field in which to order nodes by.

", - "type": "StarOrderField!", - "id": "starorderfield", - "href": "/graphql/reference/enums#starorderfield" - } - ] - }, - { - "name": "StartOrganizationMigrationInput", - "id": "startorganizationmigrationinput", - "href": "/graphql/reference/input-objects#startorganizationmigrationinput", - "description": "

Autogenerated input type of StartOrganizationMigration.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "sourceAccessToken", - "description": "

The migration source access token.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "sourceOrgUrl", - "description": "

The URL of the organization to migrate.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "targetEnterpriseId", - "description": "

The ID of the enterprise the target organization belongs to.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "targetOrgName", - "description": "

The name of the target organization.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "StartRepositoryMigrationInput", - "id": "startrepositorymigrationinput", - "href": "/graphql/reference/input-objects#startrepositorymigrationinput", - "description": "

Autogenerated input type of StartRepositoryMigration.

", - "inputFields": [ - { - "name": "accessToken", - "description": "

The migration source access token.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "continueOnError", - "description": "

Whether to continue the migration on error. Defaults to true.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "gitArchiveUrl", - "description": "

The signed URL to access the user-uploaded git archive.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "githubPat", - "description": "

The GitHub personal access token of the user importing to the target repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "lockSource", - "description": "

Whether to lock the source repository.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "metadataArchiveUrl", - "description": "

The signed URL to access the user-uploaded metadata archive.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ownerId", - "description": "

The ID of the organization that will own the imported repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "repositoryName", - "description": "

The name of the imported repository.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "skipReleases", - "description": "

Whether to skip migrating releases for the repository.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "sourceId", - "description": "

The ID of the migration source.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "sourceRepositoryUrl", - "description": "

The URL of the source repository.

", - "type": "URI!", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "targetRepoVisibility", - "description": "

The visibility of the imported repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "StatusCheckConfigurationInput", - "id": "statuscheckconfigurationinput", - "href": "/graphql/reference/input-objects#statuscheckconfigurationinput", - "description": "

Required status check.

", - "inputFields": [ - { - "name": "context", - "description": "

The status check context name that must be present on the commit.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "integrationId", - "description": "

The optional integration ID that this status check must originate from.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "SubmitPullRequestReviewInput", - "id": "submitpullrequestreviewinput", - "href": "/graphql/reference/input-objects#submitpullrequestreviewinput", - "description": "

Autogenerated input type of SubmitPullRequestReview.

", - "inputFields": [ - { - "name": "body", - "description": "

The text field to set on the Pull Request Review.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "event", - "description": "

The event to send to the Pull Request Review.

", - "type": "PullRequestReviewEvent!", - "id": "pullrequestreviewevent", - "href": "/graphql/reference/enums#pullrequestreviewevent" - }, - { - "name": "pullRequestId", - "description": "

The Pull Request ID to submit any pending reviews.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "pullRequestReviewId", - "description": "

The Pull Request Review ID to submit.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "TagNamePatternParametersInput", - "id": "tagnamepatternparametersinput", - "href": "/graphql/reference/input-objects#tagnamepatternparametersinput", - "description": "

Parameters to be used for the tag_name_pattern rule.

", - "inputFields": [ - { - "name": "name", - "description": "

How this rule will appear to users.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "operator", - "description": "

The operator to use for matching.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pattern", - "description": "

The pattern to match with.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "TeamDiscussionCommentOrder", - "id": "teamdiscussioncommentorder", - "href": "/graphql/reference/input-objects#teamdiscussioncommentorder", - "description": "

Ways in which team discussion comment connections can be ordered.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order nodes.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field by which to order nodes.

", - "type": "TeamDiscussionCommentOrderField!", - "id": "teamdiscussioncommentorderfield", - "href": "/graphql/reference/enums#teamdiscussioncommentorderfield" - } - ] - }, - { - "name": "TeamDiscussionOrder", - "id": "teamdiscussionorder", - "href": "/graphql/reference/input-objects#teamdiscussionorder", - "description": "

Ways in which team discussion connections can be ordered.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order nodes.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field by which to order nodes.

", - "type": "TeamDiscussionOrderField!", - "id": "teamdiscussionorderfield", - "href": "/graphql/reference/enums#teamdiscussionorderfield" - } - ] - }, - { - "name": "TeamMemberOrder", - "id": "teammemberorder", - "href": "/graphql/reference/input-objects#teammemberorder", - "description": "

Ordering options for team member connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order team members by.

", - "type": "TeamMemberOrderField!", - "id": "teammemberorderfield", - "href": "/graphql/reference/enums#teammemberorderfield" - } - ] - }, - { - "name": "TeamOrder", - "id": "teamorder", - "href": "/graphql/reference/input-objects#teamorder", - "description": "

Ways in which team connections can be ordered.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order nodes.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field in which to order nodes by.

", - "type": "TeamOrderField!", - "id": "teamorderfield", - "href": "/graphql/reference/enums#teamorderfield" - } - ] - }, - { - "name": "TeamRepositoryOrder", - "id": "teamrepositoryorder", - "href": "/graphql/reference/input-objects#teamrepositoryorder", - "description": "

Ordering options for team repository connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order repositories by.

", - "type": "TeamRepositoryOrderField!", - "id": "teamrepositoryorderfield", - "href": "/graphql/reference/enums#teamrepositoryorderfield" - } - ] - }, - { - "name": "TransferIssueInput", - "id": "transferissueinput", - "href": "/graphql/reference/input-objects#transferissueinput", - "description": "

Autogenerated input type of TransferIssue.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "createLabelsIfMissing", - "description": "

Whether to create labels if they don't exist in the target repository (matched by name).

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "issueId", - "description": "

The Node ID of the issue to be transferred.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "repositoryId", - "description": "

The Node ID of the repository the issue should be transferred to.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UnarchiveProjectV2ItemInput", - "id": "unarchiveprojectv2iteminput", - "href": "/graphql/reference/input-objects#unarchiveprojectv2iteminput", - "description": "

Autogenerated input type of UnarchiveProjectV2Item.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "itemId", - "description": "

The ID of the ProjectV2Item to unarchive.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "projectId", - "description": "

The ID of the Project to archive the item from.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UnarchiveRepositoryInput", - "id": "unarchiverepositoryinput", - "href": "/graphql/reference/input-objects#unarchiverepositoryinput", - "description": "

Autogenerated input type of UnarchiveRepository.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryId", - "description": "

The ID of the repository to unarchive.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UnfollowOrganizationInput", - "id": "unfolloworganizationinput", - "href": "/graphql/reference/input-objects#unfolloworganizationinput", - "description": "

Autogenerated input type of UnfollowOrganization.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationId", - "description": "

ID of the organization to unfollow.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UnfollowUserInput", - "id": "unfollowuserinput", - "href": "/graphql/reference/input-objects#unfollowuserinput", - "description": "

Autogenerated input type of UnfollowUser.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "userId", - "description": "

ID of the user to unfollow.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UnlinkProjectV2FromRepositoryInput", - "id": "unlinkprojectv2fromrepositoryinput", - "href": "/graphql/reference/input-objects#unlinkprojectv2fromrepositoryinput", - "description": "

Autogenerated input type of UnlinkProjectV2FromRepository.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "projectId", - "description": "

The ID of the project to unlink from the repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "repositoryId", - "description": "

The ID of the repository to unlink from the project.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UnlinkProjectV2FromTeamInput", - "id": "unlinkprojectv2fromteaminput", - "href": "/graphql/reference/input-objects#unlinkprojectv2fromteaminput", - "description": "

Autogenerated input type of UnlinkProjectV2FromTeam.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "projectId", - "description": "

The ID of the project to unlink from the team.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "teamId", - "description": "

The ID of the team to unlink from the project.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UnlinkRepositoryFromProjectInput", - "id": "unlinkrepositoryfromprojectinput", - "href": "/graphql/reference/input-objects#unlinkrepositoryfromprojectinput", - "description": "

Autogenerated input type of UnlinkRepositoryFromProject.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "projectId", - "description": "

The ID of the Project linked to the Repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "repositoryId", - "description": "

The ID of the Repository linked to the Project.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UnlockLockableInput", - "id": "unlocklockableinput", - "href": "/graphql/reference/input-objects#unlocklockableinput", - "description": "

Autogenerated input type of UnlockLockable.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "lockableId", - "description": "

ID of the item to be unlocked.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UnmarkDiscussionCommentAsAnswerInput", - "id": "unmarkdiscussioncommentasanswerinput", - "href": "/graphql/reference/input-objects#unmarkdiscussioncommentasanswerinput", - "description": "

Autogenerated input type of UnmarkDiscussionCommentAsAnswer.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the discussion comment to unmark as an answer.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UnmarkFileAsViewedInput", - "id": "unmarkfileasviewedinput", - "href": "/graphql/reference/input-objects#unmarkfileasviewedinput", - "description": "

Autogenerated input type of UnmarkFileAsViewed.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "path", - "description": "

The path of the file to mark as unviewed.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequestId", - "description": "

The Node ID of the pull request.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UnmarkIssueAsDuplicateInput", - "id": "unmarkissueasduplicateinput", - "href": "/graphql/reference/input-objects#unmarkissueasduplicateinput", - "description": "

Autogenerated input type of UnmarkIssueAsDuplicate.

", - "inputFields": [ - { - "name": "canonicalId", - "description": "

ID of the issue or pull request currently considered canonical/authoritative/original.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "duplicateId", - "description": "

ID of the issue or pull request currently marked as a duplicate.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UnmarkProjectV2AsTemplateInput", - "id": "unmarkprojectv2astemplateinput", - "href": "/graphql/reference/input-objects#unmarkprojectv2astemplateinput", - "description": "

Autogenerated input type of UnmarkProjectV2AsTemplate.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "projectId", - "description": "

The ID of the Project to unmark as a template.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UnminimizeCommentInput", - "id": "unminimizecommentinput", - "href": "/graphql/reference/input-objects#unminimizecommentinput", - "description": "

Autogenerated input type of UnminimizeComment.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "subjectId", - "description": "

The Node ID of the subject to modify.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UnpinIssueInput", - "id": "unpinissueinput", - "href": "/graphql/reference/input-objects#unpinissueinput", - "description": "

Autogenerated input type of UnpinIssue.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "issueId", - "description": "

The ID of the issue to be unpinned.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UnresolveReviewThreadInput", - "id": "unresolvereviewthreadinput", - "href": "/graphql/reference/input-objects#unresolvereviewthreadinput", - "description": "

Autogenerated input type of UnresolveReviewThread.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "threadId", - "description": "

The ID of the thread to unresolve.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UnsubscribeFromNotificationsInput", - "id": "unsubscribefromnotificationsinput", - "href": "/graphql/reference/input-objects#unsubscribefromnotificationsinput", - "description": "

Autogenerated input type of UnsubscribeFromNotifications.

", - "isDeprecated": false, - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ids", - "description": "

The NotificationThread IDs of the objects to unsubscribe from.

", - "type": "[ID!]!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UpdateBranchProtectionRuleInput", - "id": "updatebranchprotectionruleinput", - "href": "/graphql/reference/input-objects#updatebranchprotectionruleinput", - "description": "

Autogenerated input type of UpdateBranchProtectionRule.

", - "inputFields": [ - { - "name": "allowsDeletions", - "description": "

Can this branch be deleted.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "allowsForcePushes", - "description": "

Are force pushes allowed on this branch.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "blocksCreations", - "description": "

Is branch creation a protected operation.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "branchProtectionRuleId", - "description": "

The global relay id of the branch protection rule to be updated.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "bypassForcePushActorIds", - "description": "

A list of User, Team, or App IDs allowed to bypass force push targeting matching branches.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "bypassPullRequestActorIds", - "description": "

A list of User, Team, or App IDs allowed to bypass pull requests targeting matching branches.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "dismissesStaleReviews", - "description": "

Will new commits pushed to matching branches dismiss pull request review approvals.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "isAdminEnforced", - "description": "

Can admins override branch protection.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "lockAllowsFetchAndMerge", - "description": "

Whether users can pull changes from upstream when the branch is locked. Set to\ntrue to allow fork syncing. Set to false to prevent fork syncing.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "lockBranch", - "description": "

Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "pattern", - "description": "

The glob-like pattern used to determine matching branches.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pushActorIds", - "description": "

A list of User, Team, or App IDs allowed to push to matching branches.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "requireLastPushApproval", - "description": "

Whether the most recent push must be approved by someone other than the person who pushed it.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiredApprovingReviewCount", - "description": "

Number of approving reviews required to update matching branches.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "requiredDeploymentEnvironments", - "description": "

The list of required deployment environments.

", - "type": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "requiredStatusCheckContexts", - "description": "

List of required status check contexts that must pass for commits to be accepted to matching branches.

", - "type": "[String!]", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "requiredStatusChecks", - "description": "

The list of required status checks.

", - "type": "[RequiredStatusCheckInput!]", - "id": "requiredstatuscheckinput", - "href": "/graphql/reference/input-objects#requiredstatuscheckinput" - }, - { - "name": "requiresApprovingReviews", - "description": "

Are approving reviews required to update matching branches.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresCodeOwnerReviews", - "description": "

Are reviews from code owners required to update matching branches.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresCommitSignatures", - "description": "

Are commits required to be signed.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresConversationResolution", - "description": "

Are conversations required to be resolved before merging.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresDeployments", - "description": "

Are successful deployments required before merging.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresLinearHistory", - "description": "

Are merge commits prohibited from being pushed to this branch.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresStatusChecks", - "description": "

Are status checks required to update matching branches.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "requiresStrictStatusChecks", - "description": "

Are branches required to be up to date before merging.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "restrictsPushes", - "description": "

Is pushing to matching branches restricted.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "restrictsReviewDismissals", - "description": "

Is dismissal of pull request reviews restricted.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "reviewDismissalActorIds", - "description": "

A list of User, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id" - } - ] - }, - { - "name": "UpdateCheckRunInput", - "id": "updatecheckruninput", - "href": "/graphql/reference/input-objects#updatecheckruninput", - "description": "

Autogenerated input type of UpdateCheckRun.

", - "inputFields": [ - { - "name": "actions", - "description": "

Possible further actions the integrator can perform, which a user may trigger.

", - "type": "[CheckRunAction!]", - "id": "checkrunaction", - "href": "/graphql/reference/input-objects#checkrunaction" - }, - { - "name": "checkRunId", - "description": "

The node of the check.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "completedAt", - "description": "

The time that the check run finished.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "conclusion", - "description": "

The final conclusion of the check.

", - "type": "CheckConclusionState", - "id": "checkconclusionstate", - "href": "/graphql/reference/enums#checkconclusionstate" - }, - { - "name": "detailsUrl", - "description": "

The URL of the integrator's site that has the full details of the check.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "externalId", - "description": "

A reference for the run on the integrator's system.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The name of the check.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "output", - "description": "

Descriptive details about the run.

", - "type": "CheckRunOutput", - "id": "checkrunoutput", - "href": "/graphql/reference/input-objects#checkrunoutput" - }, - { - "name": "repositoryId", - "description": "

The node ID of the repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "startedAt", - "description": "

The time that the check run began.

", - "type": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime" - }, - { - "name": "status", - "description": "

The current status.

", - "type": "RequestableCheckStatusState", - "id": "requestablecheckstatusstate", - "href": "/graphql/reference/enums#requestablecheckstatusstate" - } - ] - }, - { - "name": "UpdateCheckSuitePreferencesInput", - "id": "updatechecksuitepreferencesinput", - "href": "/graphql/reference/input-objects#updatechecksuitepreferencesinput", - "description": "

Autogenerated input type of UpdateCheckSuitePreferences.

", - "inputFields": [ - { - "name": "autoTriggerPreferences", - "description": "

The check suite preferences to modify.

", - "type": "[CheckSuiteAutoTriggerPreference!]!", - "id": "checksuiteautotriggerpreference", - "href": "/graphql/reference/input-objects#checksuiteautotriggerpreference" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryId", - "description": "

The Node ID of the repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UpdateDiscussionCommentInput", - "id": "updatediscussioncommentinput", - "href": "/graphql/reference/input-objects#updatediscussioncommentinput", - "description": "

Autogenerated input type of UpdateDiscussionComment.

", - "inputFields": [ - { - "name": "body", - "description": "

The new contents of the comment body.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "commentId", - "description": "

The Node ID of the discussion comment to update.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UpdateDiscussionInput", - "id": "updatediscussioninput", - "href": "/graphql/reference/input-objects#updatediscussioninput", - "description": "

Autogenerated input type of UpdateDiscussion.

", - "inputFields": [ - { - "name": "body", - "description": "

The new contents of the discussion body.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "categoryId", - "description": "

The Node ID of a discussion category within the same repository to change this discussion to.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "discussionId", - "description": "

The Node ID of the discussion to update.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "title", - "description": "

The new discussion title.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput", - "id": "updateenterpriseallowprivaterepositoryforkingsettinginput", - "href": "/graphql/reference/input-objects#updateenterpriseallowprivaterepositoryforkingsettinginput", - "description": "

Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise on which to set the allow private repository forking setting.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "policyValue", - "description": "

The value for the allow private repository forking policy on the enterprise.

", - "type": "EnterpriseAllowPrivateRepositoryForkingPolicyValue", - "id": "enterpriseallowprivaterepositoryforkingpolicyvalue", - "href": "/graphql/reference/enums#enterpriseallowprivaterepositoryforkingpolicyvalue" - }, - { - "name": "settingValue", - "description": "

The value for the allow private repository forking setting on the enterprise.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - } - ] - }, - { - "name": "UpdateEnterpriseDefaultRepositoryPermissionSettingInput", - "id": "updateenterprisedefaultrepositorypermissionsettinginput", - "href": "/graphql/reference/input-objects#updateenterprisedefaultrepositorypermissionsettinginput", - "description": "

Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise on which to set the base repository permission setting.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "settingValue", - "description": "

The value for the base repository permission setting on the enterprise.

", - "type": "EnterpriseDefaultRepositoryPermissionSettingValue!", - "id": "enterprisedefaultrepositorypermissionsettingvalue", - "href": "/graphql/reference/enums#enterprisedefaultrepositorypermissionsettingvalue" - } - ] - }, - { - "name": "UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput", - "id": "updateenterprisememberscanchangerepositoryvisibilitysettinginput", - "href": "/graphql/reference/input-objects#updateenterprisememberscanchangerepositoryvisibilitysettinginput", - "description": "

Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise on which to set the members can change repository visibility setting.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "settingValue", - "description": "

The value for the members can change repository visibility setting on the enterprise.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - } - ] - }, - { - "name": "UpdateEnterpriseMembersCanCreateRepositoriesSettingInput", - "id": "updateenterprisememberscancreaterepositoriessettinginput", - "href": "/graphql/reference/input-objects#updateenterprisememberscancreaterepositoriessettinginput", - "description": "

Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise on which to set the members can create repositories setting.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "membersCanCreateInternalRepositories", - "description": "

Allow members to create internal repositories. Defaults to current value.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "membersCanCreatePrivateRepositories", - "description": "

Allow members to create private repositories. Defaults to current value.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "membersCanCreatePublicRepositories", - "description": "

Allow members to create public repositories. Defaults to current value.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "membersCanCreateRepositoriesPolicyEnabled", - "description": "

When false, allow member organizations to set their own repository creation member privileges.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "settingValue", - "description": "

Value for the members can create repositories setting on the enterprise. This\nor the granular public/private/internal allowed fields (but not both) must be provided.

", - "type": "EnterpriseMembersCanCreateRepositoriesSettingValue", - "id": "enterprisememberscancreaterepositoriessettingvalue", - "href": "/graphql/reference/enums#enterprisememberscancreaterepositoriessettingvalue" - } - ] - }, - { - "name": "UpdateEnterpriseMembersCanDeleteIssuesSettingInput", - "id": "updateenterprisememberscandeleteissuessettinginput", - "href": "/graphql/reference/input-objects#updateenterprisememberscandeleteissuessettinginput", - "description": "

Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise on which to set the members can delete issues setting.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "settingValue", - "description": "

The value for the members can delete issues setting on the enterprise.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - } - ] - }, - { - "name": "UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput", - "id": "updateenterprisememberscandeleterepositoriessettinginput", - "href": "/graphql/reference/input-objects#updateenterprisememberscandeleterepositoriessettinginput", - "description": "

Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise on which to set the members can delete repositories setting.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "settingValue", - "description": "

The value for the members can delete repositories setting on the enterprise.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - } - ] - }, - { - "name": "UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput", - "id": "updateenterprisememberscaninvitecollaboratorssettinginput", - "href": "/graphql/reference/input-objects#updateenterprisememberscaninvitecollaboratorssettinginput", - "description": "

Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise on which to set the members can invite collaborators setting.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "settingValue", - "description": "

The value for the members can invite collaborators setting on the enterprise.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - } - ] - }, - { - "name": "UpdateEnterpriseMembersCanMakePurchasesSettingInput", - "id": "updateenterprisememberscanmakepurchasessettinginput", - "href": "/graphql/reference/input-objects#updateenterprisememberscanmakepurchasessettinginput", - "description": "

Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise on which to set the members can make purchases setting.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "settingValue", - "description": "

The value for the members can make purchases setting on the enterprise.

", - "type": "EnterpriseMembersCanMakePurchasesSettingValue!", - "id": "enterprisememberscanmakepurchasessettingvalue", - "href": "/graphql/reference/enums#enterprisememberscanmakepurchasessettingvalue" - } - ] - }, - { - "name": "UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput", - "id": "updateenterprisememberscanupdateprotectedbranchessettinginput", - "href": "/graphql/reference/input-objects#updateenterprisememberscanupdateprotectedbranchessettinginput", - "description": "

Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise on which to set the members can update protected branches setting.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "settingValue", - "description": "

The value for the members can update protected branches setting on the enterprise.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - } - ] - }, - { - "name": "UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput", - "id": "updateenterprisememberscanviewdependencyinsightssettinginput", - "href": "/graphql/reference/input-objects#updateenterprisememberscanviewdependencyinsightssettinginput", - "description": "

Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise on which to set the members can view dependency insights setting.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "settingValue", - "description": "

The value for the members can view dependency insights setting on the enterprise.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - } - ] - }, - { - "name": "UpdateEnterpriseOrganizationProjectsSettingInput", - "id": "updateenterpriseorganizationprojectssettinginput", - "href": "/graphql/reference/input-objects#updateenterpriseorganizationprojectssettinginput", - "description": "

Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise on which to set the organization projects setting.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "settingValue", - "description": "

The value for the organization projects setting on the enterprise.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - } - ] - }, - { - "name": "UpdateEnterpriseOwnerOrganizationRoleInput", - "id": "updateenterpriseownerorganizationroleinput", - "href": "/graphql/reference/input-objects#updateenterpriseownerorganizationroleinput", - "description": "

Autogenerated input type of UpdateEnterpriseOwnerOrganizationRole.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the Enterprise which the owner belongs to.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "organizationId", - "description": "

The ID of the organization for membership change.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "organizationRole", - "description": "

The role to assume in the organization.

", - "type": "RoleInOrganization!", - "id": "roleinorganization", - "href": "/graphql/reference/enums#roleinorganization" - } - ] - }, - { - "name": "UpdateEnterpriseProfileInput", - "id": "updateenterpriseprofileinput", - "href": "/graphql/reference/input-objects#updateenterpriseprofileinput", - "description": "

Autogenerated input type of UpdateEnterpriseProfile.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "description", - "description": "

The description of the enterprise.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The Enterprise ID to update.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "location", - "description": "

The location of the enterprise.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The name of the enterprise.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "websiteUrl", - "description": "

The URL of the enterprise's website.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "UpdateEnterpriseRepositoryProjectsSettingInput", - "id": "updateenterpriserepositoryprojectssettinginput", - "href": "/graphql/reference/input-objects#updateenterpriserepositoryprojectssettinginput", - "description": "

Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise on which to set the repository projects setting.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "settingValue", - "description": "

The value for the repository projects setting on the enterprise.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - } - ] - }, - { - "name": "UpdateEnterpriseTeamDiscussionsSettingInput", - "id": "updateenterpriseteamdiscussionssettinginput", - "href": "/graphql/reference/input-objects#updateenterpriseteamdiscussionssettinginput", - "description": "

Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise on which to set the team discussions setting.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "settingValue", - "description": "

The value for the team discussions setting on the enterprise.

", - "type": "EnterpriseEnabledDisabledSettingValue!", - "id": "enterpriseenableddisabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" - } - ] - }, - { - "name": "UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput", - "id": "updateenterprisetwofactorauthenticationrequiredsettinginput", - "href": "/graphql/reference/input-objects#updateenterprisetwofactorauthenticationrequiredsettinginput", - "description": "

Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "enterpriseId", - "description": "

The ID of the enterprise on which to set the two factor authentication required setting.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "settingValue", - "description": "

The value for the two factor authentication required setting on the enterprise.

", - "type": "EnterpriseEnabledSettingValue!", - "id": "enterpriseenabledsettingvalue", - "href": "/graphql/reference/enums#enterpriseenabledsettingvalue" - } - ] - }, - { - "name": "UpdateEnvironmentInput", - "id": "updateenvironmentinput", - "href": "/graphql/reference/input-objects#updateenvironmentinput", - "description": "

Autogenerated input type of UpdateEnvironment.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "environmentId", - "description": "

The node ID of the environment.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "preventSelfReview", - "description": "

Whether deployments to this environment can be approved by the user who created the deployment.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "reviewers", - "description": "

The ids of users or teams that can approve deployments to this environment.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "waitTimer", - "description": "

The wait timer in minutes.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "UpdateIpAllowListEnabledSettingInput", - "id": "updateipallowlistenabledsettinginput", - "href": "/graphql/reference/input-objects#updateipallowlistenabledsettinginput", - "description": "

Autogenerated input type of UpdateIpAllowListEnabledSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ownerId", - "description": "

The ID of the owner on which to set the IP allow list enabled setting.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "settingValue", - "description": "

The value for the IP allow list enabled setting.

", - "type": "IpAllowListEnabledSettingValue!", - "id": "ipallowlistenabledsettingvalue", - "href": "/graphql/reference/enums#ipallowlistenabledsettingvalue" - } - ] - }, - { - "name": "UpdateIpAllowListEntryInput", - "id": "updateipallowlistentryinput", - "href": "/graphql/reference/input-objects#updateipallowlistentryinput", - "description": "

Autogenerated input type of UpdateIpAllowListEntry.

", - "inputFields": [ - { - "name": "allowListValue", - "description": "

An IP address or range of addresses in CIDR notation.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ipAllowListEntryId", - "description": "

The ID of the IP allow list entry to update.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "isActive", - "description": "

Whether the IP allow list entry is active when an IP allow list is enabled.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "name", - "description": "

An optional name for the IP allow list entry.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "UpdateIpAllowListForInstalledAppsEnabledSettingInput", - "id": "updateipallowlistforinstalledappsenabledsettinginput", - "href": "/graphql/reference/input-objects#updateipallowlistforinstalledappsenabledsettinginput", - "description": "

Autogenerated input type of UpdateIpAllowListForInstalledAppsEnabledSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ownerId", - "description": "

The ID of the owner.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "settingValue", - "description": "

The value for the IP allow list configuration for installed GitHub Apps setting.

", - "type": "IpAllowListForInstalledAppsEnabledSettingValue!", - "id": "ipallowlistforinstalledappsenabledsettingvalue", - "href": "/graphql/reference/enums#ipallowlistforinstalledappsenabledsettingvalue" - } - ] - }, - { - "name": "UpdateIssueCommentInput", - "id": "updateissuecommentinput", - "href": "/graphql/reference/input-objects#updateissuecommentinput", - "description": "

Autogenerated input type of UpdateIssueComment.

", - "inputFields": [ - { - "name": "body", - "description": "

The updated text of the comment.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The ID of the IssueComment to modify.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UpdateIssueInput", - "id": "updateissueinput", - "href": "/graphql/reference/input-objects#updateissueinput", - "description": "

Autogenerated input type of UpdateIssue.

", - "inputFields": [ - { - "name": "assigneeIds", - "description": "

An array of Node IDs of users for this issue.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "body", - "description": "

The body for the issue description.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The ID of the Issue to modify.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "labelIds", - "description": "

An array of Node IDs of labels for this issue.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "milestoneId", - "description": "

The Node ID of the milestone for this issue.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "projectIds", - "description": "

An array of Node IDs for projects associated with this issue.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "state", - "description": "

The desired issue state.

", - "type": "IssueState", - "id": "issuestate", - "href": "/graphql/reference/enums#issuestate" - }, - { - "name": "title", - "description": "

The title for the issue.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "UpdateLabelInput", - "id": "updatelabelinput", - "href": "/graphql/reference/input-objects#updatelabelinput", - "description": "

Autogenerated input type of UpdateLabel.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "color", - "description": "

A 6 character hex code, without the leading #, identifying the updated color of the label.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "description", - "description": "

A brief description of the label, such as its purpose.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the label to be updated.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "name", - "description": "

The updated name of the label.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "UpdateNotificationRestrictionSettingInput", - "id": "updatenotificationrestrictionsettinginput", - "href": "/graphql/reference/input-objects#updatenotificationrestrictionsettinginput", - "description": "

Autogenerated input type of UpdateNotificationRestrictionSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ownerId", - "description": "

The ID of the owner on which to set the restrict notifications setting.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "settingValue", - "description": "

The value for the restrict notifications setting.

", - "type": "NotificationRestrictionSettingValue!", - "id": "notificationrestrictionsettingvalue", - "href": "/graphql/reference/enums#notificationrestrictionsettingvalue" - } - ] - }, - { - "name": "UpdateOrganizationAllowPrivateRepositoryForkingSettingInput", - "id": "updateorganizationallowprivaterepositoryforkingsettinginput", - "href": "/graphql/reference/input-objects#updateorganizationallowprivaterepositoryforkingsettinginput", - "description": "

Autogenerated input type of UpdateOrganizationAllowPrivateRepositoryForkingSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "forkingEnabled", - "description": "

Enable forking of private repositories in the organization?.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "organizationId", - "description": "

The ID of the organization on which to set the allow private repository forking setting.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UpdateOrganizationWebCommitSignoffSettingInput", - "id": "updateorganizationwebcommitsignoffsettinginput", - "href": "/graphql/reference/input-objects#updateorganizationwebcommitsignoffsettinginput", - "description": "

Autogenerated input type of UpdateOrganizationWebCommitSignoffSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "organizationId", - "description": "

The ID of the organization on which to set the web commit signoff setting.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "webCommitSignoffRequired", - "description": "

Enable signoff on web-based commits for repositories in the organization?.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "UpdateParametersInput", - "id": "updateparametersinput", - "href": "/graphql/reference/input-objects#updateparametersinput", - "description": "

Only allow users with bypass permission to update matching refs.

", - "inputFields": [ - { - "name": "updateAllowsFetchAndMerge", - "description": "

Branch can pull changes from its upstream repository.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "UpdateProjectCardInput", - "id": "updateprojectcardinput", - "href": "/graphql/reference/input-objects#updateprojectcardinput", - "description": "

Autogenerated input type of UpdateProjectCard.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "isArchived", - "description": "

Whether or not the ProjectCard should be archived.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "note", - "description": "

The note of ProjectCard.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "projectCardId", - "description": "

The ProjectCard ID to update.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UpdateProjectColumnInput", - "id": "updateprojectcolumninput", - "href": "/graphql/reference/input-objects#updateprojectcolumninput", - "description": "

Autogenerated input type of UpdateProjectColumn.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The name of project column.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "projectColumnId", - "description": "

The ProjectColumn ID to update.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UpdateProjectInput", - "id": "updateprojectinput", - "href": "/graphql/reference/input-objects#updateprojectinput", - "description": "

Autogenerated input type of UpdateProject.

", - "inputFields": [ - { - "name": "body", - "description": "

The description of project.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "name", - "description": "

The name of project.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "projectId", - "description": "

The Project ID to update.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "public", - "description": "

Whether the project is public or not.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "state", - "description": "

Whether the project is open or closed.

", - "type": "ProjectState", - "id": "projectstate", - "href": "/graphql/reference/enums#projectstate" - } - ] - }, - { - "name": "UpdateProjectV2CollaboratorsInput", - "id": "updateprojectv2collaboratorsinput", - "href": "/graphql/reference/input-objects#updateprojectv2collaboratorsinput", - "description": "

Autogenerated input type of UpdateProjectV2Collaborators.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "collaborators", - "description": "

The collaborators to update.

", - "type": "[ProjectV2Collaborator!]!", - "id": "projectv2collaborator", - "href": "/graphql/reference/input-objects#projectv2collaborator" - }, - { - "name": "projectId", - "description": "

The ID of the project to update the collaborators for.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UpdateProjectV2DraftIssueInput", - "id": "updateprojectv2draftissueinput", - "href": "/graphql/reference/input-objects#updateprojectv2draftissueinput", - "description": "

Autogenerated input type of UpdateProjectV2DraftIssue.

", - "inputFields": [ - { - "name": "assigneeIds", - "description": "

The IDs of the assignees of the draft issue.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "body", - "description": "

The body of the draft issue.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "draftIssueId", - "description": "

The ID of the draft issue to update.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "title", - "description": "

The title of the draft issue.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "UpdateProjectV2Input", - "id": "updateprojectv2input", - "href": "/graphql/reference/input-objects#updateprojectv2input", - "description": "

Autogenerated input type of UpdateProjectV2.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "closed", - "description": "

Set the project to closed or open.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "projectId", - "description": "

The ID of the Project to update.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "public", - "description": "

Set the project to public or private.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "readme", - "description": "

Set the readme description of the project.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "shortDescription", - "description": "

Set the short description of the project.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "title", - "description": "

Set the title of the project.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "UpdateProjectV2ItemFieldValueInput", - "id": "updateprojectv2itemfieldvalueinput", - "href": "/graphql/reference/input-objects#updateprojectv2itemfieldvalueinput", - "description": "

Autogenerated input type of UpdateProjectV2ItemFieldValue.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "fieldId", - "description": "

The ID of the field to be updated.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "itemId", - "description": "

The ID of the item to be updated.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "projectId", - "description": "

The ID of the Project.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "value", - "description": "

The value which will be set on the field.

", - "type": "ProjectV2FieldValue!", - "id": "projectv2fieldvalue", - "href": "/graphql/reference/input-objects#projectv2fieldvalue" - } - ] - }, - { - "name": "UpdateProjectV2ItemPositionInput", - "id": "updateprojectv2itempositioninput", - "href": "/graphql/reference/input-objects#updateprojectv2itempositioninput", - "description": "

Autogenerated input type of UpdateProjectV2ItemPosition.

", - "inputFields": [ - { - "name": "afterId", - "description": "

The ID of the item to position this item after. If omitted or set to null the item will be moved to top.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "itemId", - "description": "

The ID of the item to be moved.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "projectId", - "description": "

The ID of the Project.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UpdatePullRequestBranchInput", - "id": "updatepullrequestbranchinput", - "href": "/graphql/reference/input-objects#updatepullrequestbranchinput", - "description": "

Autogenerated input type of UpdatePullRequestBranch.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "expectedHeadOid", - "description": "

The head ref oid for the upstream branch.

", - "type": "GitObjectID", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "pullRequestId", - "description": "

The Node ID of the pull request.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "updateMethod", - "description": "

The update branch method to use. If omitted, defaults to 'MERGE'.

", - "type": "PullRequestBranchUpdateMethod", - "id": "pullrequestbranchupdatemethod", - "href": "/graphql/reference/enums#pullrequestbranchupdatemethod" - } - ] - }, - { - "name": "UpdatePullRequestInput", - "id": "updatepullrequestinput", - "href": "/graphql/reference/input-objects#updatepullrequestinput", - "description": "

Autogenerated input type of UpdatePullRequest.

", - "inputFields": [ - { - "name": "assigneeIds", - "description": "

An array of Node IDs of users for this pull request.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "baseRefName", - "description": "

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "body", - "description": "

The contents of the pull request.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "labelIds", - "description": "

An array of Node IDs of labels for this pull request.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "maintainerCanModify", - "description": "

Indicates whether maintainers can modify the pull request.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "milestoneId", - "description": "

The Node ID of the milestone for this pull request.

", - "type": "ID", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "projectIds", - "description": "

An array of Node IDs for projects associated with this pull request.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "pullRequestId", - "description": "

The Node ID of the pull request.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "state", - "description": "

The target state of the pull request.

", - "type": "PullRequestUpdateState", - "id": "pullrequestupdatestate", - "href": "/graphql/reference/enums#pullrequestupdatestate" - }, - { - "name": "title", - "description": "

The title of the pull request.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "UpdatePullRequestReviewCommentInput", - "id": "updatepullrequestreviewcommentinput", - "href": "/graphql/reference/input-objects#updatepullrequestreviewcommentinput", - "description": "

Autogenerated input type of UpdatePullRequestReviewComment.

", - "inputFields": [ - { - "name": "body", - "description": "

The text of the comment.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequestReviewCommentId", - "description": "

The Node ID of the comment to modify.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UpdatePullRequestReviewInput", - "id": "updatepullrequestreviewinput", - "href": "/graphql/reference/input-objects#updatepullrequestreviewinput", - "description": "

Autogenerated input type of UpdatePullRequestReview.

", - "inputFields": [ - { - "name": "body", - "description": "

The contents of the pull request review body.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequestReviewId", - "description": "

The Node ID of the pull request review to modify.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UpdateRefInput", - "id": "updaterefinput", - "href": "/graphql/reference/input-objects#updaterefinput", - "description": "

Autogenerated input type of UpdateRef.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "force", - "description": "

Permit updates of branch Refs that are not fast-forwards?.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "oid", - "description": "

The GitObjectID that the Ref shall be updated to target.

", - "type": "GitObjectID!", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid" - }, - { - "name": "refId", - "description": "

The Node ID of the Ref to be updated.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UpdateRefsInput", - "id": "updaterefsinput", - "href": "/graphql/reference/input-objects#updaterefsinput", - "description": "

Autogenerated input type of UpdateRefs.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "refUpdates", - "description": "

A list of ref updates.

", - "type": "[RefUpdate!]!", - "id": "refupdate", - "href": "/graphql/reference/input-objects#refupdate" - }, - { - "name": "repositoryId", - "description": "

The Node ID of the repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UpdateRepositoryInput", - "id": "updaterepositoryinput", - "href": "/graphql/reference/input-objects#updaterepositoryinput", - "description": "

Autogenerated input type of UpdateRepository.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "description", - "description": "

A new description for the repository. Pass an empty string to erase the existing description.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "hasDiscussionsEnabled", - "description": "

Indicates if the repository should have the discussions feature enabled.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "hasIssuesEnabled", - "description": "

Indicates if the repository should have the issues feature enabled.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "hasProjectsEnabled", - "description": "

Indicates if the repository should have the project boards feature enabled.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "hasWikiEnabled", - "description": "

Indicates if the repository should have the wiki feature enabled.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "homepageUrl", - "description": "

The URL for a web page about this repository. Pass an empty string to erase the existing URL.

", - "type": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri" - }, - { - "name": "name", - "description": "

The new name of the repository.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryId", - "description": "

The ID of the repository to update.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "template", - "description": "

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "UpdateRepositoryRulesetInput", - "id": "updaterepositoryrulesetinput", - "href": "/graphql/reference/input-objects#updaterepositoryrulesetinput", - "description": "

Autogenerated input type of UpdateRepositoryRuleset.

", - "inputFields": [ - { - "name": "bypassActors", - "description": "

A list of actors that are allowed to bypass rules in this ruleset.

", - "type": "[RepositoryRulesetBypassActorInput!]", - "id": "repositoryrulesetbypassactorinput", - "href": "/graphql/reference/input-objects#repositoryrulesetbypassactorinput" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "conditions", - "description": "

The list of conditions for this ruleset.

", - "type": "RepositoryRuleConditionsInput", - "id": "repositoryruleconditionsinput", - "href": "/graphql/reference/input-objects#repositoryruleconditionsinput" - }, - { - "name": "enforcement", - "description": "

The enforcement level for this ruleset.

", - "type": "RuleEnforcement", - "id": "ruleenforcement", - "href": "/graphql/reference/enums#ruleenforcement" - }, - { - "name": "name", - "description": "

The name of the ruleset.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryRulesetId", - "description": "

The global relay id of the repository ruleset to be updated.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "rules", - "description": "

The list of rules for this ruleset.

", - "type": "[RepositoryRuleInput!]", - "id": "repositoryruleinput", - "href": "/graphql/reference/input-objects#repositoryruleinput" - }, - { - "name": "target", - "description": "

The target of the ruleset.

", - "type": "RepositoryRulesetTarget", - "id": "repositoryrulesettarget", - "href": "/graphql/reference/enums#repositoryrulesettarget" - } - ] - }, - { - "name": "UpdateRepositoryWebCommitSignoffSettingInput", - "id": "updaterepositorywebcommitsignoffsettinginput", - "href": "/graphql/reference/input-objects#updaterepositorywebcommitsignoffsettinginput", - "description": "

Autogenerated input type of UpdateRepositoryWebCommitSignoffSetting.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryId", - "description": "

The ID of the repository to update.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "webCommitSignoffRequired", - "description": "

Indicates if the repository should require signoff on web-based commits.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - } - ] - }, - { - "name": "UpdateSubscriptionInput", - "id": "updatesubscriptioninput", - "href": "/graphql/reference/input-objects#updatesubscriptioninput", - "description": "

Autogenerated input type of UpdateSubscription.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "state", - "description": "

The new state of the subscription.

", - "type": "SubscriptionState!", - "id": "subscriptionstate", - "href": "/graphql/reference/enums#subscriptionstate" - }, - { - "name": "subscribableId", - "description": "

The Node ID of the subscribable object to modify.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UpdateTeamDiscussionCommentInput", - "id": "updateteamdiscussioncommentinput", - "href": "/graphql/reference/input-objects#updateteamdiscussioncommentinput", - "description": "

Autogenerated input type of UpdateTeamDiscussionComment.

", - "inputFields": [ - { - "name": "body", - "description": "

The updated text of the comment.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyVersion", - "description": "

The current version of the body content.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The ID of the comment to modify.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UpdateTeamDiscussionInput", - "id": "updateteamdiscussioninput", - "href": "/graphql/reference/input-objects#updateteamdiscussioninput", - "description": "

Autogenerated input type of UpdateTeamDiscussion.

", - "inputFields": [ - { - "name": "body", - "description": "

The updated text of the discussion.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "bodyVersion", - "description": "

The current version of the body content. If provided, this update operation\nwill be rejected if the given version does not match the latest version on the server.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The Node ID of the discussion to modify.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "pinned", - "description": "

If provided, sets the pinned state of the updated discussion.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "title", - "description": "

The updated title of the discussion.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "UpdateTeamReviewAssignmentInput", - "id": "updateteamreviewassignmentinput", - "href": "/graphql/reference/input-objects#updateteamreviewassignmentinput", - "description": "

Autogenerated input type of UpdateTeamReviewAssignment.

", - "inputFields": [ - { - "name": "algorithm", - "description": "

The algorithm to use for review assignment.

", - "type": "TeamReviewAssignmentAlgorithm", - "id": "teamreviewassignmentalgorithm", - "href": "/graphql/reference/enums#teamreviewassignmentalgorithm" - }, - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "countMembersAlreadyRequested", - "description": "

Count any members whose review has already been requested against the required number of members assigned to review.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "enabled", - "description": "

Turn on or off review assignment.

", - "type": "Boolean!", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "excludedTeamMemberIds", - "description": "

An array of team member IDs to exclude.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "id", - "description": "

The Node ID of the team to update review assignments of.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "includeChildTeamMembers", - "description": "

Include the members of any child teams when assigning.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "notifyTeam", - "description": "

Notify the entire team of the PR if it is delegated.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "removeTeamRequest", - "description": "

Remove the team review request when assigning.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "teamMemberCount", - "description": "

The number of team members to assign.

", - "type": "Int", - "id": "int", - "href": "/graphql/reference/scalars#int" - } - ] - }, - { - "name": "UpdateTeamsRepositoryInput", - "id": "updateteamsrepositoryinput", - "href": "/graphql/reference/input-objects#updateteamsrepositoryinput", - "description": "

Autogenerated input type of UpdateTeamsRepository.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "permission", - "description": "

Permission that should be granted to the teams.

", - "type": "RepositoryPermission!", - "id": "repositorypermission", - "href": "/graphql/reference/enums#repositorypermission" - }, - { - "name": "repositoryId", - "description": "

Repository ID being granted access to.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "teamIds", - "description": "

A list of teams being granted access. Limit: 10.

", - "type": "[ID!]!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UpdateTopicsInput", - "id": "updatetopicsinput", - "href": "/graphql/reference/input-objects#updatetopicsinput", - "description": "

Autogenerated input type of UpdateTopics.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryId", - "description": "

The Node ID of the repository.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "topicNames", - "description": "

An array of topic names.

", - "type": "[String!]!", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "UpdateUserListInput", - "id": "updateuserlistinput", - "href": "/graphql/reference/input-objects#updateuserlistinput", - "description": "

Autogenerated input type of UpdateUserList.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "description", - "description": "

A description of the list.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "isPrivate", - "description": "

Whether or not the list is private.

", - "type": "Boolean", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "listId", - "description": "

The ID of the list to update.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "name", - "description": "

The name of the list.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "UpdateUserListsForItemInput", - "id": "updateuserlistsforiteminput", - "href": "/graphql/reference/input-objects#updateuserlistsforiteminput", - "description": "

Autogenerated input type of UpdateUserListsForItem.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "itemId", - "description": "

The item to add to the list.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "listIds", - "description": "

The lists to which this item should belong.

", - "type": "[ID!]!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - }, - { - "name": "suggestedListIds", - "description": "

The suggested lists to create and add this item to.

", - "type": "[ID!]", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "UserStatusOrder", - "id": "userstatusorder", - "href": "/graphql/reference/input-objects#userstatusorder", - "description": "

Ordering options for user status connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order user statuses by.

", - "type": "UserStatusOrderField!", - "id": "userstatusorderfield", - "href": "/graphql/reference/enums#userstatusorderfield" - } - ] - }, - { - "name": "VerifiableDomainOrder", - "id": "verifiabledomainorder", - "href": "/graphql/reference/input-objects#verifiabledomainorder", - "description": "

Ordering options for verifiable domain connections.

", - "inputFields": [ - { - "name": "direction", - "description": "

The ordering direction.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field to order verifiable domains by.

", - "type": "VerifiableDomainOrderField!", - "id": "verifiabledomainorderfield", - "href": "/graphql/reference/enums#verifiabledomainorderfield" - } - ] - }, - { - "name": "VerifyVerifiableDomainInput", - "id": "verifyverifiabledomaininput", - "href": "/graphql/reference/input-objects#verifyverifiabledomaininput", - "description": "

Autogenerated input type of VerifyVerifiableDomain.

", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

A unique identifier for the client performing the mutation.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "id", - "description": "

The ID of the verifiable domain to verify.

", - "type": "ID!", - "id": "id", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, - { - "name": "WorkflowFileReferenceInput", - "id": "workflowfilereferenceinput", - "href": "/graphql/reference/input-objects#workflowfilereferenceinput", - "description": "

A workflow that must run for this rule to pass.

", - "inputFields": [ - { - "name": "path", - "description": "

The path to the workflow file.

", - "type": "String!", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "ref", - "description": "

The ref (branch or tag) of the workflow file to use.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "repositoryId", - "description": "

The ID of the repository where the workflow is defined.

", - "type": "Int!", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "sha", - "description": "

The commit SHA of the workflow file to use.

", - "type": "String", - "id": "string", - "href": "/graphql/reference/scalars#string" - } - ] - }, - { - "name": "WorkflowRunOrder", - "id": "workflowrunorder", - "href": "/graphql/reference/input-objects#workflowrunorder", - "description": "

Ways in which lists of workflow runs can be ordered upon return.

", - "inputFields": [ - { - "name": "direction", - "description": "

The direction in which to order workflow runs by the specified field.

", - "type": "OrderDirection!", - "id": "orderdirection", - "href": "/graphql/reference/enums#orderdirection" - }, - { - "name": "field", - "description": "

The field by which to order workflows.

", - "type": "WorkflowRunOrderField!", - "id": "workflowrunorderfield", - "href": "/graphql/reference/enums#workflowrunorderfield" - } - ] - }, - { - "name": "WorkflowsParametersInput", - "id": "workflowsparametersinput", - "href": "/graphql/reference/input-objects#workflowsparametersinput", - "description": "

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

", - "inputFields": [ - { - "name": "workflows", - "description": "

Workflows that must pass for this rule to pass.

", - "type": "[WorkflowFileReferenceInput!]!", - "id": "workflowfilereferenceinput", - "href": "/graphql/reference/input-objects#workflowfilereferenceinput" - } - ] - } - ], - "scalars": [ - { - "name": "Base64String", - "id": "base64string", - "href": "/graphql/reference/scalars#base64string", - "description": "

A (potentially binary) string encoded using base64.

" - }, - { - "name": "BigInt", - "id": "bigint", - "href": "/graphql/reference/scalars#bigint", - "description": "

Represents non-fractional signed whole numeric values. Since the value may\nexceed the size of a 32-bit integer, it's encoded as a string.

" - }, - { - "name": "Boolean", - "description": "

Represents true or false values.

", - "id": "boolean", - "href": "/graphql/reference/scalars#boolean" - }, - { - "name": "Date", - "id": "date", - "href": "/graphql/reference/scalars#date", - "description": "

An ISO-8601 encoded date string.

" - }, - { - "name": "DateTime", - "id": "datetime", - "href": "/graphql/reference/scalars#datetime", - "description": "

An ISO-8601 encoded UTC date string.

" - }, - { - "name": "Float", - "description": "

Represents signed double-precision fractional values as specified by IEEE 754.

", - "id": "float", - "href": "/graphql/reference/scalars#float" - }, - { - "name": "GitObjectID", - "id": "gitobjectid", - "href": "/graphql/reference/scalars#gitobjectid", - "description": "

A Git object ID.

" - }, - { - "name": "GitRefname", - "id": "gitrefname", - "href": "/graphql/reference/scalars#gitrefname", - "description": "

A fully qualified reference name (e.g. refs/heads/master).

" - }, - { - "name": "GitSSHRemote", - "id": "gitsshremote", - "href": "/graphql/reference/scalars#gitsshremote", - "description": "

Git SSH string.

" - }, - { - "name": "GitTimestamp", - "id": "gittimestamp", - "href": "/graphql/reference/scalars#gittimestamp", - "description": "

An ISO-8601 encoded date string. Unlike the DateTime type, GitTimestamp is not converted in UTC.

" - }, - { - "name": "HTML", - "id": "html", - "href": "/graphql/reference/scalars#html", - "description": "

A string containing HTML code.

" - }, - { - "name": "ID", - "description": "

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as \"VXNlci0xMA==\") or integer (such as 4) input value will be accepted as an ID.

", - "id": "id", - "href": "/graphql/reference/scalars#id" - }, - { - "name": "Int", - "description": "

Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

", - "id": "int", - "href": "/graphql/reference/scalars#int" - }, - { - "name": "PreciseDateTime", - "id": "precisedatetime", - "href": "/graphql/reference/scalars#precisedatetime", - "description": "

An ISO-8601 encoded UTC date string with millisecond precision.

" - }, - { - "name": "String", - "description": "

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

", - "id": "string", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "URI", - "id": "uri", - "href": "/graphql/reference/scalars#uri", - "description": "

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

" - }, - { - "name": "X509Certificate", - "id": "x509certificate", - "href": "/graphql/reference/scalars#x509certificate", - "description": "

A valid x509 certificate string.

" - } - ] -} \ No newline at end of file diff --git a/src/graphql/data/ghes-3.14/upcoming-changes.json b/src/graphql/data/ghes-3.14/upcoming-changes.json deleted file mode 100644 index 7f9b43095cd5..000000000000 --- a/src/graphql/data/ghes-3.14/upcoming-changes.json +++ /dev/null @@ -1,580 +0,0 @@ -{ - "2024-07-01": [ - { - "location": "TeamDiscussionComment.url", - "description": "

url will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "TeamDiscussionComment.resourcePath", - "description": "

resourcePath will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "TeamDiscussionComment.number", - "description": "

number will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "TeamDiscussionComment.discussion", - "description": "

discussion will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "TeamDiscussionComment.bodyVersion", - "description": "

bodyVersion will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "TeamDiscussionComment.authorAssociation", - "description": "

authorAssociation will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "TeamDiscussion.viewerCanPin", - "description": "

viewerCanPin will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "TeamDiscussion.url", - "description": "

url will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "TeamDiscussion.title", - "description": "

title will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "TeamDiscussion.team", - "description": "

team will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "TeamDiscussion.resourcePath", - "description": "

resourcePath will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "TeamDiscussion.number", - "description": "

number will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "TeamDiscussion.isPrivate", - "description": "

isPrivate will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "TeamDiscussion.isPinned", - "description": "

isPinned will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "TeamDiscussion.commentsUrl", - "description": "

commentsUrl will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "TeamDiscussion.commentsResourcePath", - "description": "

commentsResourcePath will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "TeamDiscussion.comments", - "description": "

comments will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "TeamDiscussion.bodyVersion", - "description": "

bodyVersion will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "TeamDiscussion.authorAssociation", - "description": "

authorAssociation will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "PullRequestReviewComment.databaseId", - "description": "

databaseId will be removed. Use fullDatabaseId instead.

", - "reason": "

databaseId will be removed because it does not support 64-bit signed integer identifiers.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "JanKoszewski" - }, - { - "location": "PullRequestReview.databaseId", - "description": "

databaseId will be removed. Use fullDatabaseId instead.

", - "reason": "

databaseId will be removed because it does not support 64-bit signed integer identifiers.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "JanKoszewski" - }, - { - "location": "PullRequest.databaseId", - "description": "

databaseId will be removed. Use fullDatabaseId instead.

", - "reason": "

databaseId will be removed because it does not support 64-bit signed integer identifiers.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "JanKoszewski" - }, - { - "location": "OrganizationInvitation.inviter", - "description": "

inviter will be removed. inviter will be replaced by inviterActor.

", - "reason": "

inviter will be removed.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "jdennes" - }, - { - "location": "CreateTeamDiscussionPayload.teamDiscussion", - "description": "

teamDiscussion will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "CreateTeamDiscussionInput.title", - "description": "

title will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "CreateTeamDiscussionInput.teamId", - "description": "

teamId will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "CreateTeamDiscussionInput.private", - "description": "

private will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "CreateTeamDiscussionInput.body", - "description": "

body will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "CreateTeamDiscussionCommentPayload.teamDiscussionComment", - "description": "

teamDiscussionComment will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "CreateTeamDiscussionCommentInput.discussionId", - "description": "

discussionId will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - }, - { - "location": "CreateTeamDiscussionCommentInput.body", - "description": "

body will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", - "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", - "date": "2024-07-01", - "criticality": "breaking", - "owner": "deborah-digges" - } - ], - "2024-04-01": [ - { - "location": "TopicSuggestionDeclineReason.TOO_SPECIFIC", - "description": "

TOO_SPECIFIC will be removed.

", - "reason": "

Suggested topics are no longer supported

", - "date": "2024-04-01", - "criticality": "breaking", - "owner": "calvinchilds" - }, - { - "location": "TopicSuggestionDeclineReason.TOO_GENERAL", - "description": "

TOO_GENERAL will be removed.

", - "reason": "

Suggested topics are no longer supported

", - "date": "2024-04-01", - "criticality": "breaking", - "owner": "calvinchilds" - }, - { - "location": "TopicSuggestionDeclineReason.PERSONAL_PREFERENCE", - "description": "

PERSONAL_PREFERENCE will be removed.

", - "reason": "

Suggested topics are no longer supported

", - "date": "2024-04-01", - "criticality": "breaking", - "owner": "calvinchilds" - }, - { - "location": "TopicSuggestionDeclineReason.NOT_RELEVANT", - "description": "

NOT_RELEVANT will be removed.

", - "reason": "

Suggested topics are no longer supported

", - "date": "2024-04-01", - "criticality": "breaking", - "owner": "calvinchilds" - } - ], - "2023-10-01": [ - { - "location": "PullRequestReviewComment.position", - "description": "

position will be removed. Use the line and startLine fields instead, which are file line numbers instead of diff line numbers

", - "reason": "

We are phasing out diff-relative positioning for PR comments

", - "date": "2023-10-01", - "criticality": "breaking", - "owner": "aharpole" - }, - { - "location": "PullRequestReviewComment.originalPosition", - "description": "

originalPosition will be removed.

", - "reason": "

We are phasing out diff-relative positioning for PR comments

", - "date": "2023-10-01", - "criticality": "breaking", - "owner": "aharpole" - }, - { - "location": "AddPullRequestReviewInput.comments", - "description": "

comments will be removed. use the threads argument instead

", - "reason": "

We are deprecating comment fields that use diff-relative positioning

", - "date": "2023-10-01", - "criticality": "breaking", - "owner": "aharpole" - }, - { - "location": "AddPullRequestReviewCommentInput.pullRequestReviewId", - "description": "

pullRequestReviewId will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead

", - "reason": "

We are deprecating the addPullRequestReviewComment mutation

", - "date": "2023-10-01", - "criticality": "breaking", - "owner": "aharpole" - }, - { - "location": "AddPullRequestReviewCommentInput.pullRequestId", - "description": "

pullRequestId will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead

", - "reason": "

We are deprecating the addPullRequestReviewComment mutation

", - "date": "2023-10-01", - "criticality": "breaking", - "owner": "aharpole" - }, - { - "location": "AddPullRequestReviewCommentInput.position", - "description": "

position will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead

", - "reason": "

We are deprecating the addPullRequestReviewComment mutation

", - "date": "2023-10-01", - "criticality": "breaking", - "owner": "aharpole" - }, - { - "location": "AddPullRequestReviewCommentInput.path", - "description": "

path will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead

", - "reason": "

We are deprecating the addPullRequestReviewComment mutation

", - "date": "2023-10-01", - "criticality": "breaking", - "owner": "aharpole" - }, - { - "location": "AddPullRequestReviewCommentInput.inReplyTo", - "description": "

inReplyTo will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead

", - "reason": "

We are deprecating the addPullRequestReviewComment mutation

", - "date": "2023-10-01", - "criticality": "breaking", - "owner": "aharpole" - }, - { - "location": "AddPullRequestReviewCommentInput.commitOID", - "description": "

commitOID will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead

", - "reason": "

We are deprecating the addPullRequestReviewComment mutation

", - "date": "2023-10-01", - "criticality": "breaking", - "owner": "aharpole" - }, - { - "location": "AddPullRequestReviewCommentInput.body", - "description": "

body will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead

", - "reason": "

We are deprecating the addPullRequestReviewComment mutation

", - "date": "2023-10-01", - "criticality": "breaking", - "owner": "aharpole" - } - ], - "2023-07-01": [ - { - "location": "ProjectV2ItemFieldGroup.field", - "description": "

field will be removed. Check out the ProjectV2ItemFieldGroup#groupByField API as an example for the more capable alternative.

", - "reason": "

The ProjectV2ItemFieldGroup#field API is deprecated in favour of the more capable ProjectV2ItemFieldGroup#groupByField API.

", - "date": "2023-07-01", - "criticality": "breaking", - "owner": "stevepopovich" - }, - { - "location": "Commit.pushedDate", - "description": "

pushedDate will be removed.

", - "reason": "

pushedDate is no longer supported.

", - "date": "2023-07-01", - "criticality": "breaking", - "owner": "darthwillis" - } - ], - "2023-04-01": [ - { - "location": "Repository.squashPrTitleUsedAsDefault", - "description": "

squashPrTitleUsedAsDefault will be removed. Use Repository.squashMergeCommitTitle instead.

", - "reason": "

squashPrTitleUsedAsDefault will be removed.

", - "date": "2023-04-01", - "criticality": "breaking", - "owner": "github/pull_requests" - }, - { - "location": "ProjectV2View.verticalGroupBy", - "description": "

verticalGroupBy will be removed. Check out the ProjectV2View#vertical_group_by_fields API as an example for the more capable alternative.

", - "reason": "

The ProjectV2View#vertical_group_by API is deprecated in favour of the more capable ProjectV2View#vertical_group_by_fields API.

", - "date": "2023-04-01", - "criticality": "breaking", - "owner": "traumverloren" - }, - { - "location": "ProjectV2View.sortBy", - "description": "

sortBy will be removed. Check out the ProjectV2View#sort_by_fields API as an example for the more capable alternative.

", - "reason": "

The ProjectV2View#sort_by API is deprecated in favour of the more capable ProjectV2View#sort_by_fields API.

", - "date": "2023-04-01", - "criticality": "breaking", - "owner": "traumverloren" - }, - { - "location": "ProjectV2View.groupBy", - "description": "

groupBy will be removed. Check out the ProjectV2View#group_by_fields API as an example for the more capable alternative.

", - "reason": "

The ProjectV2View#order_by API is deprecated in favour of the more capable ProjectV2View#group_by_field API.

", - "date": "2023-04-01", - "criticality": "breaking", - "owner": "alcere" - } - ], - "2023-02-10": [ - { - "location": "PackageType.MAVEN", - "description": "

MAVEN will be removed.

", - "reason": "

MAVEN will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", - "date": "2023-02-10", - "criticality": "breaking", - "owner": "ankitkaushal01" - } - ], - "2023-01-01": [ - { - "location": "ProjectV2View.visibleFields", - "description": "

visibleFields will be removed. Check out the ProjectV2View#fields API as an example for the more capable alternative.

", - "reason": "

The ProjectV2View#visibleFields API is deprecated in favour of the more capable ProjectV2View#fields API.

", - "date": "2023-01-01", - "criticality": "breaking", - "owner": "mattruggio" - }, - { - "location": "Commit.changedFiles", - "description": "

changedFiles will be removed. Use changedFilesIfAvailable instead.

", - "reason": "

changedFiles will be removed.

", - "date": "2023-01-01", - "criticality": "breaking", - "owner": "adamshwert" - } - ], - "2022-12-28": [ - { - "location": "PackageType.RUBYGEMS", - "description": "

RUBYGEMS will be removed.

", - "reason": "

RUBYGEMS will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", - "date": "2022-12-28", - "criticality": "breaking", - "owner": "ankitkaushal01" - } - ], - "2022-11-21": [ - { - "location": "PackageType.NUGET", - "description": "

NUGET will be removed.

", - "reason": "

NUGET will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", - "date": "2022-11-21", - "criticality": "breaking", - "owner": "s-anupam" - }, - { - "location": "PackageType.NPM", - "description": "

NPM will be removed.

", - "reason": "

NPM will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", - "date": "2022-11-21", - "criticality": "breaking", - "owner": "s-anupam" - } - ], - "2022-10-01": [ - { - "location": "RemovePullRequestFromMergeQueueInput.branch", - "description": "

branch will be removed.

", - "reason": "

PRs are removed from the merge queue for the base branch, the branch argument is now a no-op

", - "date": "2022-10-01", - "criticality": "breaking", - "owner": "jhunschejones" - }, - { - "location": "DependencyGraphDependency.packageLabel", - "description": "

packageLabel will be removed. Use normalized packageName field instead.

", - "reason": "

packageLabel will be removed.

", - "date": "2022-10-01", - "criticality": "breaking", - "owner": "github/dependency_graph" - } - ], - "2022-07-01": [ - { - "location": "AddPullRequestToMergeQueueInput.branch", - "description": "

branch will be removed.

", - "reason": "

PRs are added to the merge queue for the base branch, the branch argument is now a no-op

", - "date": "2022-07-01", - "criticality": "breaking", - "owner": "jhunschejones" - } - ], - "2021-10-01": [ - { - "location": "ReactionGroup.users", - "description": "

users will be removed. Use the reactors field instead.

", - "reason": "

Reactors can now be mannequins, bots, and organizations.

", - "date": "2021-10-01", - "criticality": "breaking", - "owner": "synthead" - } - ], - "2021-06-21": [ - { - "location": "PackageType.DOCKER", - "description": "

DOCKER will be removed.

", - "reason": "

DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", - "date": "2021-06-21", - "criticality": "breaking", - "owner": "reybard" - } - ], - "2021-01-01": [ - { - "location": "MergeStateStatus.DRAFT", - "description": "

DRAFT will be removed. Use PullRequest.isDraft instead.

", - "reason": "

DRAFT state will be removed from this enum and isDraft should be used instead

", - "date": "2021-01-01", - "criticality": "breaking", - "owner": "nplasterer" - } - ], - "2020-10-01": [ - { - "location": "PullRequest.timeline", - "description": "

timeline will be removed. Use PullRequest.timelineItems instead.

", - "reason": "

timeline will be removed

", - "date": "2020-10-01", - "criticality": "breaking", - "owner": "mikesea" - }, - { - "location": "Issue.timeline", - "description": "

timeline will be removed. Use Issue.timelineItems instead.

", - "reason": "

timeline will be removed

", - "date": "2020-10-01", - "criticality": "breaking", - "owner": "mikesea" - } - ], - "2020-01-01": [ - { - "location": "UnassignedEvent.user", - "description": "

user will be removed. Use the assignee field instead.

", - "reason": "

Assignees can now be mannequins.

", - "date": "2020-01-01", - "criticality": "breaking", - "owner": "tambling" - }, - { - "location": "AssignedEvent.user", - "description": "

user will be removed. Use the assignee field instead.

", - "reason": "

Assignees can now be mannequins.

", - "date": "2020-01-01", - "criticality": "breaking", - "owner": "tambling" - } - ], - "2019-04-01": [ - { - "location": "LegacyMigration.uploadUrlTemplate", - "description": "

uploadUrlTemplate will be removed. Use uploadUrl instead.

", - "reason": "

uploadUrlTemplate is being removed because it is not a standard URL and adds an extra user step.

", - "date": "2019-04-01", - "criticality": "breaking", - "owner": "tambling" - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/actions.json b/src/rest/data/ghes-3.14-2022-11-28/actions.json deleted file mode 100644 index fc71615f4b80..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/actions.json +++ /dev/null @@ -1,37161 +0,0 @@ -{ - "artifacts": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts", - "title": "List artifacts for a repository", - "category": "actions", - "subcategory": "artifacts", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "name", - "description": "

The name field of an artifact. When specified, only artifacts with this name will be returned.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all artifacts for a repository.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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", - "workflow_run": { - "id": 2332938, - "repository_id": 1296269, - "head_repository_id": 1296269, - "head_branch": "main", - "head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3" - } - }, - { - "id": 13, - "node_id": "MDg6QXJ0aWZhY3QxMw==", - "name": "Test output", - "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", - "workflow_run": { - "id": 2332942, - "repository_id": 1296269, - "head_repository_id": 1296269, - "head_branch": "main", - "head_sha": "178f4f6090b3fccad4a65b3e83d076a622d59652" - } - } - ] - }, - "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" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the artifact.", - "type": "string" - }, - "size_in_bytes": { - "description": "The size in bytes of the artifact.", - "type": "integer" - }, - "url": { - "type": "string" - }, - "archive_download_url": { - "type": "string" - }, - "expired": { - "description": "Whether or not the artifact has expired.", - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "workflow_run": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - }, - "repository_id": { - "type": "integer" - }, - "head_repository_id": { - "type": "integer" - }, - "head_branch": { - "type": "string" - }, - "head_sha": { - "type": "string" - } - } - } - }, - "required": [ - "id", - "node_id", - "name", - "size_in_bytes", - "url", - "archive_download_url", - "expired", - "created_at", - "expires_at", - "updated_at" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - "title": "Get an artifact", - "category": "actions", - "subcategory": "artifacts", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "artifact_id", - "description": "

The unique identifier of the artifact.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific artifact for a workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "artifact_id": "ARTIFACT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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", - "workflow_run": { - "id": 2332938, - "repository_id": 1296269, - "head_repository_id": 1296269, - "head_branch": "main", - "head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3" - } - }, - "schema": { - "title": "Artifact", - "description": "An artifact", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the artifact.", - "type": "string" - }, - "size_in_bytes": { - "description": "The size in bytes of the artifact.", - "type": "integer" - }, - "url": { - "type": "string" - }, - "archive_download_url": { - "type": "string" - }, - "expired": { - "description": "Whether or not the artifact has expired.", - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "workflow_run": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - }, - "repository_id": { - "type": "integer" - }, - "head_repository_id": { - "type": "integer" - }, - "head_branch": { - "type": "string" - }, - "head_sha": { - "type": "string" - } - } - } - }, - "required": [ - "id", - "node_id", - "name", - "size_in_bytes", - "url", - "archive_download_url", - "expired", - "created_at", - "expires_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - "title": "Delete an artifact", - "category": "actions", - "subcategory": "artifacts", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "artifact_id", - "description": "

The unique identifier of the artifact.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "artifact_id": "ARTIFACT_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", - "title": "Download an artifact", - "category": "actions", - "subcategory": "artifacts", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "artifact_id", - "description": "

The unique identifier of the artifact.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "archive_format", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "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.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "artifact_id": "ARTIFACT_ID", - "archive_format": "ARCHIVE_FORMAT" - } - }, - "response": { - "statusCode": "302", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "302", - "description": "

Found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", - "title": "List workflow run artifacts", - "category": "actions", - "subcategory": "artifacts", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "name", - "description": "

The name field of an artifact. When specified, only artifacts with this name will be returned.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists artifacts for a workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "run_id": "RUN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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", - "workflow_run": { - "id": 2332938, - "repository_id": 1296269, - "head_repository_id": 1296269, - "head_branch": "main", - "head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3" - } - }, - { - "id": 13, - "node_id": "MDg6QXJ0aWZhY3QxMw==", - "name": "Test output", - "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", - "workflow_run": { - "id": 2332942, - "repository_id": 1296269, - "head_repository_id": 1296269, - "head_branch": "main", - "head_sha": "178f4f6090b3fccad4a65b3e83d076a622d59652" - } - } - ] - }, - "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" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the artifact.", - "type": "string" - }, - "size_in_bytes": { - "description": "The size in bytes of the artifact.", - "type": "integer" - }, - "url": { - "type": "string" - }, - "archive_download_url": { - "type": "string" - }, - "expired": { - "description": "Whether or not the artifact has expired.", - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "workflow_run": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - }, - "repository_id": { - "type": "integer" - }, - "head_repository_id": { - "type": "integer" - }, - "head_branch": { - "type": "string" - }, - "head_sha": { - "type": "string" - } - } - } - }, - "required": [ - "id", - "node_id", - "name", - "size_in_bytes", - "url", - "archive_download_url", - "expired", - "created_at", - "expires_at", - "updated_at" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ], - "cache": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/cache/usage", - "title": "Get GitHub Actions cache usage for an enterprise", - "category": "actions", - "subcategory": "cache", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the total GitHub Actions cache usage for an enterprise.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

\n

OAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_active_caches_size_in_bytes": 3344284, - "total_active_caches_count": 5 - }, - "schema": { - "type": "object", - "properties": { - "total_active_caches_count": { - "type": "integer", - "description": "The count of active caches across all repositories of an enterprise or an organization." - }, - "total_active_caches_size_in_bytes": { - "type": "integer", - "description": "The total size in bytes of all active cache items across all repositories of an enterprise or an organization." - } - }, - "required": [ - "total_active_caches_count", - "total_active_caches_size_in_bytes" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise administration\" enterprise permissions": "write" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/cache/usage-policy", - "title": "Get GitHub Actions cache usage policy for an enterprise", - "category": "actions", - "subcategory": "cache", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the GitHub Actions cache usage policy for an enterprise.

\n

OAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "repo_cache_size_limit_in_gb": 10, - "max_repo_cache_size_limit_in_gb": 15 - }, - "schema": { - "title": "Actions cache usage policy for an enterprise", - "description": "GitHub Actions cache usage policy for an enterprise.", - "type": "object", - "properties": { - "repo_cache_size_limit_in_gb": { - "description": "For repositories in an enterprise, the default size limit for the sum of all caches in a repository, in gigabytes.", - "type": "integer" - }, - "max_repo_cache_size_limit_in_gb": { - "description": "For repositories in an enterprise, the maximum value that can be set as the limit for the sum of all caches in a repository, in gigabytes.", - "type": "integer" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise administration\" enterprise permissions": "write" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/enterprises/{enterprise}/actions/cache/usage-policy", - "title": "Set GitHub Actions cache usage policy for an enterprise", - "category": "actions", - "subcategory": "cache", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "integer", - "name": "repo_cache_size_limit_in_gb", - "description": "

For repositories in an enterprise, the default size limit for the sum of all caches in a repository, in gigabytes.

" - }, - { - "type": "integer", - "name": "max_repo_cache_size_limit_in_gb", - "description": "

For repositories in an enterprise, the maximum value that can be set as the limit for the sum of all caches in a repository, in gigabytes.

" - } - ], - "descriptionHTML": "

Sets the GitHub Actions cache usage policy for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "repo_cache_size_limit_in_gb": 10, - "max_repo_cache_size_limit_in_gb": 15 - }, - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise administration\" enterprise permissions": "write" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/cache/usage", - "title": "Get GitHub Actions cache usage for an organization", - "category": "actions", - "subcategory": "cache", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

\n

OAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_active_caches_size_in_bytes": 3344284, - "total_active_caches_count": 5 - }, - "schema": { - "type": "object", - "properties": { - "total_active_caches_count": { - "type": "integer", - "description": "The count of active caches across all repositories of an enterprise or an organization." - }, - "total_active_caches_size_in_bytes": { - "type": "integer", - "description": "The total size in bytes of all active cache items across all repositories of an enterprise or an organization." - } - }, - "required": [ - "total_active_caches_count", - "total_active_caches_size_in_bytes" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/cache/usage-by-repository", - "title": "List repositories with GitHub Actions cache usage for an organization", - "category": "actions", - "subcategory": "cache", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

\n

OAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 2, - "repository_cache_usages": [ - { - "full_name": "octo-org/Hello-World", - "active_caches_size_in_bytes": 2322142, - "active_caches_count": 3 - }, - { - "full_name": "octo-org/server", - "active_caches_size_in_bytes": 1022142, - "active_caches_count": 2 - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "repository_cache_usages" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "repository_cache_usages": { - "type": "array", - "items": { - "title": "Actions Cache Usage by repository", - "description": "GitHub Actions Cache Usage by repository.", - "type": "object", - "properties": { - "full_name": { - "description": "The repository owner and name for the cache usage being shown.", - "type": "string" - }, - "active_caches_size_in_bytes": { - "description": "The sum of the size in bytes of all the active cache items in the repository.", - "type": "integer" - }, - "active_caches_count": { - "description": "The number of active caches in the repository.", - "type": "integer" - } - }, - "required": [ - "full_name", - "active_caches_size_in_bytes", - "active_caches_count" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/cache/usage", - "title": "Get GitHub Actions cache usage for a repository", - "category": "actions", - "subcategory": "cache", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "full_name": "octo-org/Hello-World", - "active_caches_size_in_bytes": 2322142, - "active_caches_count": 3 - }, - "schema": { - "title": "Actions Cache Usage by repository", - "description": "GitHub Actions Cache Usage by repository.", - "type": "object", - "properties": { - "full_name": { - "description": "The repository owner and name for the cache usage being shown.", - "type": "string" - }, - "active_caches_size_in_bytes": { - "description": "The sum of the size in bytes of all the active cache items in the repository.", - "type": "integer" - }, - "active_caches_count": { - "description": "The number of active caches in the repository.", - "type": "integer" - } - }, - "required": [ - "full_name", - "active_caches_size_in_bytes", - "active_caches_count" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/cache/usage-policy", - "title": "Get GitHub Actions cache usage policy for a repository", - "category": "actions", - "subcategory": "cache", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets GitHub Actions cache usage policy for a repository.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "repo_cache_size_limit_in_gb": 14 - }, - "schema": { - "title": "Actions cache usage policy for repository", - "description": "GitHub Actions cache usage policy for repository.", - "type": "object", - "properties": { - "repo_cache_size_limit_in_gb": { - "description": "The size limit for the sum of all caches, in gigabytes.", - "type": "integer" - } - }, - "required": [ - "repo_cache_size_limit_in_gb" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/actions/cache/usage-policy", - "title": "Set GitHub Actions cache usage policy for a repository", - "category": "actions", - "subcategory": "cache", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "integer", - "name": "repo_cache_size_limit_in_gb", - "description": "

The size limit for the sum of all caches, in gigabytes.

", - "isRequired": true - } - ], - "descriptionHTML": "

Sets GitHub Actions cache usage policy for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "repo_cache_size_limit_in_gb": 14 - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/caches", - "title": "List GitHub Actions caches for a repository", - "category": "actions", - "subcategory": "cache", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "ref", - "description": "

The full Git reference for narrowing down the cache. The ref for a branch should be formatted as refs/heads/<branch name>. To reference a pull request use refs/pull/<number>/merge.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "key", - "description": "

An explicit key or prefix for identifying the cache

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "

The property to sort the results by. created_at means when the cache was created. last_accessed_at means when the cache was last accessed. size_in_bytes is the size of the cache in bytes.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created_at", - "last_accessed_at", - "size_in_bytes" - ], - "default": "last_accessed_at" - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the GitHub Actions caches for a repository.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 1, - "actions_caches": [ - { - "id": 505, - "ref": "refs/heads/main", - "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", - "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0", - "last_accessed_at": "2019-01-24T22:45:36.000Z", - "created_at": "2019-01-24T22:45:36.000Z", - "size_in_bytes": 1024 - } - ] - }, - "schema": { - "title": "Repository actions caches", - "description": "Repository actions caches", - "type": "object", - "properties": { - "total_count": { - "description": "Total number of caches", - "type": "integer" - }, - "actions_caches": { - "description": "Array of caches", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "ref": { - "type": "string" - }, - "key": { - "type": "string" - }, - "version": { - "type": "string" - }, - "last_accessed_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "size_in_bytes": { - "type": "integer" - } - } - } - } - }, - "required": [ - "total_count", - "actions_caches" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/caches", - "title": "Delete GitHub Actions caches for a repository (using a cache key)", - "category": "actions", - "subcategory": "cache", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "key", - "description": "

A key for identifying the cache.

", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "description": "

The full Git reference for narrowing down the cache. The ref for a branch should be formatted as refs/heads/<branch name>. To reference a pull request use refs/pull/<number>/merge.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 1, - "actions_caches": [ - { - "id": 505, - "ref": "refs/heads/main", - "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", - "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0", - "last_accessed_at": "2019-01-24T22:45:36.000Z", - "created_at": "2019-01-24T22:45:36.000Z", - "size_in_bytes": 1024 - } - ] - }, - "schema": { - "title": "Repository actions caches", - "description": "Repository actions caches", - "type": "object", - "properties": { - "total_count": { - "description": "Total number of caches", - "type": "integer" - }, - "actions_caches": { - "description": "Array of caches", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "ref": { - "type": "string" - }, - "key": { - "type": "string" - }, - "version": { - "type": "string" - }, - "last_accessed_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "size_in_bytes": { - "type": "integer" - } - } - } - } - }, - "required": [ - "total_count", - "actions_caches" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/caches/{cache_id}", - "title": "Delete a GitHub Actions cache for a repository (using a cache ID)", - "category": "actions", - "subcategory": "cache", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cache_id", - "description": "

The unique identifier of the GitHub Actions cache.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a GitHub Actions cache for a repository, using a cache ID.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "cache_id": "CACHE_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "write" - } - ] - } - } - ], - "oidc": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/oidc/customization/sub", - "title": "Get the customization template for an OIDC subject claim for an organization", - "category": "actions", - "subcategory": "oidc", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the customization template for an OpenID Connect (OIDC) subject claim.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

A JSON serialized template for OIDC subject claim customization

", - "example": { - "include_claim_keys": [ - "repo", - "context" - ] - }, - "schema": { - "title": "Actions OIDC Subject customization", - "description": "Actions OIDC Subject customization", - "type": "object", - "properties": { - "include_claim_keys": { - "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "include_claim_keys" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

A JSON serialized template for OIDC subject claim customization

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/actions/oidc/customization/sub", - "title": "Set the customization template for an OIDC subject claim for an organization", - "category": "actions", - "subcategory": "oidc", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "include_claim_keys", - "description": "

Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

" - } - ], - "descriptionHTML": "

Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "include_claim_keys": [ - "repo", - "context" - ] - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Empty response

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Empty response

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/oidc/customization/sub", - "title": "Get the customization template for an OIDC subject claim for a repository", - "category": "actions", - "subcategory": "oidc", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the customization template for an OpenID Connect (OIDC) subject claim.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Status response

", - "example": { - "use_default": false, - "include_claim_keys": [ - "repo", - "context" - ] - }, - "schema": { - "title": "Actions OIDC subject customization for a repository", - "description": "Actions OIDC subject customization for a repository", - "type": "object", - "properties": { - "use_default": { - "description": "Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.", - "type": "boolean" - }, - "include_claim_keys": { - "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "use_default" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Status response

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/oidc/customization/sub", - "title": "Set the customization template for an OIDC subject claim for a repository", - "category": "actions", - "subcategory": "oidc", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "use_default", - "description": "

Whether to use the default template or not. If true, the include_claim_keys field is ignored.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "include_claim_keys", - "description": "

Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

" - } - ], - "descriptionHTML": "

Sets the customization template and opt-in or opt-out flag for an OpenID Connect (OIDC) subject claim for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "use_default": false, - "include_claim_keys": [ - "repo", - "context" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Empty response

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Empty response

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "write" - } - ] - } - } - ], - "permissions": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/permissions", - "title": "Get GitHub Actions permissions for an enterprise", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "enabled_organizations": "all", - "allowed_actions": "selected", - "selected_actions_url": "https://api.github.com/enterprises/2/actions/permissions/selected-actions" - }, - "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.", - "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.", - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/enterprises/{enterprise}/actions/permissions", - "title": "Set GitHub Actions permissions for an enterprise", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "enabled_organizations", - "description": "

The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.

", - "isRequired": true, - "enum": [ - "all", - "none", - "selected" - ] - }, - { - "type": "string", - "name": "allowed_actions", - "description": "

The permissions policy that controls the actions that are allowed to run.

", - "enum": [ - "all", - "local_only", - "selected" - ] - } - ], - "descriptionHTML": "

Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "enabled_organizations": "all", - "allowed_actions": "selected" - }, - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations", - "title": "List selected organizations enabled for GitHub Actions in an enterprise", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "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

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - } - ] - }, - "schema": { - "type": "object", - "properties": { - "total_count": { - "type": "number" - }, - "organizations": { - "type": "array", - "items": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - } - } - }, - "required": [ - "total_count", - "organizations" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations", - "title": "Set selected organizations enabled for GitHub Actions in an enterprise", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of integers", - "name": "selected_organization_ids", - "description": "

List of organization IDs to enable for GitHub Actions.

", - "isRequired": true - } - ], - "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

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "selected_organization_ids": [ - 32, - 91 - ] - }, - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - "title": "Enable a selected organization for GitHub Actions in an enterprise", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org_id", - "description": "

The unique identifier of the organization.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "org_id": "ORG_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - "title": "Disable a selected organization for GitHub Actions in an enterprise", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org_id", - "description": "

The unique identifier of the organization.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "org_id": "ORG_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions", - "title": "Get allowed actions for an enterprise", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "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

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] - }, - "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 from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators using GitHub Connect." - }, - "patterns_allowed": { - "type": "array", - "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\n\n> [!NOTE]\n> The `patterns_allowed` setting only applies to public repositories.", - "items": { - "type": "string" - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions", - "title": "Set allowed actions for an enterprise", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "github_owned_allowed", - "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

" - }, - { - "type": "boolean", - "name": "verified_allowed", - "description": "

Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators using GitHub Connect.

" - }, - { - "type": "array of strings", - "name": "patterns_allowed", - "description": "

Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.

\n

Note

\n

\nThe patterns_allowed setting only applies to public repositories.

\n
" - } - ], - "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

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] - }, - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/permissions/workflow", - "title": "Get default workflow permissions for an enterprise", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Give read-only permission, and allow approving PRs.

", - "example": { - "default_workflow_permissions": "read", - "can_approve_pull_request_reviews": true - }, - "schema": { - "type": "object", - "properties": { - "default_workflow_permissions": { - "type": "string", - "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "enum": [ - "read", - "write" - ] - }, - "can_approve_pull_request_reviews": { - "type": "boolean", - "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." - } - }, - "required": [ - "default_workflow_permissions", - "can_approve_pull_request_reviews" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Success response

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/enterprises/{enterprise}/actions/permissions/workflow", - "title": "Set default workflow permissions for an enterprise", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "default_workflow_permissions", - "description": "

The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "boolean", - "name": "can_approve_pull_request_reviews", - "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

" - } - ], - "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Give read-only permission, and allow approving PRs.", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "default_workflow_permissions": "read", - "can_approve_pull_request_reviews": true - }, - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "204", - "description": "

Success response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Success response

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions", - "title": "Get GitHub Actions permissions for an organization", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "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.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "enabled_repositories": "all", - "allowed_actions": "selected", - "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" - }, - "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.", - "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.", - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions", - "title": "Set GitHub Actions permissions for an organization", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "enabled_repositories", - "description": "

The policy that controls the repositories in the organization that are allowed to run GitHub Actions.

", - "isRequired": true, - "enum": [ - "all", - "none", - "selected" - ] - }, - { - "type": "string", - "name": "allowed_actions", - "description": "

The permissions policy that controls the actions that are allowed to run.

", - "enum": [ - "all", - "local_only", - "selected" - ] - } - ], - "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

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "enabled_repositories": "all", - "allowed_actions": "selected" - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/repositories", - "title": "List selected repositories enabled for GitHub Actions in an organization", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "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

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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, - "allow_auto_merge": false, - "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 - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "repositories" - ], - "properties": { - "total_count": { - "type": "number" - }, - "repositories": { - "type": "array", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories", - "title": "Set selected repositories enabled for GitHub Actions in an organization", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of integers", - "name": "selected_repository_ids", - "description": "

List of repository IDs to enable for GitHub Actions.

", - "isRequired": true - } - ], - "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

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "selected_repository_ids": [ - 32, - 42 - ] - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "title": "Enable a selected repository for GitHub Actions in an organization", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "description": "

The unique identifier of the repository.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "repository_id": "REPOSITORY_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write", - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "title": "Disable a selected repository for GitHub Actions in an organization", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "description": "

The unique identifier of the repository.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "repository_id": "REPOSITORY_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write", - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/selected-actions", - "title": "Get allowed actions for an organization", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "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.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] - }, - "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 from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators using GitHub Connect." - }, - "patterns_allowed": { - "type": "array", - "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\n\n> [!NOTE]\n> The `patterns_allowed` setting only applies to public repositories.", - "items": { - "type": "string" - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/selected-actions", - "title": "Set allowed actions for an organization", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "github_owned_allowed", - "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

" - }, - { - "type": "boolean", - "name": "verified_allowed", - "description": "

Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators using GitHub Connect.

" - }, - { - "type": "array of strings", - "name": "patterns_allowed", - "description": "

Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.

\n

Note

\n

\nThe patterns_allowed setting only applies to public repositories.

\n
" - } - ], - "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

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/permissions/workflow", - "title": "Get default workflow permissions for an organization", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Give read-only permission, and allow approving PRs.

", - "example": { - "default_workflow_permissions": "read", - "can_approve_pull_request_reviews": true - }, - "schema": { - "type": "object", - "properties": { - "default_workflow_permissions": { - "type": "string", - "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "enum": [ - "read", - "write" - ] - }, - "can_approve_pull_request_reviews": { - "type": "boolean", - "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." - } - }, - "required": [ - "default_workflow_permissions", - "can_approve_pull_request_reviews" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/workflow", - "title": "Set default workflow permissions for an organization", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "default_workflow_permissions", - "description": "

The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "boolean", - "name": "can_approve_pull_request_reviews", - "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

" - } - ], - "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Give read-only permission, and allow approving PRs.", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "default_workflow_permissions": "read", - "can_approve_pull_request_reviews": true - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "204", - "description": "

Success response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Success response

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict response when changing a setting is prevented by the owning enterprise

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions", - "title": "Get GitHub Actions permissions for a repository", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "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 endpoint. GitHub Apps must have the administration repository permission to use this API.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "enabled": true, - "allowed_actions": "selected", - "selected_actions_url": "https://api.github.com/repositories/42/actions/permissions/selected-actions" - }, - "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.", - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions", - "title": "Set GitHub Actions permissions for a repository", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "enabled", - "description": "

Whether GitHub Actions is enabled on the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "allowed_actions", - "description": "

The permissions policy that controls the actions that are allowed to run.

", - "enum": [ - "all", - "local_only", - "selected" - ] - } - ], - "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

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "enabled": true, - "allowed_actions": "selected" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/access", - "title": "Get the level of access for workflows outside of the repository", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "access_level": "organization" - }, - "schema": { - "type": "object", - "properties": { - "access_level": { - "type": "string", - "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise.", - "enum": [ - "none", - "user", - "organization", - "enterprise" - ] - } - }, - "required": [ - "access_level" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/access", - "title": "Set the level of access for workflows outside of the repository", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "access_level", - "description": "

Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.

\n

none means the access is only possible from workflows in this repository. user level access allows sharing across user owned private repositories only. organization level access allows sharing across the organization. enterprise level access allows sharing across the enterprise.

", - "isRequired": true, - "enum": [ - "none", - "user", - "organization", - "enterprise" - ] - } - ], - "descriptionHTML": "

Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "access_level": "organization" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions", - "title": "Get allowed actions for a repository", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "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.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] - }, - "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 from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators using GitHub Connect." - }, - "patterns_allowed": { - "type": "array", - "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\n\n> [!NOTE]\n> The `patterns_allowed` setting only applies to public repositories.", - "items": { - "type": "string" - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions", - "title": "Set allowed actions for a repository", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "github_owned_allowed", - "description": "

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

" - }, - { - "type": "boolean", - "name": "verified_allowed", - "description": "

Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators using GitHub Connect.

" - }, - { - "type": "array of strings", - "name": "patterns_allowed", - "description": "

Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.

\n

Note

\n

\nThe patterns_allowed setting only applies to public repositories.

\n
" - } - ], - "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

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow", - "title": "Get default workflow permissions for a repository", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Give read-only permission, and allow approving PRs.

", - "example": { - "default_workflow_permissions": "read", - "can_approve_pull_request_reviews": true - }, - "schema": { - "type": "object", - "properties": { - "default_workflow_permissions": { - "type": "string", - "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "enum": [ - "read", - "write" - ] - }, - "can_approve_pull_request_reviews": { - "type": "boolean", - "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." - } - }, - "required": [ - "default_workflow_permissions", - "can_approve_pull_request_reviews" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow", - "title": "Set default workflow permissions for a repository", - "category": "actions", - "subcategory": "permissions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "default_workflow_permissions", - "description": "

The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "boolean", - "name": "can_approve_pull_request_reviews", - "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

" - } - ], - "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Give read-only permission, and allow approving PRs.", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "default_workflow_permissions": "read", - "can_approve_pull_request_reviews": true - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Success response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Success response

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict response when changing a setting is prevented by the owning organization or enterprise

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - } - ], - "secrets": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets", - "title": "List organization secrets", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "title": "Actions Secret for an Organization", - "description": "Secrets for GitHub Actions for an organization.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/public-key", - "title": "Get an organization public key", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - }, - "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" - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string" - }, - "id": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "created_at": { - "type": "string" - } - }, - "required": [ - "key_id", - "key" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", - "title": "Get an organization secret", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a single organization secret without revealing its encrypted value.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - }, - "schema": { - "title": "Actions Secret for an Organization", - "description": "Secrets for GitHub Actions for an organization.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", - "title": "Create or update an organization secret", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

", - "isRequired": true - }, - { - "type": "string", - "name": "key_id", - "description": "

ID of the key you used to encrypt the secret.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.

", - "isRequired": true, - "enum": [ - "all", - "private", - "selected" - ] - }, - { - "type": "array of integers", - "name": "selected_repository_ids", - "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.

" - } - ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example 1: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - }, - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response when creating a secret

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 204", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - }, - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response when updating a secret

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Response when creating a secret

" - }, - { - "httpStatusCode": "204", - "description": "

Response when updating a secret

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", - "title": "Delete an organization secret", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a secret in an organization using the secret name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", - "title": "List selected repositories for an organization secret", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "repositories" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "repositories": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", - "title": "Set selected repositories for an organization secret", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of integers", - "name": "selected_repository_ids", - "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 Add selected repository to an organization secret and Remove selected repository from an organization secret endpoints.

", - "isRequired": true - } - ], - "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "selected_repository_ids": [ - 64780797 - ] - }, - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "title": "Add selected repository to an organization secret", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. For more information about setting the visibility, see Create or\nupdate an organization secret.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME", - "repository_id": "REPOSITORY_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

No Content when repository was added to the selected list

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content when repository was added to the selected list

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict when visibility type is not set to selected

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" organization permissions": "write", - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "title": "Remove selected repository from an organization secret", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME", - "repository_id": "REPOSITORY_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response when repository was removed from the selected list

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Response when repository was removed from the selected list

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict when visibility type not set to selected

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" organization permissions": "write", - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/organization-secrets", - "title": "List repository organization secrets", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - } - ] - }, - "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.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "created_at", - "updated_at" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets", - "title": "List repository secrets", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all secrets available in a repository without revealing their encrypted\nvalues.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - } - ] - }, - "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.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "created_at", - "updated_at" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/public-key", - "title": "Get a repository public key", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - }, - "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" - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string" - }, - "id": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "created_at": { - "type": "string" - } - }, - "required": [ - "key_id", - "key" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "title": "Get a repository secret", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a single repository secret without revealing its encrypted value.

\n

The authenticated user must have collaborator access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - }, - "schema": { - "title": "Actions Secret", - "description": "Set secrets for GitHub Actions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "title": "Create or update a repository secret", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

", - "isRequired": true - }, - { - "type": "string", - "name": "key_id", - "description": "

ID of the key you used to encrypt the secret.

", - "isRequired": true - } - ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example 1: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response when creating a secret

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 204", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response when updating a secret

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Response when creating a secret

" - }, - { - "httpStatusCode": "204", - "description": "

Response when updating a secret

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "title": "Delete a repository secret", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a secret in a repository using the secret name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secrets\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets", - "title": "List environment secrets", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all secrets available in an environment without revealing their\nencrypted values.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - } - ] - }, - "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.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "created_at", - "updated_at" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Environments\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key", - "title": "Get an environment public key", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - }, - "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" - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string" - }, - "id": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "created_at": { - "type": "string" - } - }, - "required": [ - "key_id", - "key" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Environments\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", - "title": "Get an environment secret", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a single environment secret without revealing its encrypted value.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - }, - "schema": { - "title": "Actions Secret", - "description": "Set secrets for GitHub Actions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Environments\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", - "title": "Create or update an environment secret", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

", - "isRequired": true - }, - { - "type": "string", - "name": "key_id", - "description": "

ID of the key you used to encrypt the secret.

", - "isRequired": true - } - ], - "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example 1: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response when creating a secret

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 204", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response when updating a secret

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Response when creating a secret

" - }, - { - "httpStatusCode": "204", - "description": "

Response when updating a secret

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Environments\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", - "title": "Delete an environment secret", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a secret in an environment using the secret name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Default response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Default response

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Environments\" repository permissions": "write" - } - ] - } - } - ], - "self-hosted-runner-groups": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups", - "title": "List self-hosted runner groups for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "visible_to_organization", - "description": "

Only return runner groups that are allowed to be used by this organization.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all self-hosted runner groups for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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, - "restricted_to_workflows": false, - "selected_workflows": [], - "workflow_restrictions_read_only": 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, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false - }, - { - "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, - "restricted_to_workflows": false, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false - } - ] - }, - "schema": { - "type": "object", - "properties": { - "total_count": { - "type": "number" - }, - "runner_groups": { - "type": "array", - "items": { - "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" - }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false - }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required." - } - } - }, - "required": [ - "id", - "name", - "visibility", - "allows_public_repositories", - "default", - "runners_url" - ] - } - } - }, - "required": [ - "total_count", - "runner_groups" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups", - "title": "Create a self-hosted runner group for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

Name of the runner group.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

Visibility of a runner group. You can select all organizations or select individual organization.

", - "enum": [ - "selected", - "all" - ] - }, - { - "type": "array of integers", - "name": "selected_organization_ids", - "description": "

List of organization IDs that can access the runner group.

" - }, - { - "type": "array of integers", - "name": "runners", - "description": "

List of runner IDs to add to the runner group.

" - }, - { - "type": "boolean", - "name": "allows_public_repositories", - "description": "

Whether the runner group can be used by public repositories.

", - "default": false - }, - { - "type": "boolean", - "name": "restricted_to_workflows", - "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", - "default": false - }, - { - "type": "array of strings", - "name": "selected_workflows", - "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

" - } - ], - "descriptionHTML": "

Creates a new self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Expensive hardware runners", - "visibility": "selected", - "selected_organization_ids": [ - 32, - 91 - ], - "runners": [ - 9, - 2 - ] - }, - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false - }, - "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" - }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false - }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required." - } - } - }, - "required": [ - "id", - "name", - "visibility", - "allows_public_repositories", - "default", - "runners_url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", - "title": "Get a self-hosted runner group for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false - }, - "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" - }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false - }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required." - } - } - }, - "required": [ - "id", - "name", - "visibility", - "allows_public_repositories", - "default", - "runners_url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", - "title": "Update a self-hosted runner group for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

Name of the runner group.

" - }, - { - "type": "string", - "name": "visibility", - "description": "

Visibility of a runner group. You can select all organizations or select individual organizations.

", - "enum": [ - "selected", - "all" - ], - "default": "all" - }, - { - "type": "boolean", - "name": "allows_public_repositories", - "description": "

Whether the runner group can be used by public repositories.

", - "default": false - }, - { - "type": "boolean", - "name": "restricted_to_workflows", - "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", - "default": false - }, - { - "type": "array of strings", - "name": "selected_workflows", - "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

" - } - ], - "descriptionHTML": "

Updates the name and visibility of a self-hosted runner group in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Expensive hardware runners", - "visibility": "selected" - }, - "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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, - "restricted_to_workflows": false, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false - }, - "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" - }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false - }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required." - } - } - }, - "required": [ - "id", - "name", - "visibility", - "allows_public_repositories", - "default", - "runners_url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", - "title": "Delete a self-hosted runner group from an enterprise", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", - "title": "List organization access to a self-hosted runner group in an enterprise", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the organizations with access to a self-hosted runner group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - } - ] - }, - "schema": { - "type": "object", - "properties": { - "total_count": { - "type": "number" - }, - "organizations": { - "type": "array", - "items": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - } - } - }, - "required": [ - "total_count", - "organizations" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", - "title": "Set organization access for a self-hosted runner group in an enterprise", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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" - } - } - ], - "bodyParameters": [ - { - "type": "array of integers", - "name": "selected_organization_ids", - "description": "

List of organization IDs that can access the runner group.

", - "isRequired": true - } - ], - "descriptionHTML": "

Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "selected_organization_ids": [ - 32, - 91 - ] - }, - "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}", - "title": "Add organization access to a self-hosted runner group in an enterprise", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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": "org_id", - "description": "

The unique identifier of the organization.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID", - "org_id": "ORG_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}", - "title": "Remove organization access to a self-hosted runner group in an enterprise", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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": "org_id", - "description": "

The unique identifier of the organization.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID", - "org_id": "ORG_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", - "title": "List self-hosted runners in a group for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the self-hosted runners that are in a specific enterprise group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 2, - "runners": [ - { - "id": 23, - "name": "linux_runner", - "os": "linux", - "status": "online", - "busy": true, - "ephemeral": false, - "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, - "ephemeral": 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" - } - ] - } - ] - }, - "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" - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer" - }, - "name": { - "description": "The name of the runner.", - "type": "string" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string" - }, - "status": { - "description": "The status of the runner.", - "type": "string" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] - } - } - }, - "required": [ - "total_count", - "runners" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", - "title": "Set self-hosted runners in a group for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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" - } - } - ], - "bodyParameters": [ - { - "type": "array of integers", - "name": "runners", - "description": "

List of runner IDs to add to the runner group.

", - "isRequired": true - } - ], - "descriptionHTML": "

Replaces the list of self-hosted runners that are part of an enterprise runner group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "runners": [ - 9, - 2 - ] - }, - "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "title": "Add a self-hosted runner to a group for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Adds a self-hosted runner to a runner group configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "title": "Remove a self-hosted runner from a group for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "runner_group_id": "RUNNER_GROUP_ID", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups", - "title": "List self-hosted runner groups for an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "visible_to_repository", - "description": "

Only return runner groups that are allowed to be used by this repository.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 3, - "runner_groups": [ - { - "id": 1, - "name": "Default", - "visibility": "all", - "default": true, - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": false, - "selected_workflows": [], - "workflow_restrictions_read_only": false - }, - { - "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": true, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": true - }, - { - "id": 3, - "name": "expensive-hardware", - "visibility": "private", - "default": false, - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": false, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "runner_groups" - ], - "properties": { - "total_count": { - "type": "number" - }, - "runner_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "number" - }, - "name": { - "type": "string" - }, - "visibility": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" - }, - "runners_url": { - "type": "string" - }, - "inherited": { - "type": "boolean" - }, - "inherited_allows_public_repositories": { - "type": "boolean" - }, - "allows_public_repositories": { - "type": "boolean" - }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false - }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required." - } - } - }, - "required": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runner-groups", - "title": "Create a self-hosted runner group for an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

Name of the runner group.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

", - "enum": [ - "selected", - "all", - "private" - ], - "default": "all" - }, - { - "type": "array of integers", - "name": "selected_repository_ids", - "description": "

List of repository IDs that can access the runner group.

" - }, - { - "type": "array of integers", - "name": "runners", - "description": "

List of runner IDs to add to the runner group.

" - }, - { - "type": "boolean", - "name": "allows_public_repositories", - "description": "

Whether the runner group can be used by public repositories.

", - "default": false - }, - { - "type": "boolean", - "name": "restricted_to_workflows", - "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", - "default": false - }, - { - "type": "array of strings", - "name": "selected_workflows", - "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

" - } - ], - "descriptionHTML": "

Creates a new self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Expensive hardware runners", - "visibility": "selected", - "selected_repository_ids": [ - 32, - 91 - ], - "runners": [ - 9, - 2 - ] - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number" - }, - "name": { - "type": "string" - }, - "visibility": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" - }, - "runners_url": { - "type": "string" - }, - "inherited": { - "type": "boolean" - }, - "inherited_allows_public_repositories": { - "type": "boolean" - }, - "allows_public_repositories": { - "type": "boolean" - }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false - }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required." - } - } - }, - "required": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", - "title": "Get a self-hosted runner group for an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific self-hosted runner group for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number" - }, - "name": { - "type": "string" - }, - "visibility": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" - }, - "runners_url": { - "type": "string" - }, - "inherited": { - "type": "boolean" - }, - "inherited_allows_public_repositories": { - "type": "boolean" - }, - "allows_public_repositories": { - "type": "boolean" - }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false - }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required." - } - } - }, - "required": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", - "title": "Update a self-hosted runner group for an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

Name of the runner group.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

", - "enum": [ - "selected", - "all", - "private" - ] - }, - { - "type": "boolean", - "name": "allows_public_repositories", - "description": "

Whether the runner group can be used by public repositories.

", - "default": false - }, - { - "type": "boolean", - "name": "restricted_to_workflows", - "description": "

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

", - "default": false - }, - { - "type": "array of strings", - "name": "selected_workflows", - "description": "

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

" - } - ], - "descriptionHTML": "

Updates the name and visibility of a self-hosted runner group in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Expensive hardware runners", - "visibility": "selected" - }, - "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number" - }, - "name": { - "type": "string" - }, - "visibility": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" - }, - "runners_url": { - "type": "string" - }, - "inherited": { - "type": "boolean" - }, - "inherited_allows_public_repositories": { - "type": "boolean" - }, - "allows_public_repositories": { - "type": "boolean" - }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false - }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required." - } - } - }, - "required": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", - "title": "Delete a self-hosted runner group from an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", - "title": "List repository access to a self-hosted runner group in an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the repositories with access to a self-hosted runner group configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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 - }, - "template_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", - "organization": null, - "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, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "delete_branch_on_merge": 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==" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "repositories" - ], - "properties": { - "total_count": { - "type": "number" - }, - "repositories": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", - "title": "Set repository access for a self-hosted runner group in an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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" - } - } - ], - "bodyParameters": [ - { - "type": "array of integers", - "name": "selected_repository_ids", - "description": "

List of repository IDs that can access the runner group.

", - "isRequired": true - } - ], - "descriptionHTML": "

Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "selected_repository_ids": [ - 32, - 91 - ] - }, - "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "title": "Add repository access to a self-hosted runner group in an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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": "repository_id", - "description": "

The unique identifier of the repository.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID", - "repository_id": "REPOSITORY_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write", - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "title": "Remove repository access to a self-hosted runner group in an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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": "repository_id", - "description": "

The unique identifier of the repository.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID", - "repository_id": "REPOSITORY_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write", - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", - "title": "List self-hosted runners in a group for an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists self-hosted runners that are in a specific organization group.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 2, - "runners": [ - { - "id": 23, - "name": "linux_runner", - "os": "linux", - "status": "online", - "busy": true, - "ephemeral": false, - "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, - "ephemeral": 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" - } - ] - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "runners" - ], - "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" - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer" - }, - "name": { - "description": "The name of the runner.", - "type": "string" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string" - }, - "status": { - "description": "The status of the runner.", - "type": "string" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", - "title": "Set self-hosted runners in a group for an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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" - } - } - ], - "bodyParameters": [ - { - "type": "array of integers", - "name": "runners", - "description": "

List of runner IDs to add to the runner group.

", - "isRequired": true - } - ], - "descriptionHTML": "

Replaces the list of self-hosted runners that are part of an organization runner group.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "runners": [ - 9, - 2 - ] - }, - "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "title": "Add a self-hosted runner to a group for an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Adds a self-hosted runner to a runner group configured in an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", - "title": "Remove a self-hosted runner from a group for an organization", - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "runner_group_id": "RUNNER_GROUP_ID", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] - } - } - ], - "self-hosted-runners": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/runners", - "title": "List self-hosted runners for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "name", - "description": "

The name of a self-hosted runner.

", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all self-hosted runners configured for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 2, - "runners": [ - { - "id": 23, - "name": "linux_runner", - "os": "linux", - "status": "online", - "busy": true, - "ephemeral": false, - "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, - "ephemeral": 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" - } - ] - } - ] - }, - "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" - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer" - }, - "name": { - "description": "The name of the runner.", - "type": "string" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string" - }, - "status": { - "description": "The status of the runner.", - "type": "string" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/runners/downloads", - "title": "List runner applications for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "os": "osx", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-osx-x64-2.277.1.tar.gz", - "filename": "actions-runner-osx-x64-2.277.1.tar.gz", - "temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA", - "sha256_checksum": "f1fa173889dc9036cd529417e652e1729e5a3f4d35ec0151806d7480fda6b89b" - }, - { - "os": "linux", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-x64-2.277.1.tar.gz", - "filename": "actions-runner-linux-x64-2.277.1.tar.gz", - "temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA", - "sha256_checksum": "02d710fc9e0008e641274bb7da7fde61f7c9aa1cbb541a2990d3450cc88f4e98" - }, - { - "os": "linux", - "architecture": "arm", - "download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm-2.277.1.tar.gz", - "filename": "actions-runner-linux-arm-2.277.1.tar.gz", - "temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIyYTEzZDRmZC01ZDhkLTRjNzgtYjg2MS0zYTMxZGQ3MmYzNjQiLCJzaWQiOiI0MzZiNTg3YS04ODMyLTRiMTMtOWM2Ny05OWRkMjA2ZTQzNmMiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MzE1NzEsImV4cCI6MTYxNzkzNTc3MX0.PMhU7-MOnZRDj5k5a4ieeFlQCmKPl2pQvpVRhGZq-9ByKF5s9G0rsnGBxDcolTYlbvEAmSSkeAEwF486F7P0kMVEb-GI14WbErqqMSyaPL81c3W7UHxMJLaSBnDs9ftHMv_IkJmRzaROS8q1ObzUW-ErlltxCdj2zF_5ruK9G2RR566AOAtiA3AHV6k7-FCY5--sDYJN_YXPgpwI0fPN1TM92fdPm93hJnoXuCJNpBYp1vl5W4gwGtU_Pa07ESdqqFN1YJJHUloedNhiIOczGfGVSapRc8vyGm9P_VCM_yKD8JI-MkOXl8JI5fCfhmjmKsw-vSAh9NW67RGvmehmpw", - "sha256_checksum": "2f2bda21e2fd8fed6938b33182a293f6b1f74e4c5d09acd6d9a0fe3f979f5c85" - }, - { - "os": "win", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-win-x64-2.277.1.zip", - "filename": "actions-runner-win-x64-2.277.1.zip", - "temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA", - "sha256_checksum": "7215c75a462eeb6a839fa8ed298d79f620617d44d47d37c583114fc3f3b27b30" - }, - { - "os": "linux", - "architecture": "arm64", - "download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm64-2.277.1.tar.gz", - "filename": "actions-runner-linux-arm64-2.277.1.tar.gz", - "temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA", - "sha256_checksum": "a6aa6dd0ba217118ef2b4ea24e9e0a85b02b13c38052a5de0776d6ced3a79c64" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Runner Application", - "description": "Runner Application", - "type": "object", - "properties": { - "os": { - "type": "string" - }, - "architecture": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "filename": { - "type": "string" - }, - "temp_download_token": { - "description": "A short lived bearer token used to download the runner, if needed.", - "type": "string" - }, - "sha256_checksum": { - "type": "string" - } - }, - "required": [ - "os", - "architecture", - "download_url", - "filename" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/enterprises/{enterprise}/actions/runners/generate-jitconfig", - "title": "Create configuration for a just-in-time runner for an Enterprise", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the new runner.

", - "isRequired": true - }, - { - "type": "integer", - "name": "runner_group_id", - "description": "

The ID of the runner group to register the runner to.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "labels", - "description": "

The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100.

", - "isRequired": true - }, - { - "type": "string", - "name": "work_folder", - "description": "

The working directory to be used for job execution, relative to the runner install directory.

", - "default": "_work" - } - ], - "descriptionHTML": "

Generates a configuration that can be passed to the runner application at startup.

\n

OAuth tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "New runner", - "runner_group_id": 1, - "labels": [ - "self-hosted", - "X64", - "macOS", - "no-gpu" - ], - "work_folder": "_work" - }, - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "runner": { - "id": 23, - "name": "New runner", - "os": "unknown", - "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" - } - ] - }, - "encoded_jit_config": "abc123" - }, - "schema": { - "type": "object", - "required": [ - "runner", - "encoded_jit_config" - ], - "properties": { - "runner": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer" - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer" - }, - "name": { - "description": "The name of the runner.", - "type": "string" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string" - }, - "status": { - "description": "The status of the runner.", - "type": "string" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] - }, - "encoded_jit_config": { - "type": "string", - "description": "The base64 encoded runner configuration." - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/enterprises/{enterprise}/actions/runners/registration-token", - "title": "Create a registration token for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

Example using registration token:

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-22T12:13:35.123-08:00" - }, - "schema": { - "title": "Authentication Token", - "description": "Authentication Token", - "type": "object", - "properties": { - "token": { - "description": "The token used for authentication", - "type": "string" - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time" - }, - "permissions": { - "type": "object" - }, - "repositories": { - "description": "The repositories this token has access to", - "type": "array", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - }, - "single_file": { - "type": [ - "string", - "null" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - } - }, - "required": [ - "token", - "expires_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/enterprises/{enterprise}/actions/runners/remove-token", - "title": "Create a remove token for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

Example using remove token:

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-29T12:13:35.123-08:00" - }, - "schema": { - "title": "Authentication Token", - "description": "Authentication Token", - "type": "object", - "properties": { - "token": { - "description": "The token used for authentication", - "type": "string" - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time" - }, - "permissions": { - "type": "object" - }, - "repositories": { - "description": "The repositories this token has access to", - "type": "array", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - }, - "single_file": { - "type": [ - "string", - "null" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - } - }, - "required": [ - "token", - "expires_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}", - "title": "Get a self-hosted runner for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 23, - "name": "MBP", - "os": "macos", - "status": "online", - "busy": true, - "ephemeral": 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" - } - ] - }, - "schema": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer" - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer" - }, - "name": { - "description": "The name of the runner.", - "type": "string" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string" - }, - "status": { - "description": "The status of the runner.", - "type": "string" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}", - "title": "Delete a self-hosted runner from an enterprise", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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" - } - } - ], - "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

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", - "title": "List labels for a self-hosted runner for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all labels for a self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 4, - "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" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", - "title": "Add custom labels to a self-hosted runner for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "labels", - "description": "

The names of the custom labels to add to the runner.

", - "isRequired": true - } - ], - "descriptionHTML": "

Add custom labels to a self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "labels": [ - "gpu", - "accelerated" - ] - }, - "parameters": { - "enterprise": "ENTERPRISE", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 4, - "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" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", - "title": "Set custom labels for a self-hosted runner for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "labels", - "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", - "isRequired": true - } - ], - "descriptionHTML": "

Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "labels": [ - "gpu", - "accelerated" - ] - }, - "parameters": { - "enterprise": "ENTERPRISE", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 4, - "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" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", - "title": "Remove all custom labels from a self-hosted runner for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Remove all custom labels from a self-hosted runner configured in an\nenterprise. Returns the remaining read-only labels from the runner.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 3, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}", - "title": "Remove a custom label from a self-hosted runner for an enterprise", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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" - } - }, - { - "name": "name", - "description": "

The name of a self-hosted runner's custom label.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Remove a custom label from a self-hosted runner configured\nin an enterprise. Returns the remaining labels from the runner.

\n

This endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "runner_id": "RUNNER_ID", - "name": "NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 4, - "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" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners", - "title": "List self-hosted runners for an organization", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "name", - "description": "

The name of a self-hosted runner.

", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all self-hosted runners configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 2, - "runners": [ - { - "id": 23, - "name": "linux_runner", - "os": "linux", - "status": "online", - "busy": true, - "ephemeral": false, - "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, - "ephemeral": 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" - } - ] - } - ] - }, - "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" - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer" - }, - "name": { - "description": "The name of the runner.", - "type": "string" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string" - }, - "status": { - "description": "The status of the runner.", - "type": "string" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/downloads", - "title": "List runner applications for an organization", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "os": "osx", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-osx-x64-2.277.1.tar.gz", - "filename": "actions-runner-osx-x64-2.277.1.tar.gz", - "temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA", - "sha256_checksum": "f1fa173889dc9036cd529417e652e1729e5a3f4d35ec0151806d7480fda6b89b" - }, - { - "os": "linux", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-x64-2.277.1.tar.gz", - "filename": "actions-runner-linux-x64-2.277.1.tar.gz", - "temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA", - "sha256_checksum": "02d710fc9e0008e641274bb7da7fde61f7c9aa1cbb541a2990d3450cc88f4e98" - }, - { - "os": "linux", - "architecture": "arm", - "download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm-2.277.1.tar.gz", - "filename": "actions-runner-linux-arm-2.277.1.tar.gz", - "temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIyYTEzZDRmZC01ZDhkLTRjNzgtYjg2MS0zYTMxZGQ3MmYzNjQiLCJzaWQiOiI0MzZiNTg3YS04ODMyLTRiMTMtOWM2Ny05OWRkMjA2ZTQzNmMiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MzE1NzEsImV4cCI6MTYxNzkzNTc3MX0.PMhU7-MOnZRDj5k5a4ieeFlQCmKPl2pQvpVRhGZq-9ByKF5s9G0rsnGBxDcolTYlbvEAmSSkeAEwF486F7P0kMVEb-GI14WbErqqMSyaPL81c3W7UHxMJLaSBnDs9ftHMv_IkJmRzaROS8q1ObzUW-ErlltxCdj2zF_5ruK9G2RR566AOAtiA3AHV6k7-FCY5--sDYJN_YXPgpwI0fPN1TM92fdPm93hJnoXuCJNpBYp1vl5W4gwGtU_Pa07ESdqqFN1YJJHUloedNhiIOczGfGVSapRc8vyGm9P_VCM_yKD8JI-MkOXl8JI5fCfhmjmKsw-vSAh9NW67RGvmehmpw", - "sha256_checksum": "2f2bda21e2fd8fed6938b33182a293f6b1f74e4c5d09acd6d9a0fe3f979f5c85" - }, - { - "os": "win", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-win-x64-2.277.1.zip", - "filename": "actions-runner-win-x64-2.277.1.zip", - "temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA", - "sha256_checksum": "7215c75a462eeb6a839fa8ed298d79f620617d44d47d37c583114fc3f3b27b30" - }, - { - "os": "linux", - "architecture": "arm64", - "download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm64-2.277.1.tar.gz", - "filename": "actions-runner-linux-arm64-2.277.1.tar.gz", - "temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA", - "sha256_checksum": "a6aa6dd0ba217118ef2b4ea24e9e0a85b02b13c38052a5de0776d6ced3a79c64" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Runner Application", - "description": "Runner Application", - "type": "object", - "properties": { - "os": { - "type": "string" - }, - "architecture": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "filename": { - "type": "string" - }, - "temp_download_token": { - "description": "A short lived bearer token used to download the runner, if needed.", - "type": "string" - }, - "sha256_checksum": { - "type": "string" - } - }, - "required": [ - "os", - "architecture", - "download_url", - "filename" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/generate-jitconfig", - "title": "Create configuration for a just-in-time runner for an organization", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the new runner.

", - "isRequired": true - }, - { - "type": "integer", - "name": "runner_group_id", - "description": "

The ID of the runner group to register the runner to.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "labels", - "description": "

The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100.

", - "isRequired": true - }, - { - "type": "string", - "name": "work_folder", - "description": "

The working directory to be used for job execution, relative to the runner install directory.

", - "default": "_work" - } - ], - "descriptionHTML": "

Generates a configuration that can be passed to the runner application at startup.

\n

The authenticated user must have admin access to the organization.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "New runner", - "runner_group_id": 1, - "labels": [ - "self-hosted", - "X64", - "macOS", - "no-gpu" - ], - "work_folder": "_work" - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "runner": { - "id": 23, - "name": "New runner", - "os": "unknown", - "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" - } - ] - }, - "encoded_jit_config": "abc123" - }, - "schema": { - "type": "object", - "required": [ - "runner", - "encoded_jit_config" - ], - "properties": { - "runner": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer" - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer" - }, - "name": { - "description": "The name of the runner.", - "type": "string" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string" - }, - "status": { - "description": "The status of the runner.", - "type": "string" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] - }, - "encoded_jit_config": { - "type": "string", - "description": "The base64 encoded runner configuration." - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/registration-token", - "title": "Create a registration token for an organization", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-22T12:13:35.123-08:00" - }, - "schema": { - "title": "Authentication Token", - "description": "Authentication Token", - "type": "object", - "properties": { - "token": { - "description": "The token used for authentication", - "type": "string" - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time" - }, - "permissions": { - "type": "object" - }, - "repositories": { - "description": "The repositories this token has access to", - "type": "array", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - }, - "single_file": { - "type": [ - "string", - "null" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - } - }, - "required": [ - "token", - "expires_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/remove-token", - "title": "Create a remove token for an organization", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

\n
./config.sh remove --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-29T12:13:35.123-08:00" - }, - "schema": { - "title": "Authentication Token", - "description": "Authentication Token", - "type": "object", - "properties": { - "token": { - "description": "The token used for authentication", - "type": "string" - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time" - }, - "permissions": { - "type": "object" - }, - "repositories": { - "description": "The repositories this token has access to", - "type": "array", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - }, - "single_file": { - "type": [ - "string", - "null" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - } - }, - "required": [ - "token", - "expires_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}", - "title": "Get a self-hosted runner for an organization", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific self-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 23, - "name": "MBP", - "os": "macos", - "status": "online", - "busy": true, - "ephemeral": 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" - } - ] - }, - "schema": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer" - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer" - }, - "name": { - "description": "The name of the runner.", - "type": "string" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string" - }, - "status": { - "description": "The status of the runner.", - "type": "string" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}", - "title": "Delete a self-hosted runner from an organization", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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" - } - } - ], - "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

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", - "title": "List labels for a self-hosted runner for an organization", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all labels for a self-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 4, - "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" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", - "title": "Add custom labels to a self-hosted runner for an organization", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "labels", - "description": "

The names of the custom labels to add to the runner.

", - "isRequired": true - } - ], - "descriptionHTML": "

Adds custom labels to a self-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "labels": [ - "gpu", - "accelerated" - ] - }, - "parameters": { - "org": "ORG", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 4, - "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" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", - "title": "Set custom labels for a self-hosted runner for an organization", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "labels", - "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", - "isRequired": true - } - ], - "descriptionHTML": "

Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "labels": [ - "gpu", - "accelerated" - ] - }, - "parameters": { - "org": "ORG", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 4, - "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" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", - "title": "Remove all custom labels from a self-hosted runner for an organization", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 3, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels/{name}", - "title": "Remove a custom label from a self-hosted runner for an organization", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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" - } - }, - { - "name": "name", - "description": "

The name of a self-hosted runner's custom label.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.

\n

This endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "runner_id": "RUNNER_ID", - "name": "NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 4, - "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" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Self-hosted runners\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners", - "title": "List self-hosted runners for a repository", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "name", - "description": "

The name of a self-hosted runner.

", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all self-hosted runners configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 2, - "runners": [ - { - "id": 23, - "name": "linux_runner", - "os": "linux", - "status": "online", - "busy": true, - "ephemeral": false, - "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, - "ephemeral": 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" - } - ] - } - ] - }, - "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" - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer" - }, - "name": { - "description": "The name of the runner.", - "type": "string" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string" - }, - "status": { - "description": "The status of the runner.", - "type": "string" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/downloads", - "title": "List runner applications for a repository", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "os": "osx", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-osx-x64-2.277.1.tar.gz", - "filename": "actions-runner-osx-x64-2.277.1.tar.gz", - "temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA", - "sha256_checksum": "f1fa173889dc9036cd529417e652e1729e5a3f4d35ec0151806d7480fda6b89b" - }, - { - "os": "linux", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-x64-2.277.1.tar.gz", - "filename": "actions-runner-linux-x64-2.277.1.tar.gz", - "temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA", - "sha256_checksum": "02d710fc9e0008e641274bb7da7fde61f7c9aa1cbb541a2990d3450cc88f4e98" - }, - { - "os": "linux", - "architecture": "arm", - "download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm-2.277.1.tar.gz", - "filename": "actions-runner-linux-arm-2.277.1.tar.gz", - "temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIyYTEzZDRmZC01ZDhkLTRjNzgtYjg2MS0zYTMxZGQ3MmYzNjQiLCJzaWQiOiI0MzZiNTg3YS04ODMyLTRiMTMtOWM2Ny05OWRkMjA2ZTQzNmMiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MzE1NzEsImV4cCI6MTYxNzkzNTc3MX0.PMhU7-MOnZRDj5k5a4ieeFlQCmKPl2pQvpVRhGZq-9ByKF5s9G0rsnGBxDcolTYlbvEAmSSkeAEwF486F7P0kMVEb-GI14WbErqqMSyaPL81c3W7UHxMJLaSBnDs9ftHMv_IkJmRzaROS8q1ObzUW-ErlltxCdj2zF_5ruK9G2RR566AOAtiA3AHV6k7-FCY5--sDYJN_YXPgpwI0fPN1TM92fdPm93hJnoXuCJNpBYp1vl5W4gwGtU_Pa07ESdqqFN1YJJHUloedNhiIOczGfGVSapRc8vyGm9P_VCM_yKD8JI-MkOXl8JI5fCfhmjmKsw-vSAh9NW67RGvmehmpw", - "sha256_checksum": "2f2bda21e2fd8fed6938b33182a293f6b1f74e4c5d09acd6d9a0fe3f979f5c85" - }, - { - "os": "win", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-win-x64-2.277.1.zip", - "filename": "actions-runner-win-x64-2.277.1.zip", - "temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA", - "sha256_checksum": "7215c75a462eeb6a839fa8ed298d79f620617d44d47d37c583114fc3f3b27b30" - }, - { - "os": "linux", - "architecture": "arm64", - "download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm64-2.277.1.tar.gz", - "filename": "actions-runner-linux-arm64-2.277.1.tar.gz", - "temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA", - "sha256_checksum": "a6aa6dd0ba217118ef2b4ea24e9e0a85b02b13c38052a5de0776d6ced3a79c64" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Runner Application", - "description": "Runner Application", - "type": "object", - "properties": { - "os": { - "type": "string" - }, - "architecture": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "filename": { - "type": "string" - }, - "temp_download_token": { - "description": "A short lived bearer token used to download the runner, if needed.", - "type": "string" - }, - "sha256_checksum": { - "type": "string" - } - }, - "required": [ - "os", - "architecture", - "download_url", - "filename" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/generate-jitconfig", - "title": "Create configuration for a just-in-time runner for a repository", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the new runner.

", - "isRequired": true - }, - { - "type": "integer", - "name": "runner_group_id", - "description": "

The ID of the runner group to register the runner to.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "labels", - "description": "

The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100.

", - "isRequired": true - }, - { - "type": "string", - "name": "work_folder", - "description": "

The working directory to be used for job execution, relative to the runner install directory.

", - "default": "_work" - } - ], - "descriptionHTML": "

Generates a configuration that can be passed to the runner application at startup.

\n

The authenticated user must have admin access to the repository.

\n

OAuth tokens and personal access tokens (classic) need therepo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "New runner", - "runner_group_id": 1, - "labels": [ - "self-hosted", - "X64", - "macOS", - "no-gpu" - ], - "work_folder": "_work" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "runner": { - "id": 23, - "name": "New runner", - "os": "unknown", - "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" - } - ] - }, - "encoded_jit_config": "abc123" - }, - "schema": { - "type": "object", - "required": [ - "runner", - "encoded_jit_config" - ], - "properties": { - "runner": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer" - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer" - }, - "name": { - "description": "The name of the runner.", - "type": "string" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string" - }, - "status": { - "description": "The status of the runner.", - "type": "string" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] - }, - "encoded_jit_config": { - "type": "string", - "description": "The base64 encoded runner configuration." - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/registration-token", - "title": "Create a registration token for a repository", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-22T12:13:35.123-08:00" - }, - "schema": { - "title": "Authentication Token", - "description": "Authentication Token", - "type": "object", - "properties": { - "token": { - "description": "The token used for authentication", - "type": "string" - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time" - }, - "permissions": { - "type": "object" - }, - "repositories": { - "description": "The repositories this token has access to", - "type": "array", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - }, - "single_file": { - "type": [ - "string", - "null" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - } - }, - "required": [ - "token", - "expires_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/remove-token", - "title": "Create a remove token for a repository", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an repository. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

\n
./config.sh remove --token TOKEN\n
\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-29T12:13:35.123-08:00" - }, - "schema": { - "title": "Authentication Token", - "description": "Authentication Token", - "type": "object", - "properties": { - "token": { - "description": "The token used for authentication", - "type": "string" - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time" - }, - "permissions": { - "type": "object" - }, - "repositories": { - "description": "The repositories this token has access to", - "type": "array", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - }, - "single_file": { - "type": [ - "string", - "null" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - } - }, - "required": [ - "token", - "expires_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "title": "Get a self-hosted runner for a repository", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific self-hosted runner configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 23, - "name": "MBP", - "os": "macos", - "status": "online", - "busy": true, - "ephemeral": 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" - } - ] - }, - "schema": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer" - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer" - }, - "name": { - "description": "The name of the runner.", - "type": "string" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string" - }, - "status": { - "description": "The status of the runner.", - "type": "string" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "title": "Delete a self-hosted runner from a repository", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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" - } - } - ], - "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

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", - "title": "List labels for a self-hosted runner for a repository", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all labels for a self-hosted runner configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 4, - "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" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", - "title": "Add custom labels to a self-hosted runner for a repository", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "labels", - "description": "

The names of the custom labels to add to the runner.

", - "isRequired": true - } - ], - "descriptionHTML": "

Adds custom labels to a self-hosted runner configured in a repository.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "labels": [ - "gpu", - "accelerated" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 4, - "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" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", - "title": "Set custom labels for a self-hosted runner for a repository", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "labels", - "description": "

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

", - "isRequired": true - } - ], - "descriptionHTML": "

Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "labels": [ - "gpu", - "accelerated" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 4, - "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" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", - "title": "Remove all custom labels from a self-hosted runner for a repository", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "runner_id": "RUNNER_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 3, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}", - "title": "Remove a custom label from a self-hosted runner for a repository", - "category": "actions", - "subcategory": "self-hosted-runners", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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" - } - }, - { - "name": "name", - "description": "

The name of a self-hosted runner's custom label.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.

\n

This endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "runner_id": "RUNNER_ID", - "name": "NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 4, - "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" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "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": [ - "name" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - } - ], - "variables": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables", - "title": "List organization variables", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 10 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all organization variables.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 3, - "variables": [ - { - "name": "USERNAME", - "value": "octocat", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "private" - }, - { - "name": "ACTIONS_RUNNER_DEBUG", - "value": true, - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" - }, - { - "name": "ADMIN_EMAIL", - "value": "octocat@github.com", - "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/variables/ADMIN_EMAIL/repositories" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "variables" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "variables": { - "type": "array", - "items": { - "title": "Actions Variable for an Organization", - "description": "Organization variable for GitHub Actions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the variable.", - "type": "string" - }, - "value": { - "description": "The value of the variable.", - "type": "string" - }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a variable", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "value", - "created_at", - "updated_at", - "visibility" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/actions/variables", - "title": "Create an organization variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the variable.

", - "isRequired": true - }, - { - "type": "string", - "name": "value", - "description": "

The value of the variable.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

The type of repositories in the organization that can access the variable. selected means only the repositories specified by selected_repository_ids can access the variable.

", - "isRequired": true, - "enum": [ - "all", - "private", - "selected" - ] - }, - { - "type": "array of integers", - "name": "selected_repository_ids", - "description": "

An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the visibility is set to selected.

" - } - ], - "descriptionHTML": "

Creates an organization variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "USERNAME", - "value": "octocat", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response when creating a variable

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Response when creating a variable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables/{name}", - "title": "Get an organization variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "

The name of the variable.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific variable in an organization.

\n

The authenticated user must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "name": "NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "name": "USERNAME", - "value": "octocat", - "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/variables/USERNAME/repositories" - }, - "schema": { - "title": "Actions Variable for an Organization", - "description": "Organization variable for GitHub Actions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the variable.", - "type": "string" - }, - "value": { - "description": "The value of the variable.", - "type": "string" - }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a variable", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "value", - "created_at", - "updated_at", - "visibility" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/orgs/{org}/actions/variables/{name}", - "title": "Update an organization variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "

The name of the variable.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the variable.

" - }, - { - "type": "string", - "name": "value", - "description": "

The value of the variable.

" - }, - { - "type": "string", - "name": "visibility", - "description": "

The type of repositories in the organization that can access the variable. selected means only the repositories specified by selected_repository_ids can access the variable.

", - "enum": [ - "all", - "private", - "selected" - ] - }, - { - "type": "array of integers", - "name": "selected_repository_ids", - "description": "

An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the visibility is set to selected.

" - } - ], - "descriptionHTML": "

Updates an organization variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "USERNAME", - "value": "octocat", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - }, - "parameters": { - "org": "ORG", - "name": "NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}", - "title": "Delete an organization variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "

The name of the variable.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes an organization variable using the variable name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "name": "NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories", - "title": "List selected repositories for an organization variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "

The name of the variable.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all repositories that can access an organization variable\nthat is available to selected repositories.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "name": "NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "repositories" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "repositories": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "409", - "description": "

Response when the visibility of the variable is not set to selected

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories", - "title": "Set selected repositories for an organization variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "

The name of the variable.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of integers", - "name": "selected_repository_ids", - "description": "

The IDs of the repositories that can access the organization variable.

", - "isRequired": true - } - ], - "descriptionHTML": "

Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their visibility field set to selected.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "selected_repository_ids": [ - 64780797 - ] - }, - "parameters": { - "org": "ORG", - "name": "NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "409", - "description": "

Response when the visibility of the variable is not set to selected

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "title": "Add selected repository to an organization variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "

The name of the variable.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their visibility field set to selected.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "name": "NAME", - "repository_id": "REPOSITORY_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "409", - "description": "

Response when the visibility of the variable is not set to selected

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" organization permissions": "write", - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "title": "Remove selected repository from an organization variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "

The name of the variable.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their visibility field set to selected.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "name": "NAME", - "repository_id": "REPOSITORY_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "409", - "description": "

Response when the visibility of the variable is not set to selected

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" organization permissions": "write", - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/organization-variables", - "title": "List repository organization variables", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 10 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all organization variables shared with a repository.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 2, - "variables": [ - { - "name": "USERNAME", - "value": "octocat", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - }, - { - "name": "EMAIL", - "value": "octocat@github.com", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "variables" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "variables": { - "type": "array", - "items": { - "title": "Actions Variable", - "type": "object", - "properties": { - "name": { - "description": "The name of the variable.", - "type": "string" - }, - "value": { - "description": "The value of the variable.", - "type": "string" - }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "value", - "created_at", - "updated_at" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/variables", - "title": "List repository variables", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 10 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all repository variables.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 2, - "variables": [ - { - "name": "USERNAME", - "value": "octocat", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - }, - { - "name": "EMAIL", - "value": "octocat@github.com", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "variables" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "variables": { - "type": "array", - "items": { - "title": "Actions Variable", - "type": "object", - "properties": { - "name": { - "description": "The name of the variable.", - "type": "string" - }, - "value": { - "description": "The value of the variable.", - "type": "string" - }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "value", - "created_at", - "updated_at" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/variables", - "title": "Create a repository variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the variable.

", - "isRequired": true - }, - { - "type": "string", - "name": "value", - "description": "

The value of the variable.

", - "isRequired": true - } - ], - "descriptionHTML": "

Creates a repository variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "USERNAME", - "value": "octocat" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}", - "title": "Get a repository variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "

The name of the variable.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific variable in a repository.

\n

The authenticated user must have collaborator access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "name": "NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "name": "USERNAME", - "value": "octocat", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2022-01-10T14:59:22Z" - }, - "schema": { - "title": "Actions Variable", - "type": "object", - "properties": { - "name": { - "description": "The name of the variable.", - "type": "string" - }, - "value": { - "description": "The value of the variable.", - "type": "string" - }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "value", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}", - "title": "Update a repository variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "

The name of the variable.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the variable.

" - }, - { - "type": "string", - "name": "value", - "description": "

The value of the variable.

" - } - ], - "descriptionHTML": "

Updates a repository variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "USERNAME", - "value": "octocat" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "name": "NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/variables/{name}", - "title": "Delete a repository variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "

The name of the variable.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a repository variable using the variable name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "name": "NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Variables\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables", - "title": "List environment variables", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 10 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all environment variables.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 2, - "variables": [ - { - "name": "USERNAME", - "value": "octocat", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - }, - { - "name": "EMAIL", - "value": "octocat@github.com", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "variables" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "variables": { - "type": "array", - "items": { - "title": "Actions Variable", - "type": "object", - "properties": { - "name": { - "description": "The name of the variable.", - "type": "string" - }, - "value": { - "description": "The value of the variable.", - "type": "string" - }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "value", - "created_at", - "updated_at" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Environments\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables", - "title": "Create an environment variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the variable.

", - "isRequired": true - }, - { - "type": "string", - "name": "value", - "description": "

The value of the variable.

", - "isRequired": true - } - ], - "descriptionHTML": "

Create an environment variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "USERNAME", - "value": "octocat" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Environments\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", - "title": "Get an environment variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "

The name of the variable.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific variable in an environment.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME", - "name": "NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "name": "USERNAME", - "value": "octocat", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2022-01-10T14:59:22Z" - }, - "schema": { - "title": "Actions Variable", - "type": "object", - "properties": { - "name": { - "description": "The name of the variable.", - "type": "string" - }, - "value": { - "description": "The value of the variable.", - "type": "string" - }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "value", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Environments\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", - "title": "Update an environment variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "

The name of the variable.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the variable.

" - }, - { - "type": "string", - "name": "value", - "description": "

The value of the variable.

" - } - ], - "descriptionHTML": "

Updates an environment variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "USERNAME", - "value": "octocat" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "name": "NAME", - "environment_name": "ENVIRONMENT_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Environments\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", - "title": "Delete an environment variable", - "category": "actions", - "subcategory": "variables", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "

The name of the variable.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes an environment variable using the variable name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "name": "NAME", - "environment_name": "ENVIRONMENT_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Environments\" repository permissions": "write" - } - ] - } - } - ], - "workflow-jobs": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}", - "title": "Get a job for a workflow run", - "category": "actions", - "subcategory": "workflow-jobs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "job_id", - "description": "

The unique identifier of the job.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific job in a workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "job_id": "JOB_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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/29679449/jobs/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@v3", - "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@v3", - "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", - "labels": [ - "self-hosted", - "foo", - "bar" - ], - "runner_id": 1, - "runner_name": "my runner", - "runner_group_id": 2, - "runner_group_name": "my runner group", - "workflow_name": "CI", - "head_branch": "main" - }, - "schema": { - "title": "Job", - "description": "Information of a job execution in a workflow run", - "type": "object", - "properties": { - "id": { - "description": "The id of the job.", - "type": "integer" - }, - "run_id": { - "description": "The id of the associated workflow run.", - "type": "integer" - }, - "run_url": { - "type": "string" - }, - "run_attempt": { - "type": "integer", - "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run." - }, - "node_id": { - "type": "string" - }, - "head_sha": { - "description": "The SHA of the commit that is being run.", - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ] - }, - "status": { - "description": "The phase of the lifecycle that the job is currently in.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "requested", - "pending" - ] - }, - "conclusion": { - "description": "The outcome of the job.", - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null - ] - }, - "created_at": { - "description": "The time that the job created, in ISO 8601 format.", - "format": "date-time", - "type": "string" - }, - "started_at": { - "description": "The time that the job started, in ISO 8601 format.", - "format": "date-time", - "type": "string" - }, - "completed_at": { - "description": "The time that the job finished, in ISO 8601 format.", - "format": "date-time", - "type": [ - "string", - "null" - ] - }, - "name": { - "description": "The name of the job.", - "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.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed" - ] - }, - "conclusion": { - "description": "The outcome of the job.", - "type": [ - "string", - "null" - ] - }, - "name": { - "description": "The name of the job.", - "type": "string" - }, - "number": { - "type": "integer" - }, - "started_at": { - "description": "The time that the step started, in ISO 8601 format.", - "format": "date-time", - "type": [ - "string", - "null" - ] - }, - "completed_at": { - "description": "The time that the job finished, in ISO 8601 format.", - "format": "date-time", - "type": [ - "string", - "null" - ] - } - } - } - }, - "check_run_url": { - "type": "string" - }, - "labels": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file." - }, - "runner_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" - }, - "runner_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" - }, - "runner_group_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" - }, - "runner_group_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" - }, - "workflow_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the workflow." - }, - "head_branch": { - "type": [ - "string", - "null" - ], - "description": "The name of the current branch." - } - }, - "required": [ - "id", - "node_id", - "run_id", - "run_url", - "head_sha", - "workflow_name", - "head_branch", - "name", - "url", - "html_url", - "status", - "conclusion", - "started_at", - "completed_at", - "check_run_url", - "labels", - "runner_id", - "runner_name", - "runner_group_id", - "runner_group_name", - "created_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", - "title": "Download job logs for a workflow run", - "category": "actions", - "subcategory": "workflow-jobs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "job_id", - "description": "

The unique identifier of the job.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "job_id": "JOB_ID" - } - }, - "response": { - "statusCode": "302", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "302", - "description": "

Found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs", - "title": "List jobs for a workflow run attempt", - "category": "actions", - "subcategory": "workflow-jobs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "attempt_number", - "description": "

The attempt number of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "run_id": "RUN_ID", - "attempt_number": "ATTEMPT_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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/29679449/jobs/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@v3", - "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@v3", - "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", - "labels": [ - "self-hosted", - "foo", - "bar" - ], - "runner_id": 1, - "runner_name": "my runner", - "runner_group_id": 2, - "runner_group_name": "my runner group", - "workflow_name": "CI", - "head_branch": "main" - } - ] - }, - "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.", - "type": "integer" - }, - "run_id": { - "description": "The id of the associated workflow run.", - "type": "integer" - }, - "run_url": { - "type": "string" - }, - "run_attempt": { - "type": "integer", - "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run." - }, - "node_id": { - "type": "string" - }, - "head_sha": { - "description": "The SHA of the commit that is being run.", - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ] - }, - "status": { - "description": "The phase of the lifecycle that the job is currently in.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "requested", - "pending" - ] - }, - "conclusion": { - "description": "The outcome of the job.", - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null - ] - }, - "created_at": { - "description": "The time that the job created, in ISO 8601 format.", - "format": "date-time", - "type": "string" - }, - "started_at": { - "description": "The time that the job started, in ISO 8601 format.", - "format": "date-time", - "type": "string" - }, - "completed_at": { - "description": "The time that the job finished, in ISO 8601 format.", - "format": "date-time", - "type": [ - "string", - "null" - ] - }, - "name": { - "description": "The name of the job.", - "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.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed" - ] - }, - "conclusion": { - "description": "The outcome of the job.", - "type": [ - "string", - "null" - ] - }, - "name": { - "description": "The name of the job.", - "type": "string" - }, - "number": { - "type": "integer" - }, - "started_at": { - "description": "The time that the step started, in ISO 8601 format.", - "format": "date-time", - "type": [ - "string", - "null" - ] - }, - "completed_at": { - "description": "The time that the job finished, in ISO 8601 format.", - "format": "date-time", - "type": [ - "string", - "null" - ] - } - } - } - }, - "check_run_url": { - "type": "string" - }, - "labels": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file." - }, - "runner_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" - }, - "runner_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" - }, - "runner_group_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" - }, - "runner_group_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" - }, - "workflow_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the workflow." - }, - "head_branch": { - "type": [ - "string", - "null" - ], - "description": "The name of the current branch." - } - }, - "required": [ - "id", - "node_id", - "run_id", - "run_url", - "head_sha", - "workflow_name", - "head_branch", - "name", - "url", - "html_url", - "status", - "conclusion", - "started_at", - "completed_at", - "check_run_url", - "labels", - "runner_id", - "runner_name", - "runner_group_id", - "runner_group_name", - "created_at" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", - "title": "List jobs for a workflow run", - "category": "actions", - "subcategory": "workflow-jobs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "filter", - "description": "

Filters jobs by their completed_at timestamp. latest returns jobs from the most recent execution of the workflow run. 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": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "run_id": "RUN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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/29679449/jobs/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@v3", - "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@v3", - "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", - "labels": [ - "self-hosted", - "foo", - "bar" - ], - "runner_id": 1, - "runner_name": "my runner", - "runner_group_id": 2, - "runner_group_name": "my runner group", - "workflow_name": "CI", - "head_branch": "main" - } - ] - }, - "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.", - "type": "integer" - }, - "run_id": { - "description": "The id of the associated workflow run.", - "type": "integer" - }, - "run_url": { - "type": "string" - }, - "run_attempt": { - "type": "integer", - "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run." - }, - "node_id": { - "type": "string" - }, - "head_sha": { - "description": "The SHA of the commit that is being run.", - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ] - }, - "status": { - "description": "The phase of the lifecycle that the job is currently in.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "requested", - "pending" - ] - }, - "conclusion": { - "description": "The outcome of the job.", - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null - ] - }, - "created_at": { - "description": "The time that the job created, in ISO 8601 format.", - "format": "date-time", - "type": "string" - }, - "started_at": { - "description": "The time that the job started, in ISO 8601 format.", - "format": "date-time", - "type": "string" - }, - "completed_at": { - "description": "The time that the job finished, in ISO 8601 format.", - "format": "date-time", - "type": [ - "string", - "null" - ] - }, - "name": { - "description": "The name of the job.", - "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.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed" - ] - }, - "conclusion": { - "description": "The outcome of the job.", - "type": [ - "string", - "null" - ] - }, - "name": { - "description": "The name of the job.", - "type": "string" - }, - "number": { - "type": "integer" - }, - "started_at": { - "description": "The time that the step started, in ISO 8601 format.", - "format": "date-time", - "type": [ - "string", - "null" - ] - }, - "completed_at": { - "description": "The time that the job finished, in ISO 8601 format.", - "format": "date-time", - "type": [ - "string", - "null" - ] - } - } - } - }, - "check_run_url": { - "type": "string" - }, - "labels": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file." - }, - "runner_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" - }, - "runner_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" - }, - "runner_group_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" - }, - "runner_group_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" - }, - "workflow_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the workflow." - }, - "head_branch": { - "type": [ - "string", - "null" - ], - "description": "The name of the current branch." - } - }, - "required": [ - "id", - "node_id", - "run_id", - "run_url", - "head_sha", - "workflow_name", - "head_branch", - "name", - "url", - "html_url", - "status", - "conclusion", - "started_at", - "completed_at", - "check_run_url", - "labels", - "runner_id", - "runner_name", - "runner_group_id", - "runner_group_name", - "created_at" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ], - "workflow-runs": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun", - "title": "Re-run a job from a workflow run", - "category": "actions", - "subcategory": "workflow-runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "job_id", - "description": "

The unique identifier of the job.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "enable_debug_logging", - "description": "

Whether to enable debug logging for the re-run.

", - "default": false - } - ], - "descriptionHTML": "

Re-run a job and its dependent jobs in a workflow run.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": null, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "job_id": "JOB_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs", - "title": "List workflow runs for a repository", - "category": "actions", - "subcategory": "workflow-runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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.\"

", - "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 Actions can set a status of waiting, pending, or requested.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "completed", - "action_required", - "cancelled", - "failure", - "neutral", - "skipped", - "stale", - "success", - "timed_out", - "in_progress", - "queued", - "requested", - "waiting", - "pending" - ] - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "created", - "description": "

Returns workflow runs created within the given date-time range. For more information on the syntax, see \"Understanding the search syntax.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "exclude_pull_requests", - "description": "

If true pull requests are omitted from the response (empty array).

", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "check_suite_id", - "description": "

Returns workflow runs with the check_suite_id that you specify.

", - "in": "query", - "schema": { - "type": "integer" - } - }, - { - "name": "head_sha", - "description": "

Only returns workflow runs that are associated with the specified head_sha.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "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.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

\n

This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 1, - "workflow_runs": [ - { - "id": 30433642, - "name": "Build", - "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", - "check_suite_id": 42, - "check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==", - "head_branch": "master", - "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", - "path": ".github/workflows/build.yml@main", - "run_number": 562, - "event": "push", - "display_title": "Update README.md", - "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", - "actor": { - "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 - }, - "run_attempt": 1, - "run_started_at": "2020-01-22T19:33:08Z", - "triggering_actor": { - "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 - }, - "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" - } - } - ] - }, - "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." - }, - "name": { - "type": [ - "string", - "null" - ], - "description": "The name of the workflow run." - }, - "node_id": { - "type": "string" - }, - "check_suite_id": { - "type": "integer", - "description": "The ID of the associated check suite." - }, - "check_suite_node_id": { - "type": "string", - "description": "The node ID of the associated check suite." - }, - "head_branch": { - "type": [ - "string", - "null" - ] - }, - "head_sha": { - "description": "The SHA of the head commit that points to the version of the workflow being run.", - "type": "string" - }, - "path": { - "description": "The full path of the workflow", - "type": "string" - }, - "run_number": { - "type": "integer", - "description": "The auto incrementing run number for the workflow run." - }, - "run_attempt": { - "type": "integer", - "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run." - }, - "referenced_workflows": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Referenced workflow", - "description": "A workflow referenced/reused by the initial caller workflow", - "type": "object", - "properties": { - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "ref": { - "type": "string" - } - }, - "required": [ - "path", - "sha" - ] - } - }, - "event": { - "type": "string" - }, - "status": { - "type": [ - "string", - "null" - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ] - }, - "workflow_id": { - "type": "integer", - "description": "The ID of the parent workflow." - }, - "url": { - "type": "string", - "description": "The URL to the workflow run." - }, - "html_url": { - "type": "string" - }, - "pull_requests": { - "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.", - "type": [ - "array", - "null" - ], - "items": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "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", - "format": "int64" - }, - "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" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "triggering_actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "run_started_at": { - "type": "string", - "format": "date-time", - "description": "The start time of the latest run. Resets on re-run." - }, - "jobs_url": { - "description": "The URL to the jobs for the workflow run.", - "type": "string" - }, - "logs_url": { - "description": "The URL to download the logs for the workflow run.", - "type": "string" - }, - "check_suite_url": { - "description": "The URL to the associated check suite.", - "type": "string" - }, - "artifacts_url": { - "description": "The URL to the artifacts for the workflow run.", - "type": "string" - }, - "cancel_url": { - "description": "The URL to cancel the workflow run.", - "type": "string" - }, - "rerun_url": { - "description": "The URL to rerun the workflow run.", - "type": "string" - }, - "previous_attempt_url": { - "description": "The URL to the previous attempted run of this workflow, if one exists.", - "type": [ - "string", - "null" - ] - }, - "workflow_url": { - "description": "The URL to the workflow.", - "type": "string" - }, - "head_commit": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple Commit", - "description": "A commit.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "SHA for the commit" - }, - "tree_id": { - "type": "string", - "description": "SHA for the commit's tree" - }, - "message": { - "description": "Message describing the purpose of the commit", - "type": "string" - }, - "timestamp": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string" - }, - "author": { - "type": [ - "object", - "null" - ], - "description": "Information about the Git author", - "properties": { - "name": { - "description": "Name of the commit's author", - "type": "string" - }, - "email": { - "description": "Git email address of the commit's author", - "type": "string", - "format": "email" - } - }, - "required": [ - "name", - "email" - ] - }, - "committer": { - "type": [ - "object", - "null" - ], - "description": "Information about the Git committer", - "properties": { - "name": { - "description": "Name of the commit's committer", - "type": "string" - }, - "email": { - "description": "Git email address of the commit's committer", - "type": "string", - "format": "email" - } - }, - "required": [ - "name", - "email" - ] - } - }, - "required": [ - "id", - "tree_id", - "message", - "timestamp", - "author", - "committer" - ] - } - ] - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - }, - "display_title": { - "type": "string", - "description": "The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow." - } - }, - "required": [ - "id", - "node_id", - "head_branch", - "run_number", - "display_title", - "event", - "status", - "conclusion", - "head_sha", - "path", - "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" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}", - "title": "Get a workflow run", - "category": "actions", - "subcategory": "workflow-runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "exclude_pull_requests", - "description": "

If true pull requests are omitted from the response (empty array).

", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "run_id": "RUN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 30433642, - "name": "Build", - "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", - "check_suite_id": 42, - "check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==", - "head_branch": "main", - "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", - "path": ".github/workflows/build.yml@main", - "run_number": 562, - "event": "push", - "display_title": "Update README.md", - "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", - "actor": { - "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 - }, - "run_attempt": 1, - "referenced_workflows": [ - { - "path": "octocat/Hello-World/.github/workflows/deploy.yml@main", - "sha": "86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db", - "ref": "refs/heads/main" - }, - { - "path": "octo-org/octo-repo/.github/workflows/report.yml@v2", - "sha": "79e9790903e1c3373b1a3e3a941d57405478a232", - "ref": "refs/tags/v2" - }, - { - "path": "octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e", - "sha": "1595d4b6de6a9e9751fb270a41019ce507d4099e" - } - ], - "run_started_at": "2020-01-22T19:33:08Z", - "triggering_actor": { - "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 - }, - "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", - "previous_attempt_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1", - "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" - } - }, - "schema": { - "title": "Workflow Run", - "description": "An invocation of a workflow", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the workflow run." - }, - "name": { - "type": [ - "string", - "null" - ], - "description": "The name of the workflow run." - }, - "node_id": { - "type": "string" - }, - "check_suite_id": { - "type": "integer", - "description": "The ID of the associated check suite." - }, - "check_suite_node_id": { - "type": "string", - "description": "The node ID of the associated check suite." - }, - "head_branch": { - "type": [ - "string", - "null" - ] - }, - "head_sha": { - "description": "The SHA of the head commit that points to the version of the workflow being run.", - "type": "string" - }, - "path": { - "description": "The full path of the workflow", - "type": "string" - }, - "run_number": { - "type": "integer", - "description": "The auto incrementing run number for the workflow run." - }, - "run_attempt": { - "type": "integer", - "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run." - }, - "referenced_workflows": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Referenced workflow", - "description": "A workflow referenced/reused by the initial caller workflow", - "type": "object", - "properties": { - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "ref": { - "type": "string" - } - }, - "required": [ - "path", - "sha" - ] - } - }, - "event": { - "type": "string" - }, - "status": { - "type": [ - "string", - "null" - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ] - }, - "workflow_id": { - "type": "integer", - "description": "The ID of the parent workflow." - }, - "url": { - "type": "string", - "description": "The URL to the workflow run." - }, - "html_url": { - "type": "string" - }, - "pull_requests": { - "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.", - "type": [ - "array", - "null" - ], - "items": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "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", - "format": "int64" - }, - "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" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "triggering_actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "run_started_at": { - "type": "string", - "format": "date-time", - "description": "The start time of the latest run. Resets on re-run." - }, - "jobs_url": { - "description": "The URL to the jobs for the workflow run.", - "type": "string" - }, - "logs_url": { - "description": "The URL to download the logs for the workflow run.", - "type": "string" - }, - "check_suite_url": { - "description": "The URL to the associated check suite.", - "type": "string" - }, - "artifacts_url": { - "description": "The URL to the artifacts for the workflow run.", - "type": "string" - }, - "cancel_url": { - "description": "The URL to cancel the workflow run.", - "type": "string" - }, - "rerun_url": { - "description": "The URL to rerun the workflow run.", - "type": "string" - }, - "previous_attempt_url": { - "description": "The URL to the previous attempted run of this workflow, if one exists.", - "type": [ - "string", - "null" - ] - }, - "workflow_url": { - "description": "The URL to the workflow.", - "type": "string" - }, - "head_commit": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple Commit", - "description": "A commit.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "SHA for the commit" - }, - "tree_id": { - "type": "string", - "description": "SHA for the commit's tree" - }, - "message": { - "description": "Message describing the purpose of the commit", - "type": "string" - }, - "timestamp": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string" - }, - "author": { - "type": [ - "object", - "null" - ], - "description": "Information about the Git author", - "properties": { - "name": { - "description": "Name of the commit's author", - "type": "string" - }, - "email": { - "description": "Git email address of the commit's author", - "type": "string", - "format": "email" - } - }, - "required": [ - "name", - "email" - ] - }, - "committer": { - "type": [ - "object", - "null" - ], - "description": "Information about the Git committer", - "properties": { - "name": { - "description": "Name of the commit's committer", - "type": "string" - }, - "email": { - "description": "Git email address of the commit's committer", - "type": "string", - "format": "email" - } - }, - "required": [ - "name", - "email" - ] - } - }, - "required": [ - "id", - "tree_id", - "message", - "timestamp", - "author", - "committer" - ] - } - ] - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - }, - "display_title": { - "type": "string", - "description": "The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow." - } - }, - "required": [ - "id", - "node_id", - "head_branch", - "run_number", - "display_title", - "event", - "status", - "conclusion", - "head_sha", - "path", - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}", - "title": "Delete a workflow run", - "category": "actions", - "subcategory": "workflow-runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a specific workflow run.

\n

Anyone with write access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "run_id": "RUN_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals", - "title": "Get the review history for a workflow run", - "category": "actions", - "subcategory": "workflow-runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "run_id": "RUN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - } - ], - "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.", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the environment.", - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "created_at": { - "description": "The time that the environment was created, in ISO 8601 format.", - "format": "date-time", - "type": "string" - }, - "updated_at": { - "description": "The time that the environment was last updated, in ISO 8601 format.", - "format": "date-time", - "type": "string" - } - } - } - }, - "state": { - "description": "Whether deployment to the environment(s) was approved or rejected or pending (with comments)", - "enum": [ - "approved", - "rejected", - "pending" - ], - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "comment": { - "type": "string", - "description": "The comment submitted with the deployment review" - } - }, - "required": [ - "environments", - "state", - "user", - "comment" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}", - "title": "Get a workflow run attempt", - "category": "actions", - "subcategory": "workflow-runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "attempt_number", - "description": "

The attempt number of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "exclude_pull_requests", - "description": "

If true pull requests are omitted from the response (empty array).

", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific workflow run attempt.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "run_id": "RUN_ID", - "attempt_number": "ATTEMPT_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 30433642, - "name": "Build", - "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", - "check_suite_id": 42, - "check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==", - "head_branch": "main", - "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", - "path": ".github/workflows/build.yml@main", - "run_number": 562, - "event": "push", - "display_title": "Update README.md", - "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", - "actor": { - "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 - }, - "run_attempt": 1, - "referenced_workflows": [ - { - "path": "octocat/Hello-World/.github/workflows/deploy.yml@main", - "sha": "86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db", - "ref": "refs/heads/main" - }, - { - "path": "octo-org/octo-repo/.github/workflows/report.yml@v2", - "sha": "79e9790903e1c3373b1a3e3a941d57405478a232", - "ref": "refs/tags/v2" - }, - { - "path": "octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e", - "sha": "1595d4b6de6a9e9751fb270a41019ce507d4099e" - } - ], - "run_started_at": "2020-01-22T19:33:08Z", - "triggering_actor": { - "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 - }, - "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", - "previous_attempt_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1", - "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" - } - }, - "schema": { - "title": "Workflow Run", - "description": "An invocation of a workflow", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the workflow run." - }, - "name": { - "type": [ - "string", - "null" - ], - "description": "The name of the workflow run." - }, - "node_id": { - "type": "string" - }, - "check_suite_id": { - "type": "integer", - "description": "The ID of the associated check suite." - }, - "check_suite_node_id": { - "type": "string", - "description": "The node ID of the associated check suite." - }, - "head_branch": { - "type": [ - "string", - "null" - ] - }, - "head_sha": { - "description": "The SHA of the head commit that points to the version of the workflow being run.", - "type": "string" - }, - "path": { - "description": "The full path of the workflow", - "type": "string" - }, - "run_number": { - "type": "integer", - "description": "The auto incrementing run number for the workflow run." - }, - "run_attempt": { - "type": "integer", - "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run." - }, - "referenced_workflows": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Referenced workflow", - "description": "A workflow referenced/reused by the initial caller workflow", - "type": "object", - "properties": { - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "ref": { - "type": "string" - } - }, - "required": [ - "path", - "sha" - ] - } - }, - "event": { - "type": "string" - }, - "status": { - "type": [ - "string", - "null" - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ] - }, - "workflow_id": { - "type": "integer", - "description": "The ID of the parent workflow." - }, - "url": { - "type": "string", - "description": "The URL to the workflow run." - }, - "html_url": { - "type": "string" - }, - "pull_requests": { - "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.", - "type": [ - "array", - "null" - ], - "items": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "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", - "format": "int64" - }, - "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" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "triggering_actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "run_started_at": { - "type": "string", - "format": "date-time", - "description": "The start time of the latest run. Resets on re-run." - }, - "jobs_url": { - "description": "The URL to the jobs for the workflow run.", - "type": "string" - }, - "logs_url": { - "description": "The URL to download the logs for the workflow run.", - "type": "string" - }, - "check_suite_url": { - "description": "The URL to the associated check suite.", - "type": "string" - }, - "artifacts_url": { - "description": "The URL to the artifacts for the workflow run.", - "type": "string" - }, - "cancel_url": { - "description": "The URL to cancel the workflow run.", - "type": "string" - }, - "rerun_url": { - "description": "The URL to rerun the workflow run.", - "type": "string" - }, - "previous_attempt_url": { - "description": "The URL to the previous attempted run of this workflow, if one exists.", - "type": [ - "string", - "null" - ] - }, - "workflow_url": { - "description": "The URL to the workflow.", - "type": "string" - }, - "head_commit": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple Commit", - "description": "A commit.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "SHA for the commit" - }, - "tree_id": { - "type": "string", - "description": "SHA for the commit's tree" - }, - "message": { - "description": "Message describing the purpose of the commit", - "type": "string" - }, - "timestamp": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string" - }, - "author": { - "type": [ - "object", - "null" - ], - "description": "Information about the Git author", - "properties": { - "name": { - "description": "Name of the commit's author", - "type": "string" - }, - "email": { - "description": "Git email address of the commit's author", - "type": "string", - "format": "email" - } - }, - "required": [ - "name", - "email" - ] - }, - "committer": { - "type": [ - "object", - "null" - ], - "description": "Information about the Git committer", - "properties": { - "name": { - "description": "Name of the commit's committer", - "type": "string" - }, - "email": { - "description": "Git email address of the commit's committer", - "type": "string", - "format": "email" - } - }, - "required": [ - "name", - "email" - ] - } - }, - "required": [ - "id", - "tree_id", - "message", - "timestamp", - "author", - "committer" - ] - } - ] - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - }, - "display_title": { - "type": "string", - "description": "The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow." - } - }, - "required": [ - "id", - "node_id", - "head_branch", - "run_number", - "display_title", - "event", - "status", - "conclusion", - "head_sha", - "path", - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs", - "title": "Download workflow run attempt logs", - "category": "actions", - "subcategory": "workflow-runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "attempt_number", - "description": "

The attempt number of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for Location: in the response header to find the URL for the download.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "run_id": "RUN_ID", - "attempt_number": "ATTEMPT_NUMBER" - } - }, - "response": { - "statusCode": "302", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "302", - "description": "

Found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel", - "title": "Cancel a workflow run", - "category": "actions", - "subcategory": "workflow-runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Cancels a workflow run using its id.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "run_id": "RUN_ID" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Response

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule", - "title": "Review custom deployment protection rules for a workflow run", - "category": "actions", - "subcategory": "workflow-runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"

\n

Note

\n

\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.

\n
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "environment_name": "prod-eus", - "state": "approved", - "comment": "All health checks passed." - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "run_id": "RUN_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Deployments\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel", - "title": "Force cancel a workflow run", - "category": "actions", - "subcategory": "workflow-runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an always() condition on a job.\nYou should only use this endpoint to cancel a workflow run when the workflow run is not responding to POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "run_id": "RUN_ID" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Response

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", - "title": "Download workflow run logs", - "category": "actions", - "subcategory": "workflow-runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "run_id": "RUN_ID" - } - }, - "response": { - "statusCode": "302", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "302", - "description": "

Found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", - "title": "Delete workflow run logs", - "category": "actions", - "subcategory": "workflow-runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes all logs for a workflow run.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "run_id": "RUN_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "title": "Get pending deployments for a workflow run", - "category": "actions", - "subcategory": "workflow-runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "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.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "run_id": "RUN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - } - ] - } - ], - "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.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the environment.", - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - }, - "wait_timer": { - "type": "integer", - "description": "The set duration of the wait timer" - }, - "wait_timer_started_at": { - "description": "The time that the wait timer began.", - "format": "date-time", - "type": [ - "string", - "null" - ] - }, - "current_user_can_approve": { - "description": "Whether the currently authenticated user can approve the deployment", - "type": "boolean" - }, - "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.", - "enum": [ - "User", - "Team" - ] - }, - "reviewer": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - ] - } - } - } - } - }, - "required": [ - "environment", - "wait_timer", - "wait_timer_started_at", - "current_user_can_approve", - "reviewers" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "title": "Review pending deployments for a workflow run", - "category": "actions", - "subcategory": "workflow-runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "array of integers", - "name": "environment_ids", - "description": "

The list of environment ids to approve or reject

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

Whether to approve or reject deployment to the specified environments.

", - "isRequired": true, - "enum": [ - "approved", - "rejected" - ] - }, - { - "type": "string", - "name": "comment", - "description": "

A comment to accompany the deployment review

", - "isRequired": true - } - ], - "descriptionHTML": "

Approve or reject pending deployments that are waiting on approval by a required reviewer.

\n

Required reviewers with read access to the repository contents and deployments can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "environment_ids": [ - 161171787 - ], - "state": "approved", - "comment": "Ship it!" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "run_id": "RUN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "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" - }, - "id": { - "description": "Unique identifier of the deployment", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "ref": { - "description": "The ref to deploy. This can be a branch, tag, or sha.", - "type": "string" - }, - "task": { - "description": "Parameter to specify a task to execute", - "type": "string" - }, - "payload": { - "oneOf": [ - { - "type": "object", - "additionalProperties": true - }, - { - "type": "string" - } - ] - }, - "original_environment": { - "type": "string" - }, - "environment": { - "description": "Name for the target deployment environment.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "transient_environment": { - "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", - "type": "boolean" - }, - "production_environment": { - "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", - "type": "boolean" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "sha", - "ref", - "task", - "environment", - "creator", - "payload", - "description", - "statuses_url", - "repository_url", - "url", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Deployments\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun", - "title": "Re-run a workflow", - "category": "actions", - "subcategory": "workflow-runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "enable_debug_logging", - "description": "

Whether to enable debug logging for the re-run.

", - "default": false - } - ], - "descriptionHTML": "

Re-runs your workflow run using its id.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": null, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "run_id": "RUN_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs", - "title": "Re-run failed jobs from a workflow run", - "category": "actions", - "subcategory": "workflow-runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "run_id", - "description": "

The unique identifier of the workflow run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "enable_debug_logging", - "description": "

Whether to enable debug logging for the re-run.

", - "default": false - } - ], - "descriptionHTML": "

Re-run all of the failed jobs and their dependent jobs in a workflow run using the id of the workflow run.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": null, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "run_id": "RUN_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", - "title": "List workflow runs for a workflow", - "category": "actions", - "subcategory": "workflow-runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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.\"

", - "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 Actions can set a status of waiting, pending, or requested.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "completed", - "action_required", - "cancelled", - "failure", - "neutral", - "skipped", - "stale", - "success", - "timed_out", - "in_progress", - "queued", - "requested", - "waiting", - "pending" - ] - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "created", - "description": "

Returns workflow runs created within the given date-time range. For more information on the syntax, see \"Understanding the search syntax.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "exclude_pull_requests", - "description": "

If true pull requests are omitted from the response (empty array).

", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "check_suite_id", - "description": "

Returns workflow runs with the check_suite_id that you specify.

", - "in": "query", - "schema": { - "type": "integer" - } - }, - { - "name": "head_sha", - "description": "

Only returns workflow runs that are associated with the specified head_sha.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "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

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

\n

This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "workflow_id": "WORKFLOW_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 1, - "workflow_runs": [ - { - "id": 30433642, - "name": "Build", - "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", - "check_suite_id": 42, - "check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==", - "head_branch": "master", - "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", - "path": ".github/workflows/build.yml@main", - "run_number": 562, - "event": "push", - "display_title": "Update README.md", - "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", - "actor": { - "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 - }, - "run_attempt": 1, - "run_started_at": "2020-01-22T19:33:08Z", - "triggering_actor": { - "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 - }, - "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" - } - } - ] - }, - "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." - }, - "name": { - "type": [ - "string", - "null" - ], - "description": "The name of the workflow run." - }, - "node_id": { - "type": "string" - }, - "check_suite_id": { - "type": "integer", - "description": "The ID of the associated check suite." - }, - "check_suite_node_id": { - "type": "string", - "description": "The node ID of the associated check suite." - }, - "head_branch": { - "type": [ - "string", - "null" - ] - }, - "head_sha": { - "description": "The SHA of the head commit that points to the version of the workflow being run.", - "type": "string" - }, - "path": { - "description": "The full path of the workflow", - "type": "string" - }, - "run_number": { - "type": "integer", - "description": "The auto incrementing run number for the workflow run." - }, - "run_attempt": { - "type": "integer", - "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run." - }, - "referenced_workflows": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Referenced workflow", - "description": "A workflow referenced/reused by the initial caller workflow", - "type": "object", - "properties": { - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "ref": { - "type": "string" - } - }, - "required": [ - "path", - "sha" - ] - } - }, - "event": { - "type": "string" - }, - "status": { - "type": [ - "string", - "null" - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ] - }, - "workflow_id": { - "type": "integer", - "description": "The ID of the parent workflow." - }, - "url": { - "type": "string", - "description": "The URL to the workflow run." - }, - "html_url": { - "type": "string" - }, - "pull_requests": { - "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.", - "type": [ - "array", - "null" - ], - "items": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "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", - "format": "int64" - }, - "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" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "triggering_actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "run_started_at": { - "type": "string", - "format": "date-time", - "description": "The start time of the latest run. Resets on re-run." - }, - "jobs_url": { - "description": "The URL to the jobs for the workflow run.", - "type": "string" - }, - "logs_url": { - "description": "The URL to download the logs for the workflow run.", - "type": "string" - }, - "check_suite_url": { - "description": "The URL to the associated check suite.", - "type": "string" - }, - "artifacts_url": { - "description": "The URL to the artifacts for the workflow run.", - "type": "string" - }, - "cancel_url": { - "description": "The URL to cancel the workflow run.", - "type": "string" - }, - "rerun_url": { - "description": "The URL to rerun the workflow run.", - "type": "string" - }, - "previous_attempt_url": { - "description": "The URL to the previous attempted run of this workflow, if one exists.", - "type": [ - "string", - "null" - ] - }, - "workflow_url": { - "description": "The URL to the workflow.", - "type": "string" - }, - "head_commit": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple Commit", - "description": "A commit.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "SHA for the commit" - }, - "tree_id": { - "type": "string", - "description": "SHA for the commit's tree" - }, - "message": { - "description": "Message describing the purpose of the commit", - "type": "string" - }, - "timestamp": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string" - }, - "author": { - "type": [ - "object", - "null" - ], - "description": "Information about the Git author", - "properties": { - "name": { - "description": "Name of the commit's author", - "type": "string" - }, - "email": { - "description": "Git email address of the commit's author", - "type": "string", - "format": "email" - } - }, - "required": [ - "name", - "email" - ] - }, - "committer": { - "type": [ - "object", - "null" - ], - "description": "Information about the Git committer", - "properties": { - "name": { - "description": "Name of the commit's committer", - "type": "string" - }, - "email": { - "description": "Git email address of the commit's committer", - "type": "string", - "format": "email" - } - }, - "required": [ - "name", - "email" - ] - } - }, - "required": [ - "id", - "tree_id", - "message", - "timestamp", - "author", - "committer" - ] - } - ] - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - }, - "display_title": { - "type": "string", - "description": "The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow." - } - }, - "required": [ - "id", - "node_id", - "head_branch", - "run_number", - "display_title", - "event", - "status", - "conclusion", - "head_sha", - "path", - "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" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ], - "workflows": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/workflows", - "title": "List repository workflows", - "category": "actions", - "subcategory": "workflows", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the workflows in a repository.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - } - ] - }, - "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" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "active", - "deleted", - "disabled_fork", - "disabled_inactivity", - "disabled_manually" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "badge_url": { - "type": "string" - }, - "deleted_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "name", - "path", - "state", - "url", - "html_url", - "badge_url", - "created_at", - "updated_at" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}", - "title": "Get a workflow", - "category": "actions", - "subcategory": "workflows", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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" - } - ] - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific workflow. You can replace workflow_id with the workflow\nfile name. For example, you could use main.yaml.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "workflow_id": "WORKFLOW_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - }, - "schema": { - "title": "Workflow", - "description": "A GitHub Actions workflow", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "active", - "deleted", - "disabled_fork", - "disabled_inactivity", - "disabled_manually" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "badge_url": { - "type": "string" - }, - "deleted_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "name", - "path", - "state", - "url", - "html_url", - "badge_url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", - "title": "Disable a workflow", - "category": "actions", - "subcategory": "workflows", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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" - } - ] - } - } - ], - "bodyParameters": [], - "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

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "workflow_id": "WORKFLOW_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", - "title": "Create a workflow dispatch event", - "category": "actions", - "subcategory": "workflows", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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" - } - ] - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "ref", - "description": "

The git reference for the workflow. The reference can be a branch or tag name.

", - "isRequired": true - }, - { - "type": "object", - "name": "inputs", - "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.

" - } - ], - "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

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "ref": "topic-branch", - "inputs": { - "name": "Mona the Octocat", - "home": "San Francisco, CA" - } - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "workflow_id": "WORKFLOW_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", - "title": "Enable a workflow", - "category": "actions", - "subcategory": "workflows", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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" - } - ] - } - } - ], - "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

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "workflow_id": "WORKFLOW_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "write" - } - ] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/activity.json b/src/rest/data/ghes-3.14-2022-11-28/activity.json deleted file mode 100644 index af2935ff53cd..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/activity.json +++ /dev/null @@ -1,175053 +0,0 @@ -{ - "events": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/events", - "title": "List public events", - "category": "activity", - "subcategory": "events", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": "22249084947", - "type": "WatchEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octocat/Hello-World", - "url": "https://api.github.com/repos/octocat/Hello-World" - }, - "payload": { - "action": "started" - }, - "public": true, - "created_at": "2022-06-09T12:47:28Z" - }, - { - "id": "22249084964", - "type": "PushEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octocat/Hello-World", - "url": "https://api.github.com/repos/octocat/Hello-World" - }, - "payload": { - "repository_id": 1296269, - "push_id": 10115855396, - "size": 1, - "distinct_size": 1, - "ref": "refs/heads/master", - "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "before": "883efe034920928c47fe18598c01249d1a9fdabd", - "commits": [ - { - "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "author": { - "email": "octocat@github.com", - "name": "Monalisa Octocat" - }, - "message": "commit", - "distinct": true, - "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" - } - ] - }, - "public": true, - "created_at": "2022-06-07T07:50:26Z" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Event", - "description": "Event", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": [ - "string", - "null" - ] - }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "payload": { - "oneOf": [ - { - "title": "CreateEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "master_branch": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "master_branch", - "pusher_type" - ] - }, - { - "title": "DeleteEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "pusher_type" - ] - }, - { - "title": "IssuesEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "issue" - ] - }, - { - "title": "IssueCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - }, - "required": [ - "action", - "issue", - "comment" - ] - }, - { - "title": "ForkEvent", - "type": "object", - "properties": { - "forkee": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "private": { - "type": "boolean" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "html_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "git_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "forks_count": { - "type": "integer" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "open_issues_count": { - "type": "integer" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "visibility": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "public": { - "type": "boolean" - } - } - } - }, - "required": [ - "forkee" - ] - }, - { - "title": "GollumEvent", - "type": "object", - "properties": { - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": [ - "string", - "null" - ] - }, - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - } - } - }, - "required": [ - "pages" - ] - }, - { - "title": "MemberEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "member": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "action", - "member" - ] - }, - { - "title": "PublicEvent", - "type": "object" - }, - { - "title": "PushEvent", - "type": "object", - "properties": { - "repository_id": { - "type": "integer" - }, - "push_id": { - "type": "integer" - }, - "ref": { - "type": "string" - }, - "head": { - "type": "string" - }, - "before": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "distinct_size": { - "type": "integer" - }, - "commits": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "message": { - "type": "string" - }, - "author": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - } - }, - "url": { - "type": "string", - "format": "uri" - }, - "distinct": { - "type": "boolean" - } - } - } - } - }, - "required": [ - "repository_id", - "push_id", - "ref", - "head", - "before" - ] - }, - { - "title": "PullRequestEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "number", - "pull_request" - ] - }, - { - "title": "PullRequestReviewCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - }, - "comment": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "pull_request_review_id": { - "type": [ - "integer", - "null" - ] - }, - "diff_hunk": { - "type": "string" - }, - "path": { - "type": "string" - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "original_position": { - "type": [ - "integer", - "null" - ] - }, - "subject_type": { - "type": [ - "string", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "title": "User", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - } - }, - "body": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "original_commit_id": { - "type": "string" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "in_reply_to_id": { - "type": "integer" - }, - "author_association": { - "type": "string" - }, - "start_line": { - "type": [ - "integer", - "null" - ] - }, - "original_start_line": { - "type": [ - "integer", - "null" - ] - }, - "start_side": { - "type": [ - "string", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "original_line": { - "type": [ - "integer", - "null" - ] - }, - "side": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "url", - "pull_request_review_id", - "id", - "node_id", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "_links", - "reactions" - ] - } - }, - "required": [ - "action", - "comment", - "pull_request" - ] - }, - { - "title": "PullRequestReviewEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "review": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "type": "string" - }, - "commit_id": { - "type": "string" - }, - "submitted_at": { - "type": [ - "string", - "null" - ] - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "updated_at": { - "type": "string" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - } - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - } - }, - "required": [ - "action", - "review", - "pull_request" - ] - }, - { - "title": "CommitCommentEvent", - "type": "object", - "properties": { - "comment": { - "type": "object", - "properties": { - "html_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "body": { - "type": "string" - }, - "path": { - "type": [ - "string", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - } - } - }, - "required": [ - "comment" - ] - }, - { - "title": "ReleaseEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "release": { - "allOf": [ - { - "title": "Release", - "description": "A release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "assets_url": { - "type": "string", - "format": "uri" - }, - "upload_url": { - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "draft": { - "description": "true to create a draft (unpublished) release, false to create a published one.", - "type": "boolean" - }, - "prerelease": { - "description": "Whether to identify the release as a prerelease or a full release.", - "type": "boolean" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "mentions_count": { - "type": "integer" - }, - "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": [ - "assets_url", - "upload_url", - "tarball_url", - "zipball_url", - "created_at", - "published_at", - "draft", - "id", - "node_id", - "author", - "html_url", - "name", - "prerelease", - "tag_name", - "target_commitish", - "assets", - "url" - ] - }, - { - "type": "object", - "properties": { - "is_short_description_html_truncated": { - "type": "boolean" - }, - "short_description_html": { - "type": "string" - } - } - } - ] - } - }, - "required": [ - "action", - "release" - ] - }, - { - "title": "WatchEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - } - }, - "required": [ - "action" - ] - } - ] - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/networks/{owner}/{repo}/events", - "title": "List public events for a network of repositories", - "category": "activity", - "subcategory": "events", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": "22249084964", - "type": "PushEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octocat/Hello-World", - "url": "https://api.github.com/repos/octocat/Hello-World" - }, - "payload": { - "repository_id": 1296269, - "push_id": 10115855396, - "size": 1, - "distinct_size": 1, - "ref": "refs/heads/master", - "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "before": "883efe034920928c47fe18598c01249d1a9fdabd", - "commits": [ - { - "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "author": { - "email": "octocat@github.com", - "name": "Monalisa Octocat" - }, - "message": "commit", - "distinct": true, - "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" - } - ] - }, - "public": true, - "created_at": "2022-06-09T12:47:28Z" - }, - { - "id": "22237752260", - "type": "WatchEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octocat/Hello-World", - "url": "https://api.github.com/repos/octocat/Hello-World" - }, - "payload": { - "action": "started" - }, - "public": true, - "created_at": "2022-06-08T23:29:25Z" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Event", - "description": "Event", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": [ - "string", - "null" - ] - }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "payload": { - "oneOf": [ - { - "title": "CreateEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "master_branch": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "master_branch", - "pusher_type" - ] - }, - { - "title": "DeleteEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "pusher_type" - ] - }, - { - "title": "IssuesEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "issue" - ] - }, - { - "title": "IssueCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - }, - "required": [ - "action", - "issue", - "comment" - ] - }, - { - "title": "ForkEvent", - "type": "object", - "properties": { - "forkee": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "private": { - "type": "boolean" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "html_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "git_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "forks_count": { - "type": "integer" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "open_issues_count": { - "type": "integer" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "visibility": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "public": { - "type": "boolean" - } - } - } - }, - "required": [ - "forkee" - ] - }, - { - "title": "GollumEvent", - "type": "object", - "properties": { - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": [ - "string", - "null" - ] - }, - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - } - } - }, - "required": [ - "pages" - ] - }, - { - "title": "MemberEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "member": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "action", - "member" - ] - }, - { - "title": "PublicEvent", - "type": "object" - }, - { - "title": "PushEvent", - "type": "object", - "properties": { - "repository_id": { - "type": "integer" - }, - "push_id": { - "type": "integer" - }, - "ref": { - "type": "string" - }, - "head": { - "type": "string" - }, - "before": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "distinct_size": { - "type": "integer" - }, - "commits": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "message": { - "type": "string" - }, - "author": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - } - }, - "url": { - "type": "string", - "format": "uri" - }, - "distinct": { - "type": "boolean" - } - } - } - } - }, - "required": [ - "repository_id", - "push_id", - "ref", - "head", - "before" - ] - }, - { - "title": "PullRequestEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "number", - "pull_request" - ] - }, - { - "title": "PullRequestReviewCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - }, - "comment": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "pull_request_review_id": { - "type": [ - "integer", - "null" - ] - }, - "diff_hunk": { - "type": "string" - }, - "path": { - "type": "string" - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "original_position": { - "type": [ - "integer", - "null" - ] - }, - "subject_type": { - "type": [ - "string", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "title": "User", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - } - }, - "body": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "original_commit_id": { - "type": "string" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "in_reply_to_id": { - "type": "integer" - }, - "author_association": { - "type": "string" - }, - "start_line": { - "type": [ - "integer", - "null" - ] - }, - "original_start_line": { - "type": [ - "integer", - "null" - ] - }, - "start_side": { - "type": [ - "string", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "original_line": { - "type": [ - "integer", - "null" - ] - }, - "side": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "url", - "pull_request_review_id", - "id", - "node_id", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "_links", - "reactions" - ] - } - }, - "required": [ - "action", - "comment", - "pull_request" - ] - }, - { - "title": "PullRequestReviewEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "review": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "type": "string" - }, - "commit_id": { - "type": "string" - }, - "submitted_at": { - "type": [ - "string", - "null" - ] - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "updated_at": { - "type": "string" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - } - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - } - }, - "required": [ - "action", - "review", - "pull_request" - ] - }, - { - "title": "CommitCommentEvent", - "type": "object", - "properties": { - "comment": { - "type": "object", - "properties": { - "html_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "body": { - "type": "string" - }, - "path": { - "type": [ - "string", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - } - } - }, - "required": [ - "comment" - ] - }, - { - "title": "ReleaseEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "release": { - "allOf": [ - { - "title": "Release", - "description": "A release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "assets_url": { - "type": "string", - "format": "uri" - }, - "upload_url": { - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "draft": { - "description": "true to create a draft (unpublished) release, false to create a published one.", - "type": "boolean" - }, - "prerelease": { - "description": "Whether to identify the release as a prerelease or a full release.", - "type": "boolean" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "mentions_count": { - "type": "integer" - }, - "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": [ - "assets_url", - "upload_url", - "tarball_url", - "zipball_url", - "created_at", - "published_at", - "draft", - "id", - "node_id", - "author", - "html_url", - "name", - "prerelease", - "tag_name", - "target_commitish", - "assets", - "url" - ] - }, - { - "type": "object", - "properties": { - "is_short_description_html_truncated": { - "type": "boolean" - }, - "short_description_html": { - "type": "string" - } - } - } - ] - } - }, - "required": [ - "action", - "release" - ] - }, - { - "title": "WatchEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - } - }, - "required": [ - "action" - ] - } - ] - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/events", - "title": "List public organization events", - "category": "activity", - "subcategory": "events", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": "22237752260", - "type": "WatchEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octo-org/octo-repo", - "url": "https://api.github.com/repos/octo-org/octo-repo" - }, - "payload": { - "action": "started" - }, - "public": true, - "created_at": "2022-06-08T23:29:25Z", - "org": { - "id": 9919, - "login": "octo-org", - "gravatar_id": "", - "url": "https://api.github.com/orgs/octo-org", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?" - } - }, - { - "id": "22249084964", - "type": "PushEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octo-org/octo-repo", - "url": "https://api.github.com/repos/octo-org/octo-repo" - }, - "payload": { - "repository_id": 1296269, - "push_id": 10115855396, - "size": 1, - "distinct_size": 1, - "ref": "refs/heads/master", - "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "before": "883efe034920928c47fe18598c01249d1a9fdabd", - "commits": [ - { - "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "author": { - "email": "octocat@github.com", - "name": "Monalisa Octocat" - }, - "message": "commit", - "distinct": true, - "url": "https://api.github.com/repos/octo-org/octo-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" - } - ] - }, - "public": true, - "created_at": "2022-06-09T12:47:28Z", - "org": { - "id": 9919, - "login": "octo-org", - "gravatar_id": "", - "url": "https://api.github.com/orgs/octo-org", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?" - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Event", - "description": "Event", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": [ - "string", - "null" - ] - }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "payload": { - "oneOf": [ - { - "title": "CreateEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "master_branch": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "master_branch", - "pusher_type" - ] - }, - { - "title": "DeleteEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "pusher_type" - ] - }, - { - "title": "IssuesEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "issue" - ] - }, - { - "title": "IssueCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - }, - "required": [ - "action", - "issue", - "comment" - ] - }, - { - "title": "ForkEvent", - "type": "object", - "properties": { - "forkee": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "private": { - "type": "boolean" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "html_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "git_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "forks_count": { - "type": "integer" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "open_issues_count": { - "type": "integer" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "visibility": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "public": { - "type": "boolean" - } - } - } - }, - "required": [ - "forkee" - ] - }, - { - "title": "GollumEvent", - "type": "object", - "properties": { - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": [ - "string", - "null" - ] - }, - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - } - } - }, - "required": [ - "pages" - ] - }, - { - "title": "MemberEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "member": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "action", - "member" - ] - }, - { - "title": "PublicEvent", - "type": "object" - }, - { - "title": "PushEvent", - "type": "object", - "properties": { - "repository_id": { - "type": "integer" - }, - "push_id": { - "type": "integer" - }, - "ref": { - "type": "string" - }, - "head": { - "type": "string" - }, - "before": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "distinct_size": { - "type": "integer" - }, - "commits": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "message": { - "type": "string" - }, - "author": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - } - }, - "url": { - "type": "string", - "format": "uri" - }, - "distinct": { - "type": "boolean" - } - } - } - } - }, - "required": [ - "repository_id", - "push_id", - "ref", - "head", - "before" - ] - }, - { - "title": "PullRequestEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "number", - "pull_request" - ] - }, - { - "title": "PullRequestReviewCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - }, - "comment": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "pull_request_review_id": { - "type": [ - "integer", - "null" - ] - }, - "diff_hunk": { - "type": "string" - }, - "path": { - "type": "string" - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "original_position": { - "type": [ - "integer", - "null" - ] - }, - "subject_type": { - "type": [ - "string", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "title": "User", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - } - }, - "body": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "original_commit_id": { - "type": "string" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "in_reply_to_id": { - "type": "integer" - }, - "author_association": { - "type": "string" - }, - "start_line": { - "type": [ - "integer", - "null" - ] - }, - "original_start_line": { - "type": [ - "integer", - "null" - ] - }, - "start_side": { - "type": [ - "string", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "original_line": { - "type": [ - "integer", - "null" - ] - }, - "side": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "url", - "pull_request_review_id", - "id", - "node_id", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "_links", - "reactions" - ] - } - }, - "required": [ - "action", - "comment", - "pull_request" - ] - }, - { - "title": "PullRequestReviewEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "review": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "type": "string" - }, - "commit_id": { - "type": "string" - }, - "submitted_at": { - "type": [ - "string", - "null" - ] - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "updated_at": { - "type": "string" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - } - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - } - }, - "required": [ - "action", - "review", - "pull_request" - ] - }, - { - "title": "CommitCommentEvent", - "type": "object", - "properties": { - "comment": { - "type": "object", - "properties": { - "html_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "body": { - "type": "string" - }, - "path": { - "type": [ - "string", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - } - } - }, - "required": [ - "comment" - ] - }, - { - "title": "ReleaseEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "release": { - "allOf": [ - { - "title": "Release", - "description": "A release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "assets_url": { - "type": "string", - "format": "uri" - }, - "upload_url": { - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "draft": { - "description": "true to create a draft (unpublished) release, false to create a published one.", - "type": "boolean" - }, - "prerelease": { - "description": "Whether to identify the release as a prerelease or a full release.", - "type": "boolean" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "mentions_count": { - "type": "integer" - }, - "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": [ - "assets_url", - "upload_url", - "tarball_url", - "zipball_url", - "created_at", - "published_at", - "draft", - "id", - "node_id", - "author", - "html_url", - "name", - "prerelease", - "tag_name", - "target_commitish", - "assets", - "url" - ] - }, - { - "type": "object", - "properties": { - "is_short_description_html_truncated": { - "type": "boolean" - }, - "short_description_html": { - "type": "string" - } - } - } - ] - } - }, - "required": [ - "action", - "release" - ] - }, - { - "title": "WatchEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - } - }, - "required": [ - "action" - ] - } - ] - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/events", - "title": "List repository events", - "category": "activity", - "subcategory": "events", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": "22249084964", - "type": "PushEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octocat/Hello-World", - "url": "https://api.github.com/repos/octocat/Hello-World" - }, - "payload": { - "repository_id": 1296269, - "push_id": 10115855396, - "size": 1, - "distinct_size": 1, - "ref": "refs/heads/master", - "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "before": "883efe034920928c47fe18598c01249d1a9fdabd", - "commits": [ - { - "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "author": { - "email": "octocat@github.com", - "name": "Monalisa Octocat" - }, - "message": "commit", - "distinct": true, - "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" - } - ] - }, - "public": true, - "created_at": "2022-06-09T12:47:28Z" - }, - { - "id": "22237752260", - "type": "WatchEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octocat/Hello-World", - "url": "https://api.github.com/repos/octocat/Hello-World" - }, - "payload": { - "action": "started" - }, - "public": true, - "created_at": "2022-06-08T23:29:25Z" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Event", - "description": "Event", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": [ - "string", - "null" - ] - }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "payload": { - "oneOf": [ - { - "title": "CreateEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "master_branch": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "master_branch", - "pusher_type" - ] - }, - { - "title": "DeleteEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "pusher_type" - ] - }, - { - "title": "IssuesEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "issue" - ] - }, - { - "title": "IssueCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - }, - "required": [ - "action", - "issue", - "comment" - ] - }, - { - "title": "ForkEvent", - "type": "object", - "properties": { - "forkee": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "private": { - "type": "boolean" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "html_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "git_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "forks_count": { - "type": "integer" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "open_issues_count": { - "type": "integer" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "visibility": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "public": { - "type": "boolean" - } - } - } - }, - "required": [ - "forkee" - ] - }, - { - "title": "GollumEvent", - "type": "object", - "properties": { - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": [ - "string", - "null" - ] - }, - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - } - } - }, - "required": [ - "pages" - ] - }, - { - "title": "MemberEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "member": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "action", - "member" - ] - }, - { - "title": "PublicEvent", - "type": "object" - }, - { - "title": "PushEvent", - "type": "object", - "properties": { - "repository_id": { - "type": "integer" - }, - "push_id": { - "type": "integer" - }, - "ref": { - "type": "string" - }, - "head": { - "type": "string" - }, - "before": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "distinct_size": { - "type": "integer" - }, - "commits": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "message": { - "type": "string" - }, - "author": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - } - }, - "url": { - "type": "string", - "format": "uri" - }, - "distinct": { - "type": "boolean" - } - } - } - } - }, - "required": [ - "repository_id", - "push_id", - "ref", - "head", - "before" - ] - }, - { - "title": "PullRequestEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "number", - "pull_request" - ] - }, - { - "title": "PullRequestReviewCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - }, - "comment": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "pull_request_review_id": { - "type": [ - "integer", - "null" - ] - }, - "diff_hunk": { - "type": "string" - }, - "path": { - "type": "string" - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "original_position": { - "type": [ - "integer", - "null" - ] - }, - "subject_type": { - "type": [ - "string", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "title": "User", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - } - }, - "body": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "original_commit_id": { - "type": "string" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "in_reply_to_id": { - "type": "integer" - }, - "author_association": { - "type": "string" - }, - "start_line": { - "type": [ - "integer", - "null" - ] - }, - "original_start_line": { - "type": [ - "integer", - "null" - ] - }, - "start_side": { - "type": [ - "string", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "original_line": { - "type": [ - "integer", - "null" - ] - }, - "side": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "url", - "pull_request_review_id", - "id", - "node_id", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "_links", - "reactions" - ] - } - }, - "required": [ - "action", - "comment", - "pull_request" - ] - }, - { - "title": "PullRequestReviewEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "review": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "type": "string" - }, - "commit_id": { - "type": "string" - }, - "submitted_at": { - "type": [ - "string", - "null" - ] - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "updated_at": { - "type": "string" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - } - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - } - }, - "required": [ - "action", - "review", - "pull_request" - ] - }, - { - "title": "CommitCommentEvent", - "type": "object", - "properties": { - "comment": { - "type": "object", - "properties": { - "html_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "body": { - "type": "string" - }, - "path": { - "type": [ - "string", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - } - } - }, - "required": [ - "comment" - ] - }, - { - "title": "ReleaseEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "release": { - "allOf": [ - { - "title": "Release", - "description": "A release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "assets_url": { - "type": "string", - "format": "uri" - }, - "upload_url": { - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "draft": { - "description": "true to create a draft (unpublished) release, false to create a published one.", - "type": "boolean" - }, - "prerelease": { - "description": "Whether to identify the release as a prerelease or a full release.", - "type": "boolean" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "mentions_count": { - "type": "integer" - }, - "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": [ - "assets_url", - "upload_url", - "tarball_url", - "zipball_url", - "created_at", - "published_at", - "draft", - "id", - "node_id", - "author", - "html_url", - "name", - "prerelease", - "tag_name", - "target_commitish", - "assets", - "url" - ] - }, - { - "type": "object", - "properties": { - "is_short_description_html_truncated": { - "type": "boolean" - }, - "short_description_html": { - "type": "string" - } - } - } - ] - } - }, - "required": [ - "action", - "release" - ] - }, - { - "title": "WatchEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - } - }, - "required": [ - "action" - ] - } - ] - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/events", - "title": "List events for the authenticated user", - "category": "activity", - "subcategory": "events", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).

\n

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": "22249084947", - "type": "WatchEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octocat/Hello-World", - "url": "https://api.github.com/repos/octocat/Hello-World" - }, - "payload": { - "action": "started" - }, - "public": true, - "created_at": "2022-06-09T12:47:28Z" - }, - { - "id": "22249084964", - "type": "PushEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octocat/Hello-World", - "url": "https://api.github.com/repos/octocat/Hello-World" - }, - "payload": { - "repository_id": 1296269, - "push_id": 10115855396, - "size": 1, - "distinct_size": 1, - "ref": "refs/heads/master", - "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "before": "883efe034920928c47fe18598c01249d1a9fdabd", - "commits": [ - { - "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "author": { - "email": "octocat@github.com", - "name": "Monalisa Octocat" - }, - "message": "commit", - "distinct": true, - "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" - } - ] - }, - "public": false, - "created_at": "2022-06-07T07:50:26Z" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Event", - "description": "Event", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": [ - "string", - "null" - ] - }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "payload": { - "oneOf": [ - { - "title": "CreateEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "master_branch": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "master_branch", - "pusher_type" - ] - }, - { - "title": "DeleteEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "pusher_type" - ] - }, - { - "title": "IssuesEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "issue" - ] - }, - { - "title": "IssueCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - }, - "required": [ - "action", - "issue", - "comment" - ] - }, - { - "title": "ForkEvent", - "type": "object", - "properties": { - "forkee": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "private": { - "type": "boolean" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "html_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "git_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "forks_count": { - "type": "integer" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "open_issues_count": { - "type": "integer" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "visibility": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "public": { - "type": "boolean" - } - } - } - }, - "required": [ - "forkee" - ] - }, - { - "title": "GollumEvent", - "type": "object", - "properties": { - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": [ - "string", - "null" - ] - }, - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - } - } - }, - "required": [ - "pages" - ] - }, - { - "title": "MemberEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "member": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "action", - "member" - ] - }, - { - "title": "PublicEvent", - "type": "object" - }, - { - "title": "PushEvent", - "type": "object", - "properties": { - "repository_id": { - "type": "integer" - }, - "push_id": { - "type": "integer" - }, - "ref": { - "type": "string" - }, - "head": { - "type": "string" - }, - "before": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "distinct_size": { - "type": "integer" - }, - "commits": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "message": { - "type": "string" - }, - "author": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - } - }, - "url": { - "type": "string", - "format": "uri" - }, - "distinct": { - "type": "boolean" - } - } - } - } - }, - "required": [ - "repository_id", - "push_id", - "ref", - "head", - "before" - ] - }, - { - "title": "PullRequestEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "number", - "pull_request" - ] - }, - { - "title": "PullRequestReviewCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - }, - "comment": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "pull_request_review_id": { - "type": [ - "integer", - "null" - ] - }, - "diff_hunk": { - "type": "string" - }, - "path": { - "type": "string" - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "original_position": { - "type": [ - "integer", - "null" - ] - }, - "subject_type": { - "type": [ - "string", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "title": "User", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - } - }, - "body": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "original_commit_id": { - "type": "string" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "in_reply_to_id": { - "type": "integer" - }, - "author_association": { - "type": "string" - }, - "start_line": { - "type": [ - "integer", - "null" - ] - }, - "original_start_line": { - "type": [ - "integer", - "null" - ] - }, - "start_side": { - "type": [ - "string", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "original_line": { - "type": [ - "integer", - "null" - ] - }, - "side": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "url", - "pull_request_review_id", - "id", - "node_id", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "_links", - "reactions" - ] - } - }, - "required": [ - "action", - "comment", - "pull_request" - ] - }, - { - "title": "PullRequestReviewEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "review": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "type": "string" - }, - "commit_id": { - "type": "string" - }, - "submitted_at": { - "type": [ - "string", - "null" - ] - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "updated_at": { - "type": "string" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - } - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - } - }, - "required": [ - "action", - "review", - "pull_request" - ] - }, - { - "title": "CommitCommentEvent", - "type": "object", - "properties": { - "comment": { - "type": "object", - "properties": { - "html_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "body": { - "type": "string" - }, - "path": { - "type": [ - "string", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - } - } - }, - "required": [ - "comment" - ] - }, - { - "title": "ReleaseEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "release": { - "allOf": [ - { - "title": "Release", - "description": "A release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "assets_url": { - "type": "string", - "format": "uri" - }, - "upload_url": { - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "draft": { - "description": "true to create a draft (unpublished) release, false to create a published one.", - "type": "boolean" - }, - "prerelease": { - "description": "Whether to identify the release as a prerelease or a full release.", - "type": "boolean" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "mentions_count": { - "type": "integer" - }, - "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": [ - "assets_url", - "upload_url", - "tarball_url", - "zipball_url", - "created_at", - "published_at", - "draft", - "id", - "node_id", - "author", - "html_url", - "name", - "prerelease", - "tag_name", - "target_commitish", - "assets", - "url" - ] - }, - { - "type": "object", - "properties": { - "is_short_description_html_truncated": { - "type": "boolean" - }, - "short_description_html": { - "type": "string" - } - } - } - ] - } - }, - "required": [ - "action", - "release" - ] - }, - { - "title": "WatchEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - } - }, - "required": [ - "action" - ] - } - ] - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/events/orgs/{org}", - "title": "List organization events for the authenticated user", - "category": "activity", - "subcategory": "events", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

This is the user's organization dashboard. You must be authenticated as the user to view this.

\n

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME", - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": "22249084964", - "type": "PushEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octo-org/octo-repo", - "url": "https://api.github.com/repos/octo-org/octo-repo" - }, - "payload": { - "repository_id": 1296269, - "push_id": 10115855396, - "size": 1, - "distinct_size": 1, - "ref": "refs/heads/master", - "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "before": "883efe034920928c47fe18598c01249d1a9fdabd", - "commits": [ - { - "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "author": { - "email": "octocat@github.com", - "name": "Monalisa Octocat" - }, - "message": "commit", - "distinct": true, - "url": "https://api.github.com/repos/octo-org/octo-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" - } - ] - }, - "public": false, - "created_at": "2022-06-09T12:47:28Z", - "org": { - "id": 9919, - "login": "octo-org", - "gravatar_id": "", - "url": "https://api.github.com/orgs/octo-org", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?" - } - }, - { - "id": "22196946742", - "type": "CreateEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octo-org/octo-repo", - "url": "https://api.github.com/repos/octo-org/octo-repo" - }, - "payload": { - "ref": "master", - "ref_type": "repository", - "master_branch": "master", - "description": null, - "pusher_type": "user" - }, - "public": false, - "created_at": "2022-06-07T07:50:26Z", - "org": { - "id": 9919, - "login": "octo-org", - "gravatar_id": "", - "url": "https://api.github.com/orgs/octo-org", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?" - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Event", - "description": "Event", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": [ - "string", - "null" - ] - }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "payload": { - "oneOf": [ - { - "title": "CreateEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "master_branch": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "master_branch", - "pusher_type" - ] - }, - { - "title": "DeleteEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "pusher_type" - ] - }, - { - "title": "IssuesEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "issue" - ] - }, - { - "title": "IssueCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - }, - "required": [ - "action", - "issue", - "comment" - ] - }, - { - "title": "ForkEvent", - "type": "object", - "properties": { - "forkee": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "private": { - "type": "boolean" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "html_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "git_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "forks_count": { - "type": "integer" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "open_issues_count": { - "type": "integer" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "visibility": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "public": { - "type": "boolean" - } - } - } - }, - "required": [ - "forkee" - ] - }, - { - "title": "GollumEvent", - "type": "object", - "properties": { - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": [ - "string", - "null" - ] - }, - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - } - } - }, - "required": [ - "pages" - ] - }, - { - "title": "MemberEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "member": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "action", - "member" - ] - }, - { - "title": "PublicEvent", - "type": "object" - }, - { - "title": "PushEvent", - "type": "object", - "properties": { - "repository_id": { - "type": "integer" - }, - "push_id": { - "type": "integer" - }, - "ref": { - "type": "string" - }, - "head": { - "type": "string" - }, - "before": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "distinct_size": { - "type": "integer" - }, - "commits": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "message": { - "type": "string" - }, - "author": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - } - }, - "url": { - "type": "string", - "format": "uri" - }, - "distinct": { - "type": "boolean" - } - } - } - } - }, - "required": [ - "repository_id", - "push_id", - "ref", - "head", - "before" - ] - }, - { - "title": "PullRequestEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "number", - "pull_request" - ] - }, - { - "title": "PullRequestReviewCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - }, - "comment": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "pull_request_review_id": { - "type": [ - "integer", - "null" - ] - }, - "diff_hunk": { - "type": "string" - }, - "path": { - "type": "string" - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "original_position": { - "type": [ - "integer", - "null" - ] - }, - "subject_type": { - "type": [ - "string", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "title": "User", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - } - }, - "body": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "original_commit_id": { - "type": "string" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "in_reply_to_id": { - "type": "integer" - }, - "author_association": { - "type": "string" - }, - "start_line": { - "type": [ - "integer", - "null" - ] - }, - "original_start_line": { - "type": [ - "integer", - "null" - ] - }, - "start_side": { - "type": [ - "string", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "original_line": { - "type": [ - "integer", - "null" - ] - }, - "side": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "url", - "pull_request_review_id", - "id", - "node_id", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "_links", - "reactions" - ] - } - }, - "required": [ - "action", - "comment", - "pull_request" - ] - }, - { - "title": "PullRequestReviewEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "review": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "type": "string" - }, - "commit_id": { - "type": "string" - }, - "submitted_at": { - "type": [ - "string", - "null" - ] - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "updated_at": { - "type": "string" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - } - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - } - }, - "required": [ - "action", - "review", - "pull_request" - ] - }, - { - "title": "CommitCommentEvent", - "type": "object", - "properties": { - "comment": { - "type": "object", - "properties": { - "html_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "body": { - "type": "string" - }, - "path": { - "type": [ - "string", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - } - } - }, - "required": [ - "comment" - ] - }, - { - "title": "ReleaseEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "release": { - "allOf": [ - { - "title": "Release", - "description": "A release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "assets_url": { - "type": "string", - "format": "uri" - }, - "upload_url": { - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "draft": { - "description": "true to create a draft (unpublished) release, false to create a published one.", - "type": "boolean" - }, - "prerelease": { - "description": "Whether to identify the release as a prerelease or a full release.", - "type": "boolean" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "mentions_count": { - "type": "integer" - }, - "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": [ - "assets_url", - "upload_url", - "tarball_url", - "zipball_url", - "created_at", - "published_at", - "draft", - "id", - "node_id", - "author", - "html_url", - "name", - "prerelease", - "tag_name", - "target_commitish", - "assets", - "url" - ] - }, - { - "type": "object", - "properties": { - "is_short_description_html_truncated": { - "type": "boolean" - }, - "short_description_html": { - "type": "string" - } - } - } - ] - } - }, - "required": [ - "action", - "release" - ] - }, - { - "title": "WatchEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - } - }, - "required": [ - "action" - ] - } - ] - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Events\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/events/public", - "title": "List public events for a user", - "category": "activity", - "subcategory": "events", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": "22249084947", - "type": "WatchEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octocat/Hello-World", - "url": "https://api.github.com/repos/octocat/Hello-World" - }, - "payload": { - "action": "started" - }, - "public": true, - "created_at": "2022-06-09T12:47:28Z" - }, - { - "id": "22249084964", - "type": "PushEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octocat/Hello-World", - "url": "https://api.github.com/repos/octocat/Hello-World" - }, - "payload": { - "repository_id": 1296269, - "push_id": 10115855396, - "size": 1, - "distinct_size": 1, - "ref": "refs/heads/master", - "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "before": "883efe034920928c47fe18598c01249d1a9fdabd", - "commits": [ - { - "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "author": { - "email": "octocat@github.com", - "name": "Monalisa Octocat" - }, - "message": "commit", - "distinct": true, - "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" - } - ] - }, - "public": true, - "created_at": "2022-06-08T23:29:25Z" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Event", - "description": "Event", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": [ - "string", - "null" - ] - }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "payload": { - "oneOf": [ - { - "title": "CreateEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "master_branch": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "master_branch", - "pusher_type" - ] - }, - { - "title": "DeleteEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "pusher_type" - ] - }, - { - "title": "IssuesEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "issue" - ] - }, - { - "title": "IssueCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - }, - "required": [ - "action", - "issue", - "comment" - ] - }, - { - "title": "ForkEvent", - "type": "object", - "properties": { - "forkee": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "private": { - "type": "boolean" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "html_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "git_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "forks_count": { - "type": "integer" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "open_issues_count": { - "type": "integer" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "visibility": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "public": { - "type": "boolean" - } - } - } - }, - "required": [ - "forkee" - ] - }, - { - "title": "GollumEvent", - "type": "object", - "properties": { - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": [ - "string", - "null" - ] - }, - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - } - } - }, - "required": [ - "pages" - ] - }, - { - "title": "MemberEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "member": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "action", - "member" - ] - }, - { - "title": "PublicEvent", - "type": "object" - }, - { - "title": "PushEvent", - "type": "object", - "properties": { - "repository_id": { - "type": "integer" - }, - "push_id": { - "type": "integer" - }, - "ref": { - "type": "string" - }, - "head": { - "type": "string" - }, - "before": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "distinct_size": { - "type": "integer" - }, - "commits": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "message": { - "type": "string" - }, - "author": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - } - }, - "url": { - "type": "string", - "format": "uri" - }, - "distinct": { - "type": "boolean" - } - } - } - } - }, - "required": [ - "repository_id", - "push_id", - "ref", - "head", - "before" - ] - }, - { - "title": "PullRequestEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "number", - "pull_request" - ] - }, - { - "title": "PullRequestReviewCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - }, - "comment": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "pull_request_review_id": { - "type": [ - "integer", - "null" - ] - }, - "diff_hunk": { - "type": "string" - }, - "path": { - "type": "string" - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "original_position": { - "type": [ - "integer", - "null" - ] - }, - "subject_type": { - "type": [ - "string", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "title": "User", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - } - }, - "body": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "original_commit_id": { - "type": "string" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "in_reply_to_id": { - "type": "integer" - }, - "author_association": { - "type": "string" - }, - "start_line": { - "type": [ - "integer", - "null" - ] - }, - "original_start_line": { - "type": [ - "integer", - "null" - ] - }, - "start_side": { - "type": [ - "string", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "original_line": { - "type": [ - "integer", - "null" - ] - }, - "side": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "url", - "pull_request_review_id", - "id", - "node_id", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "_links", - "reactions" - ] - } - }, - "required": [ - "action", - "comment", - "pull_request" - ] - }, - { - "title": "PullRequestReviewEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "review": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "type": "string" - }, - "commit_id": { - "type": "string" - }, - "submitted_at": { - "type": [ - "string", - "null" - ] - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "updated_at": { - "type": "string" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - } - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - } - }, - "required": [ - "action", - "review", - "pull_request" - ] - }, - { - "title": "CommitCommentEvent", - "type": "object", - "properties": { - "comment": { - "type": "object", - "properties": { - "html_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "body": { - "type": "string" - }, - "path": { - "type": [ - "string", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - } - } - }, - "required": [ - "comment" - ] - }, - { - "title": "ReleaseEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "release": { - "allOf": [ - { - "title": "Release", - "description": "A release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "assets_url": { - "type": "string", - "format": "uri" - }, - "upload_url": { - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "draft": { - "description": "true to create a draft (unpublished) release, false to create a published one.", - "type": "boolean" - }, - "prerelease": { - "description": "Whether to identify the release as a prerelease or a full release.", - "type": "boolean" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "mentions_count": { - "type": "integer" - }, - "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": [ - "assets_url", - "upload_url", - "tarball_url", - "zipball_url", - "created_at", - "published_at", - "draft", - "id", - "node_id", - "author", - "html_url", - "name", - "prerelease", - "tag_name", - "target_commitish", - "assets", - "url" - ] - }, - { - "type": "object", - "properties": { - "is_short_description_html_truncated": { - "type": "boolean" - }, - "short_description_html": { - "type": "string" - } - } - } - ] - } - }, - "required": [ - "action", - "release" - ] - }, - { - "title": "WatchEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - } - }, - "required": [ - "action" - ] - } - ] - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/received_events", - "title": "List events received by the authenticated user", - "category": "activity", - "subcategory": "events", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.

\n

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": "22249084964", - "type": "PushEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octocat/Hello-World", - "url": "https://api.github.com/repos/octocat/Hello-World" - }, - "payload": { - "repository_id": 1296269, - "push_id": 10115855396, - "size": 1, - "distinct_size": 1, - "ref": "refs/heads/master", - "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "before": "883efe034920928c47fe18598c01249d1a9fdabd", - "commits": [ - { - "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "author": { - "email": "octocat@github.com", - "name": "Monalisa Octocat" - }, - "message": "commit", - "distinct": true, - "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" - } - ] - }, - "public": true, - "created_at": "2022-06-09T12:47:28Z" - }, - { - "id": "22196946742", - "type": "CreateEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octocat/Hello-World", - "url": "https://api.github.com/repos/octocat/Hello-World" - }, - "payload": { - "ref": "master", - "ref_type": "repository", - "master_branch": "master", - "description": null, - "pusher_type": "user" - }, - "public": false, - "created_at": "2022-06-07T07:50:26Z" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Event", - "description": "Event", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": [ - "string", - "null" - ] - }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "payload": { - "oneOf": [ - { - "title": "CreateEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "master_branch": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "master_branch", - "pusher_type" - ] - }, - { - "title": "DeleteEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "pusher_type" - ] - }, - { - "title": "IssuesEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "issue" - ] - }, - { - "title": "IssueCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - }, - "required": [ - "action", - "issue", - "comment" - ] - }, - { - "title": "ForkEvent", - "type": "object", - "properties": { - "forkee": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "private": { - "type": "boolean" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "html_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "git_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "forks_count": { - "type": "integer" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "open_issues_count": { - "type": "integer" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "visibility": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "public": { - "type": "boolean" - } - } - } - }, - "required": [ - "forkee" - ] - }, - { - "title": "GollumEvent", - "type": "object", - "properties": { - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": [ - "string", - "null" - ] - }, - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - } - } - }, - "required": [ - "pages" - ] - }, - { - "title": "MemberEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "member": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "action", - "member" - ] - }, - { - "title": "PublicEvent", - "type": "object" - }, - { - "title": "PushEvent", - "type": "object", - "properties": { - "repository_id": { - "type": "integer" - }, - "push_id": { - "type": "integer" - }, - "ref": { - "type": "string" - }, - "head": { - "type": "string" - }, - "before": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "distinct_size": { - "type": "integer" - }, - "commits": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "message": { - "type": "string" - }, - "author": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - } - }, - "url": { - "type": "string", - "format": "uri" - }, - "distinct": { - "type": "boolean" - } - } - } - } - }, - "required": [ - "repository_id", - "push_id", - "ref", - "head", - "before" - ] - }, - { - "title": "PullRequestEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "number", - "pull_request" - ] - }, - { - "title": "PullRequestReviewCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - }, - "comment": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "pull_request_review_id": { - "type": [ - "integer", - "null" - ] - }, - "diff_hunk": { - "type": "string" - }, - "path": { - "type": "string" - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "original_position": { - "type": [ - "integer", - "null" - ] - }, - "subject_type": { - "type": [ - "string", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "title": "User", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - } - }, - "body": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "original_commit_id": { - "type": "string" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "in_reply_to_id": { - "type": "integer" - }, - "author_association": { - "type": "string" - }, - "start_line": { - "type": [ - "integer", - "null" - ] - }, - "original_start_line": { - "type": [ - "integer", - "null" - ] - }, - "start_side": { - "type": [ - "string", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "original_line": { - "type": [ - "integer", - "null" - ] - }, - "side": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "url", - "pull_request_review_id", - "id", - "node_id", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "_links", - "reactions" - ] - } - }, - "required": [ - "action", - "comment", - "pull_request" - ] - }, - { - "title": "PullRequestReviewEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "review": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "type": "string" - }, - "commit_id": { - "type": "string" - }, - "submitted_at": { - "type": [ - "string", - "null" - ] - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "updated_at": { - "type": "string" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - } - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - } - }, - "required": [ - "action", - "review", - "pull_request" - ] - }, - { - "title": "CommitCommentEvent", - "type": "object", - "properties": { - "comment": { - "type": "object", - "properties": { - "html_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "body": { - "type": "string" - }, - "path": { - "type": [ - "string", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - } - } - }, - "required": [ - "comment" - ] - }, - { - "title": "ReleaseEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "release": { - "allOf": [ - { - "title": "Release", - "description": "A release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "assets_url": { - "type": "string", - "format": "uri" - }, - "upload_url": { - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "draft": { - "description": "true to create a draft (unpublished) release, false to create a published one.", - "type": "boolean" - }, - "prerelease": { - "description": "Whether to identify the release as a prerelease or a full release.", - "type": "boolean" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "mentions_count": { - "type": "integer" - }, - "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": [ - "assets_url", - "upload_url", - "tarball_url", - "zipball_url", - "created_at", - "published_at", - "draft", - "id", - "node_id", - "author", - "html_url", - "name", - "prerelease", - "tag_name", - "target_commitish", - "assets", - "url" - ] - }, - { - "type": "object", - "properties": { - "is_short_description_html_truncated": { - "type": "boolean" - }, - "short_description_html": { - "type": "string" - } - } - } - ] - } - }, - "required": [ - "action", - "release" - ] - }, - { - "title": "WatchEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - } - }, - "required": [ - "action" - ] - } - ] - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/received_events/public", - "title": "List public events received by a user", - "category": "activity", - "subcategory": "events", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": "22249084964", - "type": "PushEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octocat/Hello-World", - "url": "https://api.github.com/repos/octocat/Hello-World" - }, - "payload": { - "repository_id": 1296269, - "push_id": 10115855396, - "size": 1, - "distinct_size": 1, - "ref": "refs/heads/master", - "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "before": "883efe034920928c47fe18598c01249d1a9fdabd", - "commits": [ - { - "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "author": { - "email": "octocat@github.com", - "name": "Monalisa Octocat" - }, - "message": "commit", - "distinct": true, - "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" - } - ] - }, - "public": true, - "created_at": "2022-06-09T12:47:28Z" - }, - { - "id": "22196946742", - "type": "CreateEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octocat/Hello-World", - "url": "https://api.github.com/repos/octocat/Hello-World" - }, - "payload": { - "ref": "master", - "ref_type": "repository", - "master_branch": "master", - "description": null, - "pusher_type": "user" - }, - "public": false, - "created_at": "2022-06-07T07:50:26Z" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Event", - "description": "Event", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": [ - "string", - "null" - ] - }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "payload": { - "oneOf": [ - { - "title": "CreateEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "master_branch": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "master_branch", - "pusher_type" - ] - }, - { - "title": "DeleteEvent", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "ref_type": { - "type": "string" - }, - "pusher_type": { - "type": "string" - } - }, - "required": [ - "ref", - "ref_type", - "pusher_type" - ] - }, - { - "title": "IssuesEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "issue" - ] - }, - { - "title": "IssueCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - }, - "required": [ - "action", - "issue", - "comment" - ] - }, - { - "title": "ForkEvent", - "type": "object", - "properties": { - "forkee": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "private": { - "type": "boolean" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "html_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "git_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "forks_count": { - "type": "integer" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "open_issues_count": { - "type": "integer" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "visibility": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "public": { - "type": "boolean" - } - } - } - }, - "required": [ - "forkee" - ] - }, - { - "title": "GollumEvent", - "type": "object", - "properties": { - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": [ - "string", - "null" - ] - }, - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - } - } - }, - "required": [ - "pages" - ] - }, - { - "title": "MemberEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "member": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "action", - "member" - ] - }, - { - "title": "PublicEvent", - "type": "object" - }, - { - "title": "PushEvent", - "type": "object", - "properties": { - "repository_id": { - "type": "integer" - }, - "push_id": { - "type": "integer" - }, - "ref": { - "type": "string" - }, - "head": { - "type": "string" - }, - "before": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "distinct_size": { - "type": "integer" - }, - "commits": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "message": { - "type": "string" - }, - "author": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - } - }, - "url": { - "type": "string", - "format": "uri" - }, - "distinct": { - "type": "boolean" - } - } - } - } - }, - "required": [ - "repository_id", - "push_id", - "ref", - "head", - "before" - ] - }, - { - "title": "PullRequestEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "label": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - }, - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - }, - "required": [ - "action", - "number", - "pull_request" - ] - }, - { - "title": "PullRequestReviewCommentEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - }, - "comment": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "pull_request_review_id": { - "type": [ - "integer", - "null" - ] - }, - "diff_hunk": { - "type": "string" - }, - "path": { - "type": "string" - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "original_position": { - "type": [ - "integer", - "null" - ] - }, - "subject_type": { - "type": [ - "string", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "title": "User", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - } - }, - "body": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "original_commit_id": { - "type": "string" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "in_reply_to_id": { - "type": "integer" - }, - "author_association": { - "type": "string" - }, - "start_line": { - "type": [ - "integer", - "null" - ] - }, - "original_start_line": { - "type": [ - "integer", - "null" - ] - }, - "start_side": { - "type": [ - "string", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "original_line": { - "type": [ - "integer", - "null" - ] - }, - "side": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "url", - "pull_request_review_id", - "id", - "node_id", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "_links", - "reactions" - ] - } - }, - "required": [ - "action", - "comment", - "pull_request" - ] - }, - { - "title": "PullRequestReviewEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "review": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "type": "string" - }, - "commit_id": { - "type": "string" - }, - "submitted_at": { - "type": [ - "string", - "null" - ] - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "updated_at": { - "type": "string" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - } - }, - "pull_request": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - } - }, - "required": [ - "action", - "review", - "pull_request" - ] - }, - { - "title": "CommitCommentEvent", - "type": "object", - "properties": { - "comment": { - "type": "object", - "properties": { - "html_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "body": { - "type": "string" - }, - "path": { - "type": [ - "string", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - } - } - }, - "required": [ - "comment" - ] - }, - { - "title": "ReleaseEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "release": { - "allOf": [ - { - "title": "Release", - "description": "A release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "assets_url": { - "type": "string", - "format": "uri" - }, - "upload_url": { - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "draft": { - "description": "true to create a draft (unpublished) release, false to create a published one.", - "type": "boolean" - }, - "prerelease": { - "description": "Whether to identify the release as a prerelease or a full release.", - "type": "boolean" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "mentions_count": { - "type": "integer" - }, - "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": [ - "assets_url", - "upload_url", - "tarball_url", - "zipball_url", - "created_at", - "published_at", - "draft", - "id", - "node_id", - "author", - "html_url", - "name", - "prerelease", - "tag_name", - "target_commitish", - "assets", - "url" - ] - }, - { - "type": "object", - "properties": { - "is_short_description_html_truncated": { - "type": "boolean" - }, - "short_description_html": { - "type": "string" - } - } - } - ] - } - }, - "required": [ - "action", - "release" - ] - }, - { - "title": "WatchEvent", - "type": "object", - "properties": { - "action": { - "type": "string" - } - }, - "required": [ - "action" - ] - } - ] - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - } - ], - "feeds": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/feeds", - "title": "Get feeds", - "category": "activity", - "subcategory": "feeds", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.

\n
    \n
  • Timeline: The GitHub Enterprise Server global public timeline
    • \n
  • User: The public timeline for any user, using uri_template. For more information, see \"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 Enterprise Server.
    • \n
\n

By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"

\n

Note

\n

\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "timeline_url": "https://github.com/timeline", - "user_url": "https://github.com/{user}", - "current_user_public_url": "https://github.com/octocat", - "current_user_url": "https://github.com/octocat.private?token=abc123", - "current_user_actor_url": "https://github.com/octocat.private.actor?token=abc123", - "current_user_organization_url": "", - "current_user_organization_urls": [ - "https://github.com/organizations/github/octocat.private.atom?token=abc123" - ], - "security_advisories_url": "https://github.com/security-advisories", - "_links": { - "timeline": { - "href": "https://github.com/timeline", - "type": "application/atom+xml" - }, - "user": { - "href": "https://github.com/{user}", - "type": "application/atom+xml" - }, - "current_user_public": { - "href": "https://github.com/octocat", - "type": "application/atom+xml" - }, - "current_user": { - "href": "https://github.com/octocat.private?token=abc123", - "type": "application/atom+xml" - }, - "current_user_actor": { - "href": "https://github.com/octocat.private.actor?token=abc123", - "type": "application/atom+xml" - }, - "current_user_organization": { - "href": "", - "type": "" - }, - "current_user_organizations": [ - { - "href": "https://github.com/organizations/github/octocat.private.atom?token=abc123", - "type": "application/atom+xml" - } - ] - } - }, - "schema": { - "title": "Feed", - "description": "Feed", - "type": "object", - "properties": { - "timeline_url": { - "type": "string" - }, - "user_url": { - "type": "string" - }, - "current_user_public_url": { - "type": "string" - }, - "current_user_url": { - "type": "string" - }, - "current_user_actor_url": { - "type": "string" - }, - "current_user_organization_url": { - "type": "string" - }, - "current_user_organization_urls": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - } - }, - "security_advisories_url": { - "type": "string" - }, - "repository_discussions_url": { - "type": "string", - "description": "A feed of discussions for a given repository." - }, - "repository_discussions_category_url": { - "type": "string", - "description": "A feed of discussions for a given repository and category." - }, - "_links": { - "type": "object", - "properties": { - "timeline": { - "title": "Link With Type", - "description": "Hypermedia Link with Type", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "href", - "type" - ] - }, - "user": { - "title": "Link With Type", - "description": "Hypermedia Link with Type", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "href", - "type" - ] - }, - "security_advisories": { - "title": "Link With Type", - "description": "Hypermedia Link with Type", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "href", - "type" - ] - }, - "current_user": { - "title": "Link With Type", - "description": "Hypermedia Link with Type", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "href", - "type" - ] - }, - "current_user_public": { - "title": "Link With Type", - "description": "Hypermedia Link with Type", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "href", - "type" - ] - }, - "current_user_actor": { - "title": "Link With Type", - "description": "Hypermedia Link with Type", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "href", - "type" - ] - }, - "current_user_organization": { - "title": "Link With Type", - "description": "Hypermedia Link with Type", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "href", - "type" - ] - }, - "current_user_organizations": { - "type": "array", - "items": { - "title": "Link With Type", - "description": "Hypermedia Link with Type", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "href", - "type" - ] - } - }, - "repository_discussions": { - "title": "Link With Type", - "description": "Hypermedia Link with Type", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "href", - "type" - ] - }, - "repository_discussions_category": { - "title": "Link With Type", - "description": "Hypermedia Link with Type", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "href", - "type" - ] - } - }, - "required": [ - "timeline", - "user" - ] - } - }, - "required": [ - "_links", - "timeline_url", - "user_url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - } - ], - "notifications": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/notifications", - "title": "List notifications for the authenticated user", - "category": "activity", - "subcategory": "notifications", - "parameters": [ - { - "name": "all", - "description": "

If true, show notifications marked as read.

", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - { - "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 - } - }, - { - "name": "since", - "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "before", - "description": "

Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 50). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 50 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List all notifications for the current user, sorted by most recently updated.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": "1", - "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" - }, - "subject": { - "title": "Greetings", - "url": "https://api.github.com/repos/octokit/octokit.rb/issues/123", - "latest_comment_url": "https://api.github.com/repos/octokit/octokit.rb/issues/comments/123", - "type": "Issue" - }, - "reason": "subscribed", - "unread": true, - "updated_at": "2014-11-07T22:01:45Z", - "last_read_at": "2014-11-07T22:01:45Z", - "url": "https://api.github.com/notifications/threads/1", - "subscription_url": "https://api.github.com/notifications/threads/1/subscription" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Thread", - "description": "Thread", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - }, - "subject": { - "type": "object", - "properties": { - "title": { - "type": "string" - }, - "url": { - "type": "string" - }, - "latest_comment_url": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "title", - "url", - "latest_comment_url", - "type" - ] - }, - "reason": { - "type": "string" - }, - "unread": { - "type": "boolean" - }, - "updated_at": { - "type": "string" - }, - "last_read_at": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - } - }, - "required": [ - "id", - "unread", - "reason", - "updated_at", - "last_read_at", - "subject", - "repository", - "url", - "subscription_url" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/notifications", - "title": "Mark notifications as read", - "category": "activity", - "subcategory": "notifications", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "last_read_at", - "description": "

Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

" - }, - { - "type": "boolean", - "name": "read", - "description": "

Whether the notification has been read.

" - } - ], - "descriptionHTML": "

Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub Enterprise Server 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.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "last_read_at": "2022-06-10T00:00:00Z", - "read": true - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Response

", - "example": { - "message": "Unread notifications couldn't be marked in a single request. Notifications are being marked as read in the background." - }, - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "205", - "description": "

Reset Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/notifications/threads/{thread_id}", - "title": "Get a thread", - "category": "activity", - "subcategory": "notifications", - "parameters": [ - { - "name": "thread_id", - "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets information about a notification thread.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "thread_id": "THREAD_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": "1", - "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" - }, - "subject": { - "title": "Greetings", - "url": "https://api.github.com/repos/octokit/octokit.rb/issues/123", - "latest_comment_url": "https://api.github.com/repos/octokit/octokit.rb/issues/comments/123", - "type": "Issue" - }, - "reason": "subscribed", - "unread": true, - "updated_at": "2014-11-07T22:01:45Z", - "last_read_at": "2014-11-07T22:01:45Z", - "url": "https://api.github.com/notifications/threads/1", - "subscription_url": "https://api.github.com/notifications/threads/1/subscription" - }, - "schema": { - "title": "Thread", - "description": "Thread", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - }, - "subject": { - "type": "object", - "properties": { - "title": { - "type": "string" - }, - "url": { - "type": "string" - }, - "latest_comment_url": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "title", - "url", - "latest_comment_url", - "type" - ] - }, - "reason": { - "type": "string" - }, - "unread": { - "type": "boolean" - }, - "updated_at": { - "type": "string" - }, - "last_read_at": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - } - }, - "required": [ - "id", - "unread", - "reason", - "updated_at", - "last_read_at", - "subject", - "repository", - "url", - "subscription_url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/notifications/threads/{thread_id}", - "title": "Mark a thread as read", - "category": "activity", - "subcategory": "notifications", - "parameters": [ - { - "name": "thread_id", - "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "thread_id": "THREAD_ID" - } - }, - "response": { - "statusCode": "205", - "description": "

Reset Content

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "205", - "description": "

Reset Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/notifications/threads/{thread_id}", - "title": "Mark a thread as done", - "category": "activity", - "subcategory": "notifications", - "parameters": [ - { - "name": "thread_id", - "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "thread_id": "THREAD_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

No content

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/notifications/threads/{thread_id}/subscription", - "title": "Get a thread subscription for the authenticated user", - "category": "activity", - "subcategory": "notifications", - "parameters": [ - { - "name": "thread_id", - "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "thread_id": "THREAD_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "subscribed": true, - "ignored": false, - "reason": null, - "created_at": "2012-10-06T21:34:12Z", - "url": "https://api.github.com/notifications/threads/1/subscription", - "thread_url": "https://api.github.com/notifications/threads/1" - }, - "schema": { - "title": "Thread Subscription", - "description": "Thread Subscription", - "type": "object", - "properties": { - "subscribed": { - "type": "boolean" - }, - "ignored": { - "type": "boolean" - }, - "reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "thread_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "created_at", - "ignored", - "reason", - "url", - "subscribed" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/notifications/threads/{thread_id}/subscription", - "title": "Set a thread subscription", - "category": "activity", - "subcategory": "notifications", - "parameters": [ - { - "name": "thread_id", - "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "ignored", - "description": "

Whether to block all notifications from a thread.

", - "default": false - } - ], - "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.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "ignored": false - }, - "parameters": { - "thread_id": "THREAD_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "subscribed": true, - "ignored": false, - "reason": null, - "created_at": "2012-10-06T21:34:12Z", - "url": "https://api.github.com/notifications/threads/1/subscription", - "thread_url": "https://api.github.com/notifications/threads/1" - }, - "schema": { - "title": "Thread Subscription", - "description": "Thread Subscription", - "type": "object", - "properties": { - "subscribed": { - "type": "boolean" - }, - "ignored": { - "type": "boolean" - }, - "reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "thread_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "created_at", - "ignored", - "reason", - "url", - "subscribed" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/notifications/threads/{thread_id}/subscription", - "title": "Delete a thread subscription", - "category": "activity", - "subcategory": "notifications", - "parameters": [ - { - "name": "thread_id", - "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "thread_id": "THREAD_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/notifications", - "title": "List repository notifications for the authenticated user", - "category": "activity", - "subcategory": "notifications", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "all", - "description": "

If true, show notifications marked as read.

", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - { - "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 - } - }, - { - "name": "since", - "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "before", - "description": "

Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all notifications for the current user in the specified repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": "1", - "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" - }, - "subject": { - "title": "Greetings", - "url": "https://api.github.com/repos/octokit/octokit.rb/issues/123", - "latest_comment_url": "https://api.github.com/repos/octokit/octokit.rb/issues/comments/123", - "type": "Issue" - }, - "reason": "subscribed", - "unread": true, - "updated_at": "2014-11-07T22:01:45Z", - "last_read_at": "2014-11-07T22:01:45Z", - "url": "https://api.github.com/notifications/threads/1", - "subscription_url": "https://api.github.com/notifications/threads/1/subscription" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Thread", - "description": "Thread", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - }, - "subject": { - "type": "object", - "properties": { - "title": { - "type": "string" - }, - "url": { - "type": "string" - }, - "latest_comment_url": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "title", - "url", - "latest_comment_url", - "type" - ] - }, - "reason": { - "type": "string" - }, - "unread": { - "type": "boolean" - }, - "updated_at": { - "type": "string" - }, - "last_read_at": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - } - }, - "required": [ - "id", - "unread", - "reason", - "updated_at", - "last_read_at", - "subject", - "repository", - "url", - "subscription_url" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/notifications", - "title": "Mark repository notifications as read", - "category": "activity", - "subcategory": "notifications", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "last_read_at", - "description": "

Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

" - } - ], - "descriptionHTML": "

Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the List repository notifications for the authenticated user endpoint and pass the query parameter all=false.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "last_read_at": "2019-01-01T00:00:00Z" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Response

", - "example": { - "message": "Unread notifications couldn't be marked in a single request. Notifications are being marked as read in the background." - }, - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "url": { - "type": "string" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "205", - "description": "

Reset Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ], - "starring": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stargazers", - "title": "List stargazers", - "category": "activity", - "subcategory": "starring", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the people that have starred the repository.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Default response

", - "example": [ - { - "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 - } - ], - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - { - "type": "array", - "items": { - "title": "Stargazer", - "description": "Stargazer", - "type": "object", - "properties": { - "starred_at": { - "type": "string", - "format": "date-time" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "starred_at", - "user" - ] - } - } - ] - } - } - }, - { - "request": { - "description": "Example 2: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Alternative response with star creation timestamps

", - "example": [ - { - "starred_at": "2011-01-16T19:06:43Z", - "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 - } - } - ], - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - { - "type": "array", - "items": { - "title": "Stargazer", - "description": "Stargazer", - "type": "object", - "properties": { - "starred_at": { - "type": "string", - "format": "date-time" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "starred_at", - "user" - ] - } - } - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/starred", - "title": "List repositories starred by the authenticated user", - "category": "activity", - "subcategory": "starring", - "parameters": [ - { - "name": "sort", - "description": "

The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Default response

", - "example": [ - { - "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, - "allow_auto_merge": false, - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - } - } - }, - { - "request": { - "description": "Example 2: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/vnd.github.v3.star+json", - "description": "

Alternative response with star creation timestamps

", - "example": [ - { - "starred_at": "2011-01-16T19:06:43Z", - "repo": { - "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, - "allow_auto_merge": false, - "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 - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Starred Repository", - "description": "Starred Repository", - "type": "object", - "properties": { - "starred_at": { - "type": "string", - "format": "date-time" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - }, - "required": [ - "starred_at", - "repo" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Starring\" user permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/starred/{owner}/{repo}", - "title": "Check if a repository is starred by the authenticated user", - "category": "activity", - "subcategory": "starring", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Whether the authenticated user has starred the repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response if this repository is starred by you

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Response if this repository is starred by you

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found if this repository is not starred by you

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read", - "\"Starring\" user permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/user/starred/{owner}/{repo}", - "title": "Star a repository for the authenticated user", - "category": "activity", - "subcategory": "starring", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Starring\" user permissions": "write", - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/user/starred/{owner}/{repo}", - "title": "Unstar a repository for the authenticated user", - "category": "activity", - "subcategory": "starring", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Unstar a repository that the authenticated user has previously starred.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Starring\" user permissions": "write", - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/starred", - "title": "List repositories starred by a user", - "category": "activity", - "subcategory": "starring", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "

The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists repositories a user has starred.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Default response

", - "example": [ - { - "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, - "allow_auto_merge": false, - "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 - } - ], - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "title": "Starred Repository", - "description": "Starred Repository", - "type": "object", - "properties": { - "starred_at": { - "type": "string", - "format": "date-time" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - }, - "required": [ - "starred_at", - "repo" - ] - } - }, - { - "type": "array", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - } - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Starring\" user permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ], - "watching": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/subscribers", - "title": "List watchers", - "category": "activity", - "subcategory": "watching", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the people watching the specified repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/subscription", - "title": "Get a repository subscription", - "category": "activity", - "subcategory": "watching", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets information about whether the authenticated user is subscribed to the repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

if you subscribe to the repository

", - "example": { - "subscribed": true, - "ignored": false, - "reason": null, - "created_at": "2012-10-06T21:34:12Z", - "url": "https://api.github.com/repos/octocat/example/subscription", - "repository_url": "https://api.github.com/repos/octocat/example" - }, - "schema": { - "title": "Repository Invitation", - "description": "Repository invitations let you manage who you collaborate with.", - "type": "object", - "properties": { - "subscribed": { - "description": "Determines if notifications should be received from this repository.", - "type": "boolean" - }, - "ignored": { - "description": "Determines if all notifications should be blocked from this repository.", - "type": "boolean" - }, - "reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "created_at", - "ignored", - "reason", - "subscribed", - "url", - "repository_url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

if you subscribe to the repository

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found if you don't subscribe to the repository

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/subscription", - "title": "Set a repository subscription", - "category": "activity", - "subcategory": "watching", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "subscribed", - "description": "

Determines if notifications should be received from this repository.

" - }, - { - "type": "boolean", - "name": "ignored", - "description": "

Determines if all notifications should be blocked from this repository.

" - } - ], - "descriptionHTML": "

If you would like to watch a repository, set subscribed to true. If you would like to ignore notifications made within a repository, set ignored to true. If you would like to stop watching a repository, delete the repository's subscription completely.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "subscribed": true, - "ignored": false - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "subscribed": true, - "ignored": false, - "reason": null, - "created_at": "2012-10-06T21:34:12Z", - "url": "https://api.github.com/repos/octocat/example/subscription", - "repository_url": "https://api.github.com/repos/octocat/example" - }, - "schema": { - "title": "Repository Invitation", - "description": "Repository invitations let you manage who you collaborate with.", - "type": "object", - "properties": { - "subscribed": { - "description": "Determines if notifications should be received from this repository.", - "type": "boolean" - }, - "ignored": { - "description": "Determines if all notifications should be blocked from this repository.", - "type": "boolean" - }, - "reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "created_at", - "ignored", - "reason", - "subscribed", - "url", - "repository_url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/subscription", - "title": "Delete a repository subscription", - "category": "activity", - "subcategory": "watching", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/subscriptions", - "title": "List repositories watched by the authenticated user", - "category": "activity", - "subcategory": "watching", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists repositories the authenticated user is watching.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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, - "has_discussions": false, - "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 - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Watching\" user permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/subscriptions", - "title": "List repositories watched by a user", - "category": "activity", - "subcategory": "watching", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists repositories a user is watching.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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, - "has_discussions": false, - "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 - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Watching\" user permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/announcement-banners.json b/src/rest/data/ghes-3.14-2022-11-28/announcement-banners.json deleted file mode 100644 index 0b22d29c4e7d..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/announcement-banners.json +++ /dev/null @@ -1,269 +0,0 @@ -{ - "organizations": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/announcement", - "title": "Get announcement banner for organization", - "category": "announcement-banners", - "subcategory": "organizations", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the\norganization level. Organization members may also see an enterprise-level announcement banner. To get an\nannouncement banner displayed at the enterprise level, use the enterprise-level endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Announcement banner

", - "example": { - "announcement": "Very **important** announcement about _something_.", - "expires_at": "2021-01-01T00:00:00.000+00:00", - "user_dismissible": false - }, - "schema": { - "title": "Announcement Banner", - "description": "Announcement at either the repository, organization, or enterprise level", - "type": "object", - "properties": { - "announcement": { - "type": [ - "string", - "null" - ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.14/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string." - }, - "user_dismissible": { - "type": [ - "boolean", - "null" - ], - "description": "Whether an announcement can be dismissed by the user.", - "default": false - } - }, - "required": [ - "announcement", - "expires_at", - "user_dismissible" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Organization announcement banners\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/orgs/{org}/announcement", - "title": "Set announcement banner for organization", - "category": "announcement-banners", - "subcategory": "organizations", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string or null", - "name": "announcement", - "description": "

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

", - "isRequired": true - }, - { - "type": "string or null", - "name": "expires_at", - "description": "

The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

" - }, - { - "type": "boolean or null", - "name": "user_dismissible", - "description": "

Whether an announcement can be dismissed by the user.

", - "default": false - } - ], - "descriptionHTML": "

Sets the announcement banner to display for the organization.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Announcement banner", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "announcement": "Very **important** announcement about _something_.", - "expires_at": "2021-01-01T00:00:00.000+00:00", - "user_dismissible": false - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Announcement banner

", - "example": { - "announcement": "Very **important** announcement about _something_.", - "expires_at": "2021-01-01T00:00:00.000+00:00", - "user_dismissible": false - }, - "schema": { - "title": "Announcement Banner", - "description": "Announcement at either the repository, organization, or enterprise level", - "type": "object", - "properties": { - "announcement": { - "type": [ - "string", - "null" - ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.14/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string." - }, - "user_dismissible": { - "type": [ - "boolean", - "null" - ], - "description": "Whether an announcement can be dismissed by the user.", - "default": false - } - }, - "required": [ - "announcement", - "expires_at", - "user_dismissible" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Organization announcement banners\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/announcement", - "title": "Remove announcement banner from organization", - "category": "announcement-banners", - "subcategory": "organizations", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes the announcement banner currently set for the organization.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Organization announcement banners\" organization permissions": "write" - } - ] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/apps.json b/src/rest/data/ghes-3.14-2022-11-28/apps.json deleted file mode 100644 index ec9593138868..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/apps.json +++ /dev/null @@ -1,15418 +0,0 @@ -{ - "apps": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/app", - "title": "Get the authenticated app", - "category": "apps", - "subcategory": "apps", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.

\n

You must use a JWT to access this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "slug": "octoapp", - "client_id": "Iv1.ab1112223334445c", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "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 - }, - "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" - ] - }, - "schema": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/app-manifests/{code}/conversions", - "title": "Create a GitHub App from a manifest", - "category": "apps", - "subcategory": "apps", - "parameters": [ - { - "name": "code", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. When you create a GitHub App with the manifest flow, you receive a temporary code used to retrieve the GitHub App's id, pem (private key), and webhook_secret.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "code": "CODE" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "slug": "octoapp", - "node_id": "MDxOkludGVncmF0aW9uMQ==", - "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" - ], - "client_id": "Iv1.8a61f9b3a7aba766", - "client_secret": "1726be1638095a19edd134c77bde3aa2ece1e5d8", - "webhook_secret": "e340154128314309424b7c8e90325147d99fdafa", - "pem": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\n-----END RSA PRIVATE KEY-----\n" - }, - "schema": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "client_secret": { - "type": "string" - }, - "webhook_secret": { - "type": [ - "string", - "null" - ] - }, - "pem": { - "type": "string" - } - }, - "required": [ - "client_id", - "client_secret", - "webhook_secret", - "pem" - ], - "additionalProperties": true - } - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/app/installation-requests", - "title": "List installation requests for the authenticated app", - "category": "apps", - "subcategory": "apps", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all the pending installation requests for the authenticated GitHub App.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

List of integration installation requests

", - "example": [ - { - "id": 25381, - "node_id": "MDEyOkludGVncmF0aW9uMTIzNDU2Nzg5MA==", - "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 - }, - "requester": { - "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": "2022-07-08T16:18:44-04:00" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Integration Installation Request", - "description": "Request to install an integration on a target", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the request installation.", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "requester": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "account", - "requester", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

List of integration installation requests

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/app/installations", - "title": "List installations for the authenticated app", - "category": "apps", - "subcategory": "apps", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "since", - "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "outdated", - "in": "query", - "required": false, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

The permissions the installation has are included under the permissions key.

\n

You must use a JWT to access this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

The permissions the installation has are included under the permissions key.

", - "example": [ - { - "id": 1, - "account": { - "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 - }, - "access_tokens_url": "https://api.github.com/app/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" - ], - "single_file_name": "config.yaml", - "has_multiple_single_files": true, - "single_file_paths": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ], - "repository_selection": "selected", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "app_slug": "github-actions", - "suspended_at": null, - "suspended_by": null - } - ], - "schema": { - "type": "array", - "items": { - "title": "Installation", - "description": "Installation", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer" - }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "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" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "app_id": { - "type": "integer" - }, - "client_id": { - "type": "string" - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string" - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "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", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "app_slug": { - "type": "string" - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ] - } - }, - "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", - "suspended_by", - "suspended_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

The permissions the installation has are included under the permissions key.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/app/installations/{installation_id}", - "title": "Get an installation for the authenticated app", - "category": "apps", - "subcategory": "apps", - "parameters": [ - { - "name": "installation_id", - "description": "

The unique identifier of the installation.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Enables an authenticated GitHub App to find an installation's information using the installation id.

\n

You must use a JWT to access this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "installation_id": 1 - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "account": { - "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 - }, - "access_tokens_url": "https://api.github.com/app/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" - ], - "single_file_name": "config.yaml", - "has_multiple_single_files": true, - "single_file_paths": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ], - "repository_selection": "selected", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "app_slug": "github-actions", - "suspended_at": null, - "suspended_by": null - }, - "schema": { - "title": "Installation", - "description": "Installation", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer" - }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "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" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "app_id": { - "type": "integer" - }, - "client_id": { - "type": "string" - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string" - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "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", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "app_slug": { - "type": "string" - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ] - } - }, - "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", - "suspended_by", - "suspended_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/app/installations/{installation_id}", - "title": "Delete an installation for the authenticated app", - "category": "apps", - "subcategory": "apps", - "parameters": [ - { - "name": "installation_id", - "description": "

The unique identifier of the installation.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.

\n

You must use a JWT to access this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "installation_id": 1 - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/app/installations/{installation_id}/access_tokens", - "title": "Create an installation access token for an app", - "category": "apps", - "subcategory": "apps", - "parameters": [ - { - "name": "installation_id", - "description": "

The unique identifier of the installation.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "repositories", - "description": "

List of repository names that the token should have access to

" - }, - { - "type": "array of integers", - "name": "repository_ids", - "description": "

List of repository IDs that the token should have access to

" - }, - { - "type": "object", - "name": "permissions", - "description": "

The permissions granted to the user access token.

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "

The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "

The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "artifact_metadata", - "description": "

The level of permission to grant the access token to create and retrieve build artifact metadata records.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "attestations", - "description": "

The level of permission to create and retrieve the access token for repository attestations.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "

The level of permission to grant the access token for checks on code.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "codespaces", - "description": "

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "

The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "dependabot_secrets", - "description": "

The level of permission to grant the access token to manage Dependabot secrets.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "

The level of permission to grant the access token for deployments and deployment statuses.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "

The level of permission to grant the access token for discussions and related comments and labels.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "

The level of permission to grant the access token for managing repository environments.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "

The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "merge_queues", - "description": "

The level of permission to grant the access token to manage the merge queues for a repository.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "

The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "

The level of permission to grant the access token for packages published to GitHub Packages.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "

The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "

The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_custom_properties", - "description": "

The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "

The level of permission to grant the access token to manage the post-receive hooks for a repository.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "

The level of permission to grant the access token to manage repository projects, columns, and cards.

", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "

The level of permission to grant the access token to view and manage secret scanning alerts.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "

The level of permission to grant the access token to manage repository secrets.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "

The level of permission to grant the access token to view and manage security events like code scanning alerts.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "

The level of permission to grant the access token to manage just a single file.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "

The level of permission to grant the access token for commit statuses.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "

The level of permission to grant the access token to manage Dependabot alerts.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "

The level of permission to grant the access token to update GitHub Actions workflow files.

", - "enum": [ - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "

The level of permission to grant the access token for organization teams and members.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "

The level of permission to grant the access token to manage access to an organization.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_custom_roles", - "description": "

The level of permission to grant the access token for custom repository roles management.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_custom_org_roles", - "description": "

The level of permission to grant the access token for custom organization roles management.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_custom_properties", - "description": "

The level of permission to grant the access token for repository custom properties management at the organization level.

", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "organization_copilot_seat_management", - "description": "

The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.

", - "enum": [ - "write" - ] - }, - { - "type": "string", - "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_announcement_banners", - "description": "

The level of permission to grant the access token to view and manage announcement banners for an organization.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_events", - "description": "

The level of permission to grant the access token to view events triggered by an activity in an organization.

", - "enum": [ - "read" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "

The level of permission to grant the access token to manage the post-receive hooks for an organization.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_personal_access_tokens", - "description": "

The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_personal_access_token_requests", - "description": "

The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "

The level of permission to grant the access token for viewing an organization's plan.

", - "enum": [ - "read" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "

The level of permission to grant the access token to manage organization projects and projects public preview (where available).

", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "

The level of permission to grant the access token for organization packages published to GitHub Packages.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "

The level of permission to grant the access token to manage organization secrets.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "

The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "

The level of permission to grant the access token to view and manage users blocked by the organization.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "email_addresses", - "description": "

The level of permission to grant the access token to manage the email addresses belonging to a user.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "followers", - "description": "

The level of permission to grant the access token to manage the followers belonging to a user.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "git_ssh_keys", - "description": "

The level of permission to grant the access token to manage git SSH keys.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "gpg_keys", - "description": "

The level of permission to grant the access token to view and manage GPG keys belonging to a user.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "interaction_limits", - "description": "

The level of permission to grant the access token to view and manage interaction limits on a repository.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "profile", - "description": "

The level of permission to grant the access token to manage the profile settings belonging to a user.

", - "enum": [ - "write" - ] - }, - { - "type": "string", - "name": "starring", - "description": "

The level of permission to grant the access token to list and manage repositories a user is starring.

", - "enum": [ - "read", - "write" - ] - } - ] - } - ], - "descriptionHTML": "

Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.

\n

Optionally, you can use the repositories or repository_ids body parameters to specify individual repositories that the installation access token can access. If you don't use repositories or repository_ids to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.

\n

Optionally, use the permissions body parameter to specify the permissions that the installation access token should have. If permissions is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.

\n

When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.

\n

You must use a JWT to access this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "repositories": [ - "Hello-World" - ], - "permissions": { - "issues": "write", - "contents": "read" - } - }, - "parameters": { - "installation_id": 1 - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "token": "ghs_16C7e42F292c6912E7710c838347Ae178B4a", - "expires_at": "2016-07-11T22:14:10Z", - "permissions": { - "issues": "write", - "contents": "read" - }, - "repository_selection": "selected", - "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, - "allow_auto_merge": false, - "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 - } - ] - }, - "schema": { - "title": "Installation Token", - "description": "Authentication token for a GitHub App installed on a user or org.", - "type": "object", - "properties": { - "token": { - "type": "string" - }, - "expires_at": { - "type": "string" - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "repository_selection": { - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "repositories": { - "type": "array", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - }, - "single_file": { - "type": "string" - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "token", - "expires_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/app/installations/{installation_id}/suspended", - "title": "Suspend an app installation", - "category": "apps", - "subcategory": "apps", - "parameters": [ - { - "name": "installation_id", - "description": "

The unique identifier of the installation.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.

\n

You must use a JWT to access this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "installation_id": 1 - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/app/installations/{installation_id}/suspended", - "title": "Unsuspend an app installation", - "category": "apps", - "subcategory": "apps", - "parameters": [ - { - "name": "installation_id", - "description": "

The unique identifier of the installation.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes a GitHub App installation suspension.

\n

You must use a JWT to access this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "installation_id": 1 - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/applications/{client_id}/token/scoped", - "title": "Create a scoped access token", - "category": "apps", - "subcategory": "apps", - "parameters": [ - { - "name": "client_id", - "in": "path", - "required": true, - "description": "

The client ID of the GitHub app.

", - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "access_token", - "description": "

The access token used to authenticate to the GitHub API.

", - "isRequired": true - }, - { - "type": "string", - "name": "target", - "description": "

The name of the user or organization to scope the user access token to. Required unless target_id is specified.

" - }, - { - "type": "integer", - "name": "target_id", - "description": "

The ID of the user or organization to scope the user access token to. Required unless target is specified.

" - }, - { - "type": "array of strings", - "name": "repositories", - "description": "

The list of repository names to scope the user access token to. repositories may not be specified if repository_ids is specified.

" - }, - { - "type": "array of integers", - "name": "repository_ids", - "description": "

The list of repository IDs to scope the user access token to. repository_ids may not be specified if repositories is specified.

" - }, - { - "type": "object", - "name": "permissions", - "description": "

The permissions granted to the user access token.

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "

The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "

The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "artifact_metadata", - "description": "

The level of permission to grant the access token to create and retrieve build artifact metadata records.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "attestations", - "description": "

The level of permission to create and retrieve the access token for repository attestations.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "

The level of permission to grant the access token for checks on code.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "codespaces", - "description": "

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "

The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "dependabot_secrets", - "description": "

The level of permission to grant the access token to manage Dependabot secrets.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "

The level of permission to grant the access token for deployments and deployment statuses.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "

The level of permission to grant the access token for discussions and related comments and labels.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "

The level of permission to grant the access token for managing repository environments.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "

The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "merge_queues", - "description": "

The level of permission to grant the access token to manage the merge queues for a repository.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "

The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "

The level of permission to grant the access token for packages published to GitHub Packages.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "

The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "

The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_custom_properties", - "description": "

The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "

The level of permission to grant the access token to manage the post-receive hooks for a repository.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "

The level of permission to grant the access token to manage repository projects, columns, and cards.

", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "

The level of permission to grant the access token to view and manage secret scanning alerts.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "

The level of permission to grant the access token to manage repository secrets.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "

The level of permission to grant the access token to view and manage security events like code scanning alerts.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "

The level of permission to grant the access token to manage just a single file.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "

The level of permission to grant the access token for commit statuses.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "

The level of permission to grant the access token to manage Dependabot alerts.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "

The level of permission to grant the access token to update GitHub Actions workflow files.

", - "enum": [ - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "

The level of permission to grant the access token for organization teams and members.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "

The level of permission to grant the access token to manage access to an organization.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_custom_roles", - "description": "

The level of permission to grant the access token for custom repository roles management.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_custom_org_roles", - "description": "

The level of permission to grant the access token for custom organization roles management.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_custom_properties", - "description": "

The level of permission to grant the access token for repository custom properties management at the organization level.

", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "organization_copilot_seat_management", - "description": "

The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.

", - "enum": [ - "write" - ] - }, - { - "type": "string", - "name": "organization_copilot_agent_settings", - "description": "

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_announcement_banners", - "description": "

The level of permission to grant the access token to view and manage announcement banners for an organization.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_events", - "description": "

The level of permission to grant the access token to view events triggered by an activity in an organization.

", - "enum": [ - "read" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "

The level of permission to grant the access token to manage the post-receive hooks for an organization.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_personal_access_tokens", - "description": "

The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_personal_access_token_requests", - "description": "

The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "

The level of permission to grant the access token for viewing an organization's plan.

", - "enum": [ - "read" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "

The level of permission to grant the access token to manage organization projects and projects public preview (where available).

", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "

The level of permission to grant the access token for organization packages published to GitHub Packages.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "

The level of permission to grant the access token to manage organization secrets.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "

The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "

The level of permission to grant the access token to view and manage users blocked by the organization.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "email_addresses", - "description": "

The level of permission to grant the access token to manage the email addresses belonging to a user.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "followers", - "description": "

The level of permission to grant the access token to manage the followers belonging to a user.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "git_ssh_keys", - "description": "

The level of permission to grant the access token to manage git SSH keys.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "gpg_keys", - "description": "

The level of permission to grant the access token to view and manage GPG keys belonging to a user.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "interaction_limits", - "description": "

The level of permission to grant the access token to view and manage interaction limits on a repository.

", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "profile", - "description": "

The level of permission to grant the access token to manage the profile settings belonging to a user.

", - "enum": [ - "write" - ] - }, - { - "type": "string", - "name": "starring", - "description": "

The level of permission to grant the access token to list and manage repositories a user is starring.

", - "enum": [ - "read", - "write" - ] - } - ] - } - ], - "descriptionHTML": "

Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.

\n

Invalid tokens will return 404 NOT FOUND.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a", - "target": "octocat", - "permissions": { - "metadata": "read", - "issues": "write", - "contents": "read" - } - }, - "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "url": "https://api.github.com/authorizations/1", - "scopes": [], - "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", - "token_last_eight": "Ae178B4a", - "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", - "app": { - "url": "http://my-github-app.com", - "name": "my github app", - "client_id": "Iv1.8a61f9b3a7aba766" - }, - "note": "optional note", - "note_url": "http://optional/note/url", - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "fingerprint": "jklmnop12345678", - "expires_at": "2011-09-08T17:26:27Z", - "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 - }, - "installation": { - "permissions": { - "metadata": "read", - "issues": "write", - "contents": "read" - }, - "repository_selection": "selected", - "single_file_name": ".github/workflow.yml", - "repositories_url": "https://api.github.com/user/repos", - "account": { - "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 - }, - "has_multiple_single_files": false, - "single_file_paths": [] - } - }, - "schema": { - "title": "Authorization", - "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string", - "format": "uri" - }, - "scopes": { - "description": "A list of scopes that this authorization is in.", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "token": { - "type": "string" - }, - "token_last_eight": { - "type": [ - "string", - "null" - ] - }, - "hashed_token": { - "type": [ - "string", - "null" - ] - }, - "app": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "client_id", - "name", - "url" - ] - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "note_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "fingerprint": { - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "installation": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Scoped Installation", - "type": "object", - "properties": { - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "single_file_name": { - "type": [ - "string", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "account": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "permissions", - "repository_selection", - "single_file_name", - "repositories_url", - "account" - ] - } - ] - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "app", - "id", - "note", - "note_url", - "scopes", - "token", - "hashed_token", - "token_last_eight", - "fingerprint", - "url", - "created_at", - "updated_at", - "expires_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [], - "basicAuth": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/apps/{app_slug}", - "title": "Get an app", - "category": "apps", - "subcategory": "apps", - "parameters": [ - { - "name": "app_slug", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThe :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "app_slug": "APP_SLUG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "slug": "octoapp", - "client_id": "Iv1.ab1112223334445c", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "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 - }, - "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" - ] - }, - "schema": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/installation", - "title": "Get an organization installation for the authenticated app", - "category": "apps", - "subcategory": "apps", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Enables an authenticated GitHub App to find the organization's installation information.

\n

You must use a JWT to access this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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/app/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, - "client_id": "Iv1.ab1112223334445c", - "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", - "suspended_at": null, - "suspended_by": null - }, - "schema": { - "title": "Installation", - "description": "Installation", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer" - }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "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" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "app_id": { - "type": "integer" - }, - "client_id": { - "type": "string" - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string" - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "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", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "app_slug": { - "type": "string" - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ] - } - }, - "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", - "suspended_by", - "suspended_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/installation", - "title": "Get a repository installation for the authenticated app", - "category": "apps", - "subcategory": "apps", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.

\n

You must use a JWT to access this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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/app/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, - "client_id": "Iv1.ab1112223334445c", - "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", - "suspended_at": null, - "suspended_by": null - }, - "schema": { - "title": "Installation", - "description": "Installation", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer" - }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "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" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "app_id": { - "type": "integer" - }, - "client_id": { - "type": "string" - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string" - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "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", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "app_slug": { - "type": "string" - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ] - } - }, - "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", - "suspended_by", - "suspended_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/installation", - "title": "Get a user installation for the authenticated app", - "category": "apps", - "subcategory": "apps", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Enables an authenticated GitHub App to find the user’s installation information.

\n

You must use a JWT to access this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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/app/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, - "client_id": "Iv1.ab1112223334445c", - "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", - "suspended_at": null, - "suspended_by": null - }, - "schema": { - "title": "Installation", - "description": "Installation", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer" - }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "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" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "app_id": { - "type": "integer" - }, - "client_id": { - "type": "string" - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string" - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "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", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "app_slug": { - "type": "string" - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ] - } - }, - "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", - "suspended_by", - "suspended_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ], - "installations": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/installation/repositories", - "title": "List repositories accessible to the app installation", - "category": "apps", - "subcategory": "installations", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List repositories that an app installation can access.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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", - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "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 - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "repositories" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "repositories": { - "type": "array", - "items": { - "allOf": [ - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - ] - } - }, - "repository_selection": { - "type": "string" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/installation/token", - "title": "Revoke an installation access token", - "category": "apps", - "subcategory": "installations", - "parameters": [], - "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.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/installations", - "title": "List app installations accessible to the user access token", - "category": "apps", - "subcategory": "installations", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

You can find the permissions for the installation under the permissions key.

", - "example": { - "total_count": 2, - "installations": [ - { - "id": 1, - "account": { - "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 - }, - "access_tokens_url": "https://api.github.com/app/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" - ], - "single_file_name": "config.yaml", - "has_multiple_single_files": true, - "single_file_paths": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ], - "repository_selection": "all", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "app_slug": "github-actions", - "suspended_at": null, - "suspended_by": null - }, - { - "id": 3, - "account": { - "login": "octocat", - "id": 2, - "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 - }, - "access_tokens_url": "https://api.github.com/app/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" - ], - "single_file_name": "config.yaml", - "has_multiple_single_files": true, - "single_file_paths": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ], - "repository_selection": "all", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "app_slug": "github-actions", - "suspended_at": null, - "suspended_by": null - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "installations" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "installations": { - "type": "array", - "items": { - "title": "Installation", - "description": "Installation", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer" - }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "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" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "app_id": { - "type": "integer" - }, - "client_id": { - "type": "string" - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string" - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "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", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "app_slug": { - "type": "string" - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ] - } - }, - "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", - "suspended_by", - "suspended_at" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

You can find the permissions for the installation under the permissions key.

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/installations/{installation_id}/repositories", - "title": "List repositories accessible to the user access token", - "category": "apps", - "subcategory": "installations", - "parameters": [ - { - "name": "installation_id", - "description": "

The unique identifier of the installation.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

The access the user has to each repository is included in the hash under the permissions key.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "installation_id": 1 - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

The access the user has to each repository is included in the hash under the permissions key.

", - "example": { - "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, - "allow_auto_merge": false, - "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 - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "repositories" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "repository_selection": { - "type": "string" - }, - "repositories": { - "type": "array", - "items": { - "allOf": [ - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

The access the user has to each repository is included in the hash under the permissions key.

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}", - "title": "Add a repository to an app installation", - "category": "apps", - "subcategory": "installations", - "parameters": [ - { - "name": "installation_id", - "description": "

The unique identifier of the installation.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "repository_id", - "description": "

The unique identifier of the repository.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Add a single repository to an installation. The authenticated user must have admin access to the repository.

\n

This endpoint only works for PATs (classic) with the repo scope.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "installation_id": 1, - "repository_id": "REPOSITORY_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}", - "title": "Remove a repository from an app installation", - "category": "apps", - "subcategory": "installations", - "parameters": [ - { - "name": "installation_id", - "description": "

The unique identifier of the installation.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "repository_id", - "description": "

The unique identifier of the repository.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the repository_selection of selected.

\n

This endpoint only works for PATs (classic) with the repo scope.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "installation_id": 1, - "repository_id": "REPOSITORY_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Returned when the application is installed on all repositories in the organization, or if this request would remove the last repository that the application has access to in the organization.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ], - "oauth-applications": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/applications/{client_id}/grant", - "title": "Delete an app authorization", - "category": "apps", - "subcategory": "oauth-applications", - "parameters": [ - { - "name": "client_id", - "in": "path", - "required": true, - "description": "

The client ID of the GitHub app.

", - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "access_token", - "description": "

The OAuth access token used to authenticate to the GitHub API.

", - "isRequired": true - } - ], - "descriptionHTML": "

OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth access_token as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on the application authorizations settings screen within GitHub.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" - }, - "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [], - "basicAuth": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/applications/{client_id}/token", - "title": "Check a token", - "category": "apps", - "subcategory": "oauth-applications", - "parameters": [ - { - "name": "client_id", - "in": "path", - "required": true, - "description": "

The client ID of the GitHub app.

", - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "access_token", - "description": "

The access_token of the OAuth or GitHub application.

", - "isRequired": true - } - ], - "descriptionHTML": "

OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return 404 NOT FOUND.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" - }, - "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "url": "https://api.github.com/authorizations/1", - "scopes": [ - "public_repo", - "user" - ], - "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", - "token_last_eight": "Ae178B4a", - "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", - "app": { - "url": "http://my-github-app.com", - "name": "my github app", - "client_id": "Iv1.8a61f9b3a7aba766" - }, - "note": "optional note", - "note_url": "http://optional/note/url", - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "fingerprint": "jklmnop12345678", - "expires_at": "2011-09-08T17:26:27Z", - "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 - } - }, - "schema": { - "title": "Authorization", - "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string", - "format": "uri" - }, - "scopes": { - "description": "A list of scopes that this authorization is in.", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "token": { - "type": "string" - }, - "token_last_eight": { - "type": [ - "string", - "null" - ] - }, - "hashed_token": { - "type": [ - "string", - "null" - ] - }, - "app": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "client_id", - "name", - "url" - ] - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "note_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "fingerprint": { - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "installation": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Scoped Installation", - "type": "object", - "properties": { - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "single_file_name": { - "type": [ - "string", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "account": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "permissions", - "repository_selection", - "single_file_name", - "repositories_url", - "account" - ] - } - ] - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "app", - "id", - "note", - "note_url", - "scopes", - "token", - "hashed_token", - "token_last_eight", - "fingerprint", - "url", - "created_at", - "updated_at", - "expires_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [], - "basicAuth": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/applications/{client_id}/token", - "title": "Reset a token", - "category": "apps", - "subcategory": "oauth-applications", - "parameters": [ - { - "name": "client_id", - "in": "path", - "required": true, - "description": "

The client ID of the GitHub app.

", - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "access_token", - "description": "

The access_token of the OAuth or GitHub application.

", - "isRequired": true - } - ], - "descriptionHTML": "

OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. Invalid tokens will return 404 NOT FOUND.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" - }, - "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "url": "https://api.github.com/authorizations/1", - "scopes": [ - "public_repo", - "user" - ], - "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", - "token_last_eight": "Ae178B4a", - "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", - "app": { - "url": "http://my-github-app.com", - "name": "my github app", - "client_id": "Iv1.8a61f9b3a7aba766" - }, - "note": "optional note", - "note_url": "http://optional/note/url", - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "fingerprint": "jklmnop12345678", - "expires_at": "2011-09-08T17:26:27Z", - "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 - } - }, - "schema": { - "title": "Authorization", - "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string", - "format": "uri" - }, - "scopes": { - "description": "A list of scopes that this authorization is in.", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "token": { - "type": "string" - }, - "token_last_eight": { - "type": [ - "string", - "null" - ] - }, - "hashed_token": { - "type": [ - "string", - "null" - ] - }, - "app": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "client_id", - "name", - "url" - ] - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "note_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "fingerprint": { - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "installation": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Scoped Installation", - "type": "object", - "properties": { - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "single_file_name": { - "type": [ - "string", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "account": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "permissions", - "repository_selection", - "single_file_name", - "repositories_url", - "account" - ] - } - ] - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "app", - "id", - "note", - "note_url", - "scopes", - "token", - "hashed_token", - "token_last_eight", - "fingerprint", - "url", - "created_at", - "updated_at", - "expires_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [], - "basicAuth": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/applications/{client_id}/token", - "title": "Delete an app token", - "category": "apps", - "subcategory": "oauth-applications", - "parameters": [ - { - "name": "client_id", - "in": "path", - "required": true, - "description": "

The client ID of the GitHub app.

", - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "access_token", - "description": "

The OAuth access token used to authenticate to the GitHub API.

", - "isRequired": true - } - ], - "descriptionHTML": "

OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" - }, - "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [], - "basicAuth": true - } - } - ], - "webhooks": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/app/hook/config", - "title": "Get a webhook configuration for an app", - "category": "apps", - "subcategory": "webhooks", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"

\n

You must use a JWT to access this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" - }, - "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.", - "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`." - }, - "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/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers)." - }, - "insecure_ssl": { - "oneOf": [ - { - "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.**" - }, - { - "type": "number" - } - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/app/hook/config", - "title": "Update a webhook configuration for an app", - "category": "apps", - "subcategory": "webhooks", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "url", - "description": "

The URL to which the payloads will be delivered.

" - }, - { - "type": "string", - "name": "content_type", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

" - }, - { - "type": "string", - "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" - }, - { - "type": "string or number", - "name": "insecure_ssl", - "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.

" - } - ], - "descriptionHTML": "

Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"

\n

You must use a JWT to access this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" - }, - "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.", - "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`." - }, - "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/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers)." - }, - "insecure_ssl": { - "oneOf": [ - { - "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.**" - }, - { - "type": "number" - } - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/app/hook/deliveries", - "title": "List deliveries for an app webhook", - "category": "apps", - "subcategory": "webhooks", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "cursor", - "description": "

Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the link header for the next and previous page cursors.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "status", - "description": "

Returns webhook deliveries filtered by delivery outcome classification based on status_code range. A status of success returns deliveries with a status_code in the 200-399 range (inclusive). A status of failure returns deliveries with a status_code in the 400-599 range (inclusive).

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "success", - "failure" - ] - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns a list of webhook deliveries for the webhook configured for a GitHub App.

\n

You must use a JWT to access this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 12345678, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "delivered_at": "2019-06-03T00:57:16Z", - "redelivery": false, - "duration": 0.27, - "status": "OK", - "status_code": 200, - "event": "issues", - "action": "opened", - "installation_id": 123, - "repository_id": 456, - "throttled_at": "2019-06-03T00:57:16Z" - }, - { - "id": 123456789, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "delivered_at": "2019-06-04T00:57:16Z", - "redelivery": true, - "duration": 0.28, - "status": "OK", - "status_code": 200, - "event": "issues", - "action": "opened", - "installation_id": 123, - "repository_id": 456, - "throttled_at": null - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple webhook delivery", - "description": "Delivery made by a webhook, without request and response information.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the webhook delivery.", - "type": "integer", - "format": "int64" - }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", - "type": "string" - }, - "delivered_at": { - "description": "Time when the webhook delivery occurred.", - "type": "string", - "format": "date-time" - }, - "redelivery": { - "description": "Whether the webhook delivery is a redelivery.", - "type": "boolean" - }, - "duration": { - "description": "Time spent delivering.", - "type": "number" - }, - "status": { - "description": "Describes the response returned after attempting the delivery.", - "type": "string" - }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer" - }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string" - }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", - "type": [ - "string", - "null" - ] - }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": [ - "integer", - "null" - ], - "format": "int64" - }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": [ - "integer", - "null" - ], - "format": "int64" - }, - "throttled_at": { - "description": "Time when the webhook delivery was throttled.", - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "guid", - "delivered_at", - "redelivery", - "duration", - "status", - "status_code", - "event", - "action", - "installation_id", - "repository_id" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/app/hook/deliveries/{delivery_id}", - "title": "Get a delivery for an app webhook", - "category": "apps", - "subcategory": "webhooks", - "parameters": [ - { - "name": "delivery_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns a delivery for the webhook configured for a GitHub App.

\n

You must use a JWT to access this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "delivery_id": "DELIVERY_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 12345678, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "delivered_at": "2019-06-03T00:57:16Z", - "redelivery": false, - "duration": 0.27, - "status": "OK", - "status_code": 200, - "event": "issues", - "action": "opened", - "installation_id": 123, - "repository_id": 456, - "url": "https://www.example.com", - "throttled_at": "2019-06-03T00:57:16Z", - "request": { - "headers": { - "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "Accept": "*/*", - "X-GitHub-Hook-ID": "42", - "User-Agent": "GitHub-Hookshot/b8c71d8", - "X-GitHub-Event": "issues", - "X-GitHub-Hook-Installation-Target-ID": "123", - "X-GitHub-Hook-Installation-Target-Type": "repository", - "content-type": "application/json", - "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" - }, - "payload": { - "action": "opened", - "issue": { - "body": "foo" - }, - "repository": { - "id": 123 - } - } - }, - "response": { - "headers": { - "Content-Type": "text/html;charset=utf-8" - }, - "payload": "ok" - } - }, - "schema": { - "title": "Webhook delivery", - "description": "Delivery made by a webhook.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the delivery.", - "type": "integer" - }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", - "type": "string" - }, - "delivered_at": { - "description": "Time when the delivery was delivered.", - "type": "string", - "format": "date-time" - }, - "redelivery": { - "description": "Whether the delivery is a redelivery.", - "type": "boolean" - }, - "duration": { - "description": "Time spent delivering.", - "type": "number" - }, - "status": { - "description": "Description of the status of the attempted delivery", - "type": "string" - }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer" - }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string" - }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", - "type": [ - "string", - "null" - ] - }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": [ - "integer", - "null" - ] - }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": [ - "integer", - "null" - ] - }, - "throttled_at": { - "description": "Time when the webhook delivery was throttled.", - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "url": { - "description": "The URL target of the delivery.", - "type": "string" - }, - "request": { - "type": "object", - "properties": { - "headers": { - "description": "The request headers sent with the webhook delivery.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - }, - "payload": { - "description": "The webhook payload.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - } - }, - "required": [ - "headers", - "payload" - ] - }, - "response": { - "type": "object", - "properties": { - "headers": { - "description": "The response headers received when the delivery was made.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - }, - "payload": { - "description": "The response payload received.", - "type": [ - "string", - "null" - ], - "additionalProperties": true - } - }, - "required": [ - "headers", - "payload" - ] - } - }, - "required": [ - "id", - "guid", - "delivered_at", - "redelivery", - "duration", - "status", - "status_code", - "event", - "action", - "installation_id", - "repository_id", - "request", - "response" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/app/hook/deliveries/{delivery_id}/attempts", - "title": "Redeliver a delivery for an app webhook", - "category": "apps", - "subcategory": "webhooks", - "parameters": [ - { - "name": "delivery_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Redeliver a delivery for the webhook configured for a GitHub App.

\n

You must use a JWT to access this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "delivery_id": "DELIVERY_ID" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Accepted

", - "example": null, - "schema": { - "type": "object" - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/billing.json b/src/rest/data/ghes-3.14-2022-11-28/billing.json deleted file mode 100644 index f56bde60bc92..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/billing.json +++ /dev/null @@ -1,174 +0,0 @@ -{ - "billing": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/settings/billing/advanced-security", - "title": "Get GitHub Advanced Security active committers for an organization", - "category": "billing", - "subcategory": "billing", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the GitHub Advanced Security active committers for an organization per repository.

\n

Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository.

\n

If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.

\n

The total number of repositories with committer information is tracked by the total_count field.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Success

", - "example": { - "total_advanced_security_committers": 2, - "total_count": 2, - "maximum_advanced_security_committers": 4, - "purchased_advanced_security_committers": 4, - "repositories": [ - { - "name": "octocat-org/Hello-World", - "advanced_security_committers": 2, - "advanced_security_committers_breakdown": [ - { - "user_login": "octocat", - "last_pushed_date": "2021-11-03", - "last_pushed_email": "octocat@github.com" - }, - { - "user_login": "octokitten", - "last_pushed_date": "2021-10-25", - "last_pushed_email": "octokitten@github.com" - } - ] - }, - { - "name": "octocat-org/server", - "advanced_security_committers": 1, - "advanced_security_committers_breakdown": [ - { - "user_login": "octokitten", - "last_pushed_date": "2021-10-26", - "last_pushed_email": "octokitten@github.com" - } - ] - } - ] - }, - "schema": { - "type": "object", - "properties": { - "total_advanced_security_committers": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "maximum_advanced_security_committers": { - "type": "integer", - "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security" - }, - "purchased_advanced_security_committers": { - "type": "integer", - "description": "The total number of GitHub Advanced Security licences purchased" - }, - "repositories": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "advanced_security_committers": { - "type": "integer" - }, - "advanced_security_committers_breakdown": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user_login": { - "type": "string" - }, - "last_pushed_date": { - "type": "string" - }, - "last_pushed_email": { - "type": "string" - } - }, - "required": [ - "user_login", - "last_pushed_date", - "last_pushed_email" - ] - } - } - }, - "required": [ - "name", - "advanced_security_committers", - "advanced_security_committers_breakdown" - ] - } - } - }, - "required": [ - "repositories" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Success

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "read" - } - ] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/branches.json b/src/rest/data/ghes-3.14-2022-11-28/branches.json deleted file mode 100644 index f0ee849797a4..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/branches.json +++ /dev/null @@ -1,21370 +0,0 @@ -{ - "branches": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches", - "title": "List branches", - "category": "branches", - "subcategory": "branches", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "protected", - "description": "

Setting to true returns only branches protected by branch protections or rulesets. When set to false, only unprotected branches are returned. Omitting this parameter returns all branches.

", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "name": "master", - "commit": { - "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" - }, - "protected": true, - "protection": { - "required_status_checks": { - "enforcement_level": "non_admins", - "contexts": [ - "ci-test", - "linter" - ] - } - }, - "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Short Branch", - "description": "Short Branch", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "commit": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - }, - "protected": { - "type": "boolean" - }, - "protection": { - "title": "Branch Protection", - "description": "Branch Protection", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "required_status_checks": { - "title": "Protected Branch Required Status Check", - "description": "Protected Branch Required Status Check", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "enforcement_level": { - "type": "string" - }, - "contexts": { - "type": "array", - "items": { - "type": "string" - } - }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": [ - "integer", - "null" - ] - } - }, - "required": [ - "context", - "app_id" - ] - } - }, - "contexts_url": { - "type": "string" - }, - "strict": { - "type": "boolean" - } - }, - "required": [ - "contexts", - "checks" - ] - }, - "enforce_admins": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "enabled": { - "type": "boolean" - } - }, - "required": [ - "url", - "enabled" - ] - }, - "required_pull_request_reviews": { - "title": "Protected Branch Pull Request Review", - "description": "Protected Branch Pull Request Review", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "dismissal_restrictions": { - "type": "object", - "properties": { - "users": { - "description": "The list of users with review dismissal access.", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "teams": { - "description": "The list of teams with review dismissal access.", - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "description": "The list of apps with review dismissal access.", - "type": "array", - "items": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - }, - "url": { - "type": "string" - }, - "users_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - } - } - }, - "bypass_pull_request_allowances": { - "type": "object", - "description": "Allow specific users, teams, or apps to bypass pull request requirements.", - "properties": { - "users": { - "description": "The list of users allowed to bypass pull request requirements.", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "teams": { - "description": "The list of teams allowed to bypass pull request requirements.", - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "description": "The list of apps allowed to bypass pull request requirements.", - "type": "array", - "items": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - } - } - }, - "dismiss_stale_reviews": { - "type": "boolean" - }, - "require_code_owner_reviews": { - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer", - "minimum": 0, - "maximum": 6 - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it.", - "type": "boolean", - "default": false - } - }, - "required": [ - "dismiss_stale_reviews", - "require_code_owner_reviews" - ] - }, - "restrictions": { - "title": "Branch Restriction Policy", - "description": "Branch Restriction Policy", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "users_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "apps_url": { - "type": "string", - "format": "uri" - }, - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "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" - }, - "user_view_type": { - "type": "string" - } - } - } - }, - "teams": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "gravatar_id": { - "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" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "user_view_type": { - "type": "string" - } - } - }, - "name": { - "type": "string" - }, - "client_id": { - "type": "string" - }, - "description": { - "type": "string" - }, - "external_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "issues": { - "type": "string" - }, - "single_file": { - "type": "string" - } - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "required": [ - "url", - "users_url", - "teams_url", - "apps_url", - "users", - "teams", - "apps" - ] - }, - "required_linear_history": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_force_pushes": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_deletions": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "block_creations": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "required_conversation_resolution": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "name": { - "type": "string" - }, - "protection_url": { - "type": "string" - }, - "required_signatures": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "enabled": { - "type": "boolean" - } - }, - "required": [ - "url", - "enabled" - ] - }, - "lock_branch": { - "type": "object", - "description": "Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.", - "properties": { - "enabled": { - "default": false, - "type": "boolean" - } - } - }, - "allow_fork_syncing": { - "type": "object", - "description": "Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing.", - "properties": { - "enabled": { - "default": false, - "type": "boolean" - } - } - } - } - }, - "protection_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "commit", - "protected" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}", - "title": "Get a branch", - "category": "branches", - "subcategory": "branches", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "name": "main", - "commit": { - "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", - "commit": { - "author": { - "name": "The Octocat", - "email": "octocat@nowhere.com", - "date": "2012-03-06T23:06:50Z" - }, - "committer": { - "name": "The Octocat", - "email": "octocat@nowhere.com", - "date": "2012-03-06T23:06:50Z" - }, - "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", - "tree": { - "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", - "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" - }, - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "comment_count": 77, - "verification": { - "verified": false, - "reason": "unsigned" - } - }, - "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", - "author": { - "login": "octocat", - "id": 583231, - "node_id": "MDQ6VXNlcjU4MzIzMQ==", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "committer": { - "login": "octocat", - "id": 583231, - "node_id": "MDQ6VXNlcjU4MzIzMQ==", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "parents": [ - { - "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", - "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" - }, - { - "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", - "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" - } - ] - }, - "_links": { - "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", - "html": "https://github.com/octocat/Hello-World/tree/main" - }, - "protected": false, - "protection": { - "enabled": false, - "required_status_checks": { - "enforcement_level": "off", - "contexts": [], - "checks": [] - } - }, - "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" - }, - "schema": { - "title": "Branch With Protection", - "description": "Branch With Protection", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "commit": { - "title": "Commit", - "description": "Commit", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "commit": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "message": { - "type": "string" - }, - "comment_count": { - "type": "integer" - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - }, - "verification": { - "title": "Verification", - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "payload": { - "type": [ - "string", - "null" - ] - }, - "signature": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] - }, - "author": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - ], - "type": [ - "null", - "object" - ] - }, - "committer": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - ], - "type": [ - "null", - "object" - ] - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - } - }, - "stats": { - "type": "object", - "properties": { - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": [ - "string", - "null" - ] - }, - "filename": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ] - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changes": { - "type": "integer" - }, - "blob_url": { - "type": "string", - "format": "uri" - }, - "raw_url": { - "type": "string", - "format": "uri" - }, - "contents_url": { - "type": "string", - "format": "uri" - }, - "patch": { - "type": "string" - }, - "previous_filename": { - "type": "string" - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] - } - } - }, - "required": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" - ] - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "string" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "html", - "self" - ] - }, - "protected": { - "type": "boolean" - }, - "protection": { - "title": "Branch Protection", - "description": "Branch Protection", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "required_status_checks": { - "title": "Protected Branch Required Status Check", - "description": "Protected Branch Required Status Check", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "enforcement_level": { - "type": "string" - }, - "contexts": { - "type": "array", - "items": { - "type": "string" - } - }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": [ - "integer", - "null" - ] - } - }, - "required": [ - "context", - "app_id" - ] - } - }, - "contexts_url": { - "type": "string" - }, - "strict": { - "type": "boolean" - } - }, - "required": [ - "contexts", - "checks" - ] - }, - "enforce_admins": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "enabled": { - "type": "boolean" - } - }, - "required": [ - "url", - "enabled" - ] - }, - "required_pull_request_reviews": { - "title": "Protected Branch Pull Request Review", - "description": "Protected Branch Pull Request Review", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "dismissal_restrictions": { - "type": "object", - "properties": { - "users": { - "description": "The list of users with review dismissal access.", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "teams": { - "description": "The list of teams with review dismissal access.", - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "description": "The list of apps with review dismissal access.", - "type": "array", - "items": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - }, - "url": { - "type": "string" - }, - "users_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - } - } - }, - "bypass_pull_request_allowances": { - "type": "object", - "description": "Allow specific users, teams, or apps to bypass pull request requirements.", - "properties": { - "users": { - "description": "The list of users allowed to bypass pull request requirements.", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "teams": { - "description": "The list of teams allowed to bypass pull request requirements.", - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "description": "The list of apps allowed to bypass pull request requirements.", - "type": "array", - "items": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - } - } - }, - "dismiss_stale_reviews": { - "type": "boolean" - }, - "require_code_owner_reviews": { - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer", - "minimum": 0, - "maximum": 6 - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it.", - "type": "boolean", - "default": false - } - }, - "required": [ - "dismiss_stale_reviews", - "require_code_owner_reviews" - ] - }, - "restrictions": { - "title": "Branch Restriction Policy", - "description": "Branch Restriction Policy", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "users_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "apps_url": { - "type": "string", - "format": "uri" - }, - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "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" - }, - "user_view_type": { - "type": "string" - } - } - } - }, - "teams": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "gravatar_id": { - "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" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "user_view_type": { - "type": "string" - } - } - }, - "name": { - "type": "string" - }, - "client_id": { - "type": "string" - }, - "description": { - "type": "string" - }, - "external_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "issues": { - "type": "string" - }, - "single_file": { - "type": "string" - } - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "required": [ - "url", - "users_url", - "teams_url", - "apps_url", - "users", - "teams", - "apps" - ] - }, - "required_linear_history": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_force_pushes": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_deletions": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "block_creations": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "required_conversation_resolution": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "name": { - "type": "string" - }, - "protection_url": { - "type": "string" - }, - "required_signatures": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "enabled": { - "type": "boolean" - } - }, - "required": [ - "url", - "enabled" - ] - }, - "lock_branch": { - "type": "object", - "description": "Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.", - "properties": { - "enabled": { - "default": false, - "type": "boolean" - } - } - }, - "allow_fork_syncing": { - "type": "object", - "description": "Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing.", - "properties": { - "enabled": { - "default": false, - "type": "boolean" - } - } - } - } - }, - "protection_url": { - "type": "string", - "format": "uri" - }, - "pattern": { - "type": "string" - }, - "required_approving_review_count": { - "type": "integer" - } - }, - "required": [ - "name", - "commit", - "_links", - "protection", - "protected", - "protection_url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", - "title": "Rename a branch", - "category": "branches", - "subcategory": "branches", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "new_name", - "description": "

The new name of the branch.

", - "isRequired": true - } - ], - "descriptionHTML": "

Renames a branch in a repository.

\n

Note

\n

\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".

\n
\n

The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.

\n

In order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "new_name": "my_renamed_branch" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "name": "master", - "commit": { - "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "node_id": "MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==", - "commit": { - "author": { - "name": "The Octocat", - "date": "2012-03-06T15:06:50-08:00", - "email": "octocat@nowhere.com" - }, - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", - "tree": { - "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", - "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" - }, - "committer": { - "name": "The Octocat", - "date": "2012-03-06T15:06:50-08:00", - "email": "octocat@nowhere.com" - }, - "verification": { - "verified": false, - "reason": "unsigned" - }, - "comment_count": 0 - }, - "author": { - "gravatar_id": "", - "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", - "url": "https://api.github.com/users/octocat", - "id": 583231, - "login": "octocat", - "node_id": "MDQ6VXNlcjE=", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "parents": [ - { - "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" - }, - { - "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303" - } - ], - "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "committer": { - "gravatar_id": "", - "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", - "url": "https://api.github.com/users/octocat", - "id": 583231, - "login": "octocat", - "node_id": "MDQ6VXNlcjE=", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" - }, - "_links": { - "html": "https://github.com/octocat/Hello-World/tree/master", - "self": "https://api.github.com/repos/octocat/Hello-World/branches/master" - }, - "protected": true, - "protection": { - "required_status_checks": { - "enforcement_level": "non_admins", - "contexts": [ - "ci-test", - "linter" - ] - } - }, - "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" - }, - "schema": { - "title": "Branch With Protection", - "description": "Branch With Protection", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "commit": { - "title": "Commit", - "description": "Commit", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "commit": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "message": { - "type": "string" - }, - "comment_count": { - "type": "integer" - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - }, - "verification": { - "title": "Verification", - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "payload": { - "type": [ - "string", - "null" - ] - }, - "signature": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] - }, - "author": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - ], - "type": [ - "null", - "object" - ] - }, - "committer": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - ], - "type": [ - "null", - "object" - ] - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - } - }, - "stats": { - "type": "object", - "properties": { - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": [ - "string", - "null" - ] - }, - "filename": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ] - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changes": { - "type": "integer" - }, - "blob_url": { - "type": "string", - "format": "uri" - }, - "raw_url": { - "type": "string", - "format": "uri" - }, - "contents_url": { - "type": "string", - "format": "uri" - }, - "patch": { - "type": "string" - }, - "previous_filename": { - "type": "string" - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] - } - } - }, - "required": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" - ] - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "string" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "html", - "self" - ] - }, - "protected": { - "type": "boolean" - }, - "protection": { - "title": "Branch Protection", - "description": "Branch Protection", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "required_status_checks": { - "title": "Protected Branch Required Status Check", - "description": "Protected Branch Required Status Check", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "enforcement_level": { - "type": "string" - }, - "contexts": { - "type": "array", - "items": { - "type": "string" - } - }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": [ - "integer", - "null" - ] - } - }, - "required": [ - "context", - "app_id" - ] - } - }, - "contexts_url": { - "type": "string" - }, - "strict": { - "type": "boolean" - } - }, - "required": [ - "contexts", - "checks" - ] - }, - "enforce_admins": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "enabled": { - "type": "boolean" - } - }, - "required": [ - "url", - "enabled" - ] - }, - "required_pull_request_reviews": { - "title": "Protected Branch Pull Request Review", - "description": "Protected Branch Pull Request Review", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "dismissal_restrictions": { - "type": "object", - "properties": { - "users": { - "description": "The list of users with review dismissal access.", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "teams": { - "description": "The list of teams with review dismissal access.", - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "description": "The list of apps with review dismissal access.", - "type": "array", - "items": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - }, - "url": { - "type": "string" - }, - "users_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - } - } - }, - "bypass_pull_request_allowances": { - "type": "object", - "description": "Allow specific users, teams, or apps to bypass pull request requirements.", - "properties": { - "users": { - "description": "The list of users allowed to bypass pull request requirements.", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "teams": { - "description": "The list of teams allowed to bypass pull request requirements.", - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "description": "The list of apps allowed to bypass pull request requirements.", - "type": "array", - "items": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - } - } - }, - "dismiss_stale_reviews": { - "type": "boolean" - }, - "require_code_owner_reviews": { - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer", - "minimum": 0, - "maximum": 6 - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it.", - "type": "boolean", - "default": false - } - }, - "required": [ - "dismiss_stale_reviews", - "require_code_owner_reviews" - ] - }, - "restrictions": { - "title": "Branch Restriction Policy", - "description": "Branch Restriction Policy", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "users_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "apps_url": { - "type": "string", - "format": "uri" - }, - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "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" - }, - "user_view_type": { - "type": "string" - } - } - } - }, - "teams": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "gravatar_id": { - "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" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "user_view_type": { - "type": "string" - } - } - }, - "name": { - "type": "string" - }, - "client_id": { - "type": "string" - }, - "description": { - "type": "string" - }, - "external_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "issues": { - "type": "string" - }, - "single_file": { - "type": "string" - } - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "required": [ - "url", - "users_url", - "teams_url", - "apps_url", - "users", - "teams", - "apps" - ] - }, - "required_linear_history": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_force_pushes": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_deletions": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "block_creations": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "required_conversation_resolution": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "name": { - "type": "string" - }, - "protection_url": { - "type": "string" - }, - "required_signatures": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "enabled": { - "type": "boolean" - } - }, - "required": [ - "url", - "enabled" - ] - }, - "lock_branch": { - "type": "object", - "description": "Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.", - "properties": { - "enabled": { - "default": false, - "type": "boolean" - } - } - }, - "allow_fork_syncing": { - "type": "object", - "description": "Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing.", - "properties": { - "enabled": { - "default": false, - "type": "boolean" - } - } - } - } - }, - "protection_url": { - "type": "string", - "format": "uri" - }, - "pattern": { - "type": "string" - }, - "required_approving_review_count": { - "type": "integer" - } - }, - "required": [ - "name", - "commit", - "_links", - "protection", - "protected", - "protection_url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merge-upstream", - "title": "Sync a fork branch with the upstream repository", - "category": "branches", - "subcategory": "branches", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "branch", - "description": "

The name of the branch which should be updated to match upstream.

", - "isRequired": true - } - ], - "descriptionHTML": "

Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "branch": "main" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

The branch has been successfully synced with the upstream repository

", - "example": { - "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", - "merge_type": "fast-forward", - "base_branch": "defunkt:main" - }, - "schema": { - "title": "Merged upstream", - "description": "Results of a successful merge upstream request", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "merge_type": { - "type": "string", - "enum": [ - "merge", - "fast-forward", - "none" - ] - }, - "base_branch": { - "type": "string" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

The branch has been successfully synced with the upstream repository

" - }, - { - "httpStatusCode": "409", - "description": "

The branch could not be synced because of a merge conflict

" - }, - { - "httpStatusCode": "422", - "description": "

The branch could not be synced for some other reason

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merges", - "title": "Merge a branch", - "category": "branches", - "subcategory": "branches", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "base", - "description": "

The name of the base branch that the head will be merged into.

", - "isRequired": true - }, - { - "type": "string", - "name": "head", - "description": "

The head to merge. This can be a branch name or a commit SHA1.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_message", - "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

" - } - ], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "base": "master", - "head": "cool_feature", - "commit_message": "Shipped cool_feature!" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Successful Response (The resulting merge commit)

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", - "commit": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "author": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "committer": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "message": "Fix all the bugs", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" - }, - "comment_count": 0, - "verification": { - "verified": false, - "reason": "unsigned" - } - }, - "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 - }, - "committer": { - "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 - }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" - } - ], - "stats": { - "additions": 104, - "deletions": 4, - "total": 108 - }, - "files": [ - { - "filename": "file1.txt", - "additions": 10, - "deletions": 2, - "changes": 12, - "status": "modified", - "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", - "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", - "patch": "@@ -29,7 +29,7 @@\n....." - } - ] - }, - "schema": { - "title": "Commit", - "description": "Commit", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "commit": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "message": { - "type": "string" - }, - "comment_count": { - "type": "integer" - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - }, - "verification": { - "title": "Verification", - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "payload": { - "type": [ - "string", - "null" - ] - }, - "signature": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] - }, - "author": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - ], - "type": [ - "null", - "object" - ] - }, - "committer": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - ], - "type": [ - "null", - "object" - ] - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - } - }, - "stats": { - "type": "object", - "properties": { - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": [ - "string", - "null" - ] - }, - "filename": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ] - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changes": { - "type": "integer" - }, - "blob_url": { - "type": "string", - "format": "uri" - }, - "raw_url": { - "type": "string", - "format": "uri" - }, - "contents_url": { - "type": "string", - "format": "uri" - }, - "patch": { - "type": "string" - }, - "previous_filename": { - "type": "string" - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] - } - } - }, - "required": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Successful Response (The resulting merge commit)

" - }, - { - "httpStatusCode": "204", - "description": "

Response when already merged

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found when the base or head does not exist

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict when there is a merge conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - } - ], - "branch-protection": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "title": "Get branch protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", - "required_status_checks": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", - "contexts": [ - "continuous-integration/travis-ci" - ], - "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", - "enforcement_level": "non_admins" - }, - "enforce_admins": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", - "enabled": true - }, - "required_pull_request_reviews": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", - "dismissal_restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", - "users": [ - { - "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 - } - ], - "teams": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "apps": [ - { - "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", - "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": "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" - ] - } - ] - }, - "dismiss_stale_reviews": true, - "require_code_owner_reviews": true, - "required_approving_review_count": 2, - "require_last_push_approval": true - }, - "restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", - "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", - "users": [ - { - "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 - } - ], - "teams": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "apps": [ - { - "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", - "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": "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" - ] - } - ] - }, - "required_linear_history": { - "enabled": true - }, - "allow_force_pushes": { - "enabled": true - }, - "allow_deletions": { - "enabled": true - }, - "required_conversation_resolution": { - "enabled": true - }, - "lock_branch": { - "enabled": true - }, - "allow_fork_syncing": { - "enabled": true - } - }, - "schema": { - "title": "Branch Protection", - "description": "Branch Protection", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "required_status_checks": { - "title": "Protected Branch Required Status Check", - "description": "Protected Branch Required Status Check", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "enforcement_level": { - "type": "string" - }, - "contexts": { - "type": "array", - "items": { - "type": "string" - } - }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": [ - "integer", - "null" - ] - } - }, - "required": [ - "context", - "app_id" - ] - } - }, - "contexts_url": { - "type": "string" - }, - "strict": { - "type": "boolean" - } - }, - "required": [ - "contexts", - "checks" - ] - }, - "enforce_admins": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "enabled": { - "type": "boolean" - } - }, - "required": [ - "url", - "enabled" - ] - }, - "required_pull_request_reviews": { - "title": "Protected Branch Pull Request Review", - "description": "Protected Branch Pull Request Review", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "dismissal_restrictions": { - "type": "object", - "properties": { - "users": { - "description": "The list of users with review dismissal access.", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "teams": { - "description": "The list of teams with review dismissal access.", - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "description": "The list of apps with review dismissal access.", - "type": "array", - "items": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - }, - "url": { - "type": "string" - }, - "users_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - } - } - }, - "bypass_pull_request_allowances": { - "type": "object", - "description": "Allow specific users, teams, or apps to bypass pull request requirements.", - "properties": { - "users": { - "description": "The list of users allowed to bypass pull request requirements.", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "teams": { - "description": "The list of teams allowed to bypass pull request requirements.", - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "description": "The list of apps allowed to bypass pull request requirements.", - "type": "array", - "items": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - } - } - }, - "dismiss_stale_reviews": { - "type": "boolean" - }, - "require_code_owner_reviews": { - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer", - "minimum": 0, - "maximum": 6 - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it.", - "type": "boolean", - "default": false - } - }, - "required": [ - "dismiss_stale_reviews", - "require_code_owner_reviews" - ] - }, - "restrictions": { - "title": "Branch Restriction Policy", - "description": "Branch Restriction Policy", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "users_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "apps_url": { - "type": "string", - "format": "uri" - }, - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "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" - }, - "user_view_type": { - "type": "string" - } - } - } - }, - "teams": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "gravatar_id": { - "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" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "user_view_type": { - "type": "string" - } - } - }, - "name": { - "type": "string" - }, - "client_id": { - "type": "string" - }, - "description": { - "type": "string" - }, - "external_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "issues": { - "type": "string" - }, - "single_file": { - "type": "string" - } - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "required": [ - "url", - "users_url", - "teams_url", - "apps_url", - "users", - "teams", - "apps" - ] - }, - "required_linear_history": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_force_pushes": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_deletions": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "block_creations": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "required_conversation_resolution": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "name": { - "type": "string" - }, - "protection_url": { - "type": "string" - }, - "required_signatures": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "enabled": { - "type": "boolean" - } - }, - "required": [ - "url", - "enabled" - ] - }, - "lock_branch": { - "type": "object", - "description": "Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.", - "properties": { - "enabled": { - "default": false, - "type": "boolean" - } - } - }, - "allow_fork_syncing": { - "type": "object", - "description": "Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing.", - "properties": { - "enabled": { - "default": false, - "type": "boolean" - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "title": "Update branch protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "object or null", - "name": "required_status_checks", - "description": "

Require status checks to pass before merging. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "strict", - "description": "

Require branches to be up to date before merging.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "contexts", - "description": "

Closing down notice: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "checks", - "description": "

The list of status checks to require in order to merge into this branch.

", - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The name of the required check

", - "isRequired": true - }, - { - "type": "integer", - "name": "app_id", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" - } - ] - } - ] - }, - { - "type": "boolean or null", - "name": "enforce_admins", - "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "required_pull_request_reviews", - "description": "

Require at least one approving review on a pull request, before merging. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "dismissal_restrictions", - "description": "

Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins with dismissal access

" - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs with dismissal access

" - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs with dismissal access

" - } - ] - }, - { - "type": "boolean", - "name": "dismiss_stale_reviews", - "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

" - }, - { - "type": "boolean", - "name": "require_code_owner_reviews", - "description": "

Blocks merging pull requests until code owners review them.

" - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

" - }, - { - "type": "boolean", - "name": "require_last_push_approval", - "description": "

Whether the most recent push must be approved by someone other than the person who pushed it. Default: false.

", - "default": false - }, - { - "type": "object", - "name": "bypass_pull_request_allowances", - "description": "

Allow specific users, teams, or apps to bypass pull request requirements.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins allowed to bypass pull request requirements.

" - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs allowed to bypass pull request requirements.

" - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs allowed to bypass pull request requirements.

" - } - ] - } - ] - }, - { - "type": "object or null", - "name": "restrictions", - "description": "

Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins with push access

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs with push access

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs with push access

" - } - ] - }, - { - "type": "boolean", - "name": "required_linear_history", - "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" - }, - { - "type": "boolean or null", - "name": "allow_force_pushes", - "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" - }, - { - "type": "boolean", - "name": "allow_deletions", - "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" - }, - { - "type": "boolean", - "name": "block_creations", - "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

" - }, - { - "type": "boolean", - "name": "required_conversation_resolution", - "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

" - }, - { - "type": "boolean", - "name": "lock_branch", - "description": "

Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. Default: false.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_fork_syncing", - "description": "

Whether users can pull changes from upstream when the branch is locked. Set to true to allow fork syncing. Set to false to prevent fork syncing. Default: false.

", - "default": false - } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Protecting a branch requires admin or owner permissions to the repository.

\n

Note

\n

\nPassing new arrays of users and teams replaces their previous values.

\n
\n

Note

\n

\nThe list of users, apps, and teams in total is limited to 100 items.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "required_status_checks": { - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ] - }, - "enforce_admins": true, - "required_pull_request_reviews": { - "dismissal_restrictions": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ] - }, - "dismiss_stale_reviews": true, - "require_code_owner_reviews": true, - "required_approving_review_count": 2, - "require_last_push_approval": true, - "bypass_pull_request_allowances": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ] - } - }, - "restrictions": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ], - "apps": [ - "super-ci" - ] - }, - "required_linear_history": true, - "allow_force_pushes": true, - "allow_deletions": true, - "block_creations": true, - "required_conversation_resolution": true, - "lock_branch": true, - "allow_fork_syncing": true - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", - "required_status_checks": { - "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ], - "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", - "checks": [ - { - "context": "continuous-integration/travis-ci", - "app_id": null - } - ] - }, - "restrictions": { - "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", - "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", - "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", - "users": [], - "teams": [], - "apps": [] - }, - "required_pull_request_reviews": { - "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", - "dismiss_stale_reviews": true, - "require_code_owner_reviews": true, - "required_approving_review_count": 2, - "require_last_push_approval": true, - "dismissal_restrictions": { - "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", - "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", - "users": [], - "teams": [], - "apps": [] - } - }, - "required_signatures": { - "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", - "enabled": false - }, - "enforce_admins": { - "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", - "enabled": true - }, - "required_linear_history": { - "enabled": true - }, - "allow_force_pushes": { - "enabled": true - }, - "allow_deletions": { - "enabled": true - }, - "block_creations": { - "enabled": true - }, - "required_conversation_resolution": { - "enabled": true - }, - "lock_branch": { - "enabled": true - }, - "allow_fork_syncing": { - "enabled": true - } - }, - "schema": { - "title": "Protected Branch", - "description": "Branch protections protect branches", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "required_status_checks": { - "title": "Status Check Policy", - "description": "Status Check Policy", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "strict": { - "type": "boolean" - }, - "contexts": { - "type": "array", - "items": { - "type": "string" - } - }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": [ - "integer", - "null" - ] - } - }, - "required": [ - "context", - "app_id" - ] - } - }, - "contexts_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "contexts_url", - "strict", - "contexts", - "checks" - ] - }, - "required_pull_request_reviews": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "dismiss_stale_reviews": { - "type": "boolean" - }, - "require_code_owner_reviews": { - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it.", - "type": "boolean", - "default": false - }, - "dismissal_restrictions": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "users_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "users": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "teams": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "type": "array", - "items": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - } - }, - "required": [ - "url", - "users_url", - "teams_url", - "users", - "teams" - ] - }, - "bypass_pull_request_allowances": { - "type": "object", - "properties": { - "users": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "teams": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "type": "array", - "items": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - } - }, - "required": [ - "users", - "teams" - ] - } - }, - "required": [ - "url" - ] - }, - "required_signatures": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "enabled": { - "type": "boolean" - } - }, - "required": [ - "url", - "enabled" - ] - }, - "enforce_admins": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "enabled": { - "type": "boolean" - } - }, - "additionalProperties": false, - "required": [ - "url", - "enabled" - ] - }, - "required_linear_history": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - }, - "additionalProperties": false, - "required": [ - "enabled" - ] - }, - "allow_force_pushes": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - }, - "additionalProperties": false, - "required": [ - "enabled" - ] - }, - "allow_deletions": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - }, - "additionalProperties": false, - "required": [ - "enabled" - ] - }, - "restrictions": { - "title": "Branch Restriction Policy", - "description": "Branch Restriction Policy", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "users_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "apps_url": { - "type": "string", - "format": "uri" - }, - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "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" - }, - "user_view_type": { - "type": "string" - } - } - } - }, - "teams": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "gravatar_id": { - "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" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "user_view_type": { - "type": "string" - } - } - }, - "name": { - "type": "string" - }, - "client_id": { - "type": "string" - }, - "description": { - "type": "string" - }, - "external_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "issues": { - "type": "string" - }, - "single_file": { - "type": "string" - } - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "required": [ - "url", - "users_url", - "teams_url", - "apps_url", - "users", - "teams", - "apps" - ] - }, - "required_conversation_resolution": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "block_creations": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - }, - "additionalProperties": false, - "required": [ - "enabled" - ] - }, - "lock_branch": { - "type": "object", - "description": "Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.", - "properties": { - "enabled": { - "default": false, - "type": "boolean" - } - }, - "additionalProperties": false - }, - "allow_fork_syncing": { - "type": "object", - "description": "Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing.", - "properties": { - "enabled": { - "default": false, - "type": "boolean" - } - }, - "additionalProperties": false - } - }, - "required": [ - "url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "title": "Delete branch protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "title": "Get admin branch protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", - "enabled": true - }, - "schema": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "enabled": { - "type": "boolean" - } - }, - "required": [ - "url", - "enabled" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "title": "Set admin branch protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", - "enabled": true - }, - "schema": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "enabled": { - "type": "boolean" - } - }, - "required": [ - "url", - "enabled" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "title": "Delete admin branch protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "title": "Get pull request review protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", - "dismissal_restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", - "users": [ - { - "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 - } - ], - "teams": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "apps": [ - { - "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", - "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": "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" - ] - } - ] - }, - "dismiss_stale_reviews": true, - "require_code_owner_reviews": true, - "required_approving_review_count": 2, - "require_last_push_approval": true - }, - "schema": { - "title": "Protected Branch Pull Request Review", - "description": "Protected Branch Pull Request Review", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "dismissal_restrictions": { - "type": "object", - "properties": { - "users": { - "description": "The list of users with review dismissal access.", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "teams": { - "description": "The list of teams with review dismissal access.", - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "description": "The list of apps with review dismissal access.", - "type": "array", - "items": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - }, - "url": { - "type": "string" - }, - "users_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - } - } - }, - "bypass_pull_request_allowances": { - "type": "object", - "description": "Allow specific users, teams, or apps to bypass pull request requirements.", - "properties": { - "users": { - "description": "The list of users allowed to bypass pull request requirements.", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "teams": { - "description": "The list of teams allowed to bypass pull request requirements.", - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "description": "The list of apps allowed to bypass pull request requirements.", - "type": "array", - "items": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - } - } - }, - "dismiss_stale_reviews": { - "type": "boolean" - }, - "require_code_owner_reviews": { - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer", - "minimum": 0, - "maximum": 6 - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it.", - "type": "boolean", - "default": false - } - }, - "required": [ - "dismiss_stale_reviews", - "require_code_owner_reviews" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "title": "Update pull request review protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "object", - "name": "dismissal_restrictions", - "description": "

Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins with dismissal access

" - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs with dismissal access

" - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs with dismissal access

" - } - ] - }, - { - "type": "boolean", - "name": "dismiss_stale_reviews", - "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

" - }, - { - "type": "boolean", - "name": "require_code_owner_reviews", - "description": "

Blocks merging pull requests until code owners have reviewed.

" - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

" - }, - { - "type": "boolean", - "name": "require_last_push_approval", - "description": "

Whether the most recent push must be approved by someone other than the person who pushed it. Default: false

", - "default": false - }, - { - "type": "object", - "name": "bypass_pull_request_allowances", - "description": "

Allow specific users, teams, or apps to bypass pull request requirements.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins allowed to bypass pull request requirements.

" - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs allowed to bypass pull request requirements.

" - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs allowed to bypass pull request requirements.

" - } - ] - } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

\n

Note

\n

\nPassing new arrays of users and teams replaces their previous values.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "dismissal_restrictions": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ], - "apps": [ - "octoapp" - ] - }, - "bypass_pull_request_allowances": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ], - "apps": [ - "octoapp" - ] - }, - "dismiss_stale_reviews": true, - "require_code_owner_reviews": true, - "required_approving_review_count": 2, - "require_last_push_approval": true - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", - "dismissal_restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", - "users": [ - { - "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 - } - ], - "teams": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "apps": [ - { - "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", - "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": "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" - ] - } - ] - }, - "dismiss_stale_reviews": true, - "require_code_owner_reviews": true, - "required_approving_review_count": 2, - "require_last_push_approval": true - }, - "schema": { - "title": "Protected Branch Pull Request Review", - "description": "Protected Branch Pull Request Review", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "dismissal_restrictions": { - "type": "object", - "properties": { - "users": { - "description": "The list of users with review dismissal access.", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "teams": { - "description": "The list of teams with review dismissal access.", - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "description": "The list of apps with review dismissal access.", - "type": "array", - "items": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - }, - "url": { - "type": "string" - }, - "users_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - } - } - }, - "bypass_pull_request_allowances": { - "type": "object", - "description": "Allow specific users, teams, or apps to bypass pull request requirements.", - "properties": { - "users": { - "description": "The list of users allowed to bypass pull request requirements.", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "teams": { - "description": "The list of teams allowed to bypass pull request requirements.", - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "description": "The list of apps allowed to bypass pull request requirements.", - "type": "array", - "items": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - } - } - }, - "dismiss_stale_reviews": { - "type": "boolean" - }, - "require_code_owner_reviews": { - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer", - "minimum": 0, - "maximum": 6 - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it.", - "type": "boolean", - "default": false - } - }, - "required": [ - "dismiss_stale_reviews", - "require_code_owner_reviews" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "title": "Delete pull request review protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "title": "Get commit signature protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.

\n

Note

\n

\nYou must enable branch protection to require signed commits.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", - "enabled": true - }, - "schema": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "enabled": { - "type": "boolean" - } - }, - "required": [ - "url", - "enabled" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "title": "Create commit signature protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", - "enabled": true - }, - "schema": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "enabled": { - "type": "boolean" - } - }, - "required": [ - "url", - "enabled" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "title": "Delete commit signature protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "title": "Get status checks protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ], - "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" - }, - "schema": { - "title": "Status Check Policy", - "description": "Status Check Policy", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "strict": { - "type": "boolean" - }, - "contexts": { - "type": "array", - "items": { - "type": "string" - } - }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": [ - "integer", - "null" - ] - } - }, - "required": [ - "context", - "app_id" - ] - } - }, - "contexts_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "contexts_url", - "strict", - "contexts", - "checks" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "title": "Update status check protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "strict", - "description": "

Require branches to be up to date before merging.

" - }, - { - "type": "array of strings", - "name": "contexts", - "description": "

Closing down notice: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

" - }, - { - "type": "array of objects", - "name": "checks", - "description": "

The list of status checks to require in order to merge into this branch.

", - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The name of the required check

", - "isRequired": true - }, - { - "type": "integer", - "name": "app_id", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" - } - ] - } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ], - "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" - }, - "schema": { - "title": "Status Check Policy", - "description": "Status Check Policy", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "strict": { - "type": "boolean" - }, - "contexts": { - "type": "array", - "items": { - "type": "string" - } - }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": [ - "integer", - "null" - ] - } - }, - "required": [ - "context", - "app_id" - ] - } - }, - "contexts_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "contexts_url", - "strict", - "contexts", - "checks" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "title": "Remove status check protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Get all status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - "continuous-integration/travis-ci" - ], - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Add status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "contexts", - "description": "

The name of the status checks

", - "isRequired": true - } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example adding status checks to a branch protection rule", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "contexts": [ - "continuous-integration/travis-ci", - "continuous-integration/jenkins" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - "continuous-integration/travis-ci", - "continuous-integration/jenkins" - ], - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Set status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "contexts", - "description": "

The name of the status checks

", - "isRequired": true - } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example updating status checks for a branch protection rule", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "contexts": [ - "continuous-integration/travis-ci" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - "continuous-integration/travis-ci" - ], - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Remove status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "contexts", - "description": "

The name of the status checks

", - "isRequired": true - } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example removing status checks from a branch protection rule", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "contexts": [ - "continuous-integration/jenkins" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - "continuous-integration/travis-ci" - ], - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "title": "Get access restrictions", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists who has access to this protected branch.

\n

Note

\n

\nUsers, apps, and teams restrictions are only available for organization-owned repositories.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", - "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", - "users": [ - { - "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 - } - ], - "teams": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "apps": [ - { - "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", - "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": "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" - ] - } - ] - }, - "schema": { - "title": "Branch Restriction Policy", - "description": "Branch Restriction Policy", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "users_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "apps_url": { - "type": "string", - "format": "uri" - }, - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "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" - }, - "user_view_type": { - "type": "string" - } - } - } - }, - "teams": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "apps": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "gravatar_id": { - "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" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "user_view_type": { - "type": "string" - } - } - }, - "name": { - "type": "string" - }, - "client_id": { - "type": "string" - }, - "description": { - "type": "string" - }, - "external_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "issues": { - "type": "string" - }, - "single_file": { - "type": "string" - } - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "required": [ - "url", - "users_url", - "teams_url", - "apps_url", - "users", - "teams", - "apps" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "title": "Delete access restrictions", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Disables the ability to restrict who can push to this branch.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "title": "Get apps with access to the protected branch", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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" - ] - } - ], - "schema": { - "type": "array", - "items": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "title": "Add app access restrictions", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "apps", - "description": "

The GitHub Apps that have push access to this branch. Use the slugified version of the app name. Note: The list of users, apps, and teams in total is limited to 100 items.

", - "isRequired": true - } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "apps": [ - "octoapp" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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" - ] - } - ], - "schema": { - "type": "array", - "items": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "title": "Set app access restrictions", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "apps", - "description": "

The GitHub Apps that have push access to this branch. Use the slugified version of the app name. Note: The list of users, apps, and teams in total is limited to 100 items.

", - "isRequired": true - } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "apps": [ - "octoapp" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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" - ] - } - ], - "schema": { - "type": "array", - "items": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "title": "Remove app access restrictions", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "apps", - "description": "

The GitHub Apps that have push access to this branch. Use the slugified version of the app name. Note: The list of users, apps, and teams in total is limited to 100 items.

", - "isRequired": true - } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "apps": [ - "my-app" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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" - ] - } - ], - "schema": { - "type": "array", - "items": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "title": "Get teams with access to the protected branch", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists the teams who have push access to this branch. The list includes child teams.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "title": "Add team access restrictions", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "teams", - "description": "

The slug values for teams

", - "isRequired": true - } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified teams push access for this branch. You can also give push access to child teams.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example adding a team in a branch protection rule", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "teams": [ - "justice-league" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "title": "Set team access restrictions", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "teams", - "description": "

The slug values for teams

", - "isRequired": true - } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example replacing a team in a branch protection rule", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "teams": [ - "justice-league" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "title": "Remove team access restrictions", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "teams", - "description": "

The slug values for teams

", - "isRequired": true - } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a team to push to this branch. You can also remove push access for child teams.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example removing a team in a branch protection rule", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "teams": [ - "octocats" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "title": "Get users with access to the protected branch", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists the people who have push access to this branch.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "title": "Add user access restrictions", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "users", - "description": "

The username for users

", - "isRequired": true - } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified people push access for this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example adding a user in a branch protection rule", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "users": [ - "octocat" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "title": "Set user access restrictions", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "users", - "description": "

The username for users

", - "isRequired": true - } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example replacing a user in a branch protection rule", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "users": [ - "octocat" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "title": "Remove user access restrictions", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "users", - "description": "

The username for users

", - "isRequired": true - } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a user to push to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example removing a user in a branch protection rule", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "users": [ - "octocat" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/checks.json b/src/rest/data/ghes-3.14-2022-11-28/checks.json deleted file mode 100644 index 972367124f2f..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/checks.json +++ /dev/null @@ -1,14225 +0,0 @@ -{ - "runs": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-runs", - "title": "Create a check run", - "category": "checks", - "subcategory": "runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "completed" - ] - } - ], - "descriptionHTML": "

Creates a new check run for a specific commit in a repository.

\n

To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.

\n

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.

\n

Note

\n

\nThe 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
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example of an in_progress conclusion", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "mighty_readme", - "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", - "status": "in_progress", - "external_id": "42", - "started_at": "2018-05-04T01:14:52Z", - "output": { - "title": "Mighty Readme report", - "summary": "", - "text": "" - } - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response for in_progress conclusion

", - "example": { - "id": 4, - "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", - "node_id": "MDg6Q2hlY2tSdW40", - "external_id": "42", - "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": "in_progress", - "conclusion": null, - "started_at": "2018-05-04T01:14:52Z", - "completed_at": null, - "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" - } - }, - "base": { - "ref": "master", - "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - } - } - ] - }, - "schema": { - "title": "CheckRun", - "description": "A check performed on the code of a given code change", - "type": "object", - "properties": { - "id": { - "description": "The id of the check.", - "type": "integer", - "format": "int64" - }, - "head_sha": { - "description": "The SHA of the commit that is being checked.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "external_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ] - }, - "details_url": { - "type": [ - "string", - "null" - ] - }, - "status": { - "description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "requested", - "pending" - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null - ] - }, - "started_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "completed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "output": { - "type": "object", - "properties": { - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "text": { - "type": [ - "string", - "null" - ] - }, - "annotations_count": { - "type": "integer" - }, - "annotations_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "title", - "summary", - "text", - "annotations_count", - "annotations_url" - ] - }, - "name": { - "description": "The name of the check.", - "type": "string" - }, - "check_suite": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - } - }, - "required": [ - "id" - ] - }, - "app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "pull_requests": { - "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.", - "type": "array", - "items": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "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", - "format": "int64" - }, - "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" - }, - "id": { - "description": "Unique identifier of the deployment", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "task": { - "description": "Parameter to specify a task to execute", - "type": "string" - }, - "original_environment": { - "type": "string" - }, - "environment": { - "description": "Name for the target deployment environment.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "transient_environment": { - "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", - "type": "boolean" - }, - "production_environment": { - "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", - "type": "boolean" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - } - }, - "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" - ] - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Example of a completed conclusion", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "mighty_readme", - "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", - "status": "completed", - "started_at": "2017-11-30T19:39:10Z", - "conclusion": "success", - "completed_at": "2017-11-30T19:49:10Z", - "output": { - "title": "Mighty Readme report", - "summary": "There are 0 failures, 2 warnings, and 1 notices.", - "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": [ - { - "path": "README.md", - "annotation_level": "warning", - "title": "Spell Checker", - "message": "Check your spelling for 'banaas'.", - "raw_details": "Do you mean 'bananas' or 'banana'?", - "start_line": 2, - "end_line": 2 - }, - { - "path": "README.md", - "annotation_level": "warning", - "title": "Spell Checker", - "message": "Check your spelling for 'aples'", - "raw_details": "Do you mean 'apples' or 'Naples'", - "start_line": 4, - "end_line": 4 - } - ], - "images": [ - { - "alt": "Super bananas", - "image_url": "http://example.com/images/42" - } - ] - }, - "actions": [ - { - "label": "Fix", - "identifier": "fix_errors", - "description": "Allow us to fix these errors for you" - } - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response for completed conclusion

", - "example": { - "id": 4, - "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", - "node_id": "MDg6Q2hlY2tSdW40", - "external_id": "42", - "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" - } - }, - "base": { - "ref": "master", - "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - } - } - ] - }, - "schema": { - "title": "CheckRun", - "description": "A check performed on the code of a given code change", - "type": "object", - "properties": { - "id": { - "description": "The id of the check.", - "type": "integer", - "format": "int64" - }, - "head_sha": { - "description": "The SHA of the commit that is being checked.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "external_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ] - }, - "details_url": { - "type": [ - "string", - "null" - ] - }, - "status": { - "description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "requested", - "pending" - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null - ] - }, - "started_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "completed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "output": { - "type": "object", - "properties": { - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "text": { - "type": [ - "string", - "null" - ] - }, - "annotations_count": { - "type": "integer" - }, - "annotations_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "title", - "summary", - "text", - "annotations_count", - "annotations_url" - ] - }, - "name": { - "description": "The name of the check.", - "type": "string" - }, - "check_suite": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - } - }, - "required": [ - "id" - ] - }, - "app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "pull_requests": { - "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.", - "type": "array", - "items": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "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", - "format": "int64" - }, - "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" - }, - "id": { - "description": "Unique identifier of the deployment", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "task": { - "description": "Parameter to specify a task to execute", - "type": "string" - }, - "original_environment": { - "type": "string" - }, - "environment": { - "description": "Name for the target deployment environment.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "transient_environment": { - "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", - "type": "boolean" - }, - "production_environment": { - "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", - "type": "boolean" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - } - }, - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Checks\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "title": "Get a check run", - "category": "checks", - "subcategory": "runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "check_run_id", - "description": "

The unique identifier of the check run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a single check run using its id.

\n

Note

\n

\nThe 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
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "check_run_id": "CHECK_RUN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - } - }, - "base": { - "ref": "master", - "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - } - } - ] - }, - "schema": { - "title": "CheckRun", - "description": "A check performed on the code of a given code change", - "type": "object", - "properties": { - "id": { - "description": "The id of the check.", - "type": "integer", - "format": "int64" - }, - "head_sha": { - "description": "The SHA of the commit that is being checked.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "external_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ] - }, - "details_url": { - "type": [ - "string", - "null" - ] - }, - "status": { - "description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "requested", - "pending" - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null - ] - }, - "started_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "completed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "output": { - "type": "object", - "properties": { - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "text": { - "type": [ - "string", - "null" - ] - }, - "annotations_count": { - "type": "integer" - }, - "annotations_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "title", - "summary", - "text", - "annotations_count", - "annotations_url" - ] - }, - "name": { - "description": "The name of the check.", - "type": "string" - }, - "check_suite": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - } - }, - "required": [ - "id" - ] - }, - "app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "pull_requests": { - "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.", - "type": "array", - "items": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "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", - "format": "int64" - }, - "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" - }, - "id": { - "description": "Unique identifier of the deployment", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "task": { - "description": "Parameter to specify a task to execute", - "type": "string" - }, - "original_environment": { - "type": "string" - }, - "environment": { - "description": "Name for the target deployment environment.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "transient_environment": { - "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", - "type": "boolean" - }, - "production_environment": { - "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", - "type": "boolean" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - } - }, - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Checks\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "title": "Update a check run", - "category": "checks", - "subcategory": "runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "check_run_id", - "description": "

The unique identifier of the check run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the check. For example, \"code-coverage\".

" - }, - { - "type": "string", - "name": "details_url", - "description": "

The URL of the integrator's site that has the full details of the check.

" - }, - { - "type": "string", - "name": "external_id", - "description": "

A reference for the run on the integrator's system.

" - }, - { - "type": "string", - "name": "started_at", - "description": "

This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "string", - "name": "status", - "description": "

The current status of the check run. Only GitHub Actions can set a status of waiting, pending, or requested.

", - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "requested", - "pending" - ] - }, - { - "type": "string", - "name": "conclusion", - "description": "

Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

", - "enum": [ - "action_required", - "cancelled", - "failure", - "neutral", - "success", - "skipped", - "stale", - "timed_out" - ] - }, - { - "type": "string", - "name": "completed_at", - "description": "

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "object", - "name": "output", - "description": "

Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run.

", - "childParamsGroups": [ - { - "type": "string", - "name": "title", - "description": "

Required.

" - }, - { - "type": "string", - "name": "summary", - "description": "

Can contain Markdown.

", - "isRequired": true - }, - { - "type": "string", - "name": "text", - "description": "

Can contain Markdown.

" - }, - { - "type": "array of objects", - "name": "annotations", - "description": "

Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"About status checks\".

", - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "

The path of the file to add an annotation to. For example, assets/css/main.css.

", - "isRequired": true - }, - { - "type": "integer", - "name": "start_line", - "description": "

The start line of the annotation. Line numbers start at 1.

", - "isRequired": true - }, - { - "type": "integer", - "name": "end_line", - "description": "

The end line of the annotation.

", - "isRequired": true - }, - { - "type": "integer", - "name": "start_column", - "description": "

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values. Column numbers start at 1.

" - }, - { - "type": "integer", - "name": "end_column", - "description": "

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

" - }, - { - "type": "string", - "name": "annotation_level", - "description": "

The level of the annotation.

", - "isRequired": true, - "enum": [ - "notice", - "warning", - "failure" - ] - }, - { - "type": "string", - "name": "message", - "description": "

A short description of the feedback for these lines of code. The maximum size is 64 KB.

", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title that represents the annotation. The maximum size is 255 characters.

" - }, - { - "type": "string", - "name": "raw_details", - "description": "

Details about this annotation. The maximum size is 64 KB.

" - } - ] - }, - { - "type": "array of objects", - "name": "images", - "description": "

Adds images to the output displayed in the GitHub pull request UI.

", - "childParamsGroups": [ - { - "type": "string", - "name": "alt", - "description": "

The alternative text for the image.

", - "isRequired": true - }, - { - "type": "string", - "name": "image_url", - "description": "

The full URL of the image.

", - "isRequired": true - }, - { - "type": "string", - "name": "caption", - "description": "

A short image description.

" - } - ] - } - ] - }, - { - "type": "array of objects", - "name": "actions", - "description": "

Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

A short explanation of what this action would do. The maximum size is 40 characters.

", - "isRequired": true - }, - { - "type": "string", - "name": "identifier", - "description": "

A reference for the action on the integrator's system. The maximum size is 20 characters.

", - "isRequired": true - } - ] - } - ], - "descriptionHTML": "

Updates a check run for a specific commit in a repository.

\n

Note

\n

\nThe endpoints to manage checks only look 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
\n

OAuth apps and personal access tokens (classic) cannot use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "mighty_readme", - "started_at": "2018-05-04T01:14:52Z", - "status": "completed", - "conclusion": "success", - "completed_at": "2018-05-04T01:14:52Z", - "output": { - "title": "Mighty Readme report", - "summary": "There are 0 failures, 2 warnings, and 1 notices.", - "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": [ - { - "path": "README.md", - "annotation_level": "warning", - "title": "Spell Checker", - "message": "Check your spelling for 'banaas'.", - "raw_details": "Do you mean 'bananas' or 'banana'?", - "start_line": 2, - "end_line": 2 - }, - { - "path": "README.md", - "annotation_level": "warning", - "title": "Spell Checker", - "message": "Check your spelling for 'aples'", - "raw_details": "Do you mean 'apples' or 'Naples'", - "start_line": 4, - "end_line": 4 - } - ], - "images": [ - { - "alt": "Super bananas", - "image_url": "http://example.com/images/42" - } - ] - } - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "check_run_id": "CHECK_RUN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - } - }, - "base": { - "ref": "master", - "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - } - } - ] - }, - "schema": { - "title": "CheckRun", - "description": "A check performed on the code of a given code change", - "type": "object", - "properties": { - "id": { - "description": "The id of the check.", - "type": "integer", - "format": "int64" - }, - "head_sha": { - "description": "The SHA of the commit that is being checked.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "external_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ] - }, - "details_url": { - "type": [ - "string", - "null" - ] - }, - "status": { - "description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "requested", - "pending" - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null - ] - }, - "started_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "completed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "output": { - "type": "object", - "properties": { - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "text": { - "type": [ - "string", - "null" - ] - }, - "annotations_count": { - "type": "integer" - }, - "annotations_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "title", - "summary", - "text", - "annotations_count", - "annotations_url" - ] - }, - "name": { - "description": "The name of the check.", - "type": "string" - }, - "check_suite": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - } - }, - "required": [ - "id" - ] - }, - "app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "pull_requests": { - "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.", - "type": "array", - "items": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "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", - "format": "int64" - }, - "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" - }, - "id": { - "description": "Unique identifier of the deployment", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "task": { - "description": "Parameter to specify a task to execute", - "type": "string" - }, - "original_environment": { - "type": "string" - }, - "environment": { - "description": "Name for the target deployment environment.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "transient_environment": { - "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", - "type": "boolean" - }, - "production_environment": { - "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", - "type": "boolean" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - } - }, - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Checks\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", - "title": "List check run annotations", - "category": "checks", - "subcategory": "runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "check_run_id", - "description": "

The unique identifier of the check run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists annotations for a check run using the annotation id.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "check_run_id": "CHECK_RUN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "path": "README.md", - "start_line": 2, - "end_line": 2, - "start_column": 5, - "end_column": 10, - "annotation_level": "warning", - "title": "Spell Checker", - "message": "Check your spelling for 'banaas'.", - "raw_details": "Do you mean 'bananas' or 'banana'?", - "blob_href": "https://api.github.com/repos/github/rest-api-description/git/blobs/abc" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Check Annotation", - "description": "Check Annotation", - "type": "object", - "properties": { - "path": { - "type": "string" - }, - "start_line": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "start_column": { - "type": [ - "integer", - "null" - ] - }, - "end_column": { - "type": [ - "integer", - "null" - ] - }, - "annotation_level": { - "type": [ - "string", - "null" - ] - }, - "title": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - }, - "raw_details": { - "type": [ - "string", - "null" - ] - }, - "blob_href": { - "type": "string" - } - }, - "required": [ - "path", - "blob_href", - "start_line", - "end_line", - "start_column", - "end_column", - "annotation_level", - "title", - "message", - "raw_details" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Checks\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest", - "title": "Rerequest a check run", - "category": "checks", - "subcategory": "runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "check_run_id", - "description": "

The unique identifier of the check run.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhook event with the action rerequested. When a check run is rerequested, the status of the check suite it belongs to is reset to queued and the conclusion is cleared. The check run itself is not updated. GitHub apps recieving the check_run webhook with the rerequested action should then decide if the check run should be reset or updated and call the update check_run endpoint to update the check_run if desired.

\n

For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "check_run_id": "CHECK_RUN_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation error if the check run is not rerequestable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Checks\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", - "title": "List check runs in a check suite", - "category": "checks", - "subcategory": "runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "check_suite_id", - "description": "

The unique identifier of the check suite.

", - "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.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed" - ] - } - }, - { - "name": "filter", - "description": "

Filters check runs by their completed_at timestamp. latest returns the most recent check runs.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "latest", - "all" - ], - "default": "latest" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists check runs for a check suite using its id.

\n

Note

\n

\nThe endpoints to manage checks only look 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
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "check_suite_id": "CHECK_SUITE_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - } - }, - "base": { - "ref": "master", - "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - } - } - ] - } - ] - }, - "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.", - "type": "integer", - "format": "int64" - }, - "head_sha": { - "description": "The SHA of the commit that is being checked.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "external_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ] - }, - "details_url": { - "type": [ - "string", - "null" - ] - }, - "status": { - "description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "requested", - "pending" - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null - ] - }, - "started_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "completed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "output": { - "type": "object", - "properties": { - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "text": { - "type": [ - "string", - "null" - ] - }, - "annotations_count": { - "type": "integer" - }, - "annotations_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "title", - "summary", - "text", - "annotations_count", - "annotations_url" - ] - }, - "name": { - "description": "The name of the check.", - "type": "string" - }, - "check_suite": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - } - }, - "required": [ - "id" - ] - }, - "app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "pull_requests": { - "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.", - "type": "array", - "items": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "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", - "format": "int64" - }, - "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" - }, - "id": { - "description": "Unique identifier of the deployment", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "task": { - "description": "Parameter to specify a task to execute", - "type": "string" - }, - "original_environment": { - "type": "string" - }, - "environment": { - "description": "Name for the target deployment environment.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "transient_environment": { - "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", - "type": "boolean" - }, - "production_environment": { - "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", - "type": "boolean" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - } - }, - "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" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Checks\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-runs", - "title": "List check runs for a Git reference", - "category": "checks", - "subcategory": "runs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "description": "

The commit reference. Can be a commit SHA, branch name (heads/BRANCH_NAME), or tag name (tags/TAG_NAME). For more information, see \"Git References\" in the Git documentation.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed" - ] - } - }, - { - "name": "filter", - "description": "

Filters check runs by their completed_at timestamp. latest returns the most recent check runs.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "latest", - "all" - ], - "default": "latest" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "app_id", - "in": "query", - "required": false, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.

\n

Note

\n

\nThe endpoints to manage checks only look 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
\n

If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the List check suites for a Git reference endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "ref": "REF" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - } - }, - "base": { - "ref": "master", - "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - } - } - ] - } - ] - }, - "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.", - "type": "integer", - "format": "int64" - }, - "head_sha": { - "description": "The SHA of the commit that is being checked.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "external_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ] - }, - "details_url": { - "type": [ - "string", - "null" - ] - }, - "status": { - "description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "requested", - "pending" - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null - ] - }, - "started_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "completed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "output": { - "type": "object", - "properties": { - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "text": { - "type": [ - "string", - "null" - ] - }, - "annotations_count": { - "type": "integer" - }, - "annotations_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "title", - "summary", - "text", - "annotations_count", - "annotations_url" - ] - }, - "name": { - "description": "The name of the check.", - "type": "string" - }, - "check_suite": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - } - }, - "required": [ - "id" - ] - }, - "app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "pull_requests": { - "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.", - "type": "array", - "items": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "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", - "format": "int64" - }, - "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" - }, - "id": { - "description": "Unique identifier of the deployment", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "task": { - "description": "Parameter to specify a task to execute", - "type": "string" - }, - "original_environment": { - "type": "string" - }, - "environment": { - "description": "Name for the target deployment environment.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "transient_environment": { - "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", - "type": "boolean" - }, - "production_environment": { - "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", - "type": "boolean" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - } - }, - "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" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Checks\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ], - "suites": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-suites", - "title": "Create a check suite", - "category": "checks", - "subcategory": "suites", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "head_sha", - "description": "

The sha of the head commit.

", - "isRequired": true - } - ], - "descriptionHTML": "

Creates a check suite manually. 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\".

\n

Note

\n

\nThe 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
\n

OAuth apps and personal access tokens (classic) cannot use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response when the suite already exists

", - "example": { - "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, - "allow_auto_merge": false, - "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" - }, - "schema": { - "title": "CheckSuite", - "description": "A suite of checks performed on the code of a given code change", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "head_branch": { - "type": [ - "string", - "null" - ] - }, - "head_sha": { - "description": "The SHA of the head commit that is being checked.", - "type": "string" - }, - "status": { - "type": [ - "string", - "null" - ], - "description": "The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.", - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "requested", - "pending", - null - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - "startup_failure", - "stale", - null - ] - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "before": { - "type": [ - "string", - "null" - ] - }, - "after": { - "type": [ - "string", - "null" - ] - }, - "pull_requests": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "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", - "format": "int64" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" - ] - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - } - }, - "required": [ - "id", - "number", - "url", - "head", - "base" - ] - } - }, - "app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "head_commit": { - "title": "Simple Commit", - "description": "A commit.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "SHA for the commit" - }, - "tree_id": { - "type": "string", - "description": "SHA for the commit's tree" - }, - "message": { - "description": "Message describing the purpose of the commit", - "type": "string" - }, - "timestamp": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string" - }, - "author": { - "type": [ - "object", - "null" - ], - "description": "Information about the Git author", - "properties": { - "name": { - "description": "Name of the commit's author", - "type": "string" - }, - "email": { - "description": "Git email address of the commit's author", - "type": "string", - "format": "email" - } - }, - "required": [ - "name", - "email" - ] - }, - "committer": { - "type": [ - "object", - "null" - ], - "description": "Information about the Git committer", - "properties": { - "name": { - "description": "Name of the commit's committer", - "type": "string" - }, - "email": { - "description": "Git email address of the commit's committer", - "type": "string", - "format": "email" - } - }, - "required": [ - "name", - "email" - ] - } - }, - "required": [ - "id", - "tree_id", - "message", - "timestamp", - "author", - "committer" - ] - }, - "latest_check_runs_count": { - "type": "integer" - }, - "check_runs_url": { - "type": "string" - }, - "rerequestable": { - "type": "boolean" - }, - "runs_rerequestable": { - "type": "boolean" - } - }, - "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" - ] - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response when the suite was created

", - "example": { - "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, - "allow_auto_merge": false, - "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" - }, - "schema": { - "title": "CheckSuite", - "description": "A suite of checks performed on the code of a given code change", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "head_branch": { - "type": [ - "string", - "null" - ] - }, - "head_sha": { - "description": "The SHA of the head commit that is being checked.", - "type": "string" - }, - "status": { - "type": [ - "string", - "null" - ], - "description": "The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.", - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "requested", - "pending", - null - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - "startup_failure", - "stale", - null - ] - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "before": { - "type": [ - "string", - "null" - ] - }, - "after": { - "type": [ - "string", - "null" - ] - }, - "pull_requests": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "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", - "format": "int64" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" - ] - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - } - }, - "required": [ - "id", - "number", - "url", - "head", - "base" - ] - } - }, - "app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "head_commit": { - "title": "Simple Commit", - "description": "A commit.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "SHA for the commit" - }, - "tree_id": { - "type": "string", - "description": "SHA for the commit's tree" - }, - "message": { - "description": "Message describing the purpose of the commit", - "type": "string" - }, - "timestamp": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string" - }, - "author": { - "type": [ - "object", - "null" - ], - "description": "Information about the Git author", - "properties": { - "name": { - "description": "Name of the commit's author", - "type": "string" - }, - "email": { - "description": "Git email address of the commit's author", - "type": "string", - "format": "email" - } - }, - "required": [ - "name", - "email" - ] - }, - "committer": { - "type": [ - "object", - "null" - ], - "description": "Information about the Git committer", - "properties": { - "name": { - "description": "Name of the commit's committer", - "type": "string" - }, - "email": { - "description": "Git email address of the commit's committer", - "type": "string", - "format": "email" - } - }, - "required": [ - "name", - "email" - ] - } - }, - "required": [ - "id", - "tree_id", - "message", - "timestamp", - "author", - "committer" - ] - }, - "latest_check_runs_count": { - "type": "integer" - }, - "check_runs_url": { - "type": "string" - }, - "rerequestable": { - "type": "boolean" - }, - "runs_rerequestable": { - "type": "boolean" - } - }, - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Response when the suite already exists

" - }, - { - "httpStatusCode": "201", - "description": "

Response when the suite was created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Checks\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/check-suites/preferences", - "title": "Update repository preferences for check suites", - "category": "checks", - "subcategory": "suites", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of objects", - "name": "auto_trigger_checks", - "description": "

Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "app_id", - "description": "

The id of the GitHub App.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "setting", - "description": "

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

", - "isRequired": true, - "default": true - } - ] - } - ], - "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.\nYou must have admin permissions in the repository to set preferences for check suites.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "auto_trigger_checks": [ - { - "app_id": 4, - "setting": false - } - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "preferences": { - "auto_trigger_checks": [ - { - "app_id": 2, - "setting": true - }, - { - "app_id": 4, - "setting": false - } - ] - }, - "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": 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, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - } - } - }, - "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": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Checks\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", - "title": "Get a check suite", - "category": "checks", - "subcategory": "suites", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "check_suite_id", - "description": "

The unique identifier of the check suite.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a single check suite using its id.

\n

Note

\n

\nThe 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
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "check_suite_id": "CHECK_SUITE_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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, - "allow_auto_merge": false, - "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" - }, - "schema": { - "title": "CheckSuite", - "description": "A suite of checks performed on the code of a given code change", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "head_branch": { - "type": [ - "string", - "null" - ] - }, - "head_sha": { - "description": "The SHA of the head commit that is being checked.", - "type": "string" - }, - "status": { - "type": [ - "string", - "null" - ], - "description": "The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.", - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "requested", - "pending", - null - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - "startup_failure", - "stale", - null - ] - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "before": { - "type": [ - "string", - "null" - ] - }, - "after": { - "type": [ - "string", - "null" - ] - }, - "pull_requests": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "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", - "format": "int64" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" - ] - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - } - }, - "required": [ - "id", - "number", - "url", - "head", - "base" - ] - } - }, - "app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "head_commit": { - "title": "Simple Commit", - "description": "A commit.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "SHA for the commit" - }, - "tree_id": { - "type": "string", - "description": "SHA for the commit's tree" - }, - "message": { - "description": "Message describing the purpose of the commit", - "type": "string" - }, - "timestamp": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string" - }, - "author": { - "type": [ - "object", - "null" - ], - "description": "Information about the Git author", - "properties": { - "name": { - "description": "Name of the commit's author", - "type": "string" - }, - "email": { - "description": "Git email address of the commit's author", - "type": "string", - "format": "email" - } - }, - "required": [ - "name", - "email" - ] - }, - "committer": { - "type": [ - "object", - "null" - ], - "description": "Information about the Git committer", - "properties": { - "name": { - "description": "Name of the commit's committer", - "type": "string" - }, - "email": { - "description": "Git email address of the commit's committer", - "type": "string", - "format": "email" - } - }, - "required": [ - "name", - "email" - ] - } - }, - "required": [ - "id", - "tree_id", - "message", - "timestamp", - "author", - "committer" - ] - }, - "latest_check_runs_count": { - "type": "integer" - }, - "check_runs_url": { - "type": "string" - }, - "rerequestable": { - "type": "boolean" - }, - "runs_rerequestable": { - "type": "boolean" - } - }, - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Checks\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", - "title": "Rerequest a check suite", - "category": "checks", - "subcategory": "suites", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "check_suite_id", - "description": "

The unique identifier of the check suite.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "check_suite_id": "CHECK_SUITE_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Checks\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-suites", - "title": "List check suites for a Git reference", - "category": "checks", - "subcategory": "suites", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "description": "

The commit reference. Can be a commit SHA, branch name (heads/BRANCH_NAME), or tag name (tags/TAG_NAME). For more information, see \"Git References\" in the Git documentation.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "app_id", - "description": "

Filters check suites by GitHub App id.

", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "check_name", - "description": "

Returns check runs with the specified name.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name.

\n

Note

\n

\nThe endpoints to manage checks only look 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
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "ref": "REF" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 1, - "check_suites": [ - { - "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": [], - "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", - "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 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "delete_branch_on_merge": true, - "subscribers_count": 42, - "network_count": 0 - }, - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "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" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "check_suites" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "check_suites": { - "type": "array", - "items": { - "title": "CheckSuite", - "description": "A suite of checks performed on the code of a given code change", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "head_branch": { - "type": [ - "string", - "null" - ] - }, - "head_sha": { - "description": "The SHA of the head commit that is being checked.", - "type": "string" - }, - "status": { - "type": [ - "string", - "null" - ], - "description": "The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.", - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "requested", - "pending", - null - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - "startup_failure", - "stale", - null - ] - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "before": { - "type": [ - "string", - "null" - ] - }, - "after": { - "type": [ - "string", - "null" - ] - }, - "pull_requests": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "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", - "format": "int64" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" - ] - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - } - }, - "required": [ - "id", - "number", - "url", - "head", - "base" - ] - } - }, - "app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "head_commit": { - "title": "Simple Commit", - "description": "A commit.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "SHA for the commit" - }, - "tree_id": { - "type": "string", - "description": "SHA for the commit's tree" - }, - "message": { - "description": "Message describing the purpose of the commit", - "type": "string" - }, - "timestamp": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string" - }, - "author": { - "type": [ - "object", - "null" - ], - "description": "Information about the Git author", - "properties": { - "name": { - "description": "Name of the commit's author", - "type": "string" - }, - "email": { - "description": "Git email address of the commit's author", - "type": "string", - "format": "email" - } - }, - "required": [ - "name", - "email" - ] - }, - "committer": { - "type": [ - "object", - "null" - ], - "description": "Information about the Git committer", - "properties": { - "name": { - "description": "Name of the commit's committer", - "type": "string" - }, - "email": { - "description": "Git email address of the commit's committer", - "type": "string", - "format": "email" - } - }, - "required": [ - "name", - "email" - ] - } - }, - "required": [ - "id", - "tree_id", - "message", - "timestamp", - "author", - "committer" - ] - }, - "latest_check_runs_count": { - "type": "integer" - }, - "check_runs_url": { - "type": "string" - }, - "rerequestable": { - "type": "boolean" - }, - "runs_rerequestable": { - "type": "boolean" - } - }, - "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" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Checks\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/code-scanning.json b/src/rest/data/ghes-3.14-2022-11-28/code-scanning.json deleted file mode 100644 index 75f9a654776d..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/code-scanning.json +++ /dev/null @@ -1,6990 +0,0 @@ -{ - "code-scanning": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/code-scanning/alerts", - "title": "List code scanning alerts for an enterprise", - "category": "code-scanning", - "subcategory": "code-scanning", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "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": { - "type": [ - "string", - "null" - ], - "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." - } - }, - { - "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "state", - "description": "

If specified, only code scanning alerts with this state will be returned.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "State of a code scanning alert.", - "enum": [ - "open", - "closed", - "dismissed", - "fixed" - ] - } - }, - { - "name": "sort", - "description": "

The property by which to sort the results.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "assignees", - "description": "

Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be a member of the enterprise to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the security_events or repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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, - "dismissed_comment": null, - "rule": { - "id": "js/zipslip", - "severity": "error", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "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", - "category": ".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" - ] - }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances", - "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}", - "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}", - "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": "https://api.github.com/repos/octocat/Hello-World/hooks" - } - }, - { - "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", - "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", - "rule": { - "id": "js/zipslip", - "severity": "error", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "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", - "category": ".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", - "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}", - "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}", - "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": "https://api.github.com/repos/octocat/Hello-World/hooks" - } - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "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 - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "instances_url": { - "type": "string", - "description": "The REST API URL for fetching the list of instances for an alert.", - "format": "uri", - "readOnly": true - }, - "state": { - "type": [ - "string", - "null" - ], - "description": "State of a code scanning alert.", - "enum": [ - "open", - "dismissed", - "fixed", - null - ] - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "The dismissal comment associated with the dismissal of the alert.", - "maxLength": 280 - }, - "rule": { - "type": "object", - "properties": { - "id": { - "type": [ - "string", - "null" - ], - "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": { - "type": [ - "string", - "null" - ], - "description": "The severity of the alert.", - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "security_severity_level": { - "type": [ - "string", - "null" - ], - "description": "The security severity of the alert.", - "enum": [ - "low", - "medium", - "high", - "critical", - null - ] - }, - "description": { - "type": "string", - "description": "A short description of the rule used to detect the alert." - }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - } - } - }, - "tool": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the tool used to generate the code scanning analysis." - }, - "version": { - "type": [ - "string", - "null" - ], - "description": "The version of the tool used to generate the code scanning analysis." - }, - "guid": { - "type": [ - "string", - "null" - ], - "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 Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." - }, - "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." - }, - "category": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." - }, - "state": { - "type": [ - "string", - "null" - ], - "description": "State of a code scanning alert.", - "enum": [ - "open", - "dismissed", - "fixed", - null - ] - }, - "commit_sha": { - "type": "string" - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "markdown": { - "type": "string", - "description": "The message text as GitHub-flavored Markdown, with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance." - } - } - }, - "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", - "null" - ], - "description": "A classification of the file. For example to identify it as generated.", - "enum": [ - "source", - "generated", - "test", - "library", - null - ] - } - } - } - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the 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", - "url" - ] - }, - "dismissal_approved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "instances_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool", - "most_recent_instance", - "repository" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/code-scanning/alerts", - "title": "List code scanning alerts for an organization", - "category": "code-scanning", - "subcategory": "code-scanning", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "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": { - "type": [ - "string", - "null" - ], - "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." - } - }, - { - "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "state", - "description": "

If specified, only code scanning alerts with this state will be returned.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "State of a code scanning alert.", - "enum": [ - "open", - "closed", - "dismissed", - "fixed" - ] - } - }, - { - "name": "sort", - "description": "

The property by which to sort the results.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "severity", - "description": "

If specified, only code scanning alerts with this severity will be returned.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "Severity of a code scanning alert.", - "enum": [ - "critical", - "high", - "medium", - "low", - "warning", - "note", - "error" - ] - } - }, - { - "name": "assignees", - "description": "

Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an owner or security manager for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the security_events or repos cope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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, - "dismissed_comment": null, - "rule": { - "id": "js/zipslip", - "severity": "error", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "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", - "category": ".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" - ] - }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances", - "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}", - "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}", - "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": "https://api.github.com/repos/octocat/Hello-World/hooks" - } - }, - { - "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", - "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", - "rule": { - "id": "js/zipslip", - "severity": "error", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "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", - "category": ".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", - "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}", - "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}", - "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": "https://api.github.com/repos/octocat/Hello-World/hooks" - } - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "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 - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "instances_url": { - "type": "string", - "description": "The REST API URL for fetching the list of instances for an alert.", - "format": "uri", - "readOnly": true - }, - "state": { - "type": [ - "string", - "null" - ], - "description": "State of a code scanning alert.", - "enum": [ - "open", - "dismissed", - "fixed", - null - ] - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "The dismissal comment associated with the dismissal of the alert.", - "maxLength": 280 - }, - "rule": { - "type": "object", - "properties": { - "id": { - "type": [ - "string", - "null" - ], - "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": { - "type": [ - "string", - "null" - ], - "description": "The severity of the alert.", - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "security_severity_level": { - "type": [ - "string", - "null" - ], - "description": "The security severity of the alert.", - "enum": [ - "low", - "medium", - "high", - "critical", - null - ] - }, - "description": { - "type": "string", - "description": "A short description of the rule used to detect the alert." - }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - } - } - }, - "tool": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the tool used to generate the code scanning analysis." - }, - "version": { - "type": [ - "string", - "null" - ], - "description": "The version of the tool used to generate the code scanning analysis." - }, - "guid": { - "type": [ - "string", - "null" - ], - "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 Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." - }, - "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." - }, - "category": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." - }, - "state": { - "type": [ - "string", - "null" - ], - "description": "State of a code scanning alert.", - "enum": [ - "open", - "dismissed", - "fixed", - null - ] - }, - "commit_sha": { - "type": "string" - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "markdown": { - "type": "string", - "description": "The message text as GitHub-flavored Markdown, with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance." - } - } - }, - "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", - "null" - ], - "description": "A classification of the file. For example to identify it as generated.", - "enum": [ - "source", - "generated", - "test", - "library", - null - ] - } - } - } - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the 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", - "url" - ] - }, - "dismissal_approved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "instances_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool", - "most_recent_instance", - "repository" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Code scanning alerts\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts", - "title": "List code scanning alerts for a repository", - "category": "code-scanning", - "subcategory": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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": { - "type": [ - "string", - "null" - ], - "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "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/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "sort", - "description": "

The property by which to sort the results.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "state", - "description": "

If specified, only code scanning alerts with this state will be returned.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "State of a code scanning alert.", - "enum": [ - "open", - "closed", - "dismissed", - "fixed" - ] - } - }, - { - "name": "severity", - "description": "

If specified, only code scanning alerts with this severity will be returned.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "Severity of a code scanning alert.", - "enum": [ - "critical", - "high", - "medium", - "low", - "warning", - "note", - "error" - ] - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists code scanning alerts.

\n

The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the default branch (or for the specified Git reference if you used ref in the request).

\n

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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", - "fixed_at": null, - "dismissed_by": null, - "dismissed_at": null, - "dismissed_reason": null, - "dismissed_comment": null, - "rule": { - "id": "js/zipslip", - "severity": "error", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "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", - "category": ".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" - ] - }, - "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", - "fixed_at": null, - "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", - "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", - "rule": { - "id": "js/zipslip", - "severity": "error", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "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", - "category": ".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" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "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 - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "instances_url": { - "type": "string", - "description": "The REST API URL for fetching the list of instances for an alert.", - "format": "uri", - "readOnly": true - }, - "state": { - "type": [ - "string", - "null" - ], - "description": "State of a code scanning alert.", - "enum": [ - "open", - "dismissed", - "fixed", - null - ] - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "The dismissal comment associated with the dismissal of the alert.", - "maxLength": 280 - }, - "rule": { - "type": "object", - "properties": { - "id": { - "type": [ - "string", - "null" - ], - "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": { - "type": [ - "string", - "null" - ], - "description": "The severity of the alert.", - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "security_severity_level": { - "type": [ - "string", - "null" - ], - "description": "The security severity of the alert.", - "enum": [ - "low", - "medium", - "high", - "critical", - null - ] - }, - "description": { - "type": "string", - "description": "A short description of the rule used to detect the alert." - }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - } - } - }, - "tool": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the tool used to generate the code scanning analysis." - }, - "version": { - "type": [ - "string", - "null" - ], - "description": "The version of the tool used to generate the code scanning analysis." - }, - "guid": { - "type": [ - "string", - "null" - ], - "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 Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." - }, - "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." - }, - "category": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." - }, - "state": { - "type": [ - "string", - "null" - ], - "description": "State of a code scanning alert.", - "enum": [ - "open", - "dismissed", - "fixed", - null - ] - }, - "commit_sha": { - "type": "string" - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "markdown": { - "type": "string", - "description": "The message text as GitHub-flavored Markdown, with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance." - } - } - }, - "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", - "null" - ], - "description": "A classification of the file. For example to identify it as generated.", - "enum": [ - "source", - "generated", - "test", - "library", - null - ] - } - } - } - }, - "dismissal_approved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "instances_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool", - "most_recent_instance" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Response if GitHub Advanced Security is not enabled for this repository

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Code scanning alerts\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "title": "Get a code scanning alert", - "category": "code-scanning", - "subcategory": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a single code scanning alert.

\n

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "alert_number": "ALERT_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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", - "fixed_at": null, - "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", - "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", - "rule": { - "id": "js/zipslip", - "severity": "error", - "security_severity_level": "high", - "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 ...", - "help_uri": "https://codeql.github.com/" - }, - "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", - "category": ".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" - }, - "schema": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "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 - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "instances_url": { - "type": "string", - "description": "The REST API URL for fetching the list of instances for an alert.", - "format": "uri", - "readOnly": true - }, - "state": { - "type": [ - "string", - "null" - ], - "description": "State of a code scanning alert.", - "enum": [ - "open", - "dismissed", - "fixed", - null - ] - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "The dismissal comment associated with the dismissal of the alert.", - "maxLength": 280 - }, - "rule": { - "type": "object", - "properties": { - "id": { - "type": [ - "string", - "null" - ], - "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": { - "type": [ - "string", - "null" - ], - "description": "The severity of the alert.", - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "security_severity_level": { - "type": [ - "string", - "null" - ], - "description": "The security severity of the alert.", - "enum": [ - "low", - "medium", - "high", - "critical", - null - ] - }, - "description": { - "type": "string", - "description": "A short description of the rule used to detect the alert." - }, - "full_description": { - "type": "string", - "description": "A description of the rule used to detect the alert." - }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, - "help": { - "type": [ - "string", - "null" - ], - "description": "Detailed documentation for the rule as GitHub Flavored Markdown." - }, - "help_uri": { - "type": [ - "string", - "null" - ], - "description": "A link to the documentation for 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": { - "type": [ - "string", - "null" - ], - "description": "The version of the tool used to generate the code scanning analysis." - }, - "guid": { - "type": [ - "string", - "null" - ], - "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 Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." - }, - "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." - }, - "category": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." - }, - "state": { - "type": [ - "string", - "null" - ], - "description": "State of a code scanning alert.", - "enum": [ - "open", - "dismissed", - "fixed", - null - ] - }, - "commit_sha": { - "type": "string" - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "markdown": { - "type": "string", - "description": "The message text as GitHub-flavored Markdown, with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance." - } - } - }, - "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", - "null" - ], - "description": "A classification of the file. For example to identify it as generated.", - "enum": [ - "source", - "generated", - "test", - "library", - null - ] - } - } - } - }, - "dismissal_approved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "instances_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool", - "most_recent_instance" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Response if GitHub Advanced Security is not enabled for this repository

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Code scanning alerts\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "title": "Update a code scanning alert", - "category": "code-scanning", - "subcategory": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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 - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "state", - "description": "

Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.

", - "isRequired": true, - "enum": [ - "open", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

Required when the state is dismissed. The reason for dismissing or closing the alert.

", - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

The dismissal comment associated with the dismissal of the alert.

" - }, - { - "type": "array of strings", - "name": "assignees", - "description": "

The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert.

" - } - ], - "descriptionHTML": "

Updates the status of a single code scanning alert.\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "state": "dismissed", - "dismissed_reason": "false positive", - "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library." - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "alert_number": "ALERT_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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", - "fixed_at": null, - "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", - "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", - "rule": { - "id": "js/zipslip", - "severity": "error", - "security_severity_level": "high", - "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 ...", - "help_uri": "https://codeql.github.com/" - }, - "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", - "category": ".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" - }, - "schema": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "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 - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "instances_url": { - "type": "string", - "description": "The REST API URL for fetching the list of instances for an alert.", - "format": "uri", - "readOnly": true - }, - "state": { - "type": [ - "string", - "null" - ], - "description": "State of a code scanning alert.", - "enum": [ - "open", - "dismissed", - "fixed", - null - ] - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "The dismissal comment associated with the dismissal of the alert.", - "maxLength": 280 - }, - "rule": { - "type": "object", - "properties": { - "id": { - "type": [ - "string", - "null" - ], - "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": { - "type": [ - "string", - "null" - ], - "description": "The severity of the alert.", - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "security_severity_level": { - "type": [ - "string", - "null" - ], - "description": "The security severity of the alert.", - "enum": [ - "low", - "medium", - "high", - "critical", - null - ] - }, - "description": { - "type": "string", - "description": "A short description of the rule used to detect the alert." - }, - "full_description": { - "type": "string", - "description": "A description of the rule used to detect the alert." - }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, - "help": { - "type": [ - "string", - "null" - ], - "description": "Detailed documentation for the rule as GitHub Flavored Markdown." - }, - "help_uri": { - "type": [ - "string", - "null" - ], - "description": "A link to the documentation for 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": { - "type": [ - "string", - "null" - ], - "description": "The version of the tool used to generate the code scanning analysis." - }, - "guid": { - "type": [ - "string", - "null" - ], - "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 Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." - }, - "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." - }, - "category": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." - }, - "state": { - "type": [ - "string", - "null" - ], - "description": "State of a code scanning alert.", - "enum": [ - "open", - "dismissed", - "fixed", - null - ] - }, - "commit_sha": { - "type": "string" - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "markdown": { - "type": "string", - "description": "The message text as GitHub-flavored Markdown, with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance." - } - } - }, - "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", - "null" - ], - "description": "A classification of the file. For example to identify it as generated.", - "enum": [ - "source", - "generated", - "test", - "library", - null - ] - } - } - } - }, - "dismissal_approved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "instances_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool", - "most_recent_instance" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "403", - "description": "

Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Code scanning alerts\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", - "title": "List instances of a code scanning alert", - "category": "code-scanning", - "subcategory": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "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/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all instances of the specified code scanning alert.

\n

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "alert_number": "ALERT_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "", - "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "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": "", - "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "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" - ] - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." - }, - "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." - }, - "category": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." - }, - "state": { - "type": [ - "string", - "null" - ], - "description": "State of a code scanning alert instance.", - "enum": [ - "open", - "fixed", - null - ] - }, - "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", - "null" - ], - "description": "A classification of the file. For example to identify it as generated.", - "enum": [ - "source", - "generated", - "test", - "library", - null - ] - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Response if GitHub Advanced Security is not enabled for this repository

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Code scanning alerts\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses", - "title": "List code scanning analyses for a repository", - "category": "code-scanning", - "subcategory": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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": { - "type": [ - "string", - "null" - ], - "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "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/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

", - "required": false, - "schema": { - "type": "string", - "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." - } - }, - { - "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.", - "examples": [ - "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53" - ] - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "sort", - "description": "

The property by which to sort the results.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created" - ], - "default": "created" - } - } - ], - "bodyParameters": [], - "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

Warning

\n

\nClosing down notice: The tool_name field is closing down 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.

\n
\n

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "ref": "refs/heads/main", - "commit_sha": "d99612c3e1f2970085cfbaeadf8f010ef69bad83", - "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", - "environment": "{\"language\":\"python\"}", - "error": "", - "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", - "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, - "warning": "" - }, - { - "ref": "refs/heads/my-branch", - "commit_sha": "c8cff6510d4d084fb1b4aa13b64b97ca12b07321", - "analysis_key": ".github/workflows/shiftleft.yml:build", - "environment": "{}", - "error": "", - "category": ".github/workflows/shiftleft.yml:build/", - "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, - "warning": "" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." - }, - "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." - }, - "category": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." - }, - "error": { - "type": "string" - }, - "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 - }, - "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 - }, - "sarif_id": { - "type": "string", - "description": "An identifier for the upload." - }, - "tool": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the tool used to generate the code scanning analysis." - }, - "version": { - "type": [ - "string", - "null" - ], - "description": "The version of the tool used to generate the code scanning analysis." - }, - "guid": { - "type": [ - "string", - "null" - ], - "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." - } - } - }, - "deletable": { - "type": "boolean" - }, - "warning": { - "type": "string", - "description": "Warning generated when processing the analysis" - } - }, - "required": [ - "ref", - "commit_sha", - "analysis_key", - "environment", - "error", - "created_at", - "results_count", - "rules_count", - "id", - "url", - "sarif_id", - "tool", - "deletable", - "warning" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Response if GitHub Advanced Security is not enabled for this repository

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Code scanning alerts\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", - "title": "Get a code scanning analysis for a repository", - "category": "code-scanning", - "subcategory": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specified code scanning analysis for a repository.

\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

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/sarif+json: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as SARIF version 2.1.0. It also returns additional data such as the github/alertNumber and github/alertUrl properties.
    • \n
\n

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

", - "codeExamples": [ - { - "request": { - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "analysis_id": "ANALYSIS_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

application/json response

", - "example": { - "ref": "refs/heads/main", - "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655", - "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", - "environment": "{\"language\":\"javascript\"}", - "error": "", - "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript", - "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, - "warning": "" - }, - "schema": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." - }, - "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." - }, - "category": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." - }, - "error": { - "type": "string" - }, - "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 - }, - "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 - }, - "sarif_id": { - "type": "string", - "description": "An identifier for the upload." - }, - "tool": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the tool used to generate the code scanning analysis." - }, - "version": { - "type": [ - "string", - "null" - ], - "description": "The version of the tool used to generate the code scanning analysis." - }, - "guid": { - "type": [ - "string", - "null" - ], - "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." - } - } - }, - "deletable": { - "type": "boolean" - }, - "warning": { - "type": "string", - "description": "Warning generated when processing the analysis" - } - }, - "required": [ - "ref", - "commit_sha", - "analysis_key", - "environment", - "error", - "created_at", - "results_count", - "rules_count", - "id", - "url", - "sarif_id", - "tool", - "deletable", - "warning" - ] - } - } - }, - { - "request": { - "description": "Example 2: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "analysis_id": "ANALYSIS_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/sarif+json", - "description": "

application/sarif+json response

", - "example": { - "runs": [ - { - "tool": { - "driver": { - "name": "CodeQL", - "organization": "GitHub", - "semanticVersion": "1.0.0", - "rules": [ - { - "id": "js/unused-local-variable", - "name": "js/unused-local-variable" - } - ] - } - }, - "results": [ - { - "guid": "326aa09f-9af8-13cf-9851-3d0e5183ec38", - "message": { - "text": "Unused variable foo." - }, - "locations": [ - { - "physicalLocation": { - "artifactLocation": { - "uri": "file1.js" - }, - "region": { - "startLine": 1 - } - } - } - ], - "ruleId": "js/unused-local-variable", - "properties": [ - { - "github/alertNumber": 2 - }, - { - "github/alertUrl": "https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2" - } - ] - } - ] - } - ] - }, - "schema": { - "type": "object", - "additionalProperties": true - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Response if GitHub Advanced Security is not enabled for this repository

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Code scanning alerts\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", - "title": "Delete a code scanning analysis from a repository", - "category": "code-scanning", - "subcategory": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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" - } - }, - { - "name": "confirm_delete", - "in": "query", - "description": "

Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to true, you'll get a 400 response with the message: Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.

", - "required": false, - "schema": { - "type": [ - "string", - "null" - ] - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a specified code scanning analysis from a repository.

\n

You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.

\n

When you list the analyses for a repository,\none or more will be identified as deletable in the response:

\n
\"deletable\": true\n
\n

An analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:

\n
    \n
  • ref
    • \n
  • tool
    • \n
  • category
    • \n
\n

If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:

\n
Analysis specified is not deletable.\n
\n

The response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.

\n

As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:

\n

Outer loop:

\n
    \n
  • \n

    List the analyses for the repository, filtered by tool.

    \n
    • \n
  • \n

    Parse this list to find a deletable analysis. If found:

    \n

    Inner loop:

    \n
      \n
    • Delete the identified analysis.
      • \n
    • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.
      • \n
    \n
    • \n
\n

The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "analysis_id": "ANALYSIS_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Default response

", - "example": { - "next_analysis_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41", - "confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete" - }, - "schema": { - "title": "Analysis deletion", - "description": "Successful deletion of a code scanning analysis", - "type": "object", - "properties": { - "next_analysis_url": { - "type": [ - "string", - "null" - ], - "description": "Next deletable analysis in chain, without last analysis deletion confirmation", - "format": "uri", - "readOnly": true - }, - "confirm_delete_url": { - "type": [ - "string", - "null" - ], - "description": "Next deletable analysis in chain, with last analysis deletion confirmation", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "next_analysis_url", - "confirm_delete_url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "403", - "description": "

Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Code scanning alerts\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/default-setup", - "title": "Get a code scanning default setup configuration", - "category": "code-scanning", - "subcategory": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a code scanning default setup configuration.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "state": "configured", - "languages": [ - "ruby", - "python" - ], - "query_suite": "default", - "updated_at": "2023-01-19T11:21:34Z", - "schedule": "weekly" - }, - "schema": { - "description": "Configuration for code scanning default setup.", - "type": "object", - "properties": { - "state": { - "description": "Code scanning default setup has been configured or not.", - "type": "string", - "enum": [ - "configured", - "not-configured" - ] - }, - "languages": { - "description": "Languages to be analyzed.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "actions", - "c-cpp", - "csharp", - "go", - "java-kotlin", - "javascript-typescript", - "javascript", - "python", - "ruby", - "typescript", - "swift" - ] - } - }, - "query_suite": { - "description": "CodeQL query suite to be used.", - "type": "string", - "enum": [ - "default", - "extended" - ] - }, - "updated_at": { - "description": "Timestamp of latest configuration update.", - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "schedule": { - "description": "The frequency of the periodic analysis.", - "type": [ - "string", - "null" - ], - "enum": [ - "weekly", - null - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Response if GitHub Advanced Security is not enabled for this repository

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/code-scanning/default-setup", - "title": "Update a code scanning default setup configuration", - "category": "code-scanning", - "subcategory": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "state", - "description": "

The desired state of code scanning default setup.

", - "enum": [ - "configured", - "not-configured" - ] - }, - { - "type": "string", - "name": "query_suite", - "description": "

CodeQL query suite to be used.

", - "enum": [ - "default", - "extended" - ] - }, - { - "type": "array of strings", - "name": "languages", - "description": "

CodeQL languages to be analyzed.\nSupported values are: actions, c-cpp, csharp, go, java-kotlin, javascript-typescript, python, ruby, swift

" - } - ], - "descriptionHTML": "

Updates a code scanning default setup configuration.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "state": "configured" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Response

", - "example": { - "run_id": 42, - "run_url": "https://api.github.com/repos/octoorg/octocat/actions/runs/42" - }, - "schema": { - "description": "You can use `run_url` to track the status of the run. This includes a property status and conclusion.\nYou should not rely on this always being an actions workflow run object.", - "type": "object", - "properties": { - "run_id": { - "description": "ID of the corresponding run.", - "type": "integer" - }, - "run_url": { - "description": "URL of the corresponding run.", - "type": "string" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "403", - "description": "

Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Response if there is already a validation run in progress with a different default setup configuration

" - }, - { - "httpStatusCode": "422", - "description": "

Response if the configuration change cannot be made because the repository is not in the required state

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs", - "title": "Upload an analysis as SARIF data", - "category": "code-scanning", - "subcategory": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "commit_sha", - "description": "

The SHA of the commit to which the analysis you are uploading relates.

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/tags/<tag>, refs/pull/<number>/merge, or refs/pull/<number>/head.

", - "isRequired": true - }, - { - "type": "string", - "name": "sarif", - "description": "

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.\"

", - "isRequired": true - }, - { - "type": "string", - "name": "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.

" - }, - { - "type": "string", - "name": "started_at", - "description": "

The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "string", - "name": "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.

" - } - ], - "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"Troubleshooting SARIF uploads.\"

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n

SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"SARIF results exceed one or more limits.\"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file20
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Tool extensions per run100
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
Tags per rule20Only 10 tags will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

\n

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

\n

This endpoint is limited to 1,000 requests per hour for each user or app installation calling it.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "commit_sha": "4b6472266afd7b471e86085a6659e8c7f2b119da", - "ref": "refs/heads/master", - "sarif": "H4sICMLGdF4AA2V4YW1wbGUuc2FyaWYAvVjdbts2FL7PUxDCijaA/CM7iRNfLkPXYgHSNstumlzQ0pHFVCI1korjFgH2ONtr7Ul2KFmy/mOn6QIkjsjDw0/nfN85NL8dEGL9pNwAImqRObECrWM1H40kXQ2XTAfJIlEgXcE1cD10RTQSVDE10K4aKSqZP1AxuKOIKg1ydJU60jSfSh8Hk6EzHA/vlOCWbfa7B6kYPpj90rlsWCZcmbHP5Bs+4oAWIjQD2SMOeJLh2vIQDnIaQerqXHjw8YIgxohybxAyDsS4cAPKsp03K4RcUs6+Up2D+JXpd8mibKIQN9fM/aMCdbyBujGSSQgVxJtx5qX2d2qUcIweQhEuDQf3GBO6CKHkogx/N3MVCKl/AeVKFuf4y5ubsMGDTj1ep+5I7sgmLIpxtU38hLtmMRGSuCFVyip5eKzs5ydh+LztVL6f2m6oih1BkYiuyQIIJWodxVpERPj4sEiWBNNH8EWT0DMG8EAjzKVHXCrB4FkPu/F64NMk1OeC+2yZSNoBOoR7CC0EzYWGbm+xFDFIzbI011+cLjfZtyJkmMZfumAh02uL3NpV2y+MZ6RAjxibyKrNxxJcVjANSb4eBGwZ1M0KsuyR2poLr5rMl8vaDSeVn6eTWEO2j2xIEcmhwlTKNOi4GMOI8gfuZYkvJ7b4v5Tiumyz7RnHeodFzpS8ASIZCH/AYdWi2z3sG8JtFxJ6fF9yR9CdifBr9Pd6d5V2+zbJKjjCFGGmsHuYFy2ytJq9tUxcLSRSQecppOGKrpUxYfxefMEFK+wOGa4hudQByBVT0L+EKtyACxnRsABhEx1QjVDs1KNI9MbpnhqfE45B6FJvu3hRu5VRU9MhZLmK7fqkKyQSTHNoyMqUFMqXCV3CwAeqEwmVokraK8IuBaGvHjQ0gMYrKjnjyw7uk9uD8tgmsBbFMPnU1bV2ZhkJNkuolUiWys3UPWzs5aaIUz9TBe8zMb+6+nT+6fLy91dlE3xzeDDT4zYszb0bW6NjJd0Rvn2EnLvWLFSdKPpBzInzfRgu8ETyMcH8nIfMnJCeC2PyfTA+UKngcnGH7Hw2hGkVQs5YlIRCtdWZYQ4/73es2JlxkfViOEIhoWJq5Oo6UBBfiKIqFBWhiE3jJGbFwVoxBHTRSuIS67sMeplei24X20shLjG+8gqbKC/bESiNMC+wd5q5id0yeS7CJEqXzmrTWNq3k05l84P6f4/bEmXFJjI0fIt1BGQssUnUDkBYeVhE5TqPnMH3jqogDcP0zKcTgLPTMSzOjhbjuVOmW23l1fYNStulfo6sXlFsGLhbDy5RECPRYGCTgOj2bd4nUQEivEd0H7KKYxqnEhFohuur3a3UPskbH/+Yg0+M5P2MHRJu3ziHh3Z2NCrWt3XF1rWTw8Ne/pfbWYXnDSE0SNZQQt1i18q7te2vOhu7ehWuvVyeu0wbLZi24mhoo6aOOTltzG/lgdVvVoXQq5V+pewkFIzL8fjEcadT55jOjpzFzHuOTtDNrMkJPMVQDd7F09RID72O/UPZ0tmctqZ7kWX6EmSZnDpP8GU67SXM8XE3YSrxbKsx6UReZ4y6n/FVZfJjs9Z7stma75W5yQtkzjk5eSJxk1lv4o7+j8TlhaJ2lsKWZO6lruDPBLib3x5ZN/KGWzZ+pn///evv7OOf4iIBv3oY9L/l1wiJ9p0Tc+F1zZnOE9NxXWEus6IQhr5pMfoqxi8WPsuu0azsns4UC6WzNzHIzbeEx4P/AJ3SefgcFAAA" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Default response

", - "example": { - "id": "47177e22-5596-11eb-80a1-c1e54ef945c6", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6" - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "An identifier for the upload." - }, - "url": { - "type": "string", - "description": "The REST API URL for checking the status of the upload.", - "format": "uri", - "readOnly": true - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request if the sarif field is invalid

" - }, - { - "httpStatusCode": "403", - "description": "

Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "413", - "description": "

Payload Too Large if the sarif field is too large

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Code scanning alerts\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}", - "title": "Get information about a SARIF upload", - "category": "code-scanning", - "subcategory": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sarif_id", - "description": "

The SARIF ID obtained after uploading.

", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "bodyParameters": [], - "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.\"\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "sarif_id": "SARIF_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Default response

", - "example": { - "processing_status": "complete", - "analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6" - }, - "schema": { - "type": "object", - "properties": { - "processing_status": { - "type": "string", - "enum": [ - "pending", - "complete", - "failed" - ], - "description": "`pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed." - }, - "analyses_url": { - "type": [ - "string", - "null" - ], - "description": "The REST API URL for getting the analyses associated with the upload.", - "format": "uri", - "readOnly": true - }, - "errors": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - }, - "description": "Any errors that ocurred during processing of the delivery.", - "readOnly": true - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Response if GitHub Advanced Security is not enabled for this repository

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found if the sarif id does not match any upload

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Code scanning alerts\" repository permissions": "read" - } - ] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/codes-of-conduct.json b/src/rest/data/ghes-3.14-2022-11-28/codes-of-conduct.json deleted file mode 100644 index cf5deeb10ba4..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/codes-of-conduct.json +++ /dev/null @@ -1,197 +0,0 @@ -{ - "codes-of-conduct": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/codes_of_conduct", - "title": "Get all codes of conduct", - "category": "codes-of-conduct", - "subcategory": "codes-of-conduct", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Returns array of all GitHub's codes of conduct.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "key": "citizen_code_of_conduct", - "name": "Citizen Code of Conduct", - "url": "https://api.github.com/codes_of_conduct/citizen_code_of_conduct", - "html_url": "http://citizencodeofconduct.org/" - }, - { - "key": "contributor_covenant", - "name": "Contributor Covenant", - "url": "https://api.github.com/codes_of_conduct/contributor_covenant", - "html_url": "https://www.contributor-covenant.org/version/2/0/code_of_conduct/" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/codes_of_conduct/{key}", - "title": "Get a code of conduct", - "category": "codes-of-conduct", - "subcategory": "codes-of-conduct", - "parameters": [ - { - "name": "key", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns information about the specified GitHub code of conduct.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "key": "KEY" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "key": "contributor_covenant", - "name": "Contributor Covenant", - "url": "https://api.github.com/codes_of_conduct/contributor_covenant", - "body": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n", - "html_url": "http://contributor-covenant.org/version/1/4/" - }, - "schema": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/collaborators.json b/src/rest/data/ghes-3.14-2022-11-28/collaborators.json deleted file mode 100644 index 34f4fd64fdbb..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/collaborators.json +++ /dev/null @@ -1,4311 +0,0 @@ -{ - "collaborators": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators", - "title": "List repository collaborators", - "category": "collaborators", - "subcategory": "collaborators", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "affiliation", - "description": "

Filter collaborators returned by their affiliation. outside means all outside collaborators of an organization-owned repository. direct means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. all means all collaborators the authenticated user can see.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" - } - }, - { - "name": "permission", - "description": "

Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

For organization-owned repositories, 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.\nThe permissions hash returned in the response contains the base role permissions of the collaborator. The role_name is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.

\n

Team members will include the members of child teams.

\n

The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization.\nOAuth app tokens and personal access tokens (classic) need the read:org and repo scopes to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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, - "permissions": { - "pull": true, - "triage": true, - "push": true, - "maintain": false, - "admin": false - }, - "role_name": "write" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Collaborator", - "description": "Collaborator", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "role_name": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "title": "Check if a user is a repository collaborator", - "category": "collaborators", - "subcategory": "collaborators", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

For organization-owned repositories, 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.

\n

Team members will include the members of child teams.

\n

The authenticated user must have push access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:org and repo scopes to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response if user is a collaborator

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Response if user is a collaborator

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found if user is not a collaborator

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "title": "Add a repository collaborator", - "category": "collaborators", - "subcategory": "collaborators", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "description": "

The permission to grant the collaborator. Only valid on organization-owned repositories.

", - "default": "push" - } - ], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"

\n

For more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

\n
Cannot assign {member} permission of {role name}\n
\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

\n

Updating an existing collaborator's permission level

\n

The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Add a collaborator with triage permissions", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "permission": "triage" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response when:

\n
    \n
  • an existing collaborator is added as a collaborator
    • \n
  • an organization member is added as an individual collaborator
    • \n
  • an existing team member (whose team is also a repository collaborator) is added as an individual collaborator
    • \n
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Response when:

\n
    \n
  • an existing collaborator is added as a collaborator
    • \n
  • an organization member is added as an individual collaborator
    • \n
  • an existing team member (whose team is also a repository collaborator) is added as an individual collaborator
    • \n
" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "title": "Remove a repository collaborator", - "category": "collaborators", - "subcategory": "collaborators", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n
    \n
  • Cancels any outstanding invitations sent by the collaborator
    • \n
  • Unassigns the user from any issues
    • \n
  • Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.
    • \n
  • Unstars the repository
    • \n
  • Updates access permissions to packages
    • \n
\n

Removing a user as a collaborator has the following effects on forks:

\n
    \n
  • If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.
    • \n
  • If the user had their own fork of the repository, the fork will be deleted.
    • \n
  • If the user still has read access to the repository, open pull requests by this user from a fork will be denied.
    • \n
\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

No Content when collaborator was removed from the repository.

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content when collaborator was removed from the repository.

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "title": "Get repository permissions for a user", - "category": "collaborators", - "subcategory": "collaborators", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Checks the repository permission and role of a collaborator.

\n

The permission attribute provides the legacy base roles of admin, write, read, and none, where the\nmaintain role is mapped to write and the triage role is mapped to read.\nThe role_name attribute provides the name of the assigned role, including custom roles. The\npermission can also be used to determine which base level of access the collaborator has to the repository.

\n

The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

if user has admin permissions

", - "example": { - "permission": "admin", - "role_name": "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 - } - }, - "schema": { - "title": "Repository Collaborator Permission", - "description": "Repository Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "type": "string" - }, - "role_name": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Collaborator", - "description": "Collaborator", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "role_name": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "permission", - "role_name", - "user" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

if user has admin permissions

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ] - } - } - ], - "invitations": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/invitations", - "title": "List repository invitations", - "category": "collaborators", - "subcategory": "invitations", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 1, - "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" - }, - "invitee": { - "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 - }, - "inviter": { - "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 - }, - "permissions": "write", - "created_at": "2016-06-13T14:52:50-05:00", - "url": "https://api.github.com/user/repository_invitations/1296269", - "html_url": "https://github.com/octocat/Hello-World/invitations", - "node_id": "MDQ6VXNlcjE=" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Repository Invitation", - "description": "Repository invitations let you manage who you collaborate with.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository invitation.", - "type": "integer", - "format": "int64" - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - }, - "invitee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "inviter": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "permissions": { - "description": "The permission associated with the invitation.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "triage", - "maintain" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "expired": { - "description": "Whether or not the invitation has expired", - "type": "boolean" - }, - "url": { - "description": "URL for the repository invitation", - "type": "string" - }, - "html_url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "permissions", - "inviter", - "invitee", - "repository", - "url", - "html_url", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - }, - { - "\"Private repository invitations\" user permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "title": "Update a repository invitation", - "category": "collaborators", - "subcategory": "invitations", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "invitation_id", - "description": "

The unique identifier of the invitation.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permissions", - "description": "

The permissions that the associated user will have on the repository. Valid values are read, write, maintain, triage, and admin.

", - "enum": [ - "read", - "write", - "maintain", - "triage", - "admin" - ] - } - ], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example request body", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "permissions": "write" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "invitation_id": "INVITATION_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "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" - }, - "invitee": { - "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 - }, - "inviter": { - "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 - }, - "permissions": "write", - "created_at": "2016-06-13T14:52:50-05:00", - "expired": false, - "url": "https://api.github.com/user/repository_invitations/1296269", - "html_url": "https://github.com/octocat/Hello-World/invitations" - }, - "schema": { - "title": "Repository Invitation", - "description": "Repository invitations let you manage who you collaborate with.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository invitation.", - "type": "integer", - "format": "int64" - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - }, - "invitee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "inviter": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "permissions": { - "description": "The permission associated with the invitation.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "triage", - "maintain" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "expired": { - "description": "Whether or not the invitation has expired", - "type": "boolean" - }, - "url": { - "description": "URL for the repository invitation", - "type": "string" - }, - "html_url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "permissions", - "inviter", - "invitee", - "repository", - "url", - "html_url", - "created_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "title": "Delete a repository invitation", - "category": "collaborators", - "subcategory": "invitations", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "invitation_id", - "description": "

The unique identifier of the invitation.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "invitation_id": "INVITATION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/repository_invitations", - "title": "List repository invitations for the authenticated user", - "category": "collaborators", - "subcategory": "invitations", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

When authenticating as a user, this endpoint will list all currently open repository invitations for that user.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 1, - "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" - }, - "invitee": { - "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 - }, - "inviter": { - "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 - }, - "permissions": "write", - "created_at": "2016-06-13T14:52:50-05:00", - "url": "https://api.github.com/user/repository_invitations/1296269", - "html_url": "https://github.com/octocat/Hello-World/invitations", - "node_id": "MDQ6VXNlcjE=" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Repository Invitation", - "description": "Repository invitations let you manage who you collaborate with.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository invitation.", - "type": "integer", - "format": "int64" - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - }, - "invitee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "inviter": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "permissions": { - "description": "The permission associated with the invitation.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "triage", - "maintain" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "expired": { - "description": "Whether or not the invitation has expired", - "type": "boolean" - }, - "url": { - "description": "URL for the repository invitation", - "type": "string" - }, - "html_url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "permissions", - "inviter", - "invitee", - "repository", - "url", - "html_url", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}", - "title": "Accept a repository invitation", - "category": "collaborators", - "subcategory": "invitations", - "parameters": [ - { - "name": "invitation_id", - "description": "

The unique identifier of the invitation.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "invitation_id": "INVITATION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/user/repository_invitations/{invitation_id}", - "title": "Decline a repository invitation", - "category": "collaborators", - "subcategory": "invitations", - "parameters": [ - { - "name": "invitation_id", - "description": "

The unique identifier of the invitation.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "invitation_id": "INVITATION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/commits.json b/src/rest/data/ghes-3.14-2022-11-28/commits.json deleted file mode 100644 index bc100e3808c7..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/commits.json +++ /dev/null @@ -1,10832 +0,0 @@ -{ - "commits": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits", - "title": "List commits", - "category": "commits", - "subcategory": "commits", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sha", - "description": "

SHA or branch to start listing commits from. Default: the repository’s default branch (usually main).

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "path", - "description": "

Only commits containing this file path will be returned.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "author", - "description": "

GitHub username or email address to use to filter by commit author.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "committer", - "description": "

GitHub username or email address to use to filter by commit committer.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "since", - "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "until", - "description": "

Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", - "commit": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "author": { - "name": "Monalisa Octocat", - "email": "support@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "committer": { - "name": "Monalisa Octocat", - "email": "support@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "message": "Fix all the bugs", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" - }, - "comment_count": 0, - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null - } - }, - "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 - }, - "committer": { - "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 - }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "title": "Commit", - "description": "Commit", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "commit": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "message": { - "type": "string" - }, - "comment_count": { - "type": "integer" - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - }, - "verification": { - "title": "Verification", - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "payload": { - "type": [ - "string", - "null" - ] - }, - "signature": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] - }, - "author": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - ], - "type": [ - "null", - "object" - ] - }, - "committer": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - ], - "type": [ - "null", - "object" - ] - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - } - }, - "stats": { - "type": "object", - "properties": { - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": [ - "string", - "null" - ] - }, - "filename": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ] - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changes": { - "type": "integer" - }, - "blob_url": { - "type": "string", - "format": "uri" - }, - "raw_url": { - "type": "string", - "format": "uri" - }, - "contents_url": { - "type": "string", - "format": "uri" - }, - "patch": { - "type": "string" - }, - "previous_filename": { - "type": "string" - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] - } - } - }, - "required": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", - "title": "List branches for HEAD commit", - "category": "commits", - "subcategory": "commits", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "commit_sha", - "description": "

The SHA of the commit.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "commit_sha": "COMMIT_SHA" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "name": "branch_5", - "commit": { - "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" - }, - "protected": false - } - ], - "schema": { - "type": "array", - "items": { - "title": "Branch Short", - "description": "Branch Short", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "commit": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string" - } - }, - "required": [ - "sha", - "url" - ] - }, - "protected": { - "type": "boolean" - } - }, - "required": [ - "name", - "commit", - "protected" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", - "title": "List pull requests associated with a commit", - "category": "commits", - "subcategory": "commits", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "commit_sha", - "description": "

The SHA of the commit.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "commit_sha": "COMMIT_SHA" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "id": 1, - "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", - "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", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", - "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", - "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "number": 1347, - "state": "open", - "locked": true, - "title": "Amazing new feature", - "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 - }, - "body": "Please pull these awesome changes in!", - "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 - } - ], - "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" - }, - "active_lock_reason": "too heated", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:01:12Z", - "closed_at": "2011-01-26T19:01:12Z", - "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "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 - }, - { - "login": "hubot", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/hubot_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/hubot", - "html_url": "https://github.com/hubot", - "followers_url": "https://api.github.com/users/hubot/followers", - "following_url": "https://api.github.com/users/hubot/following{/other_user}", - "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", - "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", - "organizations_url": "https://api.github.com/users/hubot/orgs", - "repos_url": "https://api.github.com/users/hubot/repos", - "events_url": "https://api.github.com/users/hubot/events{/privacy}", - "received_events_url": "https://api.github.com/users/hubot/received_events", - "type": "User", - "site_admin": true - } - ], - "requested_reviewers": [ - { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false - } - ], - "requested_teams": [ - { - "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", - "notification_setting": "notifications_enabled", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "head": { - "label": "octocat:new-topic", - "ref": "new-topic", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "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 - }, - "repo": { - "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, - "allow_auto_merge": false, - "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 - } - }, - "base": { - "label": "octocat:master", - "ref": "master", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "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 - }, - "repo": { - "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, - "allow_auto_merge": false, - "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 - } - }, - "_links": { - "self": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" - }, - "html": { - "href": "https://github.com/octocat/Hello-World/pull/1347" - }, - "issue": { - "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - }, - "comments": { - "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" - }, - "review_comments": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" - }, - "review_comment": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" - }, - "commits": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" - }, - "statuses": { - "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" - } - }, - "author_association": "OWNER", - "auto_merge": null, - "draft": false - } - ], - "schema": { - "type": "array", - "items": { - "title": "Pull Request Simple", - "description": "Pull Request Simple", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}", - "title": "Get a commit", - "category": "commits", - "subcategory": "commits", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "ref", - "description": "

The commit reference. Can be a commit SHA, branch name (heads/BRANCH_NAME), or tag name (tags/TAG_NAME). For more information, see \"Git References\" in the Git documentation.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note

\n

\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n
\n

This endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.
    • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.
    • \n
  • application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
    • \n
\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", - "codeExamples": [ - { - "request": { - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "ref": "REF" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", - "commit": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "author": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "committer": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "message": "Fix all the bugs", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" - }, - "comment_count": 0, - "verification": { - "verified": false, - "reason": "unsigned" - } - }, - "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 - }, - "committer": { - "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 - }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" - } - ], - "stats": { - "additions": 104, - "deletions": 4, - "total": 108 - }, - "files": [ - { - "filename": "file1.txt", - "additions": 10, - "deletions": 2, - "changes": 12, - "status": "modified", - "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", - "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", - "patch": "@@ -29,7 +29,7 @@\n....." - } - ] - }, - "schema": { - "title": "Commit", - "description": "Commit", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "commit": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "message": { - "type": "string" - }, - "comment_count": { - "type": "integer" - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - }, - "verification": { - "title": "Verification", - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "payload": { - "type": [ - "string", - "null" - ] - }, - "signature": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] - }, - "author": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - ], - "type": [ - "null", - "object" - ] - }, - "committer": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - ], - "type": [ - "null", - "object" - ] - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - } - }, - "stats": { - "type": "object", - "properties": { - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": [ - "string", - "null" - ] - }, - "filename": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ] - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changes": { - "type": "integer" - }, - "blob_url": { - "type": "string", - "format": "uri" - }, - "raw_url": { - "type": "string", - "format": "uri" - }, - "contents_url": { - "type": "string", - "format": "uri" - }, - "patch": { - "type": "string" - }, - "previous_filename": { - "type": "string" - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] - } - } - }, - "required": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" - ] - } - } - }, - { - "request": { - "description": "Example 2: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "ref": "REF" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/vnd.github.diff", - "description": "

Response

", - "example": "diff --git a/testfile b/testfile\nindex 9bdeaeb..912c7ef 100644\n--- a/testfile\n+++ b/testfile\n@@ -1 +1 @@\n-test\n+test change\n", - "schema": { - "type": "string" - } - } - }, - { - "request": { - "description": "Example 3: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "ref": "REF" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/vnd.github.patch", - "description": "

Response

", - "example": "From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001\nFrom: Mona Lisa <87831417+monalisa@users.noreply.github.com>\nDate: Fri, 6 Mar 2026 11:18:45 +0000\nSubject: [PATCH] Change 'test' to 'test change' in testfile\n\n---\ntestfile | 2 +-\n1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/testfile b/testfile\nindex 9bdeaeb..912c7ef 100644\n--- a/testfile\n+++ b/testfile\n@@ -1 +1 @@\n-test\n+test change\n", - "schema": { - "type": "string" - } - } - }, - { - "request": { - "description": "Example 4: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "ref": "REF" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/vnd.github.sha", - "description": "

Response

", - "example": "ac3282a2725be3b1d4979169a7a311c89066af1c", - "schema": { - "type": "string" - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", - "title": "Compare two commits", - "category": "commits", - "subcategory": "commits", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "basehead", - "description": "

The base branch and head branch to compare. This parameter expects the format BASE...HEAD. Both must be branch names in repo. To compare with a branch that exists in a different repository in the same network as repo, the basehead parameter expects the format USERNAME:BASE...USERNAME:HEAD.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
    • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
    • \n
\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.
    • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
    • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", - "codeExamples": [ - { - "request": { - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "basehead": "BASEHEAD" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic", - "html_url": "https://github.com/octocat/Hello-World/compare/master...topic", - "permalink_url": "https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17", - "diff_url": "https://github.com/octocat/Hello-World/compare/master...topic.diff", - "patch_url": "https://github.com/octocat/Hello-World/compare/master...topic.patch", - "base_commit": { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", - "commit": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "author": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "committer": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "message": "Fix all the bugs", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" - }, - "comment_count": 0, - "verification": { - "verified": false, - "reason": "unsigned" - } - }, - "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 - }, - "committer": { - "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 - }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" - } - ] - }, - "merge_base_commit": { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", - "commit": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "author": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "committer": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "message": "Fix all the bugs", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" - }, - "comment_count": 0, - "verification": { - "verified": false, - "reason": "unsigned" - } - }, - "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 - }, - "committer": { - "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 - }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" - } - ] - }, - "status": "behind", - "ahead_by": 1, - "behind_by": 2, - "total_commits": 1, - "commits": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", - "commit": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "author": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "committer": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "message": "Fix all the bugs", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" - }, - "comment_count": 0, - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null - } - }, - "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 - }, - "committer": { - "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 - }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" - } - ] - } - ], - "files": [ - { - "sha": "bbcd538c8e72b8c175046e27cc8f907076331401", - "filename": "file1.txt", - "status": "added", - "additions": 103, - "deletions": 21, - "changes": 124, - "blob_url": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", - "raw_url": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "patch": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" - } - ] - }, - "schema": { - "title": "Commit Comparison", - "description": "Commit Comparison", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "permalink_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "base_commit": { - "title": "Commit", - "description": "Commit", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "commit": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "message": { - "type": "string" - }, - "comment_count": { - "type": "integer" - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - }, - "verification": { - "title": "Verification", - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "payload": { - "type": [ - "string", - "null" - ] - }, - "signature": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] - }, - "author": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - ], - "type": [ - "null", - "object" - ] - }, - "committer": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - ], - "type": [ - "null", - "object" - ] - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - } - }, - "stats": { - "type": "object", - "properties": { - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": [ - "string", - "null" - ] - }, - "filename": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ] - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changes": { - "type": "integer" - }, - "blob_url": { - "type": "string", - "format": "uri" - }, - "raw_url": { - "type": "string", - "format": "uri" - }, - "contents_url": { - "type": "string", - "format": "uri" - }, - "patch": { - "type": "string" - }, - "previous_filename": { - "type": "string" - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] - } - } - }, - "required": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" - ] - }, - "merge_base_commit": { - "title": "Commit", - "description": "Commit", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "commit": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "message": { - "type": "string" - }, - "comment_count": { - "type": "integer" - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - }, - "verification": { - "title": "Verification", - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "payload": { - "type": [ - "string", - "null" - ] - }, - "signature": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] - }, - "author": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - ], - "type": [ - "null", - "object" - ] - }, - "committer": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - ], - "type": [ - "null", - "object" - ] - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - } - }, - "stats": { - "type": "object", - "properties": { - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": [ - "string", - "null" - ] - }, - "filename": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ] - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changes": { - "type": "integer" - }, - "blob_url": { - "type": "string", - "format": "uri" - }, - "raw_url": { - "type": "string", - "format": "uri" - }, - "contents_url": { - "type": "string", - "format": "uri" - }, - "patch": { - "type": "string" - }, - "previous_filename": { - "type": "string" - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] - } - } - }, - "required": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" - ] - }, - "status": { - "type": "string", - "enum": [ - "diverged", - "ahead", - "behind", - "identical" - ] - }, - "ahead_by": { - "type": "integer" - }, - "behind_by": { - "type": "integer" - }, - "total_commits": { - "type": "integer" - }, - "commits": { - "type": "array", - "items": { - "title": "Commit", - "description": "Commit", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "commit": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "message": { - "type": "string" - }, - "comment_count": { - "type": "integer" - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - }, - "verification": { - "title": "Verification", - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "payload": { - "type": [ - "string", - "null" - ] - }, - "signature": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] - }, - "author": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - ], - "type": [ - "null", - "object" - ] - }, - "committer": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - ], - "type": [ - "null", - "object" - ] - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - } - }, - "stats": { - "type": "object", - "properties": { - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": [ - "string", - "null" - ] - }, - "filename": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ] - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changes": { - "type": "integer" - }, - "blob_url": { - "type": "string", - "format": "uri" - }, - "raw_url": { - "type": "string", - "format": "uri" - }, - "contents_url": { - "type": "string", - "format": "uri" - }, - "patch": { - "type": "string" - }, - "previous_filename": { - "type": "string" - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] - } - } - }, - "required": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" - ] - } - }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": [ - "string", - "null" - ] - }, - "filename": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ] - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changes": { - "type": "integer" - }, - "blob_url": { - "type": "string", - "format": "uri" - }, - "raw_url": { - "type": "string", - "format": "uri" - }, - "contents_url": { - "type": "string", - "format": "uri" - }, - "patch": { - "type": "string" - }, - "previous_filename": { - "type": "string" - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] - } - } - }, - "required": [ - "url", - "html_url", - "permalink_url", - "diff_url", - "patch_url", - "base_commit", - "merge_base_commit", - "status", - "ahead_by", - "behind_by", - "total_commits", - "commits" - ] - } - } - }, - { - "request": { - "description": "Example 2: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "basehead": "BASEHEAD" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/vnd.github.diff", - "description": "

Response

", - "example": "diff --git a/testfile b/testfile\nindex 9bdeaeb..912c7ef 100644\n--- a/testfile\n+++ b/testfile\n@@ -1 +1 @@\n-test\n+test change\n", - "schema": { - "type": "string" - } - } - }, - { - "request": { - "description": "Example 3: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "basehead": "BASEHEAD" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/vnd.github.patch", - "description": "

Response

", - "example": "From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001\nFrom: Mona Lisa <87831417+monalisa@users.noreply.github.com>\nDate: Fri, 6 Mar 2026 11:18:45 +0000\nSubject: [PATCH] Change 'test' to 'test change' in testfile\n\n---\ntestfile | 2 +-\n1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/testfile b/testfile\nindex 9bdeaeb..912c7ef 100644\n--- a/testfile\n+++ b/testfile\n@@ -1 +1 @@\n-test\n+test change\n", - "schema": { - "type": "string" - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ], - "comments": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments", - "title": "List commit comments for a repository", - "category": "commits", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", - "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", - "id": 1, - "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", - "body": "Great stuff", - "path": "file1.txt", - "position": 4, - "line": 14, - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "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 - }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "author_association": "COLLABORATOR" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Commit Comment", - "description": "Commit Comment", - "type": "object", - "properties": { - "html_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "body": { - "type": "string" - }, - "path": { - "type": [ - "string", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": [ - "url", - "html_url", - "id", - "node_id", - "user", - "position", - "line", - "path", - "commit_id", - "body", - "author_association", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "title": "Get a commit comment", - "category": "commits", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specified commit comment.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", - "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", - "id": 1, - "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", - "body": "Great stuff", - "path": "file1.txt", - "position": 4, - "line": 14, - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "author_association": "COLLABORATOR", - "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 - }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z" - }, - "schema": { - "title": "Commit Comment", - "description": "Commit Comment", - "type": "object", - "properties": { - "html_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "body": { - "type": "string" - }, - "path": { - "type": [ - "string", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": [ - "url", - "html_url", - "id", - "node_id", - "user", - "position", - "line", - "path", - "commit_id", - "body", - "author_association", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "title": "Update a commit comment", - "category": "commits", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "body", - "description": "

The contents of the comment

", - "isRequired": true - } - ], - "descriptionHTML": "

Updates the contents of a specified commit comment.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "body": "Nice change" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", - "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", - "id": 1, - "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", - "body": "Nice change", - "path": "file1.txt", - "position": 4, - "line": 14, - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "author_association": "COLLABORATOR", - "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 - }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z" - }, - "schema": { - "title": "Commit Comment", - "description": "Commit Comment", - "type": "object", - "properties": { - "html_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "body": { - "type": "string" - }, - "path": { - "type": [ - "string", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": [ - "url", - "html_url", - "id", - "node_id", - "user", - "position", - "line", - "path", - "commit_id", - "body", - "author_association", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "title": "Delete a commit comment", - "category": "commits", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "title": "List commit comments", - "category": "commits", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "commit_sha", - "description": "

The SHA of the commit.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the comments for a specified commit.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "commit_sha": "COMMIT_SHA" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", - "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", - "id": 1, - "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", - "body": "Great stuff", - "path": "file1.txt", - "position": 4, - "line": 14, - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "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 - }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "author_association": "COLLABORATOR" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Commit Comment", - "description": "Commit Comment", - "type": "object", - "properties": { - "html_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "body": { - "type": "string" - }, - "path": { - "type": [ - "string", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": [ - "url", - "html_url", - "id", - "node_id", - "user", - "position", - "line", - "path", - "commit_id", - "body", - "author_association", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "title": "Create a commit comment", - "category": "commits", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "commit_sha", - "description": "

The SHA of the commit.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "body", - "description": "

The contents of the comment.

", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "

Relative path of the file to comment on.

" - }, - { - "type": "integer", - "name": "position", - "description": "

Line index in the diff to comment on.

" - }, - { - "type": "integer", - "name": "line", - "description": "

Closing down notice. Use position parameter instead. Line number in the file to comment on.

" - } - ], - "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "body": "Great stuff", - "path": "file1.txt", - "position": 4, - "line": 1 - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "commit_sha": "COMMIT_SHA" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", - "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", - "id": 1, - "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", - "body": "Great stuff", - "path": "file1.txt", - "position": 4, - "line": 14, - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "author_association": "COLLABORATOR", - "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 - }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z" - }, - "schema": { - "title": "Commit Comment", - "description": "Commit Comment", - "type": "object", - "properties": { - "html_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "body": { - "type": "string" - }, - "path": { - "type": [ - "string", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": [ - "url", - "html_url", - "id", - "node_id", - "user", - "position", - "line", - "path", - "commit_id", - "body", - "author_association", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ] - } - } - ], - "statuses": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/status", - "title": "Get the combined status for a specific reference", - "category": "commits", - "subcategory": "statuses", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "description": "

The commit reference. Can be a commit SHA, branch name (heads/BRANCH_NAME), or tag name (tags/TAG_NAME). For more information, see \"Git References\" in the Git documentation.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.

\n

Additionally, a combined state is returned. The state is one of:

\n
    \n
  • failure if any of the contexts report as error or failure
    • \n
  • pending if there are no statuses or a context is pending
    • \n
  • success if the latest status for all contexts is success
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "ref": "REF" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "state": "success", - "statuses": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "avatar_url": "https://github.com/images/error/hubot_happy.gif", - "id": 1, - "node_id": "MDY6U3RhdHVzMQ==", - "state": "success", - "description": "Build has completed successfully", - "target_url": "https://ci.example.com/1000/output", - "context": "continuous-integration/jenkins", - "created_at": "2012-07-20T01:19:13Z", - "updated_at": "2012-07-20T01:19:13Z" - }, - { - "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "id": 2, - "node_id": "MDY6U3RhdHVzMg==", - "state": "success", - "description": "Testing has completed successfully", - "target_url": "https://ci.example.com/2000/output", - "context": "security/brakeman", - "created_at": "2012-08-20T01:19:13Z", - "updated_at": "2012-08-20T01:19:13Z" - } - ], - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "total_count": 2, - "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" - }, - "commit_url": "https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "url": "https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status" - }, - "schema": { - "title": "Combined Commit Status", - "description": "Combined Commit Status", - "type": "object", - "properties": { - "state": { - "type": "string" - }, - "statuses": { - "type": "array", - "items": { - "title": "Simple Commit Status", - "type": "object", - "properties": { - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "state": { - "type": "string" - }, - "context": { - "type": "string" - }, - "target_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "required": { - "type": [ - "boolean", - "null" - ] - }, - "avatar_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "description", - "id", - "node_id", - "state", - "context", - "target_url", - "avatar_url", - "url", - "created_at", - "updated_at" - ] - } - }, - "sha": { - "type": "string" - }, - "total_count": { - "type": "integer" - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - }, - "commit_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "state", - "sha", - "total_count", - "statuses", - "repository", - "commit_url", - "url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Commit statuses\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/statuses", - "title": "List commit statuses for a reference", - "category": "commits", - "subcategory": "statuses", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "description": "

The commit reference. Can be a commit SHA, branch name (heads/BRANCH_NAME), or tag name (tags/TAG_NAME). For more information, see \"Git References\" in the Git documentation.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.

\n

This resource is also available via a legacy route: GET /repos/:owner/:repo/statuses/:ref.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "ref": "REF" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "avatar_url": "https://github.com/images/error/hubot_happy.gif", - "id": 1, - "node_id": "MDY6U3RhdHVzMQ==", - "state": "success", - "description": "Build has completed successfully", - "target_url": "https://ci.example.com/1000/output", - "context": "continuous-integration/jenkins", - "created_at": "2012-07-20T01:19:13Z", - "updated_at": "2012-07-20T01:19:13Z", - "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 - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Status", - "description": "The status of a commit.", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "avatar_url": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "state": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "target_url": { - "type": [ - "string", - "null" - ] - }, - "context": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "url", - "avatar_url", - "id", - "node_id", - "state", - "description", - "target_url", - "context", - "created_at", - "updated_at", - "creator" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Commit statuses\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/statuses/{sha}", - "title": "Create a commit status", - "category": "commits", - "subcategory": "statuses", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sha", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "state", - "description": "

The state of the status.

", - "isRequired": true, - "enum": [ - "error", - "failure", - "pending", - "success" - ] - }, - { - "type": "string or null", - "name": "target_url", - "description": "

The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
\nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
\nhttp://ci.example.com/user/repo/build/sha

" - }, - { - "type": "string or null", - "name": "description", - "description": "

A short description of the status.

" - }, - { - "type": "string", - "name": "context", - "description": "

A string label to differentiate this status from the status of other systems. This field is case-insensitive.

", - "default": "default" - } - ], - "descriptionHTML": "

Users with push access in a repository can create commit statuses for a given SHA.

\n

Note: there is a limit of 1000 statuses per sha and context within a repository. Attempts to create more than 1000 statuses will result in a validation error.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "state": "success", - "target_url": "https://example.com/build/status", - "description": "The build succeeded!", - "context": "continuous-integration/jenkins" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "sha": "SHA" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "avatar_url": "https://github.com/images/error/hubot_happy.gif", - "id": 1, - "node_id": "MDY6U3RhdHVzMQ==", - "state": "success", - "description": "Build has completed successfully", - "target_url": "https://ci.example.com/1000/output", - "context": "continuous-integration/jenkins", - "created_at": "2012-07-20T01:19:13Z", - "updated_at": "2012-07-20T01:19:13Z", - "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 - } - }, - "schema": { - "title": "Status", - "description": "The status of a commit.", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "avatar_url": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "state": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "target_url": { - "type": [ - "string", - "null" - ] - }, - "context": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "url", - "avatar_url", - "id", - "node_id", - "state", - "description", - "target_url", - "context", - "created_at", - "updated_at", - "creator" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Commit statuses\" repository permissions": "write" - } - ] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/dependabot.json b/src/rest/data/ghes-3.14-2022-11-28/dependabot.json deleted file mode 100644 index 704f47d9c57e..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/dependabot.json +++ /dev/null @@ -1,8641 +0,0 @@ -{ - "alerts": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/dependabot/alerts", - "title": "List Dependabot alerts for an enterprise", - "category": "dependabot", - "subcategory": "alerts", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "in": "query", - "description": "

A comma-separated list of states. If specified, only alerts with these states will be returned.

\n

Can be: auto_dismissed, dismissed, fixed, open

", - "schema": { - "type": "string" - } - }, - { - "name": "severity", - "in": "query", - "description": "

A comma-separated list of severities. If specified, only alerts with these severities will be returned.

\n

Can be: low, medium, high, critical

", - "schema": { - "type": "string" - } - }, - { - "name": "ecosystem", - "in": "query", - "description": "

A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.

\n

Can be: composer, go, maven, npm, nuget, pip, pub, rubygems, rust

", - "schema": { - "type": "string" - } - }, - { - "name": "package", - "in": "query", - "description": "

A comma-separated list of package names. If specified, only alerts for these packages will be returned.

", - "schema": { - "type": "string" - } - }, - { - "name": "epss_percentage", - "in": "query", - "description": "

CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:

\n
    \n
  • An exact number (n)
    • \n
  • Comparators such as >n, <n, >=n, <=n
    • \n
  • A range like n..n, where n is a number from 0.0 to 1.0
    • \n
\n

Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.

", - "schema": { - "type": "string" - } - }, - { - "name": "has", - "in": "query", - "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "patch" - ] - } - } - ] - } - }, - { - "name": "scope", - "in": "query", - "description": "

The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.

", - "schema": { - "type": "string", - "enum": [ - "development", - "runtime" - ] - } - }, - { - "name": "sort", - "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "first", - "description": "

Deprecated. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with last.\nInstead, use per_page in combination with after to fetch the first page of results.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "

Deprecated. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with first.\nInstead, use per_page in combination with before to fetch the last page of results.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists Dependabot alerts for repositories that are owned by the specified enterprise.

\n

The authenticated user must be a member of the enterprise to use this endpoint.

\n

Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"Managing security managers in your organization.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "number": 2, - "state": "dismissed", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-rf4j-j272-fj86", - "cve_id": "CVE-2018-6188", - "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", - "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 1.11.8, < 1.11.10", - "first_patched_version": { - "identifier": "1.11.10" - } - } - ], - "severity": "high", - "cvss": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", - "score": 8.7 - } - }, - "cwes": [ - { - "cwe_id": "CWE-200", - "name": "Exposure of Sensitive Information to an Unauthorized Actor" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-rf4j-j272-fj86" - }, - { - "type": "CVE", - "value": "CVE-2018-6188" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" - }, - { - "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" - }, - { - "url": "https://usn.ubuntu.com/3559-1/" - }, - { - "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" - }, - { - "url": "http://www.securitytracker.com/id/1040422" - } - ], - "published_at": "2018-10-03T21:13:54Z", - "updated_at": "2022-04-26T18:35:37Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", - "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", - "created_at": "2022-06-15T07:43:03Z", - "updated_at": "2022-08-23T14:29:47Z", - "dismissed_at": "2022-08-23T14:29:47Z", - "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_reason": "tolerable_risk", - "dismissed_comment": "This alert is accurate but we use a sanitizer.", - "fixed_at": null, - "repository": { - "id": 217723378, - "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", - "name": "octo-repo", - "full_name": "octo-org/octo-repo", - "owner": { - "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 - }, - "private": true, - "html_url": "https://github.com/octo-org/octo-repo", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "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}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" - } - }, - { - "number": 1, - "state": "open", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-8f4m-hccc-8qph", - "cve_id": "CVE-2021-20191", - "summary": "Insertion of Sensitive Information into Log File in ansible", - "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.9.0, < 2.9.18", - "first_patched_version": { - "identifier": "2.9.18" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.10.0, < 2.10.7", - "first_patched_version": { - "identifier": "2.10.7" - } - } - ], - "severity": "medium", - "cvss": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", - "score": 8.5 - } - }, - "cwes": [ - { - "cwe_id": "CWE-532", - "name": "Insertion of Sensitive Information into Log File" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-8f4m-hccc-8qph" - }, - { - "type": "CVE", - "value": "CVE-2021-20191" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" - }, - { - "url": "https://access.redhat.com/security/cve/cve-2021-20191" - }, - { - "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" - } - ], - "published_at": "2021-06-01T17:38:00Z", - "updated_at": "2021-08-12T23:06:00Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", - "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", - "created_at": "2022-06-14T15:21:52Z", - "updated_at": "2022-06-14T15:21:52Z", - "dismissed_at": null, - "dismissed_by": null, - "dismissed_reason": null, - "dismissed_comment": null, - "fixed_at": null, - "repository": { - "id": 664700648, - "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", - "name": "hello-world", - "full_name": "octo-org/hello-world", - "owner": { - "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 - }, - "private": true, - "html_url": "https://github.com/octo-org/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octo-org/hello-world", - "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", - "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", - "events_url": "https://api.github.com/repos/octo-org/hello-world/events", - "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", - "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", - "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", - "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", - "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", - "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", - "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", - "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" - } - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "description": "A Dependabot alert.", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, - "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" - ] - }, - "dependency": { - "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true - }, - "scope": { - "type": [ - "string", - "null" - ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null - ] - } - } - }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, - "properties": { - "ghsa_id": { - "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true - }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true - }, - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cvss_severities": { - "type": [ - "object", - "null" - ], - "properties": { - "cvss_v3": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 3 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 4 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } - }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } - }, - "published_at": { - "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false - }, - "security_vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "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 - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "auto_dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissal_request": { - "title": "Dependabot alert dismissal request", - "description": "Information about an active dismissal request for this Dependabot alert.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the dismissal request." - }, - "status": { - "type": "string", - "description": "The current status of the dismissal request.", - "enum": [ - "pending", - "approved", - "rejected", - "cancelled" - ] - }, - "requester": { - "type": "object", - "description": "The user who requested the dismissal.", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the user." - }, - "login": { - "type": "string", - "description": "The login name of the user." - } - } - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time when the dismissal request was created." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The API URL to get more information about this dismissal request." - } - } - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the 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", - "url" - ] - } - }, - "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", - "html_url", - "created_at", - "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at", - "repository" - ], - "additionalProperties": false - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/alerts", - "title": "List Dependabot alerts for an organization", - "category": "dependabot", - "subcategory": "alerts", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "in": "query", - "description": "

A comma-separated list of states. If specified, only alerts with these states will be returned.

\n

Can be: auto_dismissed, dismissed, fixed, open

", - "schema": { - "type": "string" - } - }, - { - "name": "severity", - "in": "query", - "description": "

A comma-separated list of severities. If specified, only alerts with these severities will be returned.

\n

Can be: low, medium, high, critical

", - "schema": { - "type": "string" - } - }, - { - "name": "ecosystem", - "in": "query", - "description": "

A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.

\n

Can be: composer, go, maven, npm, nuget, pip, pub, rubygems, rust

", - "schema": { - "type": "string" - } - }, - { - "name": "package", - "in": "query", - "description": "

A comma-separated list of package names. If specified, only alerts for these packages will be returned.

", - "schema": { - "type": "string" - } - }, - { - "name": "epss_percentage", - "in": "query", - "description": "

CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:

\n
    \n
  • An exact number (n)
    • \n
  • Comparators such as >n, <n, >=n, <=n
    • \n
  • A range like n..n, where n is a number from 0.0 to 1.0
    • \n
\n

Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.

", - "schema": { - "type": "string" - } - }, - { - "name": "artifact_registry_url", - "in": "query", - "description": "

A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.

", - "schema": { - "type": "string" - } - }, - { - "name": "artifact_registry", - "in": "query", - "description": "

A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned.

\n

Can be: jfrog-artifactory

", - "schema": { - "type": "string" - } - }, - { - "name": "has", - "in": "query", - "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values.

", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "patch", - "deployment" - ] - } - } - ] - } - }, - { - "name": "runtime_risk", - "in": "query", - "description": "

A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned.

\n

Can be: critical-resource, internet-exposed, sensitive-data, lateral-movement

", - "schema": { - "type": "string" - } - }, - { - "name": "scope", - "in": "query", - "description": "

The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.

", - "schema": { - "type": "string", - "enum": [ - "development", - "runtime" - ] - } - }, - { - "name": "sort", - "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "first", - "description": "

Deprecated. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with last.\nInstead, use per_page in combination with after to fetch the first page of results.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "

Deprecated. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with first.\nInstead, use per_page in combination with before to fetch the last page of results.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists Dependabot alerts for an organization.

\n

The authenticated user must be an owner or security manager for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "number": 2, - "state": "dismissed", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-rf4j-j272-fj86", - "cve_id": "CVE-2018-6188", - "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", - "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 1.11.8, < 1.11.10", - "first_patched_version": { - "identifier": "1.11.10" - } - } - ], - "severity": "high", - "cvss": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", - "score": 8.7 - } - }, - "cwes": [ - { - "cwe_id": "CWE-200", - "name": "Exposure of Sensitive Information to an Unauthorized Actor" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-rf4j-j272-fj86" - }, - { - "type": "CVE", - "value": "CVE-2018-6188" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" - }, - { - "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" - }, - { - "url": "https://usn.ubuntu.com/3559-1/" - }, - { - "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" - }, - { - "url": "http://www.securitytracker.com/id/1040422" - } - ], - "published_at": "2018-10-03T21:13:54Z", - "updated_at": "2022-04-26T18:35:37Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", - "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", - "created_at": "2022-06-15T07:43:03Z", - "updated_at": "2022-08-23T14:29:47Z", - "dismissed_at": "2022-08-23T14:29:47Z", - "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_reason": "tolerable_risk", - "dismissed_comment": "This alert is accurate but we use a sanitizer.", - "fixed_at": null, - "repository": { - "id": 217723378, - "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", - "name": "octo-repo", - "full_name": "octo-org/octo-repo", - "owner": { - "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 - }, - "private": true, - "html_url": "https://github.com/octo-org/octo-repo", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "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}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" - } - }, - { - "number": 1, - "state": "open", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-8f4m-hccc-8qph", - "cve_id": "CVE-2021-20191", - "summary": "Insertion of Sensitive Information into Log File in ansible", - "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.9.0, < 2.9.18", - "first_patched_version": { - "identifier": "2.9.18" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.10.0, < 2.10.7", - "first_patched_version": { - "identifier": "2.10.7" - } - } - ], - "severity": "medium", - "cvss": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", - "score": 8.5 - } - }, - "cwes": [ - { - "cwe_id": "CWE-532", - "name": "Insertion of Sensitive Information into Log File" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-8f4m-hccc-8qph" - }, - { - "type": "CVE", - "value": "CVE-2021-20191" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" - }, - { - "url": "https://access.redhat.com/security/cve/cve-2021-20191" - }, - { - "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" - } - ], - "published_at": "2021-06-01T17:38:00Z", - "updated_at": "2021-08-12T23:06:00Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", - "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", - "created_at": "2022-06-14T15:21:52Z", - "updated_at": "2022-06-14T15:21:52Z", - "dismissed_at": null, - "dismissed_by": null, - "dismissed_reason": null, - "dismissed_comment": null, - "fixed_at": null, - "repository": { - "id": 664700648, - "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", - "name": "hello-world", - "full_name": "octo-org/hello-world", - "owner": { - "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 - }, - "private": true, - "html_url": "https://github.com/octo-org/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octo-org/hello-world", - "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", - "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", - "events_url": "https://api.github.com/repos/octo-org/hello-world/events", - "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", - "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", - "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", - "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", - "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", - "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", - "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", - "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" - } - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "description": "A Dependabot alert.", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, - "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" - ] - }, - "dependency": { - "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true - }, - "scope": { - "type": [ - "string", - "null" - ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null - ] - } - } - }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, - "properties": { - "ghsa_id": { - "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true - }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true - }, - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cvss_severities": { - "type": [ - "object", - "null" - ], - "properties": { - "cvss_v3": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 3 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 4 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } - }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } - }, - "published_at": { - "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false - }, - "security_vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "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 - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "auto_dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissal_request": { - "title": "Dependabot alert dismissal request", - "description": "Information about an active dismissal request for this Dependabot alert.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the dismissal request." - }, - "status": { - "type": "string", - "description": "The current status of the dismissal request.", - "enum": [ - "pending", - "approved", - "rejected", - "cancelled" - ] - }, - "requester": { - "type": "object", - "description": "The user who requested the dismissal.", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the user." - }, - "login": { - "type": "string", - "description": "The login name of the user." - } - } - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time when the dismissal request was created." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The API URL to get more information about this dismissal request." - } - } - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the 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", - "url" - ] - } - }, - "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", - "html_url", - "created_at", - "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at", - "repository" - ], - "additionalProperties": false - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Dependabot alerts\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/alerts", - "title": "List Dependabot alerts for a repository", - "category": "dependabot", - "subcategory": "alerts", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "in": "query", - "description": "

A comma-separated list of states. If specified, only alerts with these states will be returned.

\n

Can be: auto_dismissed, dismissed, fixed, open

", - "schema": { - "type": "string" - } - }, - { - "name": "severity", - "in": "query", - "description": "

A comma-separated list of severities. If specified, only alerts with these severities will be returned.

\n

Can be: low, medium, high, critical

", - "schema": { - "type": "string" - } - }, - { - "name": "ecosystem", - "in": "query", - "description": "

A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.

\n

Can be: composer, go, maven, npm, nuget, pip, pub, rubygems, rust

", - "schema": { - "type": "string" - } - }, - { - "name": "package", - "in": "query", - "description": "

A comma-separated list of package names. If specified, only alerts for these packages will be returned.

", - "schema": { - "type": "string" - } - }, - { - "name": "manifest", - "in": "query", - "description": "

A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned.

", - "schema": { - "type": "string" - } - }, - { - "name": "epss_percentage", - "in": "query", - "description": "

CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:

\n
    \n
  • An exact number (n)
    • \n
  • Comparators such as >n, <n, >=n, <=n
    • \n
  • A range like n..n, where n is a number from 0.0 to 1.0
    • \n
\n

Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.

", - "schema": { - "type": "string" - } - }, - { - "name": "has", - "in": "query", - "description": "

Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple has filters can be passed to filter for alerts that have all of the values. Currently, only patch is supported.

", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "patch" - ] - } - } - ] - } - }, - { - "name": "scope", - "in": "query", - "description": "

The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.

", - "schema": { - "type": "string", - "enum": [ - "development", - "runtime" - ] - } - }, - { - "name": "sort", - "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "page", - "description": "

Deprecated. Page number of the results to fetch. Use cursor-based pagination with before or after instead.

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "first", - "description": "

Deprecated. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with last.\nInstead, use per_page in combination with after to fetch the first page of results.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "

Deprecated. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with first.\nInstead, use per_page in combination with before to fetch the last page of results.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "number": 2, - "state": "dismissed", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-rf4j-j272-fj86", - "cve_id": "CVE-2018-6188", - "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", - "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 1.11.8, < 1.11.10", - "first_patched_version": { - "identifier": "1.11.10" - } - } - ], - "severity": "high", - "cvss": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", - "score": 8.7 - } - }, - "cwes": [ - { - "cwe_id": "CWE-200", - "name": "Exposure of Sensitive Information to an Unauthorized Actor" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-rf4j-j272-fj86" - }, - { - "type": "CVE", - "value": "CVE-2018-6188" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" - }, - { - "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" - }, - { - "url": "https://usn.ubuntu.com/3559-1/" - }, - { - "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" - }, - { - "url": "http://www.securitytracker.com/id/1040422" - } - ], - "published_at": "2018-10-03T21:13:54Z", - "updated_at": "2022-04-26T18:35:37Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - "url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2", - "html_url": "https://github.com/octocat/hello-world/security/dependabot/2", - "created_at": "2022-06-15T07:43:03Z", - "updated_at": "2022-08-23T14:29:47Z", - "dismissed_at": "2022-08-23T14:29:47Z", - "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_reason": "tolerable_risk", - "dismissed_comment": "This alert is accurate but we use a sanitizer.", - "fixed_at": null - }, - { - "number": 1, - "state": "open", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-8f4m-hccc-8qph", - "cve_id": "CVE-2021-20191", - "summary": "Insertion of Sensitive Information into Log File in ansible", - "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.9.0, < 2.9.18", - "first_patched_version": { - "identifier": "2.9.18" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.10.0, < 2.10.7", - "first_patched_version": { - "identifier": "2.10.7" - } - } - ], - "severity": "medium", - "cvss": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", - "score": 8.5 - } - }, - "cwes": [ - { - "cwe_id": "CWE-532", - "name": "Insertion of Sensitive Information into Log File" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-8f4m-hccc-8qph" - }, - { - "type": "CVE", - "value": "CVE-2021-20191" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" - }, - { - "url": "https://access.redhat.com/security/cve/cve-2021-20191" - }, - { - "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" - } - ], - "published_at": "2021-06-01T17:38:00Z", - "updated_at": "2021-08-12T23:06:00Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - "url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1", - "html_url": "https://github.com/octocat/hello-world/security/dependabot/1", - "created_at": "2022-06-14T15:21:52Z", - "updated_at": "2022-06-14T15:21:52Z", - "dismissed_at": null, - "dismissed_by": null, - "dismissed_reason": null, - "dismissed_comment": null, - "fixed_at": null - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "description": "A Dependabot alert.", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, - "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" - ] - }, - "dependency": { - "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true - }, - "scope": { - "type": [ - "string", - "null" - ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null - ] - } - } - }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, - "properties": { - "ghsa_id": { - "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true - }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true - }, - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cvss_severities": { - "type": [ - "object", - "null" - ], - "properties": { - "cvss_v3": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 3 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 4 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } - }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } - }, - "published_at": { - "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false - }, - "security_vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "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 - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "auto_dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissal_request": { - "title": "Dependabot alert dismissal request", - "description": "Information about an active dismissal request for this Dependabot alert.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the dismissal request." - }, - "status": { - "type": "string", - "description": "The current status of the dismissal request.", - "enum": [ - "pending", - "approved", - "rejected", - "cancelled" - ] - }, - "requester": { - "type": "object", - "description": "The user who requested the dismissal.", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the user." - }, - "login": { - "type": "string", - "description": "The login name of the user." - } - } - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time when the dismissal request was created." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The API URL to get more information about this dismissal request." - } - } - } - }, - "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", - "html_url", - "created_at", - "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at" - ], - "additionalProperties": false - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Dependabot alerts\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}", - "title": "Get a Dependabot alert", - "category": "dependabot", - "subcategory": "alerts", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "alert_number", - "in": "path", - "description": "

The number that identifies a Dependabot alert in its repository.\nYou can find this at the end of the URL for a Dependabot alert within GitHub,\nor in number fields in the response from the\nGET /repos/{owner}/{repo}/dependabot/alerts operation.

", - "required": true, - "schema": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "alert_number": "ALERT_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "number": 1, - "state": "open", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-8f4m-hccc-8qph", - "cve_id": "CVE-2021-20191", - "summary": "Insertion of Sensitive Information into Log File in ansible", - "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.9.0, < 2.9.18", - "first_patched_version": { - "identifier": "2.9.18" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.10.0, < 2.10.7", - "first_patched_version": { - "identifier": "2.10.7" - } - } - ], - "severity": "medium", - "cvss": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", - "score": 8.5 - } - }, - "cwes": [ - { - "cwe_id": "CWE-532", - "name": "Insertion of Sensitive Information into Log File" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-8f4m-hccc-8qph" - }, - { - "type": "CVE", - "value": "CVE-2021-20191" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" - }, - { - "url": "https://access.redhat.com/security/cve/cve-2021-20191" - }, - { - "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" - } - ], - "published_at": "2021-06-01T17:38:00Z", - "updated_at": "2021-08-12T23:06:00Z" - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - "url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1", - "html_url": "https://github.com/octocat/hello-world/security/dependabot/1", - "created_at": "2022-06-14T15:21:52Z", - "updated_at": "2022-06-14T15:21:52Z" - }, - "schema": { - "type": "object", - "description": "A Dependabot alert.", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, - "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" - ] - }, - "dependency": { - "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true - }, - "scope": { - "type": [ - "string", - "null" - ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null - ] - } - } - }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, - "properties": { - "ghsa_id": { - "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true - }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true - }, - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cvss_severities": { - "type": [ - "object", - "null" - ], - "properties": { - "cvss_v3": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 3 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 4 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } - }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } - }, - "published_at": { - "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false - }, - "security_vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "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 - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "auto_dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissal_request": { - "title": "Dependabot alert dismissal request", - "description": "Information about an active dismissal request for this Dependabot alert.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the dismissal request." - }, - "status": { - "type": "string", - "description": "The current status of the dismissal request.", - "enum": [ - "pending", - "approved", - "rejected", - "cancelled" - ] - }, - "requester": { - "type": "object", - "description": "The user who requested the dismissal.", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the user." - }, - "login": { - "type": "string", - "description": "The login name of the user." - } - } - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time when the dismissal request was created." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The API URL to get more information about this dismissal request." - } - } - } - }, - "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", - "html_url", - "created_at", - "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at" - ], - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Dependabot alerts\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}", - "title": "Update a Dependabot alert", - "category": "dependabot", - "subcategory": "alerts", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "alert_number", - "in": "path", - "description": "

The number that identifies a Dependabot alert in its repository.\nYou can find this at the end of the URL for a Dependabot alert within GitHub,\nor in number fields in the response from the\nGET /repos/{owner}/{repo}/dependabot/alerts operation.

", - "required": true, - "schema": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.\nA dismissed_reason must be provided when setting the state to dismissed.

", - "enum": [ - "dismissed", - "open" - ] - }, - { - "type": "string", - "name": "dismissed_reason", - "description": "

Required when state is dismissed. A reason for dismissing the alert.

", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk" - ] - }, - { - "type": "string", - "name": "dismissed_comment", - "description": "

An optional comment associated with dismissing the alert.

" - }, - { - "type": "array of strings", - "name": "assignees", - "description": "

Usernames to assign to this Dependabot Alert.\nPass one or more user logins to replace the set of assignees on this alert.\nSend an empty array ([]) to clear all assignees from the alert.

" - } - ], - "descriptionHTML": "

The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"Granting access to security alerts.\"

\n

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "state": "dismissed", - "dismissed_reason": "tolerable_risk", - "dismissed_comment": "This alert is accurate but we use a sanitizer." - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "alert_number": "ALERT_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "number": 2, - "state": "dismissed", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-rf4j-j272-fj86", - "cve_id": "CVE-2018-6188", - "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", - "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 1.11.8, < 1.11.10", - "first_patched_version": { - "identifier": "1.11.10" - } - } - ], - "severity": "high", - "cvss": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", - "score": 8.7 - } - }, - "cwes": [ - { - "cwe_id": "CWE-200", - "name": "Exposure of Sensitive Information to an Unauthorized Actor" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-rf4j-j272-fj86" - }, - { - "type": "CVE", - "value": "CVE-2018-6188" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" - }, - { - "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" - }, - { - "url": "https://usn.ubuntu.com/3559-1/" - }, - { - "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" - }, - { - "url": "http://www.securitytracker.com/id/1040422" - } - ], - "published_at": "2018-10-03T21:13:54Z", - "updated_at": "2022-04-26T18:35:37Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - "url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2", - "html_url": "https://github.com/octocat/hello-world/security/dependabot/2", - "created_at": "2022-06-15T07:43:03Z", - "updated_at": "2022-08-23T14:29:47Z", - "dismissed_at": "2022-08-23T14:29:47Z", - "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_reason": "tolerable_risk", - "dismissed_comment": "This alert is accurate but we use a sanitizer." - }, - "schema": { - "type": "object", - "description": "A Dependabot alert.", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, - "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" - ] - }, - "dependency": { - "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true - }, - "scope": { - "type": [ - "string", - "null" - ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null - ] - } - } - }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, - "properties": { - "ghsa_id": { - "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true - }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true - }, - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cvss_severities": { - "type": [ - "object", - "null" - ], - "properties": { - "cvss_v3": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 3 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 4 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } - }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } - }, - "published_at": { - "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false - }, - "security_vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "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 - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "auto_dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissal_request": { - "title": "Dependabot alert dismissal request", - "description": "Information about an active dismissal request for this Dependabot alert.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the dismissal request." - }, - "status": { - "type": "string", - "description": "The current status of the dismissal request.", - "enum": [ - "pending", - "approved", - "rejected", - "cancelled" - ] - }, - "requester": { - "type": "object", - "description": "The user who requested the dismissal.", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the user." - }, - "login": { - "type": "string", - "description": "The login name of the user." - } - } - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time when the dismissal request was created." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The API URL to get more information about this dismissal request." - } - } - } - }, - "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", - "html_url", - "created_at", - "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at" - ], - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Dependabot alerts\" repository permissions": "write" - } - ] - } - } - ], - "secrets": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets", - "title": "List organization secrets", - "category": "dependabot", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 3, - "secrets": [ - { - "name": "MY_ARTIFACTORY_PASSWORD", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "private" - }, - { - "name": "NPM_TOKEN", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "all" - }, - { - "name": "GH_TOKEN", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "title": "Dependabot Secret for an Organization", - "description": "Secrets for GitHub Dependabot for an organization.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Organization dependabot secrets\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets/public-key", - "title": "Get an organization public key", - "category": "dependabot", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - }, - "schema": { - "title": "DependabotPublicKey", - "description": "The public key used for setting Dependabot Secrets.", - "type": "object", - "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string" - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string" - } - }, - "required": [ - "key_id", - "key" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Organization dependabot secrets\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}", - "title": "Get an organization secret", - "category": "dependabot", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a single organization secret without revealing its encrypted value.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "name": "NPM_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/dependabot/secrets/NPM_TOKEN/repositories" - }, - "schema": { - "title": "Dependabot Secret for an Organization", - "description": "Secrets for GitHub Dependabot for an organization.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Organization dependabot secrets\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}", - "title": "Create or update an organization secret", - "category": "dependabot", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

" - }, - { - "type": "string", - "name": "key_id", - "description": "

ID of the key you used to encrypt the secret.

" - }, - { - "type": "string", - "name": "visibility", - "description": "

Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.

", - "isRequired": true, - "enum": [ - "all", - "private", - "selected" - ] - }, - { - "type": "array", - "name": "selected_repository_ids", - "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.

" - } - ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example 1: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - }, - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response when creating a secret

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 204", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - }, - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response when updating a secret

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Response when creating a secret

" - }, - { - "httpStatusCode": "204", - "description": "

Response when updating a secret

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Organization dependabot secrets\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}", - "title": "Delete an organization secret", - "category": "dependabot", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a secret in an organization using the secret name.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Organization dependabot secrets\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories", - "title": "List selected repositories for an organization secret", - "category": "dependabot", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "repositories" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "repositories": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Organization dependabot secrets\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories", - "title": "Set selected repositories for an organization secret", - "category": "dependabot", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of integers", - "name": "selected_repository_ids", - "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.

", - "isRequired": true - } - ], - "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "selected_repository_ids": [ - 64780797 - ] - }, - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Organization dependabot secrets\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "title": "Add selected repository to an organization secret", - "category": "dependabot", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. The visibility is set when you Create or\nupdate an organization secret.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME", - "repository_id": "REPOSITORY_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

No Content when repository was added to the selected list

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content when repository was added to the selected list

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict when visibility type is not set to selected

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Organization dependabot secrets\" organization permissions": "write", - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "title": "Remove selected repository from an organization secret", - "category": "dependabot", - "subcategory": "secrets", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "secret_name": "SECRET_NAME", - "repository_id": "REPOSITORY_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response when repository was removed from the selected list

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Response when repository was removed from the selected list

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict when visibility type not set to selected

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Organization dependabot secrets\" organization permissions": "write", - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets", - "title": "List repository secrets", - "category": "dependabot", - "subcategory": "secrets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all secrets available in a repository without revealing their encrypted\nvalues.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 2, - "secrets": [ - { - "name": "AZURE_DEVOPS_PAT", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - }, - { - "name": "MY_ARTIFACTORY_PASSWORD", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "title": "Dependabot Secret", - "description": "Set secrets for Dependabot.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "created_at", - "updated_at" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Dependabot secrets\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/public-key", - "title": "Get a repository public key", - "category": "dependabot", - "subcategory": "secrets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets. Anyone with read access\nto the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint if the repository is private.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - }, - "schema": { - "title": "DependabotPublicKey", - "description": "The public key used for setting Dependabot Secrets.", - "type": "object", - "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string" - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string" - } - }, - "required": [ - "key_id", - "key" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Dependabot secrets\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", - "title": "Get a repository secret", - "category": "dependabot", - "subcategory": "secrets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a single repository secret without revealing its encrypted value.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "name": "MY_ARTIFACTORY_PASSWORD", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - }, - "schema": { - "title": "Dependabot Secret", - "description": "Set secrets for Dependabot.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Dependabot secrets\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", - "title": "Create or update a repository secret", - "category": "dependabot", - "subcategory": "secrets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" - }, - { - "type": "string", - "name": "key_id", - "description": "

ID of the key you used to encrypt the secret.

" - } - ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example 1: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response when creating a secret

", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 204", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response when updating a secret

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Response when creating a secret

" - }, - { - "httpStatusCode": "204", - "description": "

Response when updating a secret

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Dependabot secrets\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", - "title": "Delete a repository secret", - "category": "dependabot", - "subcategory": "secrets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "

The name of the secret.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a secret in a repository using the secret name.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Dependabot secrets\" repository permissions": "write" - } - ] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/dependency-graph.json b/src/rest/data/ghes-3.14-2022-11-28/dependency-graph.json deleted file mode 100644 index e5486f87acbd..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/dependency-graph.json +++ /dev/null @@ -1,819 +0,0 @@ -{ - "dependency-review": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}", - "title": "Get a diff of the dependencies between commits", - "category": "dependency-graph", - "subcategory": "dependency-review", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "basehead", - "description": "

The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format {base}...{head}.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "

The full path, relative to the repository root, of the dependency manifest file.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "basehead": "BASEHEAD" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "change_type": "removed", - "manifest": "package.json", - "ecosystem": "npm", - "name": "helmet", - "version": "4.6.0", - "package_url": "pkg:npm/helmet@4.6.0", - "license": "MIT", - "source_repository_url": "https://github.com/helmetjs/helmet", - "vulnerabilities": [] - }, - { - "change_type": "added", - "manifest": "package.json", - "ecosystem": "npm", - "name": "helmet", - "version": "5.0.0", - "package_url": "pkg:npm/helmet@5.0.0", - "license": "MIT", - "source_repository_url": "https://github.com/helmetjs/helmet", - "vulnerabilities": [] - }, - { - "change_type": "added", - "manifest": "Gemfile", - "ecosystem": "rubygems", - "name": "ruby-openid", - "version": "2.7.0", - "package_url": "pkg:gem/ruby-openid@2.7.0", - "license": null, - "source_repository_url": "https://github.com/openid/ruby-openid", - "vulnerabilities": [ - { - "severity": "critical", - "advisory_ghsa_id": "GHSA-fqfj-cmh6-hj49", - "advisory_summary": "Ruby OpenID", - "advisory_url": "https://github.com/advisories/GHSA-fqfj-cmh6-hj49" - } - ] - } - ], - "schema": { - "title": "Dependency Graph Diff", - "description": "A diff of the dependencies between two commits.", - "type": "array", - "items": { - "type": "object", - "properties": { - "change_type": { - "type": "string", - "enum": [ - "added", - "removed" - ] - }, - "manifest": { - "type": "string" - }, - "ecosystem": { - "type": "string" - }, - "name": { - "type": "string" - }, - "version": { - "type": "string" - }, - "package_url": { - "type": [ - "string", - "null" - ] - }, - "license": { - "type": [ - "string", - "null" - ] - }, - "source_repository_url": { - "type": [ - "string", - "null" - ] - }, - "vulnerabilities": { - "type": "array", - "items": { - "type": "object", - "properties": { - "severity": { - "type": "string" - }, - "advisory_ghsa_id": { - "type": "string" - }, - "advisory_summary": { - "type": "string" - }, - "advisory_url": { - "type": "string" - } - }, - "required": [ - "severity", - "advisory_ghsa_id", - "advisory_summary", - "advisory_url" - ] - } - }, - "scope": { - "description": "Where the dependency is utilized. `development` means that the dependency is only utilized in the development environment. `runtime` means that the dependency is utilized at runtime and in the development environment.", - "type": "string", - "enum": [ - "unknown", - "runtime", - "development" - ] - } - }, - "required": [ - "change_type", - "manifest", - "ecosystem", - "name", - "version", - "package_url", - "license", - "source_repository_url", - "vulnerabilities", - "scope" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ], - "dependency-submission": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/dependency-graph/snapshots", - "title": "Create a snapshot of dependencies for a repository", - "category": "dependency-graph", - "subcategory": "dependency-submission", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "integer", - "name": "version", - "description": "

The version of the repository snapshot submission.

", - "isRequired": true - }, - { - "type": "object", - "name": "job", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "id", - "description": "

The external ID of the job.

", - "isRequired": true - }, - { - "type": "string", - "name": "correlator", - "description": "

Correlator provides a key that is used to group snapshots submitted over time. Only the \"latest\" submitted snapshot for a given combination of job.correlator and detector.name will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given \"wave\" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "

The url for the job.

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "

The commit SHA associated with this dependency snapshot. Maximum length: 40 characters.

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The repository branch that triggered this snapshot.

", - "isRequired": true - }, - { - "type": "object", - "name": "detector", - "description": "

A description of the detector used.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the detector used.

", - "isRequired": true - }, - { - "type": "string", - "name": "version", - "description": "

The version of the detector used.

", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

The url of the detector used.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "metadata", - "description": "

User-defined metadata to store domain-specific information limited to 8 keys with scalar values.

" - }, - { - "type": "object", - "name": "manifests", - "description": "

A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.

", - "childParamsGroups": [ - { - "type": "object", - "name": "key", - "description": "

A user-defined key to represent an item in manifests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the manifest.

", - "isRequired": true - }, - { - "type": "object", - "name": "file", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "source_location", - "description": "

The path of the manifest file relative to the root of the Git repository.

" - } - ] - }, - { - "type": "object", - "name": "metadata", - "description": "

User-defined metadata to store domain-specific information limited to 8 keys with scalar values.

" - }, - { - "type": "object", - "name": "resolved", - "description": "

A collection of resolved package dependencies.

", - "childParamsGroups": [ - { - "type": "object", - "name": "key", - "description": "

A user-defined key to represent an item in resolved.

", - "childParamsGroups": [ - { - "type": "string", - "name": "package_url", - "description": "

Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.

" - }, - { - "type": "object", - "name": "metadata", - "description": "

User-defined metadata to store domain-specific information limited to 8 keys with scalar values.

" - }, - { - "type": "string", - "name": "relationship", - "description": "

A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.

", - "enum": [ - "direct", - "indirect" - ] - }, - { - "type": "string", - "name": "scope", - "description": "

A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.

", - "enum": [ - "runtime", - "development" - ] - }, - { - "type": "array of strings", - "name": "dependencies", - "description": "

Array of package-url (PURLs) of direct child dependencies.

" - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "string", - "name": "scanned", - "description": "

The time at which the snapshot was scanned.

", - "isRequired": true - } - ], - "descriptionHTML": "

Create a new snapshot of a repository's dependencies.

\n

The authenticated user must have access to the repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "version": 0, - "sha": "ce587453ced02b1526dfb4cb910479d431683101", - "ref": "refs/heads/main", - "job": { - "correlator": "yourworkflowname_youractionname", - "id": "yourrunid" - }, - "detector": { - "name": "octo-detector", - "version": "0.0.1", - "url": "https://github.com/octo-org/octo-repo" - }, - "scanned": "2022-06-14T20:25:00Z", - "manifests": { - "package-lock.json": { - "name": "package-lock.json", - "file": { - "source_location": "src/package-lock.json" - }, - "resolved": { - "@actions/core": { - "package_url": "pkg:/npm/%40actions/core@1.1.9", - "dependencies": [ - "@actions/http-client" - ] - }, - "@actions/http-client": { - "package_url": "pkg:/npm/%40actions/http-client@1.0.7", - "dependencies": [ - "tunnel" - ] - }, - "tunnel": { - "package_url": "pkg:/npm/tunnel@0.0.6" - } - } - } - } - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 12345, - "created_at": "2018-05-04T01:14:52Z", - "message": "Dependency results for the repo have been successfully updated.", - "result": "SUCCESS" - }, - "schema": { - "type": "object", - "required": [ - "id", - "created_at", - "result", - "message" - ], - "properties": { - "id": { - "type": "integer", - "description": "ID of the created snapshot." - }, - "created_at": { - "type": "string", - "description": "The time at which the snapshot was created." - }, - "result": { - "type": "string", - "description": "Either \"SUCCESS\", \"ACCEPTED\", or \"INVALID\". \"SUCCESS\" indicates that the snapshot was successfully created and the repository's dependencies were updated. \"ACCEPTED\" indicates that the snapshot was successfully created, but the repository's dependencies were not updated. \"INVALID\" indicates that the snapshot was malformed." - }, - "message": { - "type": "string", - "description": "A message providing further details about the result, such as why the dependencies were not updated." - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - } - ], - "sboms": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/dependency-graph/sbom", - "title": "Export a software bill of materials (SBOM) for a repository.", - "category": "dependency-graph", - "subcategory": "sboms", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Exports the software bill of materials (SBOM) for a repository in SPDX JSON format.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "sbom": { - "SPDXID": "SPDXRef-DOCUMENT", - "spdxVersion": "SPDX-2.3", - "creationInfo": { - "created": "2021-09-01T00:00:00Z", - "creators": [ - "Tool: GitHub.com-Dependency-Graph" - ] - }, - "name": "github/example", - "dataLicense": "CC0-1.0", - "documentNamespace": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", - "packages": [ - { - "SPDXID": "SPDXRef-Package", - "name": "rubygems:rails", - "versionInfo": "1.0.0", - "downloadLocation": "NOASSERTION", - "filesAnalyzed": false, - "licenseConcluded": "NOASSERTION", - "licenseDeclared": "NOASSERTION" - } - ], - "relationships": [ - { - "relationshipType": "DEPENDS_ON", - "spdxElementId": "SPDXRef-Repository", - "relatedSpdxElement": "SPDXRef-Package" - }, - { - "relationshipType": "DESCRIBES", - "spdxElementId": "SPDXRef-DOCUMENT", - "relatedSpdxElement": "SPDXRef-Repository" - } - ] - } - }, - "schema": { - "title": "Dependency Graph SPDX SBOM", - "description": "A schema for the SPDX JSON format returned by the Dependency Graph.", - "type": "object", - "properties": { - "sbom": { - "type": "object", - "properties": { - "SPDXID": { - "type": "string", - "description": "The SPDX identifier for the SPDX document." - }, - "spdxVersion": { - "type": "string", - "description": "The version of the SPDX specification that this document conforms to." - }, - "comment": { - "type": "string", - "description": "An optional comment about the SPDX document." - }, - "creationInfo": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "The date and time the SPDX document was created." - }, - "creators": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The tools that were used to generate the SPDX document." - } - }, - "required": [ - "created", - "creators" - ] - }, - "name": { - "type": "string", - "description": "The name of the SPDX document." - }, - "dataLicense": { - "type": "string", - "description": "The license under which the SPDX document is licensed." - }, - "documentNamespace": { - "type": "string", - "description": "The namespace for the SPDX document." - }, - "packages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "SPDXID": { - "type": "string", - "description": "A unique SPDX identifier for the package." - }, - "name": { - "type": "string", - "description": "The name of the package." - }, - "versionInfo": { - "type": "string", - "description": "The version of the package. If the package does not have an exact version specified,\na version range is given." - }, - "downloadLocation": { - "type": "string", - "description": "The location where the package can be downloaded,\nor NOASSERTION if this has not been determined." - }, - "filesAnalyzed": { - "type": "boolean", - "description": "Whether the package's file content has been subjected to\nanalysis during the creation of the SPDX document." - }, - "licenseConcluded": { - "type": "string", - "description": "The license of the package as determined while creating the SPDX document." - }, - "licenseDeclared": { - "type": "string", - "description": "The license of the package as declared by its author, or NOASSERTION if this information\nwas not available when the SPDX document was created." - }, - "supplier": { - "type": "string", - "description": "The distribution source of this package, or NOASSERTION if this was not determined." - }, - "copyrightText": { - "type": "string", - "description": "The copyright holders of the package, and any dates present with those notices, if available." - }, - "externalRefs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "referenceCategory": { - "type": "string", - "description": "The category of reference to an external resource this reference refers to." - }, - "referenceLocator": { - "type": "string", - "description": "A locator for the particular external resource this reference refers to." - }, - "referenceType": { - "type": "string", - "description": "The category of reference to an external resource this reference refers to." - } - }, - "required": [ - "referenceCategory", - "referenceLocator", - "referenceType" - ] - } - } - } - }, - "required": [ - "SPDXID", - "name", - "versionInfo", - "downloadLocation", - "filesAnalyzed" - ] - }, - "relationships": { - "type": "array", - "items": { - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "The type of relationship between the two SPDX elements." - }, - "spdxElementId": { - "type": "string", - "description": "The SPDX identifier of the package that is the source of the relationship." - }, - "relatedSpdxElement": { - "type": "string", - "description": "The SPDX identifier of the package that is the target of the relationship." - } - } - }, - "required": [ - "relationshipType", - "spdxElementId", - "relatedSpdxElement" - ] - } - }, - "required": [ - "SPDXID", - "spdxVersion", - "creationInfo", - "name", - "dataLicense", - "documentNamespace", - "packages" - ] - } - }, - "required": [ - "sbom" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/deploy-keys.json b/src/rest/data/ghes-3.14-2022-11-28/deploy-keys.json deleted file mode 100644 index 2aead039af8b..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/deploy-keys.json +++ /dev/null @@ -1,518 +0,0 @@ -{ - "deploy-keys": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/keys", - "title": "List deploy keys", - "category": "deploy-keys", - "subcategory": "deploy-keys", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "enabled": [ - { - "id": 1, - "key": "ssh-rsa AAA...", - "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", - "title": "octocat@octomac", - "verified": true, - "created_at": "2014-12-10T15:53:42Z", - "read_only": true, - "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" - } - ] - }, - "schema": { - "type": "array", - "items": { - "title": "Deploy Key", - "description": "An SSH key granting access to a single repository.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "key": { - "type": "string" - }, - "url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "verified": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "read_only": { - "type": "boolean" - }, - "added_by": { - "type": [ - "string", - "null" - ] - }, - "last_used": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "key", - "url", - "title", - "verified", - "created_at", - "read_only" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/keys", - "title": "Create a deploy key", - "category": "deploy-keys", - "subcategory": "deploy-keys", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "title", - "description": "

A name for the key.

" - }, - { - "type": "string", - "name": "key", - "description": "

The contents of the key.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "read_only", - "description": "

If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

\n

Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

" - } - ], - "descriptionHTML": "

You can create a read-only deploy key.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "title": "octocat@octomac", - "key": "ssh-rsa AAA...", - "read_only": true - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "key": "ssh-rsa AAA...", - "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", - "title": "octocat@octomac", - "verified": true, - "created_at": "2014-12-10T15:53:42Z", - "read_only": true, - "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" - }, - "schema": { - "title": "Deploy Key", - "description": "An SSH key granting access to a single repository.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "key": { - "type": "string" - }, - "url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "verified": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "read_only": { - "type": "boolean" - }, - "added_by": { - "type": [ - "string", - "null" - ] - }, - "last_used": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "key", - "url", - "title", - "verified", - "created_at", - "read_only" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "title": "Get a deploy key", - "category": "deploy-keys", - "subcategory": "deploy-keys", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "key_id", - "description": "

The unique identifier of the key.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "key_id": "KEY_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "key": "ssh-rsa AAA...", - "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", - "title": "octocat@octomac", - "verified": true, - "created_at": "2014-12-10T15:53:42Z", - "read_only": true, - "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" - }, - "schema": { - "title": "Deploy Key", - "description": "An SSH key granting access to a single repository.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "key": { - "type": "string" - }, - "url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "verified": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "read_only": { - "type": "boolean" - }, - "added_by": { - "type": [ - "string", - "null" - ] - }, - "last_used": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "key", - "url", - "title", - "verified", - "created_at", - "read_only" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", - "title": "Delete a deploy key", - "category": "deploy-keys", - "subcategory": "deploy-keys", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "key_id", - "description": "

The unique identifier of the key.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "key_id": "KEY_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/deployments.json b/src/rest/data/ghes-3.14-2022-11-28/deployments.json deleted file mode 100644 index 4ac331dafa78..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/deployments.json +++ /dev/null @@ -1,7406 +0,0 @@ -{ - "deployments": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments", - "title": "List deployments", - "category": "deployments", - "subcategory": "deployments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sha", - "description": "

The SHA recorded at creation time.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "none" - } - }, - { - "name": "ref", - "description": "

The name of the ref. This can be a branch, tag, or SHA.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "none" - } - }, - { - "name": "task", - "description": "

The name of the task for the deployment (e.g., deploy or deploy:migrations).

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "none" - } - }, - { - "name": "environment", - "description": "

The name of the environment that was deployed to (e.g., staging or production).

", - "in": "query", - "required": false, - "schema": { - "type": [ - "string", - "null" - ], - "default": "none" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Simple filtering of deployments is available via query parameters:

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "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" - }, - "id": { - "description": "Unique identifier of the deployment", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "ref": { - "description": "The ref to deploy. This can be a branch, tag, or sha.", - "type": "string" - }, - "task": { - "description": "Parameter to specify a task to execute", - "type": "string" - }, - "payload": { - "oneOf": [ - { - "type": "object", - "additionalProperties": true - }, - { - "type": "string" - } - ] - }, - "original_environment": { - "type": "string" - }, - "environment": { - "description": "Name for the target deployment environment.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "transient_environment": { - "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", - "type": "boolean" - }, - "production_environment": { - "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", - "type": "boolean" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "sha", - "ref", - "task", - "environment", - "creator", - "payload", - "description", - "statuses_url", - "repository_url", - "url", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Deployments\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/deployments", - "title": "Create a deployment", - "category": "deployments", - "subcategory": "deployments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "ref", - "description": "

The ref to deploy. This can be a branch, tag, or SHA.

", - "isRequired": true - }, - { - "type": "string", - "name": "task", - "description": "

Specifies a task to execute (e.g., deploy or deploy:migrations).

", - "default": "deploy" - }, - { - "type": "boolean", - "name": "auto_merge", - "description": "

Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

", - "default": true - }, - { - "type": "array of strings", - "name": "required_contexts", - "description": "

The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

" - }, - { - "type": "object or string", - "name": "payload", - "description": "

JSON payload with extra information about the deployment.

" - }, - { - "type": "string", - "name": "environment", - "description": "

Name for the target deployment environment (e.g., production, staging, qa).

", - "default": "production" - }, - { - "type": "string or null", - "name": "description", - "description": "

Short description of the deployment.

", - "default": "" - }, - { - "type": "boolean", - "name": "transient_environment", - "description": "

Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false

", - "default": false - }, - { - "type": "boolean", - "name": "production_environment", - "description": "

Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

" - } - ], - "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Merged branch response:

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n
    \n
  • Auto-merge option is enabled in the repository
    • \n
  • Topic branch does not include the latest changes on the base branch, which is master in the response example
    • \n
  • There are no merge conflicts
    • \n
\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response:

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks:

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

\n

OAuth app tokens and personal access tokens (classic) need the repo or repo_deployment scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Simple example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "ref": "topic-branch", - "payload": "{ \"deploy\": \"migrate\" }", - "description": "Deploy request from hubot" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Simple example

", - "example": { - "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 - }, - "schema": { - "title": "Deployment", - "description": "A request for a specific ref(branch,sha,tag) to be deployed", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the deployment", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "ref": { - "description": "The ref to deploy. This can be a branch, tag, or sha.", - "type": "string" - }, - "task": { - "description": "Parameter to specify a task to execute", - "type": "string" - }, - "payload": { - "oneOf": [ - { - "type": "object", - "additionalProperties": true - }, - { - "type": "string" - } - ] - }, - "original_environment": { - "type": "string" - }, - "environment": { - "description": "Name for the target deployment environment.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "transient_environment": { - "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", - "type": "boolean" - }, - "production_environment": { - "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", - "type": "boolean" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "sha", - "ref", - "task", - "environment", - "creator", - "payload", - "description", - "statuses_url", - "repository_url", - "url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "202", - "description": "

Merged branch response

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict when there is a merge conflict or the commit's status checks failed

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Deployments\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "title": "Get a deployment", - "category": "deployments", - "subcategory": "deployments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "deployment_id", - "description": "

deployment_id parameter

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "deployment_id": "DEPLOYMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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 - }, - "schema": { - "title": "Deployment", - "description": "A request for a specific ref(branch,sha,tag) to be deployed", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the deployment", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "ref": { - "description": "The ref to deploy. This can be a branch, tag, or sha.", - "type": "string" - }, - "task": { - "description": "Parameter to specify a task to execute", - "type": "string" - }, - "payload": { - "oneOf": [ - { - "type": "object", - "additionalProperties": true - }, - { - "type": "string" - } - ] - }, - "original_environment": { - "type": "string" - }, - "environment": { - "description": "Name for the target deployment environment.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "transient_environment": { - "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", - "type": "boolean" - }, - "production_environment": { - "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", - "type": "boolean" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "sha", - "ref", - "task", - "environment", - "creator", - "payload", - "description", - "statuses_url", - "repository_url", - "url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Deployments\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "title": "Delete a deployment", - "category": "deployments", - "subcategory": "deployments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "deployment_id", - "description": "

deployment_id parameter

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.

\n

To set a deployment as inactive, you must:

\n
    \n
  • Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
    • \n
  • Mark the active deployment as inactive by adding any non-successful deployment status.
    • \n
\n

For more information, see \"Create a deployment\" and \"Create a deployment status.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo or repo_deployment scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "deployment_id": "DEPLOYMENT_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Deployments\" repository permissions": "write" - } - ] - } - } - ], - "branch-policies": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies", - "title": "List deployment branch policies", - "category": "deployments", - "subcategory": "branch-policies", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the deployment branch policies for an environment.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 2, - "branch_policies": [ - { - "id": 361471, - "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=", - "name": "release/*" - }, - { - "id": 361472, - "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI=", - "name": "main" - } - ] - }, - "schema": { - "type": "object", - "properties": { - "total_count": { - "description": "The number of deployment branch policies for the environment.", - "type": "integer" - }, - "branch_policies": { - "type": "array", - "items": { - "title": "Deployment branch policy", - "description": "Details of a deployment branch or tag policy.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the branch or tag policy.", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name pattern that branches or tags must match in order to deploy to the environment.", - "type": "string" - }, - "type": { - "description": "Whether this rule targets a branch or tag.", - "type": "string", - "enum": [ - "branch", - "tag" - ] - } - } - } - } - }, - "required": [ - "total_count", - "branch_policies" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies", - "title": "Create a deployment branch policy", - "category": "deployments", - "subcategory": "branch-policies", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name pattern that branches or tags must match in order to deploy to the environment.

\n

Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

Whether this rule targets a branch or tag

", - "enum": [ - "branch", - "tag" - ] - } - ], - "descriptionHTML": "

Creates a deployment branch or tag policy for an environment.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 364662, - "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=", - "name": "release/*" - }, - "schema": { - "title": "Deployment branch policy", - "description": "Details of a deployment branch or tag policy.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the branch or tag policy.", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name pattern that branches or tags must match in order to deploy to the environment.", - "type": "string" - }, - "type": { - "description": "Whether this rule targets a branch or tag.", - "type": "string", - "enum": [ - "branch", - "tag" - ] - } - } - } - }, - "request": { - "contentType": "application/json", - "description": "Example of a wildcard name pattern", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "release/*" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME" - } - } - }, - { - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 364663, - "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=", - "name": "main" - }, - "schema": { - "title": "Deployment branch policy", - "description": "Details of a deployment branch or tag policy.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the branch or tag policy.", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name pattern that branches or tags must match in order to deploy to the environment.", - "type": "string" - }, - "type": { - "description": "Whether this rule targets a branch or tag.", - "type": "string", - "enum": [ - "branch", - "tag" - ] - } - } - } - }, - "request": { - "contentType": "application/json", - "description": "Example of a single branch name pattern", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "main", - "type": "branch" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME" - } - } - }, - { - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 364663, - "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=", - "name": "v1", - "type": "tag" - }, - "schema": { - "title": "Deployment branch policy", - "description": "Details of a deployment branch or tag policy.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the branch or tag policy.", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name pattern that branches or tags must match in order to deploy to the environment.", - "type": "string" - }, - "type": { - "description": "Whether this rule targets a branch or tag.", - "type": "string", - "enum": [ - "branch", - "tag" - ] - } - } - } - }, - "request": { - "contentType": "application/json", - "description": "Example of a single tag name pattern", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "v1", - "type": "tag" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME" - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "303", - "description": "

Response if the same branch name pattern already exists

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found or deployment_branch_policy.custom_branch_policies property for the environment is set to false

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - "title": "Get a deployment branch policy", - "category": "deployments", - "subcategory": "branch-policies", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, - { - "name": "branch_policy_id", - "in": "path", - "required": true, - "description": "

The unique identifier of the branch policy.

", - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a deployment branch or tag policy for an environment.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME", - "branch_policy_id": "BRANCH_POLICY_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 364662, - "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=", - "name": "release/*" - }, - "schema": { - "title": "Deployment branch policy", - "description": "Details of a deployment branch or tag policy.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the branch or tag policy.", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name pattern that branches or tags must match in order to deploy to the environment.", - "type": "string" - }, - "type": { - "description": "Whether this rule targets a branch or tag.", - "type": "string", - "enum": [ - "branch", - "tag" - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - "title": "Update a deployment branch policy", - "category": "deployments", - "subcategory": "branch-policies", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, - { - "name": "branch_policy_id", - "in": "path", - "required": true, - "description": "

The unique identifier of the branch policy.

", - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name pattern that branches must match in order to deploy to the environment.

\n

Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

", - "isRequired": true - } - ], - "descriptionHTML": "

Updates a deployment branch or tag policy for an environment.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "release/*" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME", - "branch_policy_id": "BRANCH_POLICY_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 364662, - "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=", - "name": "release/*" - }, - "schema": { - "title": "Deployment branch policy", - "description": "Details of a deployment branch or tag policy.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the branch or tag policy.", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name pattern that branches or tags must match in order to deploy to the environment.", - "type": "string" - }, - "type": { - "description": "Whether this rule targets a branch or tag.", - "type": "string", - "enum": [ - "branch", - "tag" - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - "title": "Delete a deployment branch policy", - "category": "deployments", - "subcategory": "branch-policies", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, - { - "name": "branch_policy_id", - "in": "path", - "required": true, - "description": "

The unique identifier of the branch policy.

", - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a deployment branch or tag policy for an environment.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME", - "branch_policy_id": "BRANCH_POLICY_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - } - ], - "environments": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments", - "title": "List environments", - "category": "deployments", - "subcategory": "environments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the environments for a repository.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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=", - "prevent_self_review": false, - "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", - "parent": null - } - } - ] - }, - { - "id": 3756, - "node_id": "MDQ6R2F0ZTM3NTY=", - "type": "branch_policy" - } - ], - "deployment_branch_policy": { - "protected_branches": false, - "custom_branch_policies": "trues" - } - } - ] - }, - "schema": { - "type": "object", - "properties": { - "total_count": { - "description": "The number of environments in this repository", - "type": "integer" - }, - "environments": { - "type": "array", - "items": { - "title": "Environment", - "description": "Details of a deployment environment", - "type": "object", - "properties": { - "id": { - "description": "The id of the environment.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the environment.", - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "created_at": { - "description": "The time that the environment was created, in ISO 8601 format.", - "format": "date-time", - "type": "string" - }, - "updated_at": { - "description": "The time that the environment was last updated, in ISO 8601 format.", - "format": "date-time", - "type": "string" - }, - "protection_rules": { - "type": "array", - "description": "Built-in deployment protection rules for the environment.", - "items": { - "anyOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "wait_timer": { - "type": "integer", - "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" - }, - "node_id": { - "type": "string" - }, - "prevent_self_review": { - "type": "boolean", - "description": "Whether deployments to this environment can be approved by the user who created the deployment." - }, - "type": { - "type": "string" - }, - "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.", - "enum": [ - "User", - "Team" - ] - }, - "reviewer": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - ] - } - } - } - } - }, - "required": [ - "id", - "node_id", - "type" - ] - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "type" - ] - } - ] - } - }, - "deployment_branch_policy": { - "type": [ - "object", - "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": "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`." - } - }, - "required": [ - "protected_branches", - "custom_branch_policies" - ] - } - }, - "required": [ - "id", - "node_id", - "name", - "url", - "html_url", - "created_at", - "updated_at" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", - "title": "Get an environment", - "category": "deployments", - "subcategory": "environments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"

\n
\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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=", - "prevent_self_review": false, - "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", - "parent": null - } - } - ] - }, - { - "id": 3756, - "node_id": "MDQ6R2F0ZTM3NTY=", - "type": "branch_policy" - } - ], - "deployment_branch_policy": { - "protected_branches": false, - "custom_branch_policies": true - } - }, - "schema": { - "title": "Environment", - "description": "Details of a deployment environment", - "type": "object", - "properties": { - "id": { - "description": "The id of the environment.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the environment.", - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "created_at": { - "description": "The time that the environment was created, in ISO 8601 format.", - "format": "date-time", - "type": "string" - }, - "updated_at": { - "description": "The time that the environment was last updated, in ISO 8601 format.", - "format": "date-time", - "type": "string" - }, - "protection_rules": { - "type": "array", - "description": "Built-in deployment protection rules for the environment.", - "items": { - "anyOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "wait_timer": { - "type": "integer", - "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" - }, - "node_id": { - "type": "string" - }, - "prevent_self_review": { - "type": "boolean", - "description": "Whether deployments to this environment can be approved by the user who created the deployment." - }, - "type": { - "type": "string" - }, - "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.", - "enum": [ - "User", - "Team" - ] - }, - "reviewer": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - ] - } - } - } - } - }, - "required": [ - "id", - "node_id", - "type" - ] - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "type" - ] - } - ] - } - }, - "deployment_branch_policy": { - "type": [ - "object", - "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": "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`." - } - }, - "required": [ - "protected_branches", - "custom_branch_policies" - ] - } - }, - "required": [ - "id", - "node_id", - "name", - "url", - "html_url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", - "title": "Create or update an environment", - "category": "deployments", - "subcategory": "environments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "integer", - "name": "wait_timer", - "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).

" - }, - { - "type": "boolean", - "name": "prevent_self_review", - "description": "

Whether or not a user who created the job is prevented from approving their own job.

" - }, - { - "type": "array of objects or null", - "name": "reviewers", - "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.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of reviewer.

", - "enum": [ - "User", - "Team" - ] - }, - { - "type": "integer", - "name": "id", - "description": "

The id of the user or team who can review the deployment

" - } - ] - }, - { - "type": "object or null", - "name": "deployment_branch_policy", - "description": "

The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

", - "childParamsGroups": [ - { - "type": "boolean", - "name": "protected_branches", - "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.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "custom_branch_policies", - "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.

", - "isRequired": true - } - ] - } - ], - "descriptionHTML": "

Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"

\n

Note

\n

\nTo create or update name patterns that branches must match in order to deploy to this environment, see \"Deployment branch policies.\"

\n
\n

Note

\n

\nTo create or update secrets for an environment, see \"GitHub Actions secrets.\"

\n
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "wait_timer": 30, - "prevent_self_review": false, - "reviewers": [ - { - "type": "User", - "id": 1 - }, - { - "type": "Team", - "id": 1 - } - ], - "deployment_branch_policy": { - "protected_branches": false, - "custom_branch_policies": true - } - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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=", - "prevent_self_review": false, - "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", - "parent": null - } - } - ] - }, - { - "id": 3756, - "node_id": "MDQ6R2F0ZTM3NTY=", - "type": "branch_policy" - } - ], - "deployment_branch_policy": { - "protected_branches": false, - "custom_branch_policies": true - } - }, - "schema": { - "title": "Environment", - "description": "Details of a deployment environment", - "type": "object", - "properties": { - "id": { - "description": "The id of the environment.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the environment.", - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "created_at": { - "description": "The time that the environment was created, in ISO 8601 format.", - "format": "date-time", - "type": "string" - }, - "updated_at": { - "description": "The time that the environment was last updated, in ISO 8601 format.", - "format": "date-time", - "type": "string" - }, - "protection_rules": { - "type": "array", - "description": "Built-in deployment protection rules for the environment.", - "items": { - "anyOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "wait_timer": { - "type": "integer", - "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" - }, - "node_id": { - "type": "string" - }, - "prevent_self_review": { - "type": "boolean", - "description": "Whether deployments to this environment can be approved by the user who created the deployment." - }, - "type": { - "type": "string" - }, - "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.", - "enum": [ - "User", - "Team" - ] - }, - "reviewer": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - ] - } - } - } - } - }, - "required": [ - "id", - "node_id", - "type" - ] - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "type" - ] - } - ] - } - }, - "deployment_branch_policy": { - "type": [ - "object", - "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": "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`." - } - }, - "required": [ - "protected_branches", - "custom_branch_policies" - ] - } - }, - "required": [ - "id", - "node_id", - "name", - "url", - "html_url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "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

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", - "title": "Delete an environment", - "category": "deployments", - "subcategory": "environments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Default response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Default response

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - } - ], - "protection-rules": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules", - "title": "Get all deployment protection rules for an environment", - "category": "deployments", - "subcategory": "protection-rules", - "parameters": [ - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "environment_name": "ENVIRONMENT_NAME", - "repo": "REPO", - "owner": "OWNER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

List of deployment protection rules

", - "example": { - "total_count": 2, - "custom_deployment_protection_rules": [ - { - "id": 3, - "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv", - "enabled": true, - "app": { - "id": 1, - "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", - "slug": "a-custom-app", - "integration_url": "https://api.github.com/apps/a-custom-app" - } - }, - { - "id": 4, - "node_id": "MDE2OkRlcGxveW1lbnRTdHJ41128", - "enabled": true, - "app": { - "id": 1, - "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy", - "slug": "another-custom-app", - "integration_url": "https://api.github.com/apps/another-custom-app" - } - } - ] - }, - "schema": { - "type": "object", - "properties": { - "total_count": { - "description": "The number of enabled custom deployment protection rules for this environment", - "type": "integer" - }, - "custom_deployment_protection_rules": { - "type": "array", - "items": { - "title": "Deployment protection rule", - "description": "Deployment protection rule", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier for the deployment protection rule." - }, - "node_id": { - "type": "string", - "description": "The node ID for the deployment protection rule." - }, - "enabled": { - "type": "boolean", - "description": "Whether the deployment protection rule is enabled for the environment." - }, - "app": { - "title": "Custom deployment protection rule app", - "description": "A GitHub App that is providing a custom deployment protection rule.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the deployment protection rule integration." - }, - "slug": { - "type": "string", - "description": "The slugified name of the deployment protection rule integration." - }, - "integration_url": { - "type": "string", - "description": "The URL for the endpoint to get details about the app." - }, - "node_id": { - "type": "string", - "description": "The node ID for the deployment protection rule integration." - } - }, - "required": [ - "id", - "slug", - "integration_url", - "node_id" - ] - } - }, - "required": [ - "id", - "node_id", - "enabled", - "app" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

List of deployment protection rules

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules", - "title": "Create a custom deployment protection rule on an environment", - "category": "deployments", - "subcategory": "protection-rules", - "parameters": [ - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "integer", - "name": "integration_id", - "description": "

The ID of the custom app that will be enabled on the environment.

" - } - ], - "descriptionHTML": "

Enable a custom deployment protection rule for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint, as well as the guide to creating custom deployment protection rules.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "integration_id": 5 - }, - "parameters": { - "environment_name": "ENVIRONMENT_NAME", - "repo": "REPO", - "owner": "OWNER" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

The enabled custom deployment protection rule

", - "example": { - "id": 3, - "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv", - "enabled": true, - "app": { - "id": 1, - "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", - "slug": "a-custom-app", - "integration_url": "https://api.github.com/apps/a-custom-app" - } - }, - "schema": { - "title": "Deployment protection rule", - "description": "Deployment protection rule", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier for the deployment protection rule." - }, - "node_id": { - "type": "string", - "description": "The node ID for the deployment protection rule." - }, - "enabled": { - "type": "boolean", - "description": "Whether the deployment protection rule is enabled for the environment." - }, - "app": { - "title": "Custom deployment protection rule app", - "description": "A GitHub App that is providing a custom deployment protection rule.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the deployment protection rule integration." - }, - "slug": { - "type": "string", - "description": "The slugified name of the deployment protection rule integration." - }, - "integration_url": { - "type": "string", - "description": "The URL for the endpoint to get details about the app." - }, - "node_id": { - "type": "string", - "description": "The node ID for the deployment protection rule integration." - } - }, - "required": [ - "id", - "slug", - "integration_url", - "node_id" - ] - } - }, - "required": [ - "id", - "node_id", - "enabled", - "app" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

The enabled custom deployment protection rule

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps", - "title": "List custom deployment rule integrations available for an environment", - "category": "deployments", - "subcategory": "protection-rules", - "parameters": [ - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets all custom deployment protection rule integrations that are available for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see \"GET an app\".

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "environment_name": "ENVIRONMENT_NAME", - "repo": "REPO", - "owner": "OWNER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

A list of custom deployment rule integrations available for this environment.

", - "example": [ - { - "total_count": 2 - }, - { - "available_custom_deployment_protection_rule_integrations": [ - { - "id": 1, - "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", - "slug": "a-custom-app", - "integration_url": "https://api.github.com/apps/a-custom-app" - }, - { - "id": 2, - "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy", - "slug": "another-custom-app", - "integration_url": "https://api.github.com/apps/another-custom-app" - } - ] - } - ], - "schema": { - "type": "object", - "properties": { - "total_count": { - "description": "The total number of custom deployment protection rule integrations available for this environment.", - "type": "integer" - }, - "available_custom_deployment_protection_rule_integrations": { - "type": "array", - "items": { - "title": "Custom deployment protection rule app", - "description": "A GitHub App that is providing a custom deployment protection rule.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the deployment protection rule integration." - }, - "slug": { - "type": "string", - "description": "The slugified name of the deployment protection rule integration." - }, - "integration_url": { - "type": "string", - "description": "The URL for the endpoint to get details about the app." - }, - "node_id": { - "type": "string", - "description": "The node ID for the deployment protection rule integration." - } - }, - "required": [ - "id", - "slug", - "integration_url", - "node_id" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

A list of custom deployment rule integrations available for this environment.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}", - "title": "Get a custom deployment protection rule", - "category": "deployments", - "subcategory": "protection-rules", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, - { - "name": "protection_rule_id", - "description": "

The unique identifier of the protection rule.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see GET /apps/{app_slug}.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME", - "protection_rule_id": "PROTECTION_RULE_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 3, - "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv", - "enabled": true, - "app": { - "id": 1, - "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", - "slug": "a-custom-app", - "integration_url": "https://api.github.com/apps/a-custom-app" - } - }, - "schema": { - "title": "Deployment protection rule", - "description": "Deployment protection rule", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier for the deployment protection rule." - }, - "node_id": { - "type": "string", - "description": "The node ID for the deployment protection rule." - }, - "enabled": { - "type": "boolean", - "description": "Whether the deployment protection rule is enabled for the environment." - }, - "app": { - "title": "Custom deployment protection rule app", - "description": "A GitHub App that is providing a custom deployment protection rule.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the deployment protection rule integration." - }, - "slug": { - "type": "string", - "description": "The slugified name of the deployment protection rule integration." - }, - "integration_url": { - "type": "string", - "description": "The URL for the endpoint to get details about the app." - }, - "node_id": { - "type": "string", - "description": "The node ID for the deployment protection rule integration." - } - }, - "required": [ - "id", - "slug", - "integration_url", - "node_id" - ] - } - }, - "required": [ - "id", - "node_id", - "enabled", - "app" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Actions\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}", - "title": "Disable a custom protection rule for an environment", - "category": "deployments", - "subcategory": "protection-rules", - "parameters": [ - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

", - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "protection_rule_id", - "description": "

The unique identifier of the protection rule.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Disables a custom deployment protection rule for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "environment_name": "ENVIRONMENT_NAME", - "repo": "REPO", - "owner": "OWNER", - "protection_rule_id": "PROTECTION_RULE_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - } - ], - "statuses": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "title": "List deployment statuses", - "category": "deployments", - "subcategory": "statuses", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "deployment_id", - "description": "

deployment_id parameter

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Users with pull access can view deployment statuses for a deployment:

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "deployment_id": "DEPLOYMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", - "id": 1, - "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMx", - "state": "success", - "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 - }, - "description": "Deployment finished successfully.", - "environment": "production", - "target_url": "https://example.com/deployment/42/output", - "created_at": "2012-07-20T01:19:13Z", - "updated_at": "2012-07-20T01:19:13Z", - "deployment_url": "https://api.github.com/repos/octocat/example/deployments/42", - "repository_url": "https://api.github.com/repos/octocat/example", - "environment_url": "https://test-branch.lab.acme.com", - "log_url": "https://example.com/deployment/42/output" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Deployment Status", - "description": "The status of a deployment.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "state": { - "description": "The state of the status.", - "enum": [ - "error", - "failure", - "inactive", - "pending", - "success", - "queued", - "in_progress" - ], - "type": "string" - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "description": { - "description": "A short description of the status.", - "default": "", - "type": "string", - "maxLength": 140 - }, - "environment": { - "description": "The environment of the deployment that the status is for.", - "default": "", - "type": "string" - }, - "target_url": { - "description": "Closing down notice: the URL to associate with this status.", - "default": "", - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "deployment_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "environment_url": { - "description": "The URL for accessing your environment.", - "default": "", - "type": "string", - "format": "uri" - }, - "log_url": { - "description": "The URL to associate with this status.", - "default": "", - "type": "string", - "format": "uri" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "state", - "creator", - "description", - "deployment_url", - "target_url", - "repository_url", - "url", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Deployments\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "title": "Create a deployment status", - "category": "deployments", - "subcategory": "statuses", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "deployment_id", - "description": "

deployment_id parameter

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "state", - "description": "

The state of the status. When you set a transient deployment to inactive, the deployment will be shown as destroyed in GitHub.

", - "isRequired": true, - "enum": [ - "error", - "failure", - "inactive", - "in_progress", - "queued", - "pending", - "success" - ] - }, - { - "type": "string", - "name": "target_url", - "description": "

The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.

\n

Note

\n

\nIt's recommended to use the log_url parameter, which replaces target_url.

\n
", - "default": "" - }, - { - "type": "string", - "name": "log_url", - "description": "

The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: \"\"

", - "default": "" - }, - { - "type": "string", - "name": "description", - "description": "

A short description of the status. The maximum description length is 140 characters.

", - "default": "" - }, - { - "type": "string", - "name": "environment", - "description": "

Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used.

" - }, - { - "type": "string", - "name": "environment_url", - "description": "

Sets the URL for accessing your environment. Default: \"\"

", - "default": "" - }, - { - "type": "boolean", - "name": "auto_inactive", - "description": "

Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

" - } - ], - "descriptionHTML": "

Users with push access can create deployment statuses for a given deployment.

\n

OAuth app tokens and personal access tokens (classic) need the repo_deployment scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "environment": "production", - "state": "success", - "log_url": "https://example.com/deployment/42/output", - "description": "Deployment finished successfully." - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "deployment_id": "DEPLOYMENT_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", - "id": 1, - "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMx", - "state": "success", - "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 - }, - "description": "Deployment finished successfully.", - "environment": "production", - "target_url": "https://example.com/deployment/42/output", - "created_at": "2012-07-20T01:19:13Z", - "updated_at": "2012-07-20T01:19:13Z", - "deployment_url": "https://api.github.com/repos/octocat/example/deployments/42", - "repository_url": "https://api.github.com/repos/octocat/example", - "environment_url": "https://test-branch.lab.acme.com", - "log_url": "https://example.com/deployment/42/output" - }, - "schema": { - "title": "Deployment Status", - "description": "The status of a deployment.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "state": { - "description": "The state of the status.", - "enum": [ - "error", - "failure", - "inactive", - "pending", - "success", - "queued", - "in_progress" - ], - "type": "string" - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "description": { - "description": "A short description of the status.", - "default": "", - "type": "string", - "maxLength": 140 - }, - "environment": { - "description": "The environment of the deployment that the status is for.", - "default": "", - "type": "string" - }, - "target_url": { - "description": "Closing down notice: the URL to associate with this status.", - "default": "", - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "deployment_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "environment_url": { - "description": "The URL for accessing your environment.", - "default": "", - "type": "string", - "format": "uri" - }, - "log_url": { - "description": "The URL to associate with this status.", - "default": "", - "type": "string", - "format": "uri" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "state", - "creator", - "description", - "deployment_url", - "target_url", - "repository_url", - "url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Deployments\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", - "title": "Get a deployment status", - "category": "deployments", - "subcategory": "statuses", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "deployment_id", - "description": "

deployment_id parameter

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "status_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Users with pull access can view a deployment status for a deployment:

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "deployment_id": "DEPLOYMENT_ID", - "status_id": "STATUS_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", - "id": 1, - "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMx", - "state": "success", - "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 - }, - "description": "Deployment finished successfully.", - "environment": "production", - "target_url": "https://example.com/deployment/42/output", - "created_at": "2012-07-20T01:19:13Z", - "updated_at": "2012-07-20T01:19:13Z", - "deployment_url": "https://api.github.com/repos/octocat/example/deployments/42", - "repository_url": "https://api.github.com/repos/octocat/example", - "environment_url": "https://test-branch.lab.acme.com", - "log_url": "https://example.com/deployment/42/output" - }, - "schema": { - "title": "Deployment Status", - "description": "The status of a deployment.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "state": { - "description": "The state of the status.", - "enum": [ - "error", - "failure", - "inactive", - "pending", - "success", - "queued", - "in_progress" - ], - "type": "string" - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "description": { - "description": "A short description of the status.", - "default": "", - "type": "string", - "maxLength": 140 - }, - "environment": { - "description": "The environment of the deployment that the status is for.", - "default": "", - "type": "string" - }, - "target_url": { - "description": "Closing down notice: the URL to associate with this status.", - "default": "", - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "deployment_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "environment_url": { - "description": "The URL for accessing your environment.", - "default": "", - "type": "string", - "format": "uri" - }, - "log_url": { - "description": "The URL to associate with this status.", - "default": "", - "type": "string", - "format": "uri" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "state", - "creator", - "description", - "deployment_url", - "target_url", - "repository_url", - "url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Deployments\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/emojis.json b/src/rest/data/ghes-3.14-2022-11-28/emojis.json deleted file mode 100644 index ebd365fae43c..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/emojis.json +++ /dev/null @@ -1,1931 +0,0 @@ -{ - "emojis": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/emojis", - "title": "Get emojis", - "category": "emojis", - "subcategory": "emojis", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Lists all the emojis available to use on GitHub Enterprise Server.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "100": "https://github.githubassets.com/images/icons/emoji/unicode/1f4af.png?v8", - "1234": "https://github.githubassets.com/images/icons/emoji/unicode/1f522.png?v8", - "+1": "https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8", - "-1": "https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8", - "1st_place_medal": "https://github.githubassets.com/images/icons/emoji/unicode/1f947.png?v8", - "2nd_place_medal": "https://github.githubassets.com/images/icons/emoji/unicode/1f948.png?v8", - "3rd_place_medal": "https://github.githubassets.com/images/icons/emoji/unicode/1f949.png?v8", - "8ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b1.png?v8", - "a": "https://github.githubassets.com/images/icons/emoji/unicode/1f170.png?v8", - "ab": "https://github.githubassets.com/images/icons/emoji/unicode/1f18e.png?v8", - "abacus": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ee.png?v8", - "abc": "https://github.githubassets.com/images/icons/emoji/unicode/1f524.png?v8", - "abcd": "https://github.githubassets.com/images/icons/emoji/unicode/1f521.png?v8", - "accept": "https://github.githubassets.com/images/icons/emoji/unicode/1f251.png?v8", - "accessibility": "https://github.githubassets.com/images/icons/emoji/accessibility.png?v8", - "accordion": "https://github.githubassets.com/images/icons/emoji/unicode/1fa97.png?v8", - "adhesive_bandage": "https://github.githubassets.com/images/icons/emoji/unicode/1fa79.png?v8", - "adult": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1.png?v8", - "aerial_tramway": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a1.png?v8", - "afghanistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1eb.png?v8", - "airplane": "https://github.githubassets.com/images/icons/emoji/unicode/2708.png?v8", - "aland_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fd.png?v8", - "alarm_clock": "https://github.githubassets.com/images/icons/emoji/unicode/23f0.png?v8", - "albania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f1.png?v8", - "alembic": "https://github.githubassets.com/images/icons/emoji/unicode/2697.png?v8", - "algeria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ff.png?v8", - "alien": "https://github.githubassets.com/images/icons/emoji/unicode/1f47d.png?v8", - "ambulance": "https://github.githubassets.com/images/icons/emoji/unicode/1f691.png?v8", - "american_samoa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f8.png?v8", - "amphora": "https://github.githubassets.com/images/icons/emoji/unicode/1f3fa.png?v8", - "anatomical_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1fac0.png?v8", - "anchor": "https://github.githubassets.com/images/icons/emoji/unicode/2693.png?v8", - "andorra": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e9.png?v8", - "angel": "https://github.githubassets.com/images/icons/emoji/unicode/1f47c.png?v8", - "anger": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a2.png?v8", - "angola": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f4.png?v8", - "angry": "https://github.githubassets.com/images/icons/emoji/unicode/1f620.png?v8", - "anguilla": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ee.png?v8", - "anguished": "https://github.githubassets.com/images/icons/emoji/unicode/1f627.png?v8", - "ant": "https://github.githubassets.com/images/icons/emoji/unicode/1f41c.png?v8", - "antarctica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f6.png?v8", - "antigua_barbuda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ec.png?v8", - "apple": "https://github.githubassets.com/images/icons/emoji/unicode/1f34e.png?v8", - "aquarius": "https://github.githubassets.com/images/icons/emoji/unicode/2652.png?v8", - "argentina": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f7.png?v8", - "aries": "https://github.githubassets.com/images/icons/emoji/unicode/2648.png?v8", - "armenia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f2.png?v8", - "arrow_backward": "https://github.githubassets.com/images/icons/emoji/unicode/25c0.png?v8", - "arrow_double_down": "https://github.githubassets.com/images/icons/emoji/unicode/23ec.png?v8", - "arrow_double_up": "https://github.githubassets.com/images/icons/emoji/unicode/23eb.png?v8", - "arrow_down": "https://github.githubassets.com/images/icons/emoji/unicode/2b07.png?v8", - "arrow_down_small": "https://github.githubassets.com/images/icons/emoji/unicode/1f53d.png?v8", - "arrow_forward": "https://github.githubassets.com/images/icons/emoji/unicode/25b6.png?v8", - "arrow_heading_down": "https://github.githubassets.com/images/icons/emoji/unicode/2935.png?v8", - "arrow_heading_up": "https://github.githubassets.com/images/icons/emoji/unicode/2934.png?v8", - "arrow_left": "https://github.githubassets.com/images/icons/emoji/unicode/2b05.png?v8", - "arrow_lower_left": "https://github.githubassets.com/images/icons/emoji/unicode/2199.png?v8", - "arrow_lower_right": "https://github.githubassets.com/images/icons/emoji/unicode/2198.png?v8", - "arrow_right": "https://github.githubassets.com/images/icons/emoji/unicode/27a1.png?v8", - "arrow_right_hook": "https://github.githubassets.com/images/icons/emoji/unicode/21aa.png?v8", - "arrow_up": "https://github.githubassets.com/images/icons/emoji/unicode/2b06.png?v8", - "arrow_up_down": "https://github.githubassets.com/images/icons/emoji/unicode/2195.png?v8", - "arrow_up_small": "https://github.githubassets.com/images/icons/emoji/unicode/1f53c.png?v8", - "arrow_upper_left": "https://github.githubassets.com/images/icons/emoji/unicode/2196.png?v8", - "arrow_upper_right": "https://github.githubassets.com/images/icons/emoji/unicode/2197.png?v8", - "arrows_clockwise": "https://github.githubassets.com/images/icons/emoji/unicode/1f503.png?v8", - "arrows_counterclockwise": "https://github.githubassets.com/images/icons/emoji/unicode/1f504.png?v8", - "art": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a8.png?v8", - "articulated_lorry": "https://github.githubassets.com/images/icons/emoji/unicode/1f69b.png?v8", - "artificial_satellite": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f0.png?v8", - "artist": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a8.png?v8", - "aruba": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fc.png?v8", - "ascension_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e8.png?v8", - "asterisk": "https://github.githubassets.com/images/icons/emoji/unicode/002a-20e3.png?v8", - "astonished": "https://github.githubassets.com/images/icons/emoji/unicode/1f632.png?v8", - "astronaut": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f680.png?v8", - "athletic_shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f45f.png?v8", - "atm": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e7.png?v8", - "atom": "https://github.githubassets.com/images/icons/emoji/atom.png?v8", - "atom_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/269b.png?v8", - "australia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fa.png?v8", - "austria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f9.png?v8", - "auto_rickshaw": "https://github.githubassets.com/images/icons/emoji/unicode/1f6fa.png?v8", - "avocado": "https://github.githubassets.com/images/icons/emoji/unicode/1f951.png?v8", - "axe": "https://github.githubassets.com/images/icons/emoji/unicode/1fa93.png?v8", - "azerbaijan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ff.png?v8", - "b": "https://github.githubassets.com/images/icons/emoji/unicode/1f171.png?v8", - "baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f476.png?v8", - "baby_bottle": "https://github.githubassets.com/images/icons/emoji/unicode/1f37c.png?v8", - "baby_chick": "https://github.githubassets.com/images/icons/emoji/unicode/1f424.png?v8", - "baby_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bc.png?v8", - "back": "https://github.githubassets.com/images/icons/emoji/unicode/1f519.png?v8", - "bacon": "https://github.githubassets.com/images/icons/emoji/unicode/1f953.png?v8", - "badger": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a1.png?v8", - "badminton": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f8.png?v8", - "bagel": "https://github.githubassets.com/images/icons/emoji/unicode/1f96f.png?v8", - "baggage_claim": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c4.png?v8", - "baguette_bread": "https://github.githubassets.com/images/icons/emoji/unicode/1f956.png?v8", - "bahamas": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f8.png?v8", - "bahrain": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ed.png?v8", - "balance_scale": "https://github.githubassets.com/images/icons/emoji/unicode/2696.png?v8", - "bald_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b2.png?v8", - "bald_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b2.png?v8", - "ballet_shoes": "https://github.githubassets.com/images/icons/emoji/unicode/1fa70.png?v8", - "balloon": "https://github.githubassets.com/images/icons/emoji/unicode/1f388.png?v8", - "ballot_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f5f3.png?v8", - "ballot_box_with_check": "https://github.githubassets.com/images/icons/emoji/unicode/2611.png?v8", - "bamboo": "https://github.githubassets.com/images/icons/emoji/unicode/1f38d.png?v8", - "banana": "https://github.githubassets.com/images/icons/emoji/unicode/1f34c.png?v8", - "bangbang": "https://github.githubassets.com/images/icons/emoji/unicode/203c.png?v8", - "bangladesh": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e9.png?v8", - "banjo": "https://github.githubassets.com/images/icons/emoji/unicode/1fa95.png?v8", - "bank": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e6.png?v8", - "bar_chart": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ca.png?v8", - "barbados": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e7.png?v8", - "barber": "https://github.githubassets.com/images/icons/emoji/unicode/1f488.png?v8", - "baseball": "https://github.githubassets.com/images/icons/emoji/unicode/26be.png?v8", - "basecamp": "https://github.githubassets.com/images/icons/emoji/basecamp.png?v8", - "basecampy": "https://github.githubassets.com/images/icons/emoji/basecampy.png?v8", - "basket": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fa.png?v8", - "basketball": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c0.png?v8", - "basketball_man": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8", - "basketball_woman": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8", - "bat": "https://github.githubassets.com/images/icons/emoji/unicode/1f987.png?v8", - "bath": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c0.png?v8", - "bathtub": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c1.png?v8", - "battery": "https://github.githubassets.com/images/icons/emoji/unicode/1f50b.png?v8", - "beach_umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d6.png?v8", - "bear": "https://github.githubassets.com/images/icons/emoji/unicode/1f43b.png?v8", - "bearded_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d4.png?v8", - "beaver": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ab.png?v8", - "bed": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cf.png?v8", - "bee": "https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8", - "beer": "https://github.githubassets.com/images/icons/emoji/unicode/1f37a.png?v8", - "beers": "https://github.githubassets.com/images/icons/emoji/unicode/1f37b.png?v8", - "beetle": "https://github.githubassets.com/images/icons/emoji/unicode/1fab2.png?v8", - "beginner": "https://github.githubassets.com/images/icons/emoji/unicode/1f530.png?v8", - "belarus": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fe.png?v8", - "belgium": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ea.png?v8", - "belize": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ff.png?v8", - "bell": "https://github.githubassets.com/images/icons/emoji/unicode/1f514.png?v8", - "bell_pepper": "https://github.githubassets.com/images/icons/emoji/unicode/1fad1.png?v8", - "bellhop_bell": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ce.png?v8", - "benin": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ef.png?v8", - "bento": "https://github.githubassets.com/images/icons/emoji/unicode/1f371.png?v8", - "bermuda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f2.png?v8", - "beverage_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c3.png?v8", - "bhutan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f9.png?v8", - "bicyclist": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b4.png?v8", - "bike": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b2.png?v8", - "biking_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2642.png?v8", - "biking_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2640.png?v8", - "bikini": "https://github.githubassets.com/images/icons/emoji/unicode/1f459.png?v8", - "billed_cap": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e2.png?v8", - "biohazard": "https://github.githubassets.com/images/icons/emoji/unicode/2623.png?v8", - "bird": "https://github.githubassets.com/images/icons/emoji/unicode/1f426.png?v8", - "birthday": "https://github.githubassets.com/images/icons/emoji/unicode/1f382.png?v8", - "bison": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ac.png?v8", - "black_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f408-2b1b.png?v8", - "black_circle": "https://github.githubassets.com/images/icons/emoji/unicode/26ab.png?v8", - "black_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4.png?v8", - "black_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f5a4.png?v8", - "black_joker": "https://github.githubassets.com/images/icons/emoji/unicode/1f0cf.png?v8", - "black_large_square": "https://github.githubassets.com/images/icons/emoji/unicode/2b1b.png?v8", - "black_medium_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fe.png?v8", - "black_medium_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fc.png?v8", - "black_nib": "https://github.githubassets.com/images/icons/emoji/unicode/2712.png?v8", - "black_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25aa.png?v8", - "black_square_button": "https://github.githubassets.com/images/icons/emoji/unicode/1f532.png?v8", - "blond_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f471-2642.png?v8", - "blond_haired_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f471.png?v8", - "blond_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8", - "blonde_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8", - "blossom": "https://github.githubassets.com/images/icons/emoji/unicode/1f33c.png?v8", - "blowfish": "https://github.githubassets.com/images/icons/emoji/unicode/1f421.png?v8", - "blue_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d8.png?v8", - "blue_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f699.png?v8", - "blue_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f499.png?v8", - "blue_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e6.png?v8", - "blueberries": "https://github.githubassets.com/images/icons/emoji/unicode/1fad0.png?v8", - "blush": "https://github.githubassets.com/images/icons/emoji/unicode/1f60a.png?v8", - "boar": "https://github.githubassets.com/images/icons/emoji/unicode/1f417.png?v8", - "boat": "https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8", - "bolivia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f4.png?v8", - "bomb": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a3.png?v8", - "bone": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b4.png?v8", - "book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8", - "bookmark": "https://github.githubassets.com/images/icons/emoji/unicode/1f516.png?v8", - "bookmark_tabs": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d1.png?v8", - "books": "https://github.githubassets.com/images/icons/emoji/unicode/1f4da.png?v8", - "boom": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8", - "boomerang": "https://github.githubassets.com/images/icons/emoji/unicode/1fa83.png?v8", - "boot": "https://github.githubassets.com/images/icons/emoji/unicode/1f462.png?v8", - "bosnia_herzegovina": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e6.png?v8", - "botswana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fc.png?v8", - "bouncing_ball_man": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8", - "bouncing_ball_person": "https://github.githubassets.com/images/icons/emoji/unicode/26f9.png?v8", - "bouncing_ball_woman": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8", - "bouquet": "https://github.githubassets.com/images/icons/emoji/unicode/1f490.png?v8", - "bouvet_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fb.png?v8", - "bow": "https://github.githubassets.com/images/icons/emoji/unicode/1f647.png?v8", - "bow_and_arrow": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f9.png?v8", - "bowing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f647-2642.png?v8", - "bowing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f647-2640.png?v8", - "bowl_with_spoon": "https://github.githubassets.com/images/icons/emoji/unicode/1f963.png?v8", - "bowling": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b3.png?v8", - "bowtie": "https://github.githubassets.com/images/icons/emoji/bowtie.png?v8", - "boxing_glove": "https://github.githubassets.com/images/icons/emoji/unicode/1f94a.png?v8", - "boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f466.png?v8", - "brain": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e0.png?v8", - "brazil": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f7.png?v8", - "bread": "https://github.githubassets.com/images/icons/emoji/unicode/1f35e.png?v8", - "breast_feeding": "https://github.githubassets.com/images/icons/emoji/unicode/1f931.png?v8", - "bricks": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f1.png?v8", - "bride_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8", - "bridge_at_night": "https://github.githubassets.com/images/icons/emoji/unicode/1f309.png?v8", - "briefcase": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bc.png?v8", - "british_indian_ocean_territory": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f4.png?v8", - "british_virgin_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ec.png?v8", - "broccoli": "https://github.githubassets.com/images/icons/emoji/unicode/1f966.png?v8", - "broken_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f494.png?v8", - "broom": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f9.png?v8", - "brown_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e4.png?v8", - "brown_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f90e.png?v8", - "brown_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7eb.png?v8", - "brunei": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f3.png?v8", - "bubble_tea": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cb.png?v8", - "bucket": "https://github.githubassets.com/images/icons/emoji/unicode/1faa3.png?v8", - "bug": "https://github.githubassets.com/images/icons/emoji/unicode/1f41b.png?v8", - "building_construction": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d7.png?v8", - "bulb": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a1.png?v8", - "bulgaria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ec.png?v8", - "bullettrain_front": "https://github.githubassets.com/images/icons/emoji/unicode/1f685.png?v8", - "bullettrain_side": "https://github.githubassets.com/images/icons/emoji/unicode/1f684.png?v8", - "burkina_faso": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1eb.png?v8", - "burrito": "https://github.githubassets.com/images/icons/emoji/unicode/1f32f.png?v8", - "burundi": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ee.png?v8", - "bus": "https://github.githubassets.com/images/icons/emoji/unicode/1f68c.png?v8", - "business_suit_levitating": "https://github.githubassets.com/images/icons/emoji/unicode/1f574.png?v8", - "busstop": "https://github.githubassets.com/images/icons/emoji/unicode/1f68f.png?v8", - "bust_in_silhouette": "https://github.githubassets.com/images/icons/emoji/unicode/1f464.png?v8", - "busts_in_silhouette": "https://github.githubassets.com/images/icons/emoji/unicode/1f465.png?v8", - "butter": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c8.png?v8", - "butterfly": "https://github.githubassets.com/images/icons/emoji/unicode/1f98b.png?v8", - "cactus": "https://github.githubassets.com/images/icons/emoji/unicode/1f335.png?v8", - "cake": "https://github.githubassets.com/images/icons/emoji/unicode/1f370.png?v8", - "calendar": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c6.png?v8", - "call_me_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f919.png?v8", - "calling": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f2.png?v8", - "cambodia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ed.png?v8", - "camel": "https://github.githubassets.com/images/icons/emoji/unicode/1f42b.png?v8", - "camera": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f7.png?v8", - "camera_flash": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f8.png?v8", - "cameroon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f2.png?v8", - "camping": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d5.png?v8", - "canada": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e6.png?v8", - "canary_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e8.png?v8", - "cancer": "https://github.githubassets.com/images/icons/emoji/unicode/264b.png?v8", - "candle": "https://github.githubassets.com/images/icons/emoji/unicode/1f56f.png?v8", - "candy": "https://github.githubassets.com/images/icons/emoji/unicode/1f36c.png?v8", - "canned_food": "https://github.githubassets.com/images/icons/emoji/unicode/1f96b.png?v8", - "canoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f6.png?v8", - "cape_verde": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fb.png?v8", - "capital_abcd": "https://github.githubassets.com/images/icons/emoji/unicode/1f520.png?v8", - "capricorn": "https://github.githubassets.com/images/icons/emoji/unicode/2651.png?v8", - "car": "https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8", - "card_file_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f5c3.png?v8", - "card_index": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c7.png?v8", - "card_index_dividers": "https://github.githubassets.com/images/icons/emoji/unicode/1f5c2.png?v8", - "caribbean_netherlands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f6.png?v8", - "carousel_horse": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a0.png?v8", - "carpentry_saw": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9a.png?v8", - "carrot": "https://github.githubassets.com/images/icons/emoji/unicode/1f955.png?v8", - "cartwheeling": "https://github.githubassets.com/images/icons/emoji/unicode/1f938.png?v8", - "cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f431.png?v8", - "cat2": "https://github.githubassets.com/images/icons/emoji/unicode/1f408.png?v8", - "cayman_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fe.png?v8", - "cd": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bf.png?v8", - "central_african_republic": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1eb.png?v8", - "ceuta_melilla": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e6.png?v8", - "chad": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e9.png?v8", - "chains": "https://github.githubassets.com/images/icons/emoji/unicode/26d3.png?v8", - "chair": "https://github.githubassets.com/images/icons/emoji/unicode/1fa91.png?v8", - "champagne": "https://github.githubassets.com/images/icons/emoji/unicode/1f37e.png?v8", - "chart": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b9.png?v8", - "chart_with_downwards_trend": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c9.png?v8", - "chart_with_upwards_trend": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c8.png?v8", - "checkered_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c1.png?v8", - "cheese": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c0.png?v8", - "cherries": "https://github.githubassets.com/images/icons/emoji/unicode/1f352.png?v8", - "cherry_blossom": "https://github.githubassets.com/images/icons/emoji/unicode/1f338.png?v8", - "chess_pawn": "https://github.githubassets.com/images/icons/emoji/unicode/265f.png?v8", - "chestnut": "https://github.githubassets.com/images/icons/emoji/unicode/1f330.png?v8", - "chicken": "https://github.githubassets.com/images/icons/emoji/unicode/1f414.png?v8", - "child": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d2.png?v8", - "children_crossing": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b8.png?v8", - "chile": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f1.png?v8", - "chipmunk": "https://github.githubassets.com/images/icons/emoji/unicode/1f43f.png?v8", - "chocolate_bar": "https://github.githubassets.com/images/icons/emoji/unicode/1f36b.png?v8", - "chopsticks": "https://github.githubassets.com/images/icons/emoji/unicode/1f962.png?v8", - "christmas_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fd.png?v8", - "christmas_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f384.png?v8", - "church": "https://github.githubassets.com/images/icons/emoji/unicode/26ea.png?v8", - "cinema": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a6.png?v8", - "circus_tent": "https://github.githubassets.com/images/icons/emoji/unicode/1f3aa.png?v8", - "city_sunrise": "https://github.githubassets.com/images/icons/emoji/unicode/1f307.png?v8", - "city_sunset": "https://github.githubassets.com/images/icons/emoji/unicode/1f306.png?v8", - "cityscape": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d9.png?v8", - "cl": "https://github.githubassets.com/images/icons/emoji/unicode/1f191.png?v8", - "clamp": "https://github.githubassets.com/images/icons/emoji/unicode/1f5dc.png?v8", - "clap": "https://github.githubassets.com/images/icons/emoji/unicode/1f44f.png?v8", - "clapper": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ac.png?v8", - "classical_building": "https://github.githubassets.com/images/icons/emoji/unicode/1f3db.png?v8", - "climbing": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d7.png?v8", - "climbing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2642.png?v8", - "climbing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2640.png?v8", - "clinking_glasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f942.png?v8", - "clipboard": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cb.png?v8", - "clipperton_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f5.png?v8", - "clock1": "https://github.githubassets.com/images/icons/emoji/unicode/1f550.png?v8", - "clock10": "https://github.githubassets.com/images/icons/emoji/unicode/1f559.png?v8", - "clock1030": "https://github.githubassets.com/images/icons/emoji/unicode/1f565.png?v8", - "clock11": "https://github.githubassets.com/images/icons/emoji/unicode/1f55a.png?v8", - "clock1130": "https://github.githubassets.com/images/icons/emoji/unicode/1f566.png?v8", - "clock12": "https://github.githubassets.com/images/icons/emoji/unicode/1f55b.png?v8", - "clock1230": "https://github.githubassets.com/images/icons/emoji/unicode/1f567.png?v8", - "clock130": "https://github.githubassets.com/images/icons/emoji/unicode/1f55c.png?v8", - "clock2": "https://github.githubassets.com/images/icons/emoji/unicode/1f551.png?v8", - "clock230": "https://github.githubassets.com/images/icons/emoji/unicode/1f55d.png?v8", - "clock3": "https://github.githubassets.com/images/icons/emoji/unicode/1f552.png?v8", - "clock330": "https://github.githubassets.com/images/icons/emoji/unicode/1f55e.png?v8", - "clock4": "https://github.githubassets.com/images/icons/emoji/unicode/1f553.png?v8", - "clock430": "https://github.githubassets.com/images/icons/emoji/unicode/1f55f.png?v8", - "clock5": "https://github.githubassets.com/images/icons/emoji/unicode/1f554.png?v8", - "clock530": "https://github.githubassets.com/images/icons/emoji/unicode/1f560.png?v8", - "clock6": "https://github.githubassets.com/images/icons/emoji/unicode/1f555.png?v8", - "clock630": "https://github.githubassets.com/images/icons/emoji/unicode/1f561.png?v8", - "clock7": "https://github.githubassets.com/images/icons/emoji/unicode/1f556.png?v8", - "clock730": "https://github.githubassets.com/images/icons/emoji/unicode/1f562.png?v8", - "clock8": "https://github.githubassets.com/images/icons/emoji/unicode/1f557.png?v8", - "clock830": "https://github.githubassets.com/images/icons/emoji/unicode/1f563.png?v8", - "clock9": "https://github.githubassets.com/images/icons/emoji/unicode/1f558.png?v8", - "clock930": "https://github.githubassets.com/images/icons/emoji/unicode/1f564.png?v8", - "closed_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d5.png?v8", - "closed_lock_with_key": "https://github.githubassets.com/images/icons/emoji/unicode/1f510.png?v8", - "closed_umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/1f302.png?v8", - "cloud": "https://github.githubassets.com/images/icons/emoji/unicode/2601.png?v8", - "cloud_with_lightning": "https://github.githubassets.com/images/icons/emoji/unicode/1f329.png?v8", - "cloud_with_lightning_and_rain": "https://github.githubassets.com/images/icons/emoji/unicode/26c8.png?v8", - "cloud_with_rain": "https://github.githubassets.com/images/icons/emoji/unicode/1f327.png?v8", - "cloud_with_snow": "https://github.githubassets.com/images/icons/emoji/unicode/1f328.png?v8", - "clown_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f921.png?v8", - "clubs": "https://github.githubassets.com/images/icons/emoji/unicode/2663.png?v8", - "cn": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f3.png?v8", - "coat": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e5.png?v8", - "cockroach": "https://github.githubassets.com/images/icons/emoji/unicode/1fab3.png?v8", - "cocktail": "https://github.githubassets.com/images/icons/emoji/unicode/1f378.png?v8", - "coconut": "https://github.githubassets.com/images/icons/emoji/unicode/1f965.png?v8", - "cocos_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e8.png?v8", - "coffee": "https://github.githubassets.com/images/icons/emoji/unicode/2615.png?v8", - "coffin": "https://github.githubassets.com/images/icons/emoji/unicode/26b0.png?v8", - "coin": "https://github.githubassets.com/images/icons/emoji/unicode/1fa99.png?v8", - "cold_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f976.png?v8", - "cold_sweat": "https://github.githubassets.com/images/icons/emoji/unicode/1f630.png?v8", - "collision": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8", - "colombia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f4.png?v8", - "comet": "https://github.githubassets.com/images/icons/emoji/unicode/2604.png?v8", - "comoros": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f2.png?v8", - "compass": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ed.png?v8", - "computer": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bb.png?v8", - "computer_mouse": "https://github.githubassets.com/images/icons/emoji/unicode/1f5b1.png?v8", - "confetti_ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f38a.png?v8", - "confounded": "https://github.githubassets.com/images/icons/emoji/unicode/1f616.png?v8", - "confused": "https://github.githubassets.com/images/icons/emoji/unicode/1f615.png?v8", - "congo_brazzaville": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ec.png?v8", - "congo_kinshasa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e9.png?v8", - "congratulations": "https://github.githubassets.com/images/icons/emoji/unicode/3297.png?v8", - "construction": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a7.png?v8", - "construction_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f477.png?v8", - "construction_worker_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f477-2642.png?v8", - "construction_worker_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f477-2640.png?v8", - "control_knobs": "https://github.githubassets.com/images/icons/emoji/unicode/1f39b.png?v8", - "convenience_store": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ea.png?v8", - "cook": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f373.png?v8", - "cook_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f0.png?v8", - "cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8", - "cool": "https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8", - "cop": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", - "copilot": "https://github.githubassets.com/images/icons/emoji/copilot.png?v8", - "copyright": "https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8", - "corn": "https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8", - "costa_rica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8", - "cote_divoire": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ee.png?v8", - "couch_and_lamp": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cb.png?v8", - "couple": "https://github.githubassets.com/images/icons/emoji/unicode/1f46b.png?v8", - "couple_with_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f491.png?v8", - "couple_with_heart_man_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f468.png?v8", - "couple_with_heart_woman_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f468.png?v8", - "couple_with_heart_woman_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f469.png?v8", - "couplekiss": "https://github.githubassets.com/images/icons/emoji/unicode/1f48f.png?v8", - "couplekiss_man_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f48b-1f468.png?v8", - "couplekiss_man_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f468.png?v8", - "couplekiss_woman_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f469.png?v8", - "cow": "https://github.githubassets.com/images/icons/emoji/unicode/1f42e.png?v8", - "cow2": "https://github.githubassets.com/images/icons/emoji/unicode/1f404.png?v8", - "cowboy_hat_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f920.png?v8", - "crab": "https://github.githubassets.com/images/icons/emoji/unicode/1f980.png?v8", - "crayon": "https://github.githubassets.com/images/icons/emoji/unicode/1f58d.png?v8", - "credit_card": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b3.png?v8", - "crescent_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f319.png?v8", - "cricket": "https://github.githubassets.com/images/icons/emoji/unicode/1f997.png?v8", - "cricket_game": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cf.png?v8", - "croatia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f7.png?v8", - "crocodile": "https://github.githubassets.com/images/icons/emoji/unicode/1f40a.png?v8", - "croissant": "https://github.githubassets.com/images/icons/emoji/unicode/1f950.png?v8", - "crossed_fingers": "https://github.githubassets.com/images/icons/emoji/unicode/1f91e.png?v8", - "crossed_flags": "https://github.githubassets.com/images/icons/emoji/unicode/1f38c.png?v8", - "crossed_swords": "https://github.githubassets.com/images/icons/emoji/unicode/2694.png?v8", - "crown": "https://github.githubassets.com/images/icons/emoji/unicode/1f451.png?v8", - "cry": "https://github.githubassets.com/images/icons/emoji/unicode/1f622.png?v8", - "crying_cat_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f63f.png?v8", - "crystal_ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f52e.png?v8", - "cuba": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fa.png?v8", - "cucumber": "https://github.githubassets.com/images/icons/emoji/unicode/1f952.png?v8", - "cup_with_straw": "https://github.githubassets.com/images/icons/emoji/unicode/1f964.png?v8", - "cupcake": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c1.png?v8", - "cupid": "https://github.githubassets.com/images/icons/emoji/unicode/1f498.png?v8", - "curacao": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fc.png?v8", - "curling_stone": "https://github.githubassets.com/images/icons/emoji/unicode/1f94c.png?v8", - "curly_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b1.png?v8", - "curly_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b1.png?v8", - "curly_loop": "https://github.githubassets.com/images/icons/emoji/unicode/27b0.png?v8", - "currency_exchange": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b1.png?v8", - "curry": "https://github.githubassets.com/images/icons/emoji/unicode/1f35b.png?v8", - "cursing_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92c.png?v8", - "custard": "https://github.githubassets.com/images/icons/emoji/unicode/1f36e.png?v8", - "customs": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c3.png?v8", - "cut_of_meat": "https://github.githubassets.com/images/icons/emoji/unicode/1f969.png?v8", - "cyclone": "https://github.githubassets.com/images/icons/emoji/unicode/1f300.png?v8", - "cyprus": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fe.png?v8", - "czech_republic": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ff.png?v8", - "dagger": "https://github.githubassets.com/images/icons/emoji/unicode/1f5e1.png?v8", - "dancer": "https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8", - "dancers": "https://github.githubassets.com/images/icons/emoji/unicode/1f46f.png?v8", - "dancing_men": "https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2642.png?v8", - "dancing_women": "https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2640.png?v8", - "dango": "https://github.githubassets.com/images/icons/emoji/unicode/1f361.png?v8", - "dark_sunglasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f576.png?v8", - "dart": "https://github.githubassets.com/images/icons/emoji/unicode/1f3af.png?v8", - "dash": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a8.png?v8", - "date": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c5.png?v8", - "de": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ea.png?v8", - "deaf_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2642.png?v8", - "deaf_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cf.png?v8", - "deaf_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2640.png?v8", - "deciduous_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f333.png?v8", - "deer": "https://github.githubassets.com/images/icons/emoji/unicode/1f98c.png?v8", - "denmark": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f0.png?v8", - "department_store": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ec.png?v8", - "dependabot": "https://github.githubassets.com/images/icons/emoji/dependabot.png?v8", - "derelict_house": "https://github.githubassets.com/images/icons/emoji/unicode/1f3da.png?v8", - "desert": "https://github.githubassets.com/images/icons/emoji/unicode/1f3dc.png?v8", - "desert_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f3dd.png?v8", - "desktop_computer": "https://github.githubassets.com/images/icons/emoji/unicode/1f5a5.png?v8", - "detective": "https://github.githubassets.com/images/icons/emoji/unicode/1f575.png?v8", - "diamond_shape_with_a_dot_inside": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a0.png?v8", - "diamonds": "https://github.githubassets.com/images/icons/emoji/unicode/2666.png?v8", - "diego_garcia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ec.png?v8", - "disappointed": "https://github.githubassets.com/images/icons/emoji/unicode/1f61e.png?v8", - "disappointed_relieved": "https://github.githubassets.com/images/icons/emoji/unicode/1f625.png?v8", - "disguised_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f978.png?v8", - "diving_mask": "https://github.githubassets.com/images/icons/emoji/unicode/1f93f.png?v8", - "diya_lamp": "https://github.githubassets.com/images/icons/emoji/unicode/1fa94.png?v8", - "dizzy": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ab.png?v8", - "dizzy_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f635.png?v8", - "djibouti": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ef.png?v8", - "dna": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ec.png?v8", - "do_not_litter": "https://github.githubassets.com/images/icons/emoji/unicode/1f6af.png?v8", - "dodo": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a4.png?v8", - "dog": "https://github.githubassets.com/images/icons/emoji/unicode/1f436.png?v8", - "dog2": "https://github.githubassets.com/images/icons/emoji/unicode/1f415.png?v8", - "dollar": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b5.png?v8", - "dolls": "https://github.githubassets.com/images/icons/emoji/unicode/1f38e.png?v8", - "dolphin": "https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8", - "dominica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f2.png?v8", - "dominican_republic": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f4.png?v8", - "door": "https://github.githubassets.com/images/icons/emoji/unicode/1f6aa.png?v8", - "doughnut": "https://github.githubassets.com/images/icons/emoji/unicode/1f369.png?v8", - "dove": "https://github.githubassets.com/images/icons/emoji/unicode/1f54a.png?v8", - "dragon": "https://github.githubassets.com/images/icons/emoji/unicode/1f409.png?v8", - "dragon_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f432.png?v8", - "dress": "https://github.githubassets.com/images/icons/emoji/unicode/1f457.png?v8", - "dromedary_camel": "https://github.githubassets.com/images/icons/emoji/unicode/1f42a.png?v8", - "drooling_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f924.png?v8", - "drop_of_blood": "https://github.githubassets.com/images/icons/emoji/unicode/1fa78.png?v8", - "droplet": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a7.png?v8", - "drum": "https://github.githubassets.com/images/icons/emoji/unicode/1f941.png?v8", - "duck": "https://github.githubassets.com/images/icons/emoji/unicode/1f986.png?v8", - "dumpling": "https://github.githubassets.com/images/icons/emoji/unicode/1f95f.png?v8", - "dvd": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c0.png?v8", - "e-mail": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8", - "eagle": "https://github.githubassets.com/images/icons/emoji/unicode/1f985.png?v8", - "ear": "https://github.githubassets.com/images/icons/emoji/unicode/1f442.png?v8", - "ear_of_rice": "https://github.githubassets.com/images/icons/emoji/unicode/1f33e.png?v8", - "ear_with_hearing_aid": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bb.png?v8", - "earth_africa": "https://github.githubassets.com/images/icons/emoji/unicode/1f30d.png?v8", - "earth_americas": "https://github.githubassets.com/images/icons/emoji/unicode/1f30e.png?v8", - "earth_asia": "https://github.githubassets.com/images/icons/emoji/unicode/1f30f.png?v8", - "ecuador": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e8.png?v8", - "egg": "https://github.githubassets.com/images/icons/emoji/unicode/1f95a.png?v8", - "eggplant": "https://github.githubassets.com/images/icons/emoji/unicode/1f346.png?v8", - "egypt": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ec.png?v8", - "eight": "https://github.githubassets.com/images/icons/emoji/unicode/0038-20e3.png?v8", - "eight_pointed_black_star": "https://github.githubassets.com/images/icons/emoji/unicode/2734.png?v8", - "eight_spoked_asterisk": "https://github.githubassets.com/images/icons/emoji/unicode/2733.png?v8", - "eject_button": "https://github.githubassets.com/images/icons/emoji/unicode/23cf.png?v8", - "el_salvador": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fb.png?v8", - "electric_plug": "https://github.githubassets.com/images/icons/emoji/unicode/1f50c.png?v8", - "electron": "https://github.githubassets.com/images/icons/emoji/electron.png?v8", - "elephant": "https://github.githubassets.com/images/icons/emoji/unicode/1f418.png?v8", - "elevator": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d7.png?v8", - "elf": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dd.png?v8", - "elf_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2642.png?v8", - "elf_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2640.png?v8", - "email": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8", - "end": "https://github.githubassets.com/images/icons/emoji/unicode/1f51a.png?v8", - "england": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0065-e006e-e0067-e007f.png?v8", - "envelope": "https://github.githubassets.com/images/icons/emoji/unicode/2709.png?v8", - "envelope_with_arrow": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e9.png?v8", - "equatorial_guinea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f6.png?v8", - "eritrea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f7.png?v8", - "es": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f8.png?v8", - "estonia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ea.png?v8", - "ethiopia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f9.png?v8", - "eu": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8", - "euro": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b6.png?v8", - "european_castle": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f0.png?v8", - "european_post_office": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e4.png?v8", - "european_union": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8", - "evergreen_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f332.png?v8", - "exclamation": "https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8", - "exploding_head": "https://github.githubassets.com/images/icons/emoji/unicode/1f92f.png?v8", - "expressionless": "https://github.githubassets.com/images/icons/emoji/unicode/1f611.png?v8", - "eye": "https://github.githubassets.com/images/icons/emoji/unicode/1f441.png?v8", - "eye_speech_bubble": "https://github.githubassets.com/images/icons/emoji/unicode/1f441-1f5e8.png?v8", - "eyeglasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f453.png?v8", - "eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f440.png?v8", - "face_exhaling": "https://github.githubassets.com/images/icons/emoji/unicode/1f62e-1f4a8.png?v8", - "face_in_clouds": "https://github.githubassets.com/images/icons/emoji/unicode/1f636-1f32b.png?v8", - "face_with_head_bandage": "https://github.githubassets.com/images/icons/emoji/unicode/1f915.png?v8", - "face_with_spiral_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f635-1f4ab.png?v8", - "face_with_thermometer": "https://github.githubassets.com/images/icons/emoji/unicode/1f912.png?v8", - "facepalm": "https://github.githubassets.com/images/icons/emoji/unicode/1f926.png?v8", - "facepunch": "https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8", - "factory": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ed.png?v8", - "factory_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3ed.png?v8", - "fairy": "https://github.githubassets.com/images/icons/emoji/unicode/1f9da.png?v8", - "fairy_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2642.png?v8", - "fairy_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2640.png?v8", - "falafel": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c6.png?v8", - "falkland_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f0.png?v8", - "fallen_leaf": "https://github.githubassets.com/images/icons/emoji/unicode/1f342.png?v8", - "family": "https://github.githubassets.com/images/icons/emoji/unicode/1f46a.png?v8", - "family_man_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466.png?v8", - "family_man_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466-1f466.png?v8", - "family_man_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467.png?v8", - "family_man_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f466.png?v8", - "family_man_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f467.png?v8", - "family_man_man_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466.png?v8", - "family_man_man_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466-1f466.png?v8", - "family_man_man_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467.png?v8", - "family_man_man_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f466.png?v8", - "family_man_man_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f467.png?v8", - "family_man_woman_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466.png?v8", - "family_man_woman_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466-1f466.png?v8", - "family_man_woman_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467.png?v8", - "family_man_woman_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f466.png?v8", - "family_man_woman_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f467.png?v8", - "family_woman_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466.png?v8", - "family_woman_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466-1f466.png?v8", - "family_woman_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467.png?v8", - "family_woman_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f466.png?v8", - "family_woman_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f467.png?v8", - "family_woman_woman_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466.png?v8", - "family_woman_woman_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466-1f466.png?v8", - "family_woman_woman_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467.png?v8", - "family_woman_woman_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f466.png?v8", - "family_woman_woman_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f467.png?v8", - "farmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f33e.png?v8", - "faroe_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f4.png?v8", - "fast_forward": "https://github.githubassets.com/images/icons/emoji/unicode/23e9.png?v8", - "fax": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e0.png?v8", - "fearful": "https://github.githubassets.com/images/icons/emoji/unicode/1f628.png?v8", - "feather": "https://github.githubassets.com/images/icons/emoji/unicode/1fab6.png?v8", - "feelsgood": "https://github.githubassets.com/images/icons/emoji/feelsgood.png?v8", - "feet": "https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8", - "female_detective": "https://github.githubassets.com/images/icons/emoji/unicode/1f575-2640.png?v8", - "female_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2640.png?v8", - "ferris_wheel": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a1.png?v8", - "ferry": "https://github.githubassets.com/images/icons/emoji/unicode/26f4.png?v8", - "field_hockey": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d1.png?v8", - "fiji": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ef.png?v8", - "file_cabinet": "https://github.githubassets.com/images/icons/emoji/unicode/1f5c4.png?v8", - "file_folder": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c1.png?v8", - "film_projector": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fd.png?v8", - "film_strip": "https://github.githubassets.com/images/icons/emoji/unicode/1f39e.png?v8", - "finland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ee.png?v8", - "finnadie": "https://github.githubassets.com/images/icons/emoji/finnadie.png?v8", - "fire": "https://github.githubassets.com/images/icons/emoji/unicode/1f525.png?v8", - "fire_engine": "https://github.githubassets.com/images/icons/emoji/unicode/1f692.png?v8", - "fire_extinguisher": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ef.png?v8", - "firecracker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e8.png?v8", - "firefighter": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f692.png?v8", - "fireworks": "https://github.githubassets.com/images/icons/emoji/unicode/1f386.png?v8", - "first_quarter_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f313.png?v8", - "first_quarter_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31b.png?v8", - "fish": "https://github.githubassets.com/images/icons/emoji/unicode/1f41f.png?v8", - "fish_cake": "https://github.githubassets.com/images/icons/emoji/unicode/1f365.png?v8", - "fishsticks": "https://github.githubassets.com/images/icons/emoji/fishsticks.png?v8", - "fishing_pole_and_fish": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a3.png?v8", - "fist": "https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8", - "fist_left": "https://github.githubassets.com/images/icons/emoji/unicode/1f91b.png?v8", - "fist_oncoming": "https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8", - "fist_raised": "https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8", - "fist_right": "https://github.githubassets.com/images/icons/emoji/unicode/1f91c.png?v8", - "five": "https://github.githubassets.com/images/icons/emoji/unicode/0035-20e3.png?v8", - "flags": "https://github.githubassets.com/images/icons/emoji/unicode/1f38f.png?v8", - "flamingo": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a9.png?v8", - "flashlight": "https://github.githubassets.com/images/icons/emoji/unicode/1f526.png?v8", - "flat_shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f97f.png?v8", - "flatbread": "https://github.githubassets.com/images/icons/emoji/unicode/1fad3.png?v8", - "fleur_de_lis": "https://github.githubassets.com/images/icons/emoji/unicode/269c.png?v8", - "flight_arrival": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ec.png?v8", - "flight_departure": "https://github.githubassets.com/images/icons/emoji/unicode/1f6eb.png?v8", - "flipper": "https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8", - "floppy_disk": "https://github.githubassets.com/images/icons/emoji/unicode/1f4be.png?v8", - "flower_playing_cards": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b4.png?v8", - "flushed": "https://github.githubassets.com/images/icons/emoji/unicode/1f633.png?v8", - "fly": "https://github.githubassets.com/images/icons/emoji/unicode/1fab0.png?v8", - "flying_disc": "https://github.githubassets.com/images/icons/emoji/unicode/1f94f.png?v8", - "flying_saucer": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f8.png?v8", - "fog": "https://github.githubassets.com/images/icons/emoji/unicode/1f32b.png?v8", - "foggy": "https://github.githubassets.com/images/icons/emoji/unicode/1f301.png?v8", - "fondue": "https://github.githubassets.com/images/icons/emoji/unicode/1fad5.png?v8", - "foot": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b6.png?v8", - "football": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c8.png?v8", - "footprints": "https://github.githubassets.com/images/icons/emoji/unicode/1f463.png?v8", - "fork_and_knife": "https://github.githubassets.com/images/icons/emoji/unicode/1f374.png?v8", - "fortune_cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f960.png?v8", - "fountain": "https://github.githubassets.com/images/icons/emoji/unicode/26f2.png?v8", - "fountain_pen": "https://github.githubassets.com/images/icons/emoji/unicode/1f58b.png?v8", - "four": "https://github.githubassets.com/images/icons/emoji/unicode/0034-20e3.png?v8", - "four_leaf_clover": "https://github.githubassets.com/images/icons/emoji/unicode/1f340.png?v8", - "fox_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f98a.png?v8", - "fr": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f7.png?v8", - "framed_picture": "https://github.githubassets.com/images/icons/emoji/unicode/1f5bc.png?v8", - "free": "https://github.githubassets.com/images/icons/emoji/unicode/1f193.png?v8", - "french_guiana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1eb.png?v8", - "french_polynesia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1eb.png?v8", - "french_southern_territories": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1eb.png?v8", - "fried_egg": "https://github.githubassets.com/images/icons/emoji/unicode/1f373.png?v8", - "fried_shrimp": "https://github.githubassets.com/images/icons/emoji/unicode/1f364.png?v8", - "fries": "https://github.githubassets.com/images/icons/emoji/unicode/1f35f.png?v8", - "frog": "https://github.githubassets.com/images/icons/emoji/unicode/1f438.png?v8", - "frowning": "https://github.githubassets.com/images/icons/emoji/unicode/1f626.png?v8", - "frowning_face": "https://github.githubassets.com/images/icons/emoji/unicode/2639.png?v8", - "frowning_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2642.png?v8", - "frowning_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f64d.png?v8", - "frowning_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2640.png?v8", - "fu": "https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8", - "fuelpump": "https://github.githubassets.com/images/icons/emoji/unicode/26fd.png?v8", - "full_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f315.png?v8", - "full_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31d.png?v8", - "funeral_urn": "https://github.githubassets.com/images/icons/emoji/unicode/26b1.png?v8", - "gabon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e6.png?v8", - "gambia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f2.png?v8", - "game_die": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b2.png?v8", - "garlic": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c4.png?v8", - "gb": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8", - "gear": "https://github.githubassets.com/images/icons/emoji/unicode/2699.png?v8", - "gem": "https://github.githubassets.com/images/icons/emoji/unicode/1f48e.png?v8", - "gemini": "https://github.githubassets.com/images/icons/emoji/unicode/264a.png?v8", - "genie": "https://github.githubassets.com/images/icons/emoji/unicode/1f9de.png?v8", - "genie_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2642.png?v8", - "genie_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2640.png?v8", - "georgia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ea.png?v8", - "ghana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ed.png?v8", - "ghost": "https://github.githubassets.com/images/icons/emoji/unicode/1f47b.png?v8", - "gibraltar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ee.png?v8", - "gift": "https://github.githubassets.com/images/icons/emoji/unicode/1f381.png?v8", - "gift_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49d.png?v8", - "giraffe": "https://github.githubassets.com/images/icons/emoji/unicode/1f992.png?v8", - "girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f467.png?v8", - "globe_with_meridians": "https://github.githubassets.com/images/icons/emoji/unicode/1f310.png?v8", - "gloves": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e4.png?v8", - "goal_net": "https://github.githubassets.com/images/icons/emoji/unicode/1f945.png?v8", - "goat": "https://github.githubassets.com/images/icons/emoji/unicode/1f410.png?v8", - "goberserk": "https://github.githubassets.com/images/icons/emoji/goberserk.png?v8", - "godmode": "https://github.githubassets.com/images/icons/emoji/godmode.png?v8", - "goggles": "https://github.githubassets.com/images/icons/emoji/unicode/1f97d.png?v8", - "golf": "https://github.githubassets.com/images/icons/emoji/unicode/26f3.png?v8", - "golfing": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cc.png?v8", - "golfing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2642.png?v8", - "golfing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2640.png?v8", - "gorilla": "https://github.githubassets.com/images/icons/emoji/unicode/1f98d.png?v8", - "grapes": "https://github.githubassets.com/images/icons/emoji/unicode/1f347.png?v8", - "greece": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f7.png?v8", - "green_apple": "https://github.githubassets.com/images/icons/emoji/unicode/1f34f.png?v8", - "green_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d7.png?v8", - "green_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e2.png?v8", - "green_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49a.png?v8", - "green_salad": "https://github.githubassets.com/images/icons/emoji/unicode/1f957.png?v8", - "green_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e9.png?v8", - "greenland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f1.png?v8", - "grenada": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e9.png?v8", - "grey_exclamation": "https://github.githubassets.com/images/icons/emoji/unicode/2755.png?v8", - "grey_question": "https://github.githubassets.com/images/icons/emoji/unicode/2754.png?v8", - "grimacing": "https://github.githubassets.com/images/icons/emoji/unicode/1f62c.png?v8", - "grin": "https://github.githubassets.com/images/icons/emoji/unicode/1f601.png?v8", - "grinning": "https://github.githubassets.com/images/icons/emoji/unicode/1f600.png?v8", - "guadeloupe": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f5.png?v8", - "guam": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fa.png?v8", - "guard": "https://github.githubassets.com/images/icons/emoji/unicode/1f482.png?v8", - "guardsman": "https://github.githubassets.com/images/icons/emoji/unicode/1f482-2642.png?v8", - "guardswoman": "https://github.githubassets.com/images/icons/emoji/unicode/1f482-2640.png?v8", - "guatemala": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f9.png?v8", - "guernsey": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ec.png?v8", - "guide_dog": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ae.png?v8", - "guinea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f3.png?v8", - "guinea_bissau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fc.png?v8", - "guitar": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b8.png?v8", - "gun": "https://github.githubassets.com/images/icons/emoji/unicode/1f52b.png?v8", - "guyana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fe.png?v8", - "haircut": "https://github.githubassets.com/images/icons/emoji/unicode/1f487.png?v8", - "haircut_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f487-2642.png?v8", - "haircut_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f487-2640.png?v8", - "haiti": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f9.png?v8", - "hamburger": "https://github.githubassets.com/images/icons/emoji/unicode/1f354.png?v8", - "hammer": "https://github.githubassets.com/images/icons/emoji/unicode/1f528.png?v8", - "hammer_and_pick": "https://github.githubassets.com/images/icons/emoji/unicode/2692.png?v8", - "hammer_and_wrench": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e0.png?v8", - "hamster": "https://github.githubassets.com/images/icons/emoji/unicode/1f439.png?v8", - "hand": "https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8", - "hand_over_mouth": "https://github.githubassets.com/images/icons/emoji/unicode/1f92d.png?v8", - "handbag": "https://github.githubassets.com/images/icons/emoji/unicode/1f45c.png?v8", - "handball_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f93e.png?v8", - "handshake": "https://github.githubassets.com/images/icons/emoji/unicode/1f91d.png?v8", - "hankey": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8", - "hash": "https://github.githubassets.com/images/icons/emoji/unicode/0023-20e3.png?v8", - "hatched_chick": "https://github.githubassets.com/images/icons/emoji/unicode/1f425.png?v8", - "hatching_chick": "https://github.githubassets.com/images/icons/emoji/unicode/1f423.png?v8", - "headphones": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a7.png?v8", - "headstone": "https://github.githubassets.com/images/icons/emoji/unicode/1faa6.png?v8", - "health_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2695.png?v8", - "hear_no_evil": "https://github.githubassets.com/images/icons/emoji/unicode/1f649.png?v8", - "heard_mcdonald_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f2.png?v8", - "heart": "https://github.githubassets.com/images/icons/emoji/unicode/2764.png?v8", - "heart_decoration": "https://github.githubassets.com/images/icons/emoji/unicode/1f49f.png?v8", - "heart_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f60d.png?v8", - "heart_eyes_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63b.png?v8", - "heart_on_fire": "https://github.githubassets.com/images/icons/emoji/unicode/2764-1f525.png?v8", - "heartbeat": "https://github.githubassets.com/images/icons/emoji/unicode/1f493.png?v8", - "heartpulse": "https://github.githubassets.com/images/icons/emoji/unicode/1f497.png?v8", - "hearts": "https://github.githubassets.com/images/icons/emoji/unicode/2665.png?v8", - "heavy_check_mark": "https://github.githubassets.com/images/icons/emoji/unicode/2714.png?v8", - "heavy_division_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2797.png?v8", - "heavy_dollar_sign": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b2.png?v8", - "heavy_exclamation_mark": "https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8", - "heavy_heart_exclamation": "https://github.githubassets.com/images/icons/emoji/unicode/2763.png?v8", - "heavy_minus_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2796.png?v8", - "heavy_multiplication_x": "https://github.githubassets.com/images/icons/emoji/unicode/2716.png?v8", - "heavy_plus_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2795.png?v8", - "hedgehog": "https://github.githubassets.com/images/icons/emoji/unicode/1f994.png?v8", - "helicopter": "https://github.githubassets.com/images/icons/emoji/unicode/1f681.png?v8", - "herb": "https://github.githubassets.com/images/icons/emoji/unicode/1f33f.png?v8", - "hibiscus": "https://github.githubassets.com/images/icons/emoji/unicode/1f33a.png?v8", - "high_brightness": "https://github.githubassets.com/images/icons/emoji/unicode/1f506.png?v8", - "high_heel": "https://github.githubassets.com/images/icons/emoji/unicode/1f460.png?v8", - "hiking_boot": "https://github.githubassets.com/images/icons/emoji/unicode/1f97e.png?v8", - "hindu_temple": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d5.png?v8", - "hippopotamus": "https://github.githubassets.com/images/icons/emoji/unicode/1f99b.png?v8", - "hocho": "https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8", - "hole": "https://github.githubassets.com/images/icons/emoji/unicode/1f573.png?v8", - "honduras": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f3.png?v8", - "honey_pot": "https://github.githubassets.com/images/icons/emoji/unicode/1f36f.png?v8", - "honeybee": "https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8", - "hong_kong": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f0.png?v8", - "hook": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9d.png?v8", - "horse": "https://github.githubassets.com/images/icons/emoji/unicode/1f434.png?v8", - "horse_racing": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c7.png?v8", - "hospital": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e5.png?v8", - "hot_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f975.png?v8", - "hot_pepper": "https://github.githubassets.com/images/icons/emoji/unicode/1f336.png?v8", - "hotdog": "https://github.githubassets.com/images/icons/emoji/unicode/1f32d.png?v8", - "hotel": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e8.png?v8", - "hotsprings": "https://github.githubassets.com/images/icons/emoji/unicode/2668.png?v8", - "hourglass": "https://github.githubassets.com/images/icons/emoji/unicode/231b.png?v8", - "hourglass_flowing_sand": "https://github.githubassets.com/images/icons/emoji/unicode/23f3.png?v8", - "house": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e0.png?v8", - "house_with_garden": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e1.png?v8", - "houses": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d8.png?v8", - "hugs": "https://github.githubassets.com/images/icons/emoji/unicode/1f917.png?v8", - "hungary": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1fa.png?v8", - "hurtrealbad": "https://github.githubassets.com/images/icons/emoji/hurtrealbad.png?v8", - "hushed": "https://github.githubassets.com/images/icons/emoji/unicode/1f62f.png?v8", - "hut": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d6.png?v8", - "ice_cream": "https://github.githubassets.com/images/icons/emoji/unicode/1f368.png?v8", - "ice_cube": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ca.png?v8", - "ice_hockey": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d2.png?v8", - "ice_skate": "https://github.githubassets.com/images/icons/emoji/unicode/26f8.png?v8", - "icecream": "https://github.githubassets.com/images/icons/emoji/unicode/1f366.png?v8", - "iceland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f8.png?v8", - "id": "https://github.githubassets.com/images/icons/emoji/unicode/1f194.png?v8", - "ideograph_advantage": "https://github.githubassets.com/images/icons/emoji/unicode/1f250.png?v8", - "imp": "https://github.githubassets.com/images/icons/emoji/unicode/1f47f.png?v8", - "inbox_tray": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e5.png?v8", - "incoming_envelope": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e8.png?v8", - "india": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f3.png?v8", - "indonesia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e9.png?v8", - "infinity": "https://github.githubassets.com/images/icons/emoji/unicode/267e.png?v8", - "information_desk_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8", - "information_source": "https://github.githubassets.com/images/icons/emoji/unicode/2139.png?v8", - "innocent": "https://github.githubassets.com/images/icons/emoji/unicode/1f607.png?v8", - "interrobang": "https://github.githubassets.com/images/icons/emoji/unicode/2049.png?v8", - "iphone": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f1.png?v8", - "iran": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f7.png?v8", - "iraq": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f6.png?v8", - "ireland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1ea.png?v8", - "isle_of_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f2.png?v8", - "israel": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f1.png?v8", - "it": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f9.png?v8", - "izakaya_lantern": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8", - "jack_o_lantern": "https://github.githubassets.com/images/icons/emoji/unicode/1f383.png?v8", - "jamaica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f2.png?v8", - "japan": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fe.png?v8", - "japanese_castle": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ef.png?v8", - "japanese_goblin": "https://github.githubassets.com/images/icons/emoji/unicode/1f47a.png?v8", - "japanese_ogre": "https://github.githubassets.com/images/icons/emoji/unicode/1f479.png?v8", - "jeans": "https://github.githubassets.com/images/icons/emoji/unicode/1f456.png?v8", - "jersey": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1ea.png?v8", - "jigsaw": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e9.png?v8", - "jordan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f4.png?v8", - "joy": "https://github.githubassets.com/images/icons/emoji/unicode/1f602.png?v8", - "joy_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f639.png?v8", - "joystick": "https://github.githubassets.com/images/icons/emoji/unicode/1f579.png?v8", - "jp": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f5.png?v8", - "judge": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2696.png?v8", - "juggling_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f939.png?v8", - "kangaroo": "https://github.githubassets.com/images/icons/emoji/unicode/1f998.png?v8", - "kazakhstan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ff.png?v8", - "kenya": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ea.png?v8", - "key": "https://github.githubassets.com/images/icons/emoji/unicode/1f511.png?v8", - "keyboard": "https://github.githubassets.com/images/icons/emoji/unicode/2328.png?v8", - "keycap_ten": "https://github.githubassets.com/images/icons/emoji/unicode/1f51f.png?v8", - "kick_scooter": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f4.png?v8", - "kimono": "https://github.githubassets.com/images/icons/emoji/unicode/1f458.png?v8", - "kiribati": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ee.png?v8", - "kiss": "https://github.githubassets.com/images/icons/emoji/unicode/1f48b.png?v8", - "kissing": "https://github.githubassets.com/images/icons/emoji/unicode/1f617.png?v8", - "kissing_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63d.png?v8", - "kissing_closed_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f61a.png?v8", - "kissing_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f618.png?v8", - "kissing_smiling_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f619.png?v8", - "kite": "https://github.githubassets.com/images/icons/emoji/unicode/1fa81.png?v8", - "kiwi_fruit": "https://github.githubassets.com/images/icons/emoji/unicode/1f95d.png?v8", - "kneeling_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2642.png?v8", - "kneeling_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ce.png?v8", - "kneeling_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2640.png?v8", - "knife": "https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8", - "knot": "https://github.githubassets.com/images/icons/emoji/unicode/1faa2.png?v8", - "koala": "https://github.githubassets.com/images/icons/emoji/unicode/1f428.png?v8", - "koko": "https://github.githubassets.com/images/icons/emoji/unicode/1f201.png?v8", - "kosovo": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fd-1f1f0.png?v8", - "kr": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f7.png?v8", - "kuwait": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fc.png?v8", - "kyrgyzstan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ec.png?v8", - "lab_coat": "https://github.githubassets.com/images/icons/emoji/unicode/1f97c.png?v8", - "label": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f7.png?v8", - "lacrosse": "https://github.githubassets.com/images/icons/emoji/unicode/1f94d.png?v8", - "ladder": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9c.png?v8", - "lady_beetle": "https://github.githubassets.com/images/icons/emoji/unicode/1f41e.png?v8", - "lantern": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8", - "laos": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e6.png?v8", - "large_blue_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f535.png?v8", - "large_blue_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f537.png?v8", - "large_orange_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f536.png?v8", - "last_quarter_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f317.png?v8", - "last_quarter_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31c.png?v8", - "latin_cross": "https://github.githubassets.com/images/icons/emoji/unicode/271d.png?v8", - "latvia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fb.png?v8", - "laughing": "https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8", - "leafy_green": "https://github.githubassets.com/images/icons/emoji/unicode/1f96c.png?v8", - "leaves": "https://github.githubassets.com/images/icons/emoji/unicode/1f343.png?v8", - "lebanon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e7.png?v8", - "ledger": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d2.png?v8", - "left_luggage": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c5.png?v8", - "left_right_arrow": "https://github.githubassets.com/images/icons/emoji/unicode/2194.png?v8", - "left_speech_bubble": "https://github.githubassets.com/images/icons/emoji/unicode/1f5e8.png?v8", - "leftwards_arrow_with_hook": "https://github.githubassets.com/images/icons/emoji/unicode/21a9.png?v8", - "leg": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b5.png?v8", - "lemon": "https://github.githubassets.com/images/icons/emoji/unicode/1f34b.png?v8", - "leo": "https://github.githubassets.com/images/icons/emoji/unicode/264c.png?v8", - "leopard": "https://github.githubassets.com/images/icons/emoji/unicode/1f406.png?v8", - "lesotho": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f8.png?v8", - "level_slider": "https://github.githubassets.com/images/icons/emoji/unicode/1f39a.png?v8", - "liberia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f7.png?v8", - "libra": "https://github.githubassets.com/images/icons/emoji/unicode/264e.png?v8", - "libya": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fe.png?v8", - "liechtenstein": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1ee.png?v8", - "light_rail": "https://github.githubassets.com/images/icons/emoji/unicode/1f688.png?v8", - "link": "https://github.githubassets.com/images/icons/emoji/unicode/1f517.png?v8", - "lion": "https://github.githubassets.com/images/icons/emoji/unicode/1f981.png?v8", - "lips": "https://github.githubassets.com/images/icons/emoji/unicode/1f444.png?v8", - "lipstick": "https://github.githubassets.com/images/icons/emoji/unicode/1f484.png?v8", - "lithuania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f9.png?v8", - "lizard": "https://github.githubassets.com/images/icons/emoji/unicode/1f98e.png?v8", - "llama": "https://github.githubassets.com/images/icons/emoji/unicode/1f999.png?v8", - "lobster": "https://github.githubassets.com/images/icons/emoji/unicode/1f99e.png?v8", - "lock": "https://github.githubassets.com/images/icons/emoji/unicode/1f512.png?v8", - "lock_with_ink_pen": "https://github.githubassets.com/images/icons/emoji/unicode/1f50f.png?v8", - "lollipop": "https://github.githubassets.com/images/icons/emoji/unicode/1f36d.png?v8", - "long_drum": "https://github.githubassets.com/images/icons/emoji/unicode/1fa98.png?v8", - "loop": "https://github.githubassets.com/images/icons/emoji/unicode/27bf.png?v8", - "lotion_bottle": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f4.png?v8", - "lotus_position": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d8.png?v8", - "lotus_position_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2642.png?v8", - "lotus_position_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2640.png?v8", - "loud_sound": "https://github.githubassets.com/images/icons/emoji/unicode/1f50a.png?v8", - "loudspeaker": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e2.png?v8", - "love_hotel": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e9.png?v8", - "love_letter": "https://github.githubassets.com/images/icons/emoji/unicode/1f48c.png?v8", - "love_you_gesture": "https://github.githubassets.com/images/icons/emoji/unicode/1f91f.png?v8", - "low_brightness": "https://github.githubassets.com/images/icons/emoji/unicode/1f505.png?v8", - "luggage": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f3.png?v8", - "lungs": "https://github.githubassets.com/images/icons/emoji/unicode/1fac1.png?v8", - "luxembourg": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fa.png?v8", - "lying_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f925.png?v8", - "m": "https://github.githubassets.com/images/icons/emoji/unicode/24c2.png?v8", - "macau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f4.png?v8", - "macedonia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f0.png?v8", - "madagascar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ec.png?v8", - "mag": "https://github.githubassets.com/images/icons/emoji/unicode/1f50d.png?v8", - "mag_right": "https://github.githubassets.com/images/icons/emoji/unicode/1f50e.png?v8", - "mage": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d9.png?v8", - "mage_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2642.png?v8", - "mage_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2640.png?v8", - "magic_wand": "https://github.githubassets.com/images/icons/emoji/unicode/1fa84.png?v8", - "magnet": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f2.png?v8", - "mahjong": "https://github.githubassets.com/images/icons/emoji/unicode/1f004.png?v8", - "mailbox": "https://github.githubassets.com/images/icons/emoji/unicode/1f4eb.png?v8", - "mailbox_closed": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ea.png?v8", - "mailbox_with_mail": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ec.png?v8", - "mailbox_with_no_mail": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ed.png?v8", - "malawi": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fc.png?v8", - "malaysia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fe.png?v8", - "maldives": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fb.png?v8", - "male_detective": "https://github.githubassets.com/images/icons/emoji/unicode/1f575-2642.png?v8", - "male_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2642.png?v8", - "mali": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f1.png?v8", - "malta": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f9.png?v8", - "mammoth": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a3.png?v8", - "man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468.png?v8", - "man_artist": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a8.png?v8", - "man_astronaut": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f680.png?v8", - "man_beard": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2642.png?v8", - "man_cartwheeling": "https://github.githubassets.com/images/icons/emoji/unicode/1f938-2642.png?v8", - "man_cook": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f373.png?v8", - "man_dancing": "https://github.githubassets.com/images/icons/emoji/unicode/1f57a.png?v8", - "man_facepalming": "https://github.githubassets.com/images/icons/emoji/unicode/1f926-2642.png?v8", - "man_factory_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3ed.png?v8", - "man_farmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f33e.png?v8", - "man_feeding_baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f37c.png?v8", - "man_firefighter": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f692.png?v8", - "man_health_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2695.png?v8", - "man_in_manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bd.png?v8", - "man_in_motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bc.png?v8", - "man_in_tuxedo": "https://github.githubassets.com/images/icons/emoji/unicode/1f935-2642.png?v8", - "man_judge": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2696.png?v8", - "man_juggling": "https://github.githubassets.com/images/icons/emoji/unicode/1f939-2642.png?v8", - "man_mechanic": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f527.png?v8", - "man_office_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bc.png?v8", - "man_pilot": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2708.png?v8", - "man_playing_handball": "https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2642.png?v8", - "man_playing_water_polo": "https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2642.png?v8", - "man_scientist": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f52c.png?v8", - "man_shrugging": "https://github.githubassets.com/images/icons/emoji/unicode/1f937-2642.png?v8", - "man_singer": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a4.png?v8", - "man_student": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f393.png?v8", - "man_teacher": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3eb.png?v8", - "man_technologist": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bb.png?v8", - "man_with_gua_pi_mao": "https://github.githubassets.com/images/icons/emoji/unicode/1f472.png?v8", - "man_with_probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9af.png?v8", - "man_with_turban": "https://github.githubassets.com/images/icons/emoji/unicode/1f473-2642.png?v8", - "man_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470-2642.png?v8", - "mandarin": "https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8", - "mango": "https://github.githubassets.com/images/icons/emoji/unicode/1f96d.png?v8", - "mans_shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8", - "mantelpiece_clock": "https://github.githubassets.com/images/icons/emoji/unicode/1f570.png?v8", - "manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bd.png?v8", - "maple_leaf": "https://github.githubassets.com/images/icons/emoji/unicode/1f341.png?v8", - "marshall_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ed.png?v8", - "martial_arts_uniform": "https://github.githubassets.com/images/icons/emoji/unicode/1f94b.png?v8", - "martinique": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f6.png?v8", - "mask": "https://github.githubassets.com/images/icons/emoji/unicode/1f637.png?v8", - "massage": "https://github.githubassets.com/images/icons/emoji/unicode/1f486.png?v8", - "massage_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f486-2642.png?v8", - "massage_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f486-2640.png?v8", - "mate": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c9.png?v8", - "mauritania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f7.png?v8", - "mauritius": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fa.png?v8", - "mayotte": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1f9.png?v8", - "meat_on_bone": "https://github.githubassets.com/images/icons/emoji/unicode/1f356.png?v8", - "mechanic": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f527.png?v8", - "mechanical_arm": "https://github.githubassets.com/images/icons/emoji/unicode/1f9be.png?v8", - "mechanical_leg": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bf.png?v8", - "medal_military": "https://github.githubassets.com/images/icons/emoji/unicode/1f396.png?v8", - "medal_sports": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c5.png?v8", - "medical_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/2695.png?v8", - "mega": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e3.png?v8", - "melon": "https://github.githubassets.com/images/icons/emoji/unicode/1f348.png?v8", - "memo": "https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8", - "men_wrestling": "https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2642.png?v8", - "mending_heart": "https://github.githubassets.com/images/icons/emoji/unicode/2764-1fa79.png?v8", - "menorah": "https://github.githubassets.com/images/icons/emoji/unicode/1f54e.png?v8", - "mens": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b9.png?v8", - "mermaid": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2640.png?v8", - "merman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2642.png?v8", - "merperson": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dc.png?v8", - "metal": "https://github.githubassets.com/images/icons/emoji/unicode/1f918.png?v8", - "metro": "https://github.githubassets.com/images/icons/emoji/unicode/1f687.png?v8", - "mexico": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fd.png?v8", - "microbe": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a0.png?v8", - "micronesia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f2.png?v8", - "microphone": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a4.png?v8", - "microscope": "https://github.githubassets.com/images/icons/emoji/unicode/1f52c.png?v8", - "middle_finger": "https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8", - "military_helmet": "https://github.githubassets.com/images/icons/emoji/unicode/1fa96.png?v8", - "milk_glass": "https://github.githubassets.com/images/icons/emoji/unicode/1f95b.png?v8", - "milky_way": "https://github.githubassets.com/images/icons/emoji/unicode/1f30c.png?v8", - "minibus": "https://github.githubassets.com/images/icons/emoji/unicode/1f690.png?v8", - "minidisc": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bd.png?v8", - "mirror": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9e.png?v8", - "mobile_phone_off": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f4.png?v8", - "moldova": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e9.png?v8", - "monaco": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e8.png?v8", - "money_mouth_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f911.png?v8", - "money_with_wings": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b8.png?v8", - "moneybag": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b0.png?v8", - "mongolia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f3.png?v8", - "monkey": "https://github.githubassets.com/images/icons/emoji/unicode/1f412.png?v8", - "monkey_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f435.png?v8", - "monocle_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d0.png?v8", - "monorail": "https://github.githubassets.com/images/icons/emoji/unicode/1f69d.png?v8", - "montenegro": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ea.png?v8", - "montserrat": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f8.png?v8", - "moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8", - "moon_cake": "https://github.githubassets.com/images/icons/emoji/unicode/1f96e.png?v8", - "morocco": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e6.png?v8", - "mortar_board": "https://github.githubassets.com/images/icons/emoji/unicode/1f393.png?v8", - "mosque": "https://github.githubassets.com/images/icons/emoji/unicode/1f54c.png?v8", - "mosquito": "https://github.githubassets.com/images/icons/emoji/unicode/1f99f.png?v8", - "motor_boat": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e5.png?v8", - "motor_scooter": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f5.png?v8", - "motorcycle": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cd.png?v8", - "motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bc.png?v8", - "motorway": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e3.png?v8", - "mount_fuji": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fb.png?v8", - "mountain": "https://github.githubassets.com/images/icons/emoji/unicode/26f0.png?v8", - "mountain_bicyclist": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b5.png?v8", - "mountain_biking_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2642.png?v8", - "mountain_biking_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2640.png?v8", - "mountain_cableway": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a0.png?v8", - "mountain_railway": "https://github.githubassets.com/images/icons/emoji/unicode/1f69e.png?v8", - "mountain_snow": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d4.png?v8", - "mouse": "https://github.githubassets.com/images/icons/emoji/unicode/1f42d.png?v8", - "mouse2": "https://github.githubassets.com/images/icons/emoji/unicode/1f401.png?v8", - "mouse_trap": "https://github.githubassets.com/images/icons/emoji/unicode/1faa4.png?v8", - "movie_camera": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a5.png?v8", - "moyai": "https://github.githubassets.com/images/icons/emoji/unicode/1f5ff.png?v8", - "mozambique": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ff.png?v8", - "mrs_claus": "https://github.githubassets.com/images/icons/emoji/unicode/1f936.png?v8", - "muscle": "https://github.githubassets.com/images/icons/emoji/unicode/1f4aa.png?v8", - "mushroom": "https://github.githubassets.com/images/icons/emoji/unicode/1f344.png?v8", - "musical_keyboard": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b9.png?v8", - "musical_note": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b5.png?v8", - "musical_score": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bc.png?v8", - "mute": "https://github.githubassets.com/images/icons/emoji/unicode/1f507.png?v8", - "mx_claus": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f384.png?v8", - "myanmar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f2.png?v8", - "nail_care": "https://github.githubassets.com/images/icons/emoji/unicode/1f485.png?v8", - "name_badge": "https://github.githubassets.com/images/icons/emoji/unicode/1f4db.png?v8", - "namibia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e6.png?v8", - "national_park": "https://github.githubassets.com/images/icons/emoji/unicode/1f3de.png?v8", - "nauru": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f7.png?v8", - "nauseated_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f922.png?v8", - "nazar_amulet": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ff.png?v8", - "neckbeard": "https://github.githubassets.com/images/icons/emoji/neckbeard.png?v8", - "necktie": "https://github.githubassets.com/images/icons/emoji/unicode/1f454.png?v8", - "negative_squared_cross_mark": "https://github.githubassets.com/images/icons/emoji/unicode/274e.png?v8", - "nepal": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f5.png?v8", - "nerd_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f913.png?v8", - "nesting_dolls": "https://github.githubassets.com/images/icons/emoji/unicode/1fa86.png?v8", - "netherlands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f1.png?v8", - "neutral_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f610.png?v8", - "new": "https://github.githubassets.com/images/icons/emoji/unicode/1f195.png?v8", - "new_caledonia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e8.png?v8", - "new_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f311.png?v8", - "new_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31a.png?v8", - "new_zealand": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ff.png?v8", - "newspaper": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f0.png?v8", - "newspaper_roll": "https://github.githubassets.com/images/icons/emoji/unicode/1f5de.png?v8", - "next_track_button": "https://github.githubassets.com/images/icons/emoji/unicode/23ed.png?v8", - "ng": "https://github.githubassets.com/images/icons/emoji/unicode/1f196.png?v8", - "ng_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8", - "ng_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8", - "nicaragua": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ee.png?v8", - "niger": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ea.png?v8", - "nigeria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ec.png?v8", - "night_with_stars": "https://github.githubassets.com/images/icons/emoji/unicode/1f303.png?v8", - "nine": "https://github.githubassets.com/images/icons/emoji/unicode/0039-20e3.png?v8", - "ninja": "https://github.githubassets.com/images/icons/emoji/unicode/1f977.png?v8", - "niue": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1fa.png?v8", - "no_bell": "https://github.githubassets.com/images/icons/emoji/unicode/1f515.png?v8", - "no_bicycles": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b3.png?v8", - "no_entry": "https://github.githubassets.com/images/icons/emoji/unicode/26d4.png?v8", - "no_entry_sign": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ab.png?v8", - "no_good": "https://github.githubassets.com/images/icons/emoji/unicode/1f645.png?v8", - "no_good_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8", - "no_good_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8", - "no_mobile_phones": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f5.png?v8", - "no_mouth": "https://github.githubassets.com/images/icons/emoji/unicode/1f636.png?v8", - "no_pedestrians": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b7.png?v8", - "no_smoking": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ad.png?v8", - "non-potable_water": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b1.png?v8", - "norfolk_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1eb.png?v8", - "north_korea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f5.png?v8", - "northern_mariana_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f5.png?v8", - "norway": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f4.png?v8", - "nose": "https://github.githubassets.com/images/icons/emoji/unicode/1f443.png?v8", - "notebook": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d3.png?v8", - "notebook_with_decorative_cover": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d4.png?v8", - "notes": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b6.png?v8", - "nut_and_bolt": "https://github.githubassets.com/images/icons/emoji/unicode/1f529.png?v8", - "o": "https://github.githubassets.com/images/icons/emoji/unicode/2b55.png?v8", - "o2": "https://github.githubassets.com/images/icons/emoji/unicode/1f17e.png?v8", - "ocean": "https://github.githubassets.com/images/icons/emoji/unicode/1f30a.png?v8", - "octocat": "https://github.githubassets.com/images/icons/emoji/octocat.png?v8", - "octopus": "https://github.githubassets.com/images/icons/emoji/unicode/1f419.png?v8", - "oden": "https://github.githubassets.com/images/icons/emoji/unicode/1f362.png?v8", - "office": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e2.png?v8", - "office_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bc.png?v8", - "oil_drum": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e2.png?v8", - "ok": "https://github.githubassets.com/images/icons/emoji/unicode/1f197.png?v8", - "ok_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f44c.png?v8", - "ok_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f646-2642.png?v8", - "ok_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f646.png?v8", - "ok_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f646-2640.png?v8", - "old_key": "https://github.githubassets.com/images/icons/emoji/unicode/1f5dd.png?v8", - "older_adult": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d3.png?v8", - "older_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f474.png?v8", - "older_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f475.png?v8", - "olive": "https://github.githubassets.com/images/icons/emoji/unicode/1fad2.png?v8", - "om": "https://github.githubassets.com/images/icons/emoji/unicode/1f549.png?v8", - "oman": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f4-1f1f2.png?v8", - "on": "https://github.githubassets.com/images/icons/emoji/unicode/1f51b.png?v8", - "oncoming_automobile": "https://github.githubassets.com/images/icons/emoji/unicode/1f698.png?v8", - "oncoming_bus": "https://github.githubassets.com/images/icons/emoji/unicode/1f68d.png?v8", - "oncoming_police_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f694.png?v8", - "oncoming_taxi": "https://github.githubassets.com/images/icons/emoji/unicode/1f696.png?v8", - "one": "https://github.githubassets.com/images/icons/emoji/unicode/0031-20e3.png?v8", - "one_piece_swimsuit": "https://github.githubassets.com/images/icons/emoji/unicode/1fa71.png?v8", - "onion": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c5.png?v8", - "open_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8", - "open_file_folder": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c2.png?v8", - "open_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f450.png?v8", - "open_mouth": "https://github.githubassets.com/images/icons/emoji/unicode/1f62e.png?v8", - "open_umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/2602.png?v8", - "ophiuchus": "https://github.githubassets.com/images/icons/emoji/unicode/26ce.png?v8", - "orange": "https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8", - "orange_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d9.png?v8", - "orange_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e0.png?v8", - "orange_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e1.png?v8", - "orange_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e7.png?v8", - "orangutan": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a7.png?v8", - "orthodox_cross": "https://github.githubassets.com/images/icons/emoji/unicode/2626.png?v8", - "otter": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a6.png?v8", - "outbox_tray": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e4.png?v8", - "owl": "https://github.githubassets.com/images/icons/emoji/unicode/1f989.png?v8", - "ox": "https://github.githubassets.com/images/icons/emoji/unicode/1f402.png?v8", - "oyster": "https://github.githubassets.com/images/icons/emoji/unicode/1f9aa.png?v8", - "package": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e6.png?v8", - "page_facing_up": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c4.png?v8", - "page_with_curl": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c3.png?v8", - "pager": "https://github.githubassets.com/images/icons/emoji/unicode/1f4df.png?v8", - "paintbrush": "https://github.githubassets.com/images/icons/emoji/unicode/1f58c.png?v8", - "pakistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f0.png?v8", - "palau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fc.png?v8", - "palestinian_territories": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f8.png?v8", - "palm_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f334.png?v8", - "palms_up_together": "https://github.githubassets.com/images/icons/emoji/unicode/1f932.png?v8", - "panama": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1e6.png?v8", - "pancakes": "https://github.githubassets.com/images/icons/emoji/unicode/1f95e.png?v8", - "panda_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f43c.png?v8", - "paperclip": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ce.png?v8", - "paperclips": "https://github.githubassets.com/images/icons/emoji/unicode/1f587.png?v8", - "papua_new_guinea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ec.png?v8", - "parachute": "https://github.githubassets.com/images/icons/emoji/unicode/1fa82.png?v8", - "paraguay": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fe.png?v8", - "parasol_on_ground": "https://github.githubassets.com/images/icons/emoji/unicode/26f1.png?v8", - "parking": "https://github.githubassets.com/images/icons/emoji/unicode/1f17f.png?v8", - "parrot": "https://github.githubassets.com/images/icons/emoji/unicode/1f99c.png?v8", - "part_alternation_mark": "https://github.githubassets.com/images/icons/emoji/unicode/303d.png?v8", - "partly_sunny": "https://github.githubassets.com/images/icons/emoji/unicode/26c5.png?v8", - "partying_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f973.png?v8", - "passenger_ship": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f3.png?v8", - "passport_control": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c2.png?v8", - "pause_button": "https://github.githubassets.com/images/icons/emoji/unicode/23f8.png?v8", - "paw_prints": "https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8", - "peace_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/262e.png?v8", - "peach": "https://github.githubassets.com/images/icons/emoji/unicode/1f351.png?v8", - "peacock": "https://github.githubassets.com/images/icons/emoji/unicode/1f99a.png?v8", - "peanuts": "https://github.githubassets.com/images/icons/emoji/unicode/1f95c.png?v8", - "pear": "https://github.githubassets.com/images/icons/emoji/unicode/1f350.png?v8", - "pen": "https://github.githubassets.com/images/icons/emoji/unicode/1f58a.png?v8", - "pencil": "https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8", - "pencil2": "https://github.githubassets.com/images/icons/emoji/unicode/270f.png?v8", - "penguin": "https://github.githubassets.com/images/icons/emoji/unicode/1f427.png?v8", - "pensive": "https://github.githubassets.com/images/icons/emoji/unicode/1f614.png?v8", - "people_holding_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f91d-1f9d1.png?v8", - "people_hugging": "https://github.githubassets.com/images/icons/emoji/unicode/1fac2.png?v8", - "performing_arts": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ad.png?v8", - "persevere": "https://github.githubassets.com/images/icons/emoji/unicode/1f623.png?v8", - "person_bald": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b2.png?v8", - "person_curly_hair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b1.png?v8", - "person_feeding_baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f37c.png?v8", - "person_fencing": "https://github.githubassets.com/images/icons/emoji/unicode/1f93a.png?v8", - "person_in_manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bd.png?v8", - "person_in_motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bc.png?v8", - "person_in_tuxedo": "https://github.githubassets.com/images/icons/emoji/unicode/1f935.png?v8", - "person_red_hair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b0.png?v8", - "person_white_hair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b3.png?v8", - "person_with_probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9af.png?v8", - "person_with_turban": "https://github.githubassets.com/images/icons/emoji/unicode/1f473.png?v8", - "person_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470.png?v8", - "peru": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ea.png?v8", - "petri_dish": "https://github.githubassets.com/images/icons/emoji/unicode/1f9eb.png?v8", - "philippines": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ed.png?v8", - "phone": "https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8", - "pick": "https://github.githubassets.com/images/icons/emoji/unicode/26cf.png?v8", - "pickup_truck": "https://github.githubassets.com/images/icons/emoji/unicode/1f6fb.png?v8", - "pie": "https://github.githubassets.com/images/icons/emoji/unicode/1f967.png?v8", - "pig": "https://github.githubassets.com/images/icons/emoji/unicode/1f437.png?v8", - "pig2": "https://github.githubassets.com/images/icons/emoji/unicode/1f416.png?v8", - "pig_nose": "https://github.githubassets.com/images/icons/emoji/unicode/1f43d.png?v8", - "pill": "https://github.githubassets.com/images/icons/emoji/unicode/1f48a.png?v8", - "pilot": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2708.png?v8", - "pinata": "https://github.githubassets.com/images/icons/emoji/unicode/1fa85.png?v8", - "pinched_fingers": "https://github.githubassets.com/images/icons/emoji/unicode/1f90c.png?v8", - "pinching_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f90f.png?v8", - "pineapple": "https://github.githubassets.com/images/icons/emoji/unicode/1f34d.png?v8", - "ping_pong": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d3.png?v8", - "pirate_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-2620.png?v8", - "pisces": "https://github.githubassets.com/images/icons/emoji/unicode/2653.png?v8", - "pitcairn_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f3.png?v8", - "pizza": "https://github.githubassets.com/images/icons/emoji/unicode/1f355.png?v8", - "placard": "https://github.githubassets.com/images/icons/emoji/unicode/1faa7.png?v8", - "place_of_worship": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d0.png?v8", - "plate_with_cutlery": "https://github.githubassets.com/images/icons/emoji/unicode/1f37d.png?v8", - "play_or_pause_button": "https://github.githubassets.com/images/icons/emoji/unicode/23ef.png?v8", - "pleading_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f97a.png?v8", - "plunger": "https://github.githubassets.com/images/icons/emoji/unicode/1faa0.png?v8", - "point_down": "https://github.githubassets.com/images/icons/emoji/unicode/1f447.png?v8", - "point_left": "https://github.githubassets.com/images/icons/emoji/unicode/1f448.png?v8", - "point_right": "https://github.githubassets.com/images/icons/emoji/unicode/1f449.png?v8", - "point_up": "https://github.githubassets.com/images/icons/emoji/unicode/261d.png?v8", - "point_up_2": "https://github.githubassets.com/images/icons/emoji/unicode/1f446.png?v8", - "poland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f1.png?v8", - "polar_bear": "https://github.githubassets.com/images/icons/emoji/unicode/1f43b-2744.png?v8", - "police_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f693.png?v8", - "police_officer": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", - "policeman": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2642.png?v8", - "policewoman": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2640.png?v8", - "poodle": "https://github.githubassets.com/images/icons/emoji/unicode/1f429.png?v8", - "poop": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8", - "popcorn": "https://github.githubassets.com/images/icons/emoji/unicode/1f37f.png?v8", - "portugal": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f9.png?v8", - "post_office": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e3.png?v8", - "postal_horn": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ef.png?v8", - "postbox": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ee.png?v8", - "potable_water": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b0.png?v8", - "potato": "https://github.githubassets.com/images/icons/emoji/unicode/1f954.png?v8", - "potted_plant": "https://github.githubassets.com/images/icons/emoji/unicode/1fab4.png?v8", - "pouch": "https://github.githubassets.com/images/icons/emoji/unicode/1f45d.png?v8", - "poultry_leg": "https://github.githubassets.com/images/icons/emoji/unicode/1f357.png?v8", - "pound": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b7.png?v8", - "pout": "https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8", - "pouting_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63e.png?v8", - "pouting_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f64e.png?v8", - "pouting_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2642.png?v8", - "pouting_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2640.png?v8", - "pray": "https://github.githubassets.com/images/icons/emoji/unicode/1f64f.png?v8", - "prayer_beads": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ff.png?v8", - "pregnant_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f930.png?v8", - "pretzel": "https://github.githubassets.com/images/icons/emoji/unicode/1f968.png?v8", - "previous_track_button": "https://github.githubassets.com/images/icons/emoji/unicode/23ee.png?v8", - "prince": "https://github.githubassets.com/images/icons/emoji/unicode/1f934.png?v8", - "princess": "https://github.githubassets.com/images/icons/emoji/unicode/1f478.png?v8", - "printer": "https://github.githubassets.com/images/icons/emoji/unicode/1f5a8.png?v8", - "probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f9af.png?v8", - "puerto_rico": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f7.png?v8", - "punch": "https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8", - "purple_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e3.png?v8", - "purple_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49c.png?v8", - "purple_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7ea.png?v8", - "purse": "https://github.githubassets.com/images/icons/emoji/unicode/1f45b.png?v8", - "pushpin": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cc.png?v8", - "put_litter_in_its_place": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ae.png?v8", - "qatar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f6-1f1e6.png?v8", - "question": "https://github.githubassets.com/images/icons/emoji/unicode/2753.png?v8", - "rabbit": "https://github.githubassets.com/images/icons/emoji/unicode/1f430.png?v8", - "rabbit2": "https://github.githubassets.com/images/icons/emoji/unicode/1f407.png?v8", - "raccoon": "https://github.githubassets.com/images/icons/emoji/unicode/1f99d.png?v8", - "racehorse": "https://github.githubassets.com/images/icons/emoji/unicode/1f40e.png?v8", - "racing_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ce.png?v8", - "radio": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fb.png?v8", - "radio_button": "https://github.githubassets.com/images/icons/emoji/unicode/1f518.png?v8", - "radioactive": "https://github.githubassets.com/images/icons/emoji/unicode/2622.png?v8", - "rage": "https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8", - "rage1": "https://github.githubassets.com/images/icons/emoji/rage1.png?v8", - "rage2": "https://github.githubassets.com/images/icons/emoji/rage2.png?v8", - "rage3": "https://github.githubassets.com/images/icons/emoji/rage3.png?v8", - "rage4": "https://github.githubassets.com/images/icons/emoji/rage4.png?v8", - "railway_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f683.png?v8", - "railway_track": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e4.png?v8", - "rainbow": "https://github.githubassets.com/images/icons/emoji/unicode/1f308.png?v8", - "rainbow_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-1f308.png?v8", - "raised_back_of_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f91a.png?v8", - "raised_eyebrow": "https://github.githubassets.com/images/icons/emoji/unicode/1f928.png?v8", - "raised_hand": "https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8", - "raised_hand_with_fingers_splayed": "https://github.githubassets.com/images/icons/emoji/unicode/1f590.png?v8", - "raised_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f64c.png?v8", - "raising_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f64b.png?v8", - "raising_hand_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2642.png?v8", - "raising_hand_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2640.png?v8", - "ram": "https://github.githubassets.com/images/icons/emoji/unicode/1f40f.png?v8", - "ramen": "https://github.githubassets.com/images/icons/emoji/unicode/1f35c.png?v8", - "rat": "https://github.githubassets.com/images/icons/emoji/unicode/1f400.png?v8", - "razor": "https://github.githubassets.com/images/icons/emoji/unicode/1fa92.png?v8", - "receipt": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fe.png?v8", - "record_button": "https://github.githubassets.com/images/icons/emoji/unicode/23fa.png?v8", - "recycle": "https://github.githubassets.com/images/icons/emoji/unicode/267b.png?v8", - "red_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8", - "red_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f534.png?v8", - "red_envelope": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e7.png?v8", - "red_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b0.png?v8", - "red_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b0.png?v8", - "red_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e5.png?v8", - "registered": "https://github.githubassets.com/images/icons/emoji/unicode/00ae.png?v8", - "relaxed": "https://github.githubassets.com/images/icons/emoji/unicode/263a.png?v8", - "relieved": "https://github.githubassets.com/images/icons/emoji/unicode/1f60c.png?v8", - "reminder_ribbon": "https://github.githubassets.com/images/icons/emoji/unicode/1f397.png?v8", - "repeat": "https://github.githubassets.com/images/icons/emoji/unicode/1f501.png?v8", - "repeat_one": "https://github.githubassets.com/images/icons/emoji/unicode/1f502.png?v8", - "rescue_worker_helmet": "https://github.githubassets.com/images/icons/emoji/unicode/26d1.png?v8", - "restroom": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bb.png?v8", - "reunion": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1ea.png?v8", - "revolving_hearts": "https://github.githubassets.com/images/icons/emoji/unicode/1f49e.png?v8", - "rewind": "https://github.githubassets.com/images/icons/emoji/unicode/23ea.png?v8", - "rhinoceros": "https://github.githubassets.com/images/icons/emoji/unicode/1f98f.png?v8", - "ribbon": "https://github.githubassets.com/images/icons/emoji/unicode/1f380.png?v8", - "rice": "https://github.githubassets.com/images/icons/emoji/unicode/1f35a.png?v8", - "rice_ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f359.png?v8", - "rice_cracker": "https://github.githubassets.com/images/icons/emoji/unicode/1f358.png?v8", - "rice_scene": "https://github.githubassets.com/images/icons/emoji/unicode/1f391.png?v8", - "right_anger_bubble": "https://github.githubassets.com/images/icons/emoji/unicode/1f5ef.png?v8", - "ring": "https://github.githubassets.com/images/icons/emoji/unicode/1f48d.png?v8", - "ringed_planet": "https://github.githubassets.com/images/icons/emoji/unicode/1fa90.png?v8", - "robot": "https://github.githubassets.com/images/icons/emoji/unicode/1f916.png?v8", - "rock": "https://github.githubassets.com/images/icons/emoji/unicode/1faa8.png?v8", - "rocket": "https://github.githubassets.com/images/icons/emoji/unicode/1f680.png?v8", - "rofl": "https://github.githubassets.com/images/icons/emoji/unicode/1f923.png?v8", - "roll_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f644.png?v8", - "roll_of_paper": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fb.png?v8", - "roller_coaster": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a2.png?v8", - "roller_skate": "https://github.githubassets.com/images/icons/emoji/unicode/1f6fc.png?v8", - "romania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f4.png?v8", - "rooster": "https://github.githubassets.com/images/icons/emoji/unicode/1f413.png?v8", - "rose": "https://github.githubassets.com/images/icons/emoji/unicode/1f339.png?v8", - "rosette": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f5.png?v8", - "rotating_light": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a8.png?v8", - "round_pushpin": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cd.png?v8", - "rowboat": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a3.png?v8", - "rowing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2642.png?v8", - "rowing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2640.png?v8", - "ru": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fa.png?v8", - "rugby_football": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c9.png?v8", - "runner": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8", - "running": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8", - "running_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2642.png?v8", - "running_shirt_with_sash": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bd.png?v8", - "running_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2640.png?v8", - "rwanda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fc.png?v8", - "sa": "https://github.githubassets.com/images/icons/emoji/unicode/1f202.png?v8", - "safety_pin": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f7.png?v8", - "safety_vest": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ba.png?v8", - "sagittarius": "https://github.githubassets.com/images/icons/emoji/unicode/2650.png?v8", - "sailboat": "https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8", - "sake": "https://github.githubassets.com/images/icons/emoji/unicode/1f376.png?v8", - "salt": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c2.png?v8", - "samoa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1f8.png?v8", - "san_marino": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f2.png?v8", - "sandal": "https://github.githubassets.com/images/icons/emoji/unicode/1f461.png?v8", - "sandwich": "https://github.githubassets.com/images/icons/emoji/unicode/1f96a.png?v8", - "santa": "https://github.githubassets.com/images/icons/emoji/unicode/1f385.png?v8", - "sao_tome_principe": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f9.png?v8", - "sari": "https://github.githubassets.com/images/icons/emoji/unicode/1f97b.png?v8", - "sassy_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8", - "sassy_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8", - "satellite": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e1.png?v8", - "satisfied": "https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8", - "saudi_arabia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e6.png?v8", - "sauna_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2642.png?v8", - "sauna_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d6.png?v8", - "sauna_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2640.png?v8", - "sauropod": "https://github.githubassets.com/images/icons/emoji/unicode/1f995.png?v8", - "saxophone": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b7.png?v8", - "scarf": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e3.png?v8", - "school": "https://github.githubassets.com/images/icons/emoji/unicode/1f3eb.png?v8", - "school_satchel": "https://github.githubassets.com/images/icons/emoji/unicode/1f392.png?v8", - "scientist": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f52c.png?v8", - "scissors": "https://github.githubassets.com/images/icons/emoji/unicode/2702.png?v8", - "scorpion": "https://github.githubassets.com/images/icons/emoji/unicode/1f982.png?v8", - "scorpius": "https://github.githubassets.com/images/icons/emoji/unicode/264f.png?v8", - "scotland": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0073-e0063-e0074-e007f.png?v8", - "scream": "https://github.githubassets.com/images/icons/emoji/unicode/1f631.png?v8", - "scream_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f640.png?v8", - "screwdriver": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9b.png?v8", - "scroll": "https://github.githubassets.com/images/icons/emoji/unicode/1f4dc.png?v8", - "seal": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ad.png?v8", - "seat": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ba.png?v8", - "secret": "https://github.githubassets.com/images/icons/emoji/unicode/3299.png?v8", - "see_no_evil": "https://github.githubassets.com/images/icons/emoji/unicode/1f648.png?v8", - "seedling": "https://github.githubassets.com/images/icons/emoji/unicode/1f331.png?v8", - "selfie": "https://github.githubassets.com/images/icons/emoji/unicode/1f933.png?v8", - "senegal": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f3.png?v8", - "serbia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f8.png?v8", - "service_dog": "https://github.githubassets.com/images/icons/emoji/unicode/1f415-1f9ba.png?v8", - "seven": "https://github.githubassets.com/images/icons/emoji/unicode/0037-20e3.png?v8", - "sewing_needle": "https://github.githubassets.com/images/icons/emoji/unicode/1faa1.png?v8", - "seychelles": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e8.png?v8", - "shallow_pan_of_food": "https://github.githubassets.com/images/icons/emoji/unicode/1f958.png?v8", - "shamrock": "https://github.githubassets.com/images/icons/emoji/unicode/2618.png?v8", - "shark": "https://github.githubassets.com/images/icons/emoji/unicode/1f988.png?v8", - "shaved_ice": "https://github.githubassets.com/images/icons/emoji/unicode/1f367.png?v8", - "sheep": "https://github.githubassets.com/images/icons/emoji/unicode/1f411.png?v8", - "shell": "https://github.githubassets.com/images/icons/emoji/unicode/1f41a.png?v8", - "shield": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e1.png?v8", - "shinto_shrine": "https://github.githubassets.com/images/icons/emoji/unicode/26e9.png?v8", - "ship": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a2.png?v8", - "shipit": "https://github.githubassets.com/images/icons/emoji/shipit.png?v8", - "shirt": "https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8", - "shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8", - "shopping": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cd.png?v8", - "shopping_cart": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d2.png?v8", - "shorts": "https://github.githubassets.com/images/icons/emoji/unicode/1fa73.png?v8", - "shower": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bf.png?v8", - "shrimp": "https://github.githubassets.com/images/icons/emoji/unicode/1f990.png?v8", - "shrug": "https://github.githubassets.com/images/icons/emoji/unicode/1f937.png?v8", - "shushing_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92b.png?v8", - "sierra_leone": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f1.png?v8", - "signal_strength": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f6.png?v8", - "singapore": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ec.png?v8", - "singer": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a4.png?v8", - "sint_maarten": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fd.png?v8", - "six": "https://github.githubassets.com/images/icons/emoji/unicode/0036-20e3.png?v8", - "six_pointed_star": "https://github.githubassets.com/images/icons/emoji/unicode/1f52f.png?v8", - "skateboard": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f9.png?v8", - "ski": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bf.png?v8", - "skier": "https://github.githubassets.com/images/icons/emoji/unicode/26f7.png?v8", - "skull": "https://github.githubassets.com/images/icons/emoji/unicode/1f480.png?v8", - "skull_and_crossbones": "https://github.githubassets.com/images/icons/emoji/unicode/2620.png?v8", - "skunk": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a8.png?v8", - "sled": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f7.png?v8", - "sleeping": "https://github.githubassets.com/images/icons/emoji/unicode/1f634.png?v8", - "sleeping_bed": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cc.png?v8", - "sleepy": "https://github.githubassets.com/images/icons/emoji/unicode/1f62a.png?v8", - "slightly_frowning_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f641.png?v8", - "slightly_smiling_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f642.png?v8", - "slot_machine": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b0.png?v8", - "sloth": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a5.png?v8", - "slovakia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f0.png?v8", - "slovenia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ee.png?v8", - "small_airplane": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e9.png?v8", - "small_blue_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f539.png?v8", - "small_orange_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f538.png?v8", - "small_red_triangle": "https://github.githubassets.com/images/icons/emoji/unicode/1f53a.png?v8", - "small_red_triangle_down": "https://github.githubassets.com/images/icons/emoji/unicode/1f53b.png?v8", - "smile": "https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8", - "smile_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f638.png?v8", - "smiley": "https://github.githubassets.com/images/icons/emoji/unicode/1f603.png?v8", - "smiley_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63a.png?v8", - "smiling_face_with_tear": "https://github.githubassets.com/images/icons/emoji/unicode/1f972.png?v8", - "smiling_face_with_three_hearts": "https://github.githubassets.com/images/icons/emoji/unicode/1f970.png?v8", - "smiling_imp": "https://github.githubassets.com/images/icons/emoji/unicode/1f608.png?v8", - "smirk": "https://github.githubassets.com/images/icons/emoji/unicode/1f60f.png?v8", - "smirk_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63c.png?v8", - "smoking": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ac.png?v8", - "snail": "https://github.githubassets.com/images/icons/emoji/unicode/1f40c.png?v8", - "snake": "https://github.githubassets.com/images/icons/emoji/unicode/1f40d.png?v8", - "sneezing_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f927.png?v8", - "snowboarder": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c2.png?v8", - "snowflake": "https://github.githubassets.com/images/icons/emoji/unicode/2744.png?v8", - "snowman": "https://github.githubassets.com/images/icons/emoji/unicode/26c4.png?v8", - "snowman_with_snow": "https://github.githubassets.com/images/icons/emoji/unicode/2603.png?v8", - "soap": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fc.png?v8", - "sob": "https://github.githubassets.com/images/icons/emoji/unicode/1f62d.png?v8", - "soccer": "https://github.githubassets.com/images/icons/emoji/unicode/26bd.png?v8", - "socks": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e6.png?v8", - "softball": "https://github.githubassets.com/images/icons/emoji/unicode/1f94e.png?v8", - "solomon_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e7.png?v8", - "somalia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f4.png?v8", - "soon": "https://github.githubassets.com/images/icons/emoji/unicode/1f51c.png?v8", - "sos": "https://github.githubassets.com/images/icons/emoji/unicode/1f198.png?v8", - "sound": "https://github.githubassets.com/images/icons/emoji/unicode/1f509.png?v8", - "south_africa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1e6.png?v8", - "south_georgia_south_sandwich_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f8.png?v8", - "south_sudan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f8.png?v8", - "space_invader": "https://github.githubassets.com/images/icons/emoji/unicode/1f47e.png?v8", - "spades": "https://github.githubassets.com/images/icons/emoji/unicode/2660.png?v8", - "spaghetti": "https://github.githubassets.com/images/icons/emoji/unicode/1f35d.png?v8", - "sparkle": "https://github.githubassets.com/images/icons/emoji/unicode/2747.png?v8", - "sparkler": "https://github.githubassets.com/images/icons/emoji/unicode/1f387.png?v8", - "sparkles": "https://github.githubassets.com/images/icons/emoji/unicode/2728.png?v8", - "sparkling_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f496.png?v8", - "speak_no_evil": "https://github.githubassets.com/images/icons/emoji/unicode/1f64a.png?v8", - "speaker": "https://github.githubassets.com/images/icons/emoji/unicode/1f508.png?v8", - "speaking_head": "https://github.githubassets.com/images/icons/emoji/unicode/1f5e3.png?v8", - "speech_balloon": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ac.png?v8", - "speedboat": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a4.png?v8", - "spider": "https://github.githubassets.com/images/icons/emoji/unicode/1f577.png?v8", - "spider_web": "https://github.githubassets.com/images/icons/emoji/unicode/1f578.png?v8", - "spiral_calendar": "https://github.githubassets.com/images/icons/emoji/unicode/1f5d3.png?v8", - "spiral_notepad": "https://github.githubassets.com/images/icons/emoji/unicode/1f5d2.png?v8", - "sponge": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fd.png?v8", - "spoon": "https://github.githubassets.com/images/icons/emoji/unicode/1f944.png?v8", - "squid": "https://github.githubassets.com/images/icons/emoji/unicode/1f991.png?v8", - "sri_lanka": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f0.png?v8", - "st_barthelemy": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f1.png?v8", - "st_helena": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ed.png?v8", - "st_kitts_nevis": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f3.png?v8", - "st_lucia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e8.png?v8", - "st_martin": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1eb.png?v8", - "st_pierre_miquelon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f2.png?v8", - "st_vincent_grenadines": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e8.png?v8", - "stadium": "https://github.githubassets.com/images/icons/emoji/unicode/1f3df.png?v8", - "standing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2642.png?v8", - "standing_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cd.png?v8", - "standing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2640.png?v8", - "star": "https://github.githubassets.com/images/icons/emoji/unicode/2b50.png?v8", - "star2": "https://github.githubassets.com/images/icons/emoji/unicode/1f31f.png?v8", - "star_and_crescent": "https://github.githubassets.com/images/icons/emoji/unicode/262a.png?v8", - "star_of_david": "https://github.githubassets.com/images/icons/emoji/unicode/2721.png?v8", - "star_struck": "https://github.githubassets.com/images/icons/emoji/unicode/1f929.png?v8", - "stars": "https://github.githubassets.com/images/icons/emoji/unicode/1f320.png?v8", - "station": "https://github.githubassets.com/images/icons/emoji/unicode/1f689.png?v8", - "statue_of_liberty": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fd.png?v8", - "steam_locomotive": "https://github.githubassets.com/images/icons/emoji/unicode/1f682.png?v8", - "stethoscope": "https://github.githubassets.com/images/icons/emoji/unicode/1fa7a.png?v8", - "stew": "https://github.githubassets.com/images/icons/emoji/unicode/1f372.png?v8", - "stop_button": "https://github.githubassets.com/images/icons/emoji/unicode/23f9.png?v8", - "stop_sign": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d1.png?v8", - "stopwatch": "https://github.githubassets.com/images/icons/emoji/unicode/23f1.png?v8", - "straight_ruler": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cf.png?v8", - "strawberry": "https://github.githubassets.com/images/icons/emoji/unicode/1f353.png?v8", - "stuck_out_tongue": "https://github.githubassets.com/images/icons/emoji/unicode/1f61b.png?v8", - "stuck_out_tongue_closed_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f61d.png?v8", - "stuck_out_tongue_winking_eye": "https://github.githubassets.com/images/icons/emoji/unicode/1f61c.png?v8", - "student": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f393.png?v8", - "studio_microphone": "https://github.githubassets.com/images/icons/emoji/unicode/1f399.png?v8", - "stuffed_flatbread": "https://github.githubassets.com/images/icons/emoji/unicode/1f959.png?v8", - "sudan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e9.png?v8", - "sun_behind_large_cloud": "https://github.githubassets.com/images/icons/emoji/unicode/1f325.png?v8", - "sun_behind_rain_cloud": "https://github.githubassets.com/images/icons/emoji/unicode/1f326.png?v8", - "sun_behind_small_cloud": "https://github.githubassets.com/images/icons/emoji/unicode/1f324.png?v8", - "sun_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31e.png?v8", - "sunflower": "https://github.githubassets.com/images/icons/emoji/unicode/1f33b.png?v8", - "sunglasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f60e.png?v8", - "sunny": "https://github.githubassets.com/images/icons/emoji/unicode/2600.png?v8", - "sunrise": "https://github.githubassets.com/images/icons/emoji/unicode/1f305.png?v8", - "sunrise_over_mountains": "https://github.githubassets.com/images/icons/emoji/unicode/1f304.png?v8", - "superhero": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b8.png?v8", - "superhero_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2642.png?v8", - "superhero_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2640.png?v8", - "supervillain": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b9.png?v8", - "supervillain_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2642.png?v8", - "supervillain_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2640.png?v8", - "surfer": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c4.png?v8", - "surfing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2642.png?v8", - "surfing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2640.png?v8", - "suriname": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f7.png?v8", - "sushi": "https://github.githubassets.com/images/icons/emoji/unicode/1f363.png?v8", - "suspect": "https://github.githubassets.com/images/icons/emoji/suspect.png?v8", - "suspension_railway": "https://github.githubassets.com/images/icons/emoji/unicode/1f69f.png?v8", - "svalbard_jan_mayen": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ef.png?v8", - "swan": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a2.png?v8", - "swaziland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ff.png?v8", - "sweat": "https://github.githubassets.com/images/icons/emoji/unicode/1f613.png?v8", - "sweat_drops": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a6.png?v8", - "sweat_smile": "https://github.githubassets.com/images/icons/emoji/unicode/1f605.png?v8", - "sweden": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ea.png?v8", - "sweet_potato": "https://github.githubassets.com/images/icons/emoji/unicode/1f360.png?v8", - "swim_brief": "https://github.githubassets.com/images/icons/emoji/unicode/1fa72.png?v8", - "swimmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ca.png?v8", - "swimming_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2642.png?v8", - "swimming_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2640.png?v8", - "switzerland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ed.png?v8", - "symbols": "https://github.githubassets.com/images/icons/emoji/unicode/1f523.png?v8", - "synagogue": "https://github.githubassets.com/images/icons/emoji/unicode/1f54d.png?v8", - "syria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fe.png?v8", - "syringe": "https://github.githubassets.com/images/icons/emoji/unicode/1f489.png?v8", - "t-rex": "https://github.githubassets.com/images/icons/emoji/unicode/1f996.png?v8", - "taco": "https://github.githubassets.com/images/icons/emoji/unicode/1f32e.png?v8", - "tada": "https://github.githubassets.com/images/icons/emoji/unicode/1f389.png?v8", - "taiwan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fc.png?v8", - "tajikistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ef.png?v8", - "takeout_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f961.png?v8", - "tamale": "https://github.githubassets.com/images/icons/emoji/unicode/1fad4.png?v8", - "tanabata_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f38b.png?v8", - "tangerine": "https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8", - "tanzania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ff.png?v8", - "taurus": "https://github.githubassets.com/images/icons/emoji/unicode/2649.png?v8", - "taxi": "https://github.githubassets.com/images/icons/emoji/unicode/1f695.png?v8", - "tea": "https://github.githubassets.com/images/icons/emoji/unicode/1f375.png?v8", - "teacher": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3eb.png?v8", - "teapot": "https://github.githubassets.com/images/icons/emoji/unicode/1fad6.png?v8", - "technologist": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bb.png?v8", - "teddy_bear": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f8.png?v8", - "telephone": "https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8", - "telephone_receiver": "https://github.githubassets.com/images/icons/emoji/unicode/1f4de.png?v8", - "telescope": "https://github.githubassets.com/images/icons/emoji/unicode/1f52d.png?v8", - "tennis": "https://github.githubassets.com/images/icons/emoji/unicode/1f3be.png?v8", - "tent": "https://github.githubassets.com/images/icons/emoji/unicode/26fa.png?v8", - "test_tube": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ea.png?v8", - "thailand": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ed.png?v8", - "thermometer": "https://github.githubassets.com/images/icons/emoji/unicode/1f321.png?v8", - "thinking": "https://github.githubassets.com/images/icons/emoji/unicode/1f914.png?v8", - "thong_sandal": "https://github.githubassets.com/images/icons/emoji/unicode/1fa74.png?v8", - "thought_balloon": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ad.png?v8", - "thread": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f5.png?v8", - "three": "https://github.githubassets.com/images/icons/emoji/unicode/0033-20e3.png?v8", - "thumbsdown": "https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8", - "thumbsup": "https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8", - "ticket": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ab.png?v8", - "tickets": "https://github.githubassets.com/images/icons/emoji/unicode/1f39f.png?v8", - "tiger": "https://github.githubassets.com/images/icons/emoji/unicode/1f42f.png?v8", - "tiger2": "https://github.githubassets.com/images/icons/emoji/unicode/1f405.png?v8", - "timer_clock": "https://github.githubassets.com/images/icons/emoji/unicode/23f2.png?v8", - "timor_leste": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f1.png?v8", - "tipping_hand_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8", - "tipping_hand_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8", - "tipping_hand_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8", - "tired_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f62b.png?v8", - "tm": "https://github.githubassets.com/images/icons/emoji/unicode/2122.png?v8", - "togo": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ec.png?v8", - "toilet": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bd.png?v8", - "tokelau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f0.png?v8", - "tokyo_tower": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fc.png?v8", - "tomato": "https://github.githubassets.com/images/icons/emoji/unicode/1f345.png?v8", - "tonga": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f4.png?v8", - "tongue": "https://github.githubassets.com/images/icons/emoji/unicode/1f445.png?v8", - "toolbox": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f0.png?v8", - "tooth": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b7.png?v8", - "toothbrush": "https://github.githubassets.com/images/icons/emoji/unicode/1faa5.png?v8", - "top": "https://github.githubassets.com/images/icons/emoji/unicode/1f51d.png?v8", - "tophat": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a9.png?v8", - "tornado": "https://github.githubassets.com/images/icons/emoji/unicode/1f32a.png?v8", - "tr": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f7.png?v8", - "trackball": "https://github.githubassets.com/images/icons/emoji/unicode/1f5b2.png?v8", - "tractor": "https://github.githubassets.com/images/icons/emoji/unicode/1f69c.png?v8", - "traffic_light": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a5.png?v8", - "train": "https://github.githubassets.com/images/icons/emoji/unicode/1f68b.png?v8", - "train2": "https://github.githubassets.com/images/icons/emoji/unicode/1f686.png?v8", - "tram": "https://github.githubassets.com/images/icons/emoji/unicode/1f68a.png?v8", - "transgender_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-26a7.png?v8", - "transgender_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/26a7.png?v8", - "triangular_flag_on_post": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a9.png?v8", - "triangular_ruler": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d0.png?v8", - "trident": "https://github.githubassets.com/images/icons/emoji/unicode/1f531.png?v8", - "trinidad_tobago": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f9.png?v8", - "tristan_da_cunha": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e6.png?v8", - "triumph": "https://github.githubassets.com/images/icons/emoji/unicode/1f624.png?v8", - "trolleybus": "https://github.githubassets.com/images/icons/emoji/unicode/1f68e.png?v8", - "trollface": "https://github.githubassets.com/images/icons/emoji/trollface.png?v8", - "trophy": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c6.png?v8", - "tropical_drink": "https://github.githubassets.com/images/icons/emoji/unicode/1f379.png?v8", - "tropical_fish": "https://github.githubassets.com/images/icons/emoji/unicode/1f420.png?v8", - "truck": "https://github.githubassets.com/images/icons/emoji/unicode/1f69a.png?v8", - "trumpet": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ba.png?v8", - "tshirt": "https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8", - "tulip": "https://github.githubassets.com/images/icons/emoji/unicode/1f337.png?v8", - "tumbler_glass": "https://github.githubassets.com/images/icons/emoji/unicode/1f943.png?v8", - "tunisia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f3.png?v8", - "turkey": "https://github.githubassets.com/images/icons/emoji/unicode/1f983.png?v8", - "turkmenistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f2.png?v8", - "turks_caicos_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e8.png?v8", - "turtle": "https://github.githubassets.com/images/icons/emoji/unicode/1f422.png?v8", - "tuvalu": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fb.png?v8", - "tv": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fa.png?v8", - "twisted_rightwards_arrows": "https://github.githubassets.com/images/icons/emoji/unicode/1f500.png?v8", - "two": "https://github.githubassets.com/images/icons/emoji/unicode/0032-20e3.png?v8", - "two_hearts": "https://github.githubassets.com/images/icons/emoji/unicode/1f495.png?v8", - "two_men_holding_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f46c.png?v8", - "two_women_holding_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f46d.png?v8", - "u5272": "https://github.githubassets.com/images/icons/emoji/unicode/1f239.png?v8", - "u5408": "https://github.githubassets.com/images/icons/emoji/unicode/1f234.png?v8", - "u55b6": "https://github.githubassets.com/images/icons/emoji/unicode/1f23a.png?v8", - "u6307": "https://github.githubassets.com/images/icons/emoji/unicode/1f22f.png?v8", - "u6708": "https://github.githubassets.com/images/icons/emoji/unicode/1f237.png?v8", - "u6709": "https://github.githubassets.com/images/icons/emoji/unicode/1f236.png?v8", - "u6e80": "https://github.githubassets.com/images/icons/emoji/unicode/1f235.png?v8", - "u7121": "https://github.githubassets.com/images/icons/emoji/unicode/1f21a.png?v8", - "u7533": "https://github.githubassets.com/images/icons/emoji/unicode/1f238.png?v8", - "u7981": "https://github.githubassets.com/images/icons/emoji/unicode/1f232.png?v8", - "u7a7a": "https://github.githubassets.com/images/icons/emoji/unicode/1f233.png?v8", - "uganda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ec.png?v8", - "uk": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8", - "ukraine": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1e6.png?v8", - "umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/2614.png?v8", - "unamused": "https://github.githubassets.com/images/icons/emoji/unicode/1f612.png?v8", - "underage": "https://github.githubassets.com/images/icons/emoji/unicode/1f51e.png?v8", - "unicorn": "https://github.githubassets.com/images/icons/emoji/unicode/1f984.png?v8", - "united_arab_emirates": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ea.png?v8", - "united_nations": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f3.png?v8", - "unlock": "https://github.githubassets.com/images/icons/emoji/unicode/1f513.png?v8", - "up": "https://github.githubassets.com/images/icons/emoji/unicode/1f199.png?v8", - "upside_down_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f643.png?v8", - "uruguay": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1fe.png?v8", - "us": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f8.png?v8", - "us_outlying_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f2.png?v8", - "us_virgin_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ee.png?v8", - "uzbekistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ff.png?v8", - "v": "https://github.githubassets.com/images/icons/emoji/unicode/270c.png?v8", - "vampire": "https://github.githubassets.com/images/icons/emoji/unicode/1f9db.png?v8", - "vampire_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2642.png?v8", - "vampire_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2640.png?v8", - "vanuatu": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1fa.png?v8", - "vatican_city": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e6.png?v8", - "venezuela": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ea.png?v8", - "vertical_traffic_light": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a6.png?v8", - "vhs": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fc.png?v8", - "vibration_mode": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f3.png?v8", - "video_camera": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f9.png?v8", - "video_game": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ae.png?v8", - "vietnam": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1f3.png?v8", - "violin": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bb.png?v8", - "virgo": "https://github.githubassets.com/images/icons/emoji/unicode/264d.png?v8", - "volcano": "https://github.githubassets.com/images/icons/emoji/unicode/1f30b.png?v8", - "volleyball": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d0.png?v8", - "vomiting_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92e.png?v8", - "vs": "https://github.githubassets.com/images/icons/emoji/unicode/1f19a.png?v8", - "vulcan_salute": "https://github.githubassets.com/images/icons/emoji/unicode/1f596.png?v8", - "waffle": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c7.png?v8", - "wales": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0077-e006c-e0073-e007f.png?v8", - "walking": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b6.png?v8", - "walking_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2642.png?v8", - "walking_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2640.png?v8", - "wallis_futuna": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1eb.png?v8", - "waning_crescent_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f318.png?v8", - "waning_gibbous_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f316.png?v8", - "warning": "https://github.githubassets.com/images/icons/emoji/unicode/26a0.png?v8", - "wastebasket": "https://github.githubassets.com/images/icons/emoji/unicode/1f5d1.png?v8", - "watch": "https://github.githubassets.com/images/icons/emoji/unicode/231a.png?v8", - "water_buffalo": "https://github.githubassets.com/images/icons/emoji/unicode/1f403.png?v8", - "water_polo": "https://github.githubassets.com/images/icons/emoji/unicode/1f93d.png?v8", - "watermelon": "https://github.githubassets.com/images/icons/emoji/unicode/1f349.png?v8", - "wave": "https://github.githubassets.com/images/icons/emoji/unicode/1f44b.png?v8", - "wavy_dash": "https://github.githubassets.com/images/icons/emoji/unicode/3030.png?v8", - "waxing_crescent_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f312.png?v8", - "waxing_gibbous_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8", - "wc": "https://github.githubassets.com/images/icons/emoji/unicode/1f6be.png?v8", - "weary": "https://github.githubassets.com/images/icons/emoji/unicode/1f629.png?v8", - "wedding": "https://github.githubassets.com/images/icons/emoji/unicode/1f492.png?v8", - "weight_lifting": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cb.png?v8", - "weight_lifting_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2642.png?v8", - "weight_lifting_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2640.png?v8", - "western_sahara": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ed.png?v8", - "whale": "https://github.githubassets.com/images/icons/emoji/unicode/1f433.png?v8", - "whale2": "https://github.githubassets.com/images/icons/emoji/unicode/1f40b.png?v8", - "wheel_of_dharma": "https://github.githubassets.com/images/icons/emoji/unicode/2638.png?v8", - "wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/267f.png?v8", - "white_check_mark": "https://github.githubassets.com/images/icons/emoji/unicode/2705.png?v8", - "white_circle": "https://github.githubassets.com/images/icons/emoji/unicode/26aa.png?v8", - "white_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f3.png?v8", - "white_flower": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ae.png?v8", - "white_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b3.png?v8", - "white_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b3.png?v8", - "white_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f90d.png?v8", - "white_large_square": "https://github.githubassets.com/images/icons/emoji/unicode/2b1c.png?v8", - "white_medium_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fd.png?v8", - "white_medium_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fb.png?v8", - "white_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25ab.png?v8", - "white_square_button": "https://github.githubassets.com/images/icons/emoji/unicode/1f533.png?v8", - "wilted_flower": "https://github.githubassets.com/images/icons/emoji/unicode/1f940.png?v8", - "wind_chime": "https://github.githubassets.com/images/icons/emoji/unicode/1f390.png?v8", - "wind_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f32c.png?v8", - "window": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9f.png?v8", - "wine_glass": "https://github.githubassets.com/images/icons/emoji/unicode/1f377.png?v8", - "wink": "https://github.githubassets.com/images/icons/emoji/unicode/1f609.png?v8", - "wolf": "https://github.githubassets.com/images/icons/emoji/unicode/1f43a.png?v8", - "woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469.png?v8", - "woman_artist": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a8.png?v8", - "woman_astronaut": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f680.png?v8", - "woman_beard": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2640.png?v8", - "woman_cartwheeling": "https://github.githubassets.com/images/icons/emoji/unicode/1f938-2640.png?v8", - "woman_cook": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f373.png?v8", - "woman_dancing": "https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8", - "woman_facepalming": "https://github.githubassets.com/images/icons/emoji/unicode/1f926-2640.png?v8", - "woman_factory_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3ed.png?v8", - "woman_farmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f33e.png?v8", - "woman_feeding_baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f37c.png?v8", - "woman_firefighter": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f692.png?v8", - "woman_health_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2695.png?v8", - "woman_in_manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bd.png?v8", - "woman_in_motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bc.png?v8", - "woman_in_tuxedo": "https://github.githubassets.com/images/icons/emoji/unicode/1f935-2640.png?v8", - "woman_judge": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2696.png?v8", - "woman_juggling": "https://github.githubassets.com/images/icons/emoji/unicode/1f939-2640.png?v8", - "woman_mechanic": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f527.png?v8", - "woman_office_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bc.png?v8", - "woman_pilot": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2708.png?v8", - "woman_playing_handball": "https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2640.png?v8", - "woman_playing_water_polo": "https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2640.png?v8", - "woman_scientist": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f52c.png?v8", - "woman_shrugging": "https://github.githubassets.com/images/icons/emoji/unicode/1f937-2640.png?v8", - "woman_singer": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a4.png?v8", - "woman_student": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f393.png?v8", - "woman_teacher": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3eb.png?v8", - "woman_technologist": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bb.png?v8", - "woman_with_headscarf": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d5.png?v8", - "woman_with_probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9af.png?v8", - "woman_with_turban": "https://github.githubassets.com/images/icons/emoji/unicode/1f473-2640.png?v8", - "woman_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8", - "womans_clothes": "https://github.githubassets.com/images/icons/emoji/unicode/1f45a.png?v8", - "womans_hat": "https://github.githubassets.com/images/icons/emoji/unicode/1f452.png?v8", - "women_wrestling": "https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2640.png?v8", - "womens": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ba.png?v8", - "wood": "https://github.githubassets.com/images/icons/emoji/unicode/1fab5.png?v8", - "woozy_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f974.png?v8", - "world_map": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fa.png?v8", - "worm": "https://github.githubassets.com/images/icons/emoji/unicode/1fab1.png?v8", - "worried": "https://github.githubassets.com/images/icons/emoji/unicode/1f61f.png?v8", - "wrench": "https://github.githubassets.com/images/icons/emoji/unicode/1f527.png?v8", - "wrestling": "https://github.githubassets.com/images/icons/emoji/unicode/1f93c.png?v8", - "writing_hand": "https://github.githubassets.com/images/icons/emoji/unicode/270d.png?v8", - "x": "https://github.githubassets.com/images/icons/emoji/unicode/274c.png?v8", - "yarn": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f6.png?v8", - "yawning_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f971.png?v8", - "yellow_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e1.png?v8", - "yellow_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49b.png?v8", - "yellow_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e8.png?v8", - "yemen": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1ea.png?v8", - "yen": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b4.png?v8", - "yin_yang": "https://github.githubassets.com/images/icons/emoji/unicode/262f.png?v8", - "yo_yo": "https://github.githubassets.com/images/icons/emoji/unicode/1fa80.png?v8", - "yum": "https://github.githubassets.com/images/icons/emoji/unicode/1f60b.png?v8", - "zambia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1f2.png?v8", - "zany_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92a.png?v8", - "zap": "https://github.githubassets.com/images/icons/emoji/unicode/26a1.png?v8", - "zebra": "https://github.githubassets.com/images/icons/emoji/unicode/1f993.png?v8", - "zero": "https://github.githubassets.com/images/icons/emoji/unicode/0030-20e3.png?v8", - "zimbabwe": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1fc.png?v8", - "zipper_mouth_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f910.png?v8", - "zombie": "https://github.githubassets.com/images/icons/emoji/unicode/1f9df.png?v8", - "zombie_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8", - "zombie_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8", - "zzz": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8" - }, - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/enterprise-admin.json b/src/rest/data/ghes-3.14-2022-11-28/enterprise-admin.json deleted file mode 100644 index b54041d9bb45..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/enterprise-admin.json +++ /dev/null @@ -1,18349 +0,0 @@ -{ - "admin-stats": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/stats/all", - "title": "Get all statistics", - "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "repos": { - "total_repos": 212, - "root_repos": 194, - "fork_repos": 18, - "org_repos": 51, - "total_pushes": 3082, - "total_wikis": 15 - }, - "hooks": { - "total_hooks": 27, - "active_hooks": 23, - "inactive_hooks": 4 - }, - "pages": { - "total_pages": 36 - }, - "orgs": { - "total_orgs": 33, - "disabled_orgs": 0, - "total_teams": 60, - "total_team_members": 314 - }, - "users": { - "total_users": 254, - "admin_users": 45, - "suspended_users": 21 - }, - "pulls": { - "total_pulls": 86, - "merged_pulls": 60, - "mergeable_pulls": 21, - "unmergeable_pulls": 3 - }, - "issues": { - "total_issues": 179, - "open_issues": 83, - "closed_issues": 96 - }, - "milestones": { - "total_milestones": 7, - "open_milestones": 6, - "closed_milestones": 1 - }, - "gists": { - "total_gists": 178, - "private_gists": 151, - "public_gists": 25 - }, - "comments": { - "total_commit_comments": 6, - "total_gist_comments": 28, - "total_issue_comments": 366, - "total_pull_request_comments": 30 - } - }, - "schema": { - "type": "object", - "properties": { - "repos": { - "title": "Repository Enterprise Stats", - "type": "object", - "properties": { - "total_repos": { - "type": "integer" - }, - "root_repos": { - "type": "integer" - }, - "fork_repos": { - "type": "integer" - }, - "org_repos": { - "type": "integer" - }, - "total_pushes": { - "type": "integer" - }, - "total_wikis": { - "type": "integer" - } - }, - "required": [ - "total_repos", - "root_repos", - "fork_repos", - "org_repos", - "total_pushes", - "total_wikis" - ] - }, - "hooks": { - "title": "Hooks Enterprise Stats", - "type": "object", - "properties": { - "total_hooks": { - "type": "integer" - }, - "active_hooks": { - "type": "integer" - }, - "inactive_hooks": { - "type": "integer" - } - }, - "required": [ - "total_hooks", - "active_hooks", - "inactive_hooks" - ] - }, - "pages": { - "title": "Enterprise Pages Stats", - "type": "object", - "properties": { - "total_pages": { - "type": "integer" - } - }, - "required": [ - "total_pages" - ] - }, - "orgs": { - "title": "Enterprise Organization Stats", - "type": "object", - "properties": { - "total_orgs": { - "type": "integer" - }, - "disabled_orgs": { - "type": "integer" - }, - "total_teams": { - "type": "integer" - }, - "total_team_members": { - "type": "integer" - } - }, - "required": [ - "total_orgs", - "disabled_orgs", - "total_teams", - "total_team_members" - ] - }, - "users": { - "title": "Enterprise User Stats", - "type": "object", - "properties": { - "total_users": { - "type": "integer" - }, - "admin_users": { - "type": "integer" - }, - "suspended_users": { - "type": "integer" - } - }, - "required": [ - "total_users", - "admin_users", - "suspended_users" - ] - }, - "pulls": { - "title": "Enterprise Pull Request Stats", - "type": "object", - "properties": { - "total_pulls": { - "type": "integer" - }, - "merged_pulls": { - "type": "integer" - }, - "mergeable_pulls": { - "type": "integer" - }, - "unmergeable_pulls": { - "type": "integer" - } - }, - "required": [ - "total_pulls", - "merged_pulls", - "mergeable_pulls", - "unmergeable_pulls" - ] - }, - "issues": { - "title": "Enterprise Issue Stats", - "type": "object", - "properties": { - "total_issues": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - } - }, - "required": [ - "total_issues", - "open_issues", - "closed_issues" - ] - }, - "milestones": { - "title": "Enterprise Milestone Stats", - "type": "object", - "properties": { - "total_milestones": { - "type": "integer" - }, - "open_milestones": { - "type": "integer" - }, - "closed_milestones": { - "type": "integer" - } - }, - "required": [ - "total_milestones", - "open_milestones", - "closed_milestones" - ] - }, - "gists": { - "title": "Enterprise Gist Stats", - "type": "object", - "properties": { - "total_gists": { - "type": "integer" - }, - "private_gists": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - } - }, - "required": [ - "total_gists", - "private_gists", - "public_gists" - ] - }, - "comments": { - "title": "Enterprise Comment Stats", - "type": "object", - "properties": { - "total_commit_comments": { - "type": "integer" - }, - "total_gist_comments": { - "type": "integer" - }, - "total_issue_comments": { - "type": "integer" - }, - "total_pull_request_comments": { - "type": "integer" - } - }, - "required": [ - "total_commit_comments", - "total_gist_comments", - "total_issue_comments", - "total_pull_request_comments" - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/stats/comments", - "title": "Get comment statistics", - "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_commit_comments": 5000, - "total_gist_comments": 400, - "total_issue_comments": 10900, - "total_pull_request_comments": 9900 - }, - "schema": { - "title": "Enterprise Comment Stats", - "type": "object", - "properties": { - "total_commit_comments": { - "type": "integer" - }, - "total_gist_comments": { - "type": "integer" - }, - "total_issue_comments": { - "type": "integer" - }, - "total_pull_request_comments": { - "type": "integer" - } - }, - "required": [ - "total_commit_comments", - "total_gist_comments", - "total_issue_comments", - "total_pull_request_comments" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/stats/gists", - "title": "Get gist statistics", - "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_gists": 500, - "private_gists": 30, - "public_gists": 470 - }, - "schema": { - "title": "Enterprise Gist Stats", - "type": "object", - "properties": { - "total_gists": { - "type": "integer" - }, - "private_gists": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - } - }, - "required": [ - "total_gists", - "private_gists", - "public_gists" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/stats/hooks", - "title": "Get hooks statistics", - "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_hooks": 50, - "active_hooks": 47, - "inactive_hooks": 3 - }, - "schema": { - "title": "Hooks Enterprise Stats", - "type": "object", - "properties": { - "total_hooks": { - "type": "integer" - }, - "active_hooks": { - "type": "integer" - }, - "inactive_hooks": { - "type": "integer" - } - }, - "required": [ - "total_hooks", - "active_hooks", - "inactive_hooks" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/stats/issues", - "title": "Get issue statistics", - "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_issues": 5000, - "open_issues": 300, - "closed_issues": 4700 - }, - "schema": { - "title": "Enterprise Issue Stats", - "type": "object", - "properties": { - "total_issues": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - } - }, - "required": [ - "total_issues", - "open_issues", - "closed_issues" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/stats/milestones", - "title": "Get milestone statistics", - "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_milestones": 90, - "open_milestones": 10, - "closed_milestones": 80 - }, - "schema": { - "title": "Enterprise Milestone Stats", - "type": "object", - "properties": { - "total_milestones": { - "type": "integer" - }, - "open_milestones": { - "type": "integer" - }, - "closed_milestones": { - "type": "integer" - } - }, - "required": [ - "total_milestones", - "open_milestones", - "closed_milestones" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/stats/orgs", - "title": "Get organization statistics", - "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_orgs": 50, - "disabled_orgs": 1, - "total_teams": 70, - "total_team_members": 700 - }, - "schema": { - "title": "Enterprise Organization Stats", - "type": "object", - "properties": { - "total_orgs": { - "type": "integer" - }, - "disabled_orgs": { - "type": "integer" - }, - "total_teams": { - "type": "integer" - }, - "total_team_members": { - "type": "integer" - } - }, - "required": [ - "total_orgs", - "disabled_orgs", - "total_teams", - "total_team_members" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/stats/pages", - "title": "Get pages statistics", - "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_pages": 20 - }, - "schema": { - "title": "Enterprise Pages Stats", - "type": "object", - "properties": { - "total_pages": { - "type": "integer" - } - }, - "required": [ - "total_pages" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/stats/pulls", - "title": "Get pull request statistics", - "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_pulls": 1200, - "merged_pulls": 1100, - "mergeable_pulls": 90, - "unmergeable_pulls": 10 - }, - "schema": { - "title": "Enterprise Pull Request Stats", - "type": "object", - "properties": { - "total_pulls": { - "type": "integer" - }, - "merged_pulls": { - "type": "integer" - }, - "mergeable_pulls": { - "type": "integer" - }, - "unmergeable_pulls": { - "type": "integer" - } - }, - "required": [ - "total_pulls", - "merged_pulls", - "mergeable_pulls", - "unmergeable_pulls" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/stats/repos", - "title": "Get repository statistics", - "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_repos": 200, - "root_repos": 1, - "fork_repos": 10, - "org_repos": 150, - "total_pushes": 39000, - "total_wikis": 5 - }, - "schema": { - "title": "Repository Enterprise Stats", - "type": "object", - "properties": { - "total_repos": { - "type": "integer" - }, - "root_repos": { - "type": "integer" - }, - "fork_repos": { - "type": "integer" - }, - "org_repos": { - "type": "integer" - }, - "total_pushes": { - "type": "integer" - }, - "total_wikis": { - "type": "integer" - } - }, - "required": [ - "total_repos", - "root_repos", - "fork_repos", - "org_repos", - "total_pushes", - "total_wikis" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/stats/security-products", - "title": "Get security products statistics", - "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Gets the statistics about security products for a GitHub Enterprise Server instance.

\n

To use this endpoint, you must be a site admin.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_repos": 150, - "nonarchived_repos": 130, - "secret_scanning_enabled_repos": 150, - "secret_scanning_push_protection_enabled_repos": 120, - "code_scanning_enabled_repos": 140, - "code_scanning_pr_reviews_enabled_repos": 100, - "code_scanning_default_setup_enabled_repos": 50, - "code_scanning_default_setup_eligible_repos": 30, - "dependabot_alerts_enabled_repos": 130, - "dependabot_security_updates_enabled_repos": 120, - "dependabot_version_updates_enabled_repos": 121, - "advanced_security_enabled_repos": 150, - "active_committers": 30, - "purchased_committers": 90, - "maximum_committers": 80 - }, - "schema": { - "title": "Enterprise Security Products Stats", - "type": "object", - "properties": { - "total_repos": { - "type": "integer" - }, - "nonarchived_repos": { - "type": "integer" - }, - "secret_scanning_enabled_repos": { - "type": "integer" - }, - "secret_scanning_push_protection_enabled_repos": { - "type": "integer" - }, - "code_scanning_enabled_repos": { - "type": "integer" - }, - "code_scanning_pr_reviews_enabled_repos": { - "type": "integer" - }, - "code_scanning_default_setup_enabled_repos": { - "type": "integer" - }, - "code_scanning_default_setup_eligible_repos": { - "type": "integer" - }, - "dependabot_alerts_enabled_repos": { - "type": "integer" - }, - "dependabot_security_updates_enabled_repos": { - "type": "integer" - }, - "dependabot_version_updates_enabled_repos": { - "type": "integer" - }, - "advanced_security_enabled_repos": { - "type": "integer" - }, - "active_committers": { - "type": "integer" - }, - "purchased_committers": { - "type": "integer" - }, - "maximum_committers": { - "type": "integer" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/stats/users", - "title": "Get users statistics", - "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_users": 100, - "admin_users": 3, - "suspended_users": 1 - }, - "schema": { - "title": "Enterprise User Stats", - "type": "object", - "properties": { - "total_users": { - "type": "integer" - }, - "admin_users": { - "type": "integer" - }, - "suspended_users": { - "type": "integer" - } - }, - "required": [ - "total_users", - "admin_users", - "suspended_users" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ], - "announcement": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/announcement", - "title": "Get the global announcement banner", - "category": "enterprise-admin", - "subcategory": "announcement", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Gets the current message and expiration date of the global announcement banner in your enterprise.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Announcement banner

", - "example": { - "announcement": "Very **important** announcement about _something_.", - "expires_at": "2021-01-01T00:00:00.000+00:00", - "user_dismissible": false - }, - "schema": { - "title": "Enterprise Announcement", - "description": "Enterprise global announcement", - "type": "object", - "properties": { - "announcement": { - "type": [ - "string", - "null" - ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.14/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string." - }, - "user_dismissible": { - "type": [ - "boolean", - "null" - ], - "description": "Whether an announcement can be dismissed by the user.", - "default": false - } - }, - "required": [ - "announcement" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/enterprise/announcement", - "title": "Set the global announcement banner", - "category": "enterprise-admin", - "subcategory": "announcement", - "parameters": [], - "bodyParameters": [ - { - "type": "string or null", - "name": "announcement", - "description": "

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

", - "isRequired": true - }, - { - "type": "string or null", - "name": "expires_at", - "description": "

The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

" - }, - { - "type": "boolean or null", - "name": "user_dismissible", - "description": "

Whether an announcement can be dismissed by the user.

", - "default": false - } - ], - "descriptionHTML": "

Sets the message and expiration time for the global announcement banner in your enterprise.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "announcement": "Very **important** announcement about _something_.", - "expires_at": "2021-01-01T00:00:00.000+00:00" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Announcement banner

", - "example": { - "announcement": "Very **important** announcement about _something_.", - "expires_at": "2021-01-01T00:00:00.000+00:00", - "user_dismissible": false - }, - "schema": { - "title": "Enterprise Announcement", - "description": "Enterprise global announcement", - "type": "object", - "properties": { - "announcement": { - "type": [ - "string", - "null" - ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.14/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string." - }, - "user_dismissible": { - "type": [ - "boolean", - "null" - ], - "description": "Whether an announcement can be dismissed by the user.", - "default": false - } - }, - "required": [ - "announcement" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/enterprise/announcement", - "title": "Remove the global announcement banner", - "category": "enterprise-admin", - "subcategory": "announcement", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Removes the global announcement banner in your enterprise.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ], - "audit-log": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/audit-log", - "title": "Get the audit log for an enterprise", - "category": "enterprise-admin", - "subcategory": "audit-log", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "phrase", - "description": "

A search phrase. For more information, see Searching the audit log.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "include", - "description": "

The event types to include:

\n
    \n
  • web - returns web (non-Git) events.
    • \n
  • git - returns Git events.
    • \n
  • all - returns both web and Git events.
    • \n
\n

The default is web.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "web", - "git", - "all" - ] - } - }, - { - "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "order", - "description": "

The order of audit log events. To list newest events first, specify desc. To list oldest events first, specify asc.

\n

The default is desc.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "desc", - "asc" - ] - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the audit log for an enterprise.

\n

The authenticated user must be an enterprise admin to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "actor_ip": "88.123.45.123", - "from": "pull_requests#merge", - "device_cookie": null, - "actor": "mona-admin", - "actor_id": 7, - "repo": "octo-org/octo-repo", - "repo_id": 17, - "business": "github", - "business_id": 1, - "org": "octo-org", - "org_id": 8, - "action": "pull_request.merge", - "@timestamp": 1635940599755, - "created_at": 1635940599755, - "operation_type": "modify", - "actor_location": { - "country_code": "GB", - "country_name": "United Kingdom", - "region": "ENG", - "region_name": "England", - "city": "Louth", - "postal_code": "LN11", - "location": { - "lat": 53.4457, - "lon": 0.141 - } - }, - "data": { - "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", - "method": "POST", - "request_id": "e4dabc4d-ba16-4bca-1234-649be7ae1188", - "server_id": "5d17aab5-fd9f-abcd-a820-16bed246441b", - "request_category": "other", - "controller_action": "merge", - "url": "https://example.com/octo-org/octo-repo/pull/1/merge", - "client_id": 322299977.1635936, - "referrer": "https://example.com/octo-org/octo-repo/pull/1", - "actor_session": 1, - "pull_request_id": 1, - "category_type": "Resource Management" - } - }, - { - "actor_ip": "88.123.45.123", - "from": "pull_request_review_events#create", - "device_cookie": null, - "actor": "mona-admin", - "actor_id": 7, - "business_id": 1, - "org_id": 8, - "action": "pull_request_review.submit", - "@timestamp": 1635940593079, - "created_at": 1635940593079, - "operation_type": "modify", - "actor_location": { - "country_code": "GB", - "country_name": "United Kingdom", - "region": "ENG", - "region_name": "England", - "city": "Louth", - "postal_code": "LN11", - "location": { - "lat": 53.4457, - "lon": 0.141 - } - }, - "data": { - "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", - "method": "PUT", - "request_id": "c0f63bb7-17b6-4796-940c-12345c5a581b", - "server_id": "2abc1234-f651-43e3-9696-e942ad5f8c89", - "request_category": "other", - "controller_action": "create", - "url": "https://example.com/octo-org/octo-repo/pull/1/reviews", - "client_id": 322299977.1635936, - "referrer": "https://example.com/octo-org/octo-repo/pull/1/files", - "actor_session": 1, - "spammy": false, - "pull_request_id": 1, - "body": null, - "allowed": true, - "id": 1, - "state": 40, - "issue_id": 1, - "review_id": 1, - "category_type": "Resource Management" - } - }, - { - "actor_ip": "88.123.45.123", - "from": "pull_requests#create", - "device_cookie": null, - "actor": "mona", - "actor_id": 9, - "user_id": 9, - "repo": "octo-org/octo-repo", - "repo_id": 17, - "business": "github", - "business_id": 1, - "org": "octo-org", - "org_id": 8, - "action": "pull_request.create", - "@timestamp": 1635940554161, - "created_at": 1635940554161, - "operation_type": "create", - "actor_location": { - "country_code": "GB", - "country_name": "United Kingdom", - "region": "ENG", - "region_name": "England", - "city": "Louth", - "postal_code": "LN11", - "location": { - "lat": 53.4457, - "lon": 0.141 - } - }, - "data": { - "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", - "method": "POST", - "request_id": "2773abeb-477f-4ebf-a017-f8e8a206c305", - "server_id": "796e3115-4ce8-4606-8fd0-99ea57a2e12b", - "request_category": "other", - "controller_action": "create", - "url": "https://example.com/octo-org/octo-repo/pull/create?base=octo-org%3Amain&head=mona%3Apatch-1", - "client_id": 386351111.163594, - "referrer": "https://example.com/octo-org/octo-repo/compare/main...mona:patch-1", - "actor_session": 2, - "pull_request_id": 1, - "category_type": "Resource Management" - } - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "@timestamp": { - "type": "integer", - "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." - }, - "action": { - "type": "string", - "description": "The name of the action that was performed, for example `user.login` or `repo.create`." - }, - "active": { - "type": "boolean" - }, - "active_was": { - "type": "boolean" - }, - "actor": { - "type": "string", - "description": "The actor who performed the action." - }, - "actor_id": { - "type": "integer", - "description": "The id of the actor who performed the action." - }, - "actor_location": { - "type": "object", - "properties": { - "country_name": { - "type": "string" - } - } - }, - "data": { - "type": "object", - "additionalProperties": true - }, - "org_id": { - "type": "integer" - }, - "user_id": { - "type": "integer" - }, - "business_id": { - "type": "integer" - }, - "blocked_user": { - "type": "string", - "description": "The username of the account being blocked." - }, - "business": { - "type": "string" - }, - "config": { - "type": "array", - "items": { - "type": "object" - } - }, - "config_was": { - "type": "array", - "items": { - "type": "object" - } - }, - "content_type": { - "type": "string" - }, - "operation_type": { - "type": "string" - }, - "created_at": { - "type": "integer", - "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." - }, - "deploy_key_fingerprint": { - "type": "string" - }, - "_document_id": { - "type": "string", - "description": "A unique identifier for an audit event." - }, - "emoji": { - "type": "string" - }, - "events": { - "type": "array", - "items": { - "type": "object" - } - }, - "events_were": { - "type": "array", - "items": { - "type": "object" - } - }, - "explanation": { - "type": "string" - }, - "fingerprint": { - "type": "string" - }, - "hook_id": { - "type": "integer" - }, - "limited_availability": { - "type": "boolean" - }, - "message": { - "type": "string" - }, - "name": { - "type": "string" - }, - "old_user": { - "type": "string" - }, - "openssh_public_key": { - "type": "string" - }, - "org": { - "type": "string" - }, - "previous_visibility": { - "type": "string" - }, - "read_only": { - "type": "boolean" - }, - "repo": { - "type": "string", - "description": "The name of the repository." - }, - "repository": { - "type": "string", - "description": "The name of the repository." - }, - "repository_public": { - "type": "boolean" - }, - "target_login": { - "type": "string" - }, - "team": { - "type": "string" - }, - "transport_protocol": { - "type": "integer", - "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." - }, - "transport_protocol_name": { - "type": "string", - "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." - }, - "user": { - "type": "string", - "description": "The user that was affected by the action performed (if available)." - }, - "visibility": { - "type": "string", - "description": "The repository visibility, for example `public` or `private`." - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise administration\" enterprise permissions": "read" - } - ], - "disabledForPatV2": true - } - } - ], - "code-security-and-analysis": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/code_security_and_analysis", - "title": "Get code security and analysis features for an enterprise", - "category": "enterprise-admin", - "subcategory": "code-security-and-analysis", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets code security and analysis settings for the specified enterprise.

\n

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "advanced_security_enabled_for_new_repositories": true, - "dependabot_alerts_enabled_for_new_repositories": true, - "secret_scanning_enabled_for_new_repositories": true, - "secret_scanning_push_protection_enabled_for_new_repositories": true, - "secret_scanning_push_protection_custom_link": "https://github.com/test-org/test-repo/blob/main/README.md" - }, - "schema": { - "title": "Enterprise Security Analysis Settings", - "type": "object", - "properties": { - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to\nthis enterprise." - }, - "advanced_security_enabled_for_new_user_namespace_repositories": { - "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new user namespace repositories." - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this\nenterprise." - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\nenterprise." - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this enterprise." - }, - "secret_scanning_push_protection_custom_link": { - "type": [ - "string", - "null" - ], - "description": "An optional URL string to display to contributors who are blocked from pushing a secret." - } - }, - "required": [ - "advanced_security_enabled_for_new_repositories", - "dependabot_alerts_enabled_for_new_repositories", - "secret_scanning_enabled_for_new_repositories", - "secret_scanning_push_protection_enabled_for_new_repositories" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/enterprises/{enterprise}/code_security_and_analysis", - "title": "Update code security and analysis features for an enterprise", - "category": "enterprise-admin", - "subcategory": "code-security-and-analysis", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "advanced_security_enabled_for_new_repositories", - "description": "

Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"About GitHub Advanced Security.\"

" - }, - { - "type": "boolean", - "name": "advanced_security_enabled_new_user_namespace_repos", - "description": "

Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see \"About GitHub Advanced Security.\"

" - }, - { - "type": "boolean", - "name": "dependabot_alerts_enabled_for_new_repositories", - "description": "

Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"About Dependabot alerts.\"

" - }, - { - "type": "boolean", - "name": "secret_scanning_enabled_for_new_repositories", - "description": "

Whether secret scanning is automatically enabled for new repositories. For more information, see \"About secret scanning.\"

" - }, - { - "type": "boolean", - "name": "secret_scanning_push_protection_enabled_for_new_repositories", - "description": "

Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"Protecting pushes with secret scanning.\"

" - }, - { - "type": "string or null", - "name": "secret_scanning_push_protection_custom_link", - "description": "

The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"Protecting pushes with secret scanning.\"\nTo disable this functionality, set this field to null.

" - } - ], - "descriptionHTML": "

Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.

\n

The authenticated user must be an administrator of the enterprise to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "advanced_security_enabled_for_new_repositories": true, - "advanced_security_enabled_new_user_namespace_repos": true, - "dependabot_alerts_enabled_for_new_repositories": true, - "secret_scanning_enabled_for_new_repositories": true, - "secret_scanning_push_protection_enabled_for_new_repositories": true, - "secret_scanning_push_protection_custom_link": "https://github.com/test-org/test-repo/blob/main/README.md" - }, - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "204", - "description": "

Action started

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Action started

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

The action could not be taken due to an in progress enablement, or a policy is preventing enablement

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/enterprises/{enterprise}/{security_product}/{enablement}", - "title": "Enable or disable a security feature", - "category": "enterprise-admin", - "subcategory": "code-security-and-analysis", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "security_product", - "in": "path", - "description": "

The security feature to enable or disable.

", - "required": true, - "schema": { - "type": "string", - "enum": [ - "advanced_security", - "advanced_security_user_namespace", - "dependabot_alerts", - "secret_scanning", - "secret_scanning_push_protection" - ] - } - }, - { - "name": "enablement", - "in": "path", - "description": "

The action to take.

\n

enable_all means to enable the specified security feature for all repositories in the enterprise.\ndisable_all means to disable the specified security feature for all repositories in the enterprise.

", - "required": true, - "schema": { - "type": "string", - "enum": [ - "enable_all", - "disable_all" - ] - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Enables or disables the specified security feature for all repositories in an enterprise.

\n

The authenticated user must be an administrator of the enterprise to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "security_product": "SECURITY_PRODUCT", - "enablement": "ENABLEMENT" - } - }, - "response": { - "statusCode": "204", - "description": "

Action started

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Action started

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

The action could not be taken due to an in progress enablement, or a policy is preventing enablement

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ], - "global-webhooks": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/admin/hooks", - "title": "List global webhooks", - "category": "enterprise-admin", - "subcategory": "global-webhooks", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "type": "Global", - "id": 1, - "name": "web", - "active": true, - "events": [ - "organization", - "user" - ], - "config": { - "url": "https://example.com", - "content_type": "json", - "insecure_ssl": "0", - "secret": "********" - }, - "updated_at": "2017-12-07T00:14:59Z", - "created_at": "2017-12-07T00:14:59Z", - "url": "https://api.github.com/admin/hooks/1", - "ping_url": "https://api.github.com/admin/hooks/1/pings" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "content_type": { - "type": "string" - }, - "insecure_ssl": { - "type": "string" - }, - "secret": { - "type": "string" - } - } - }, - "updated_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "ping_url": { - "type": "string" - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/admin/hooks", - "title": "Create a global webhook", - "category": "enterprise-admin", - "subcategory": "global-webhooks", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

Must be passed as \"web\".

", - "isRequired": true - }, - { - "type": "object", - "name": "config", - "description": "

Key/value pairs to provide settings for this webhook.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL to which the payloads will be delivered.

", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

" - }, - { - "type": "string", - "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

" - }, - { - "type": "string", - "name": "insecure_ssl", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

" - }, - { - "type": "boolean", - "name": "active", - "description": "

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

", - "default": true - } - ], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "web", - "events": [ - "organization", - "user" - ], - "config": { - "url": "https://example.com/webhook", - "content_type": "json", - "secret": "secret" - } - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "type": "Global", - "id": 1, - "name": "web", - "active": true, - "events": [ - "organization", - "user" - ], - "config": { - "url": "https://example.com", - "content_type": "json", - "insecure_ssl": "0", - "secret": "********" - }, - "updated_at": "2017-12-07T00:14:59Z", - "created_at": "2017-12-07T00:14:59Z", - "url": "https://api.github.com/admin/hooks/1", - "ping_url": "https://api.github.com/admin/hooks/1/pings" - }, - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "content_type": { - "type": "string" - }, - "insecure_ssl": { - "type": "string" - }, - "secret": { - "type": "string" - } - } - }, - "updated_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "ping_url": { - "type": "string" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/admin/hooks/{hook_id}", - "title": "Get a global webhook", - "category": "enterprise-admin", - "subcategory": "global-webhooks", - "parameters": [ - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "type": "Global", - "id": 1, - "name": "web", - "active": true, - "events": [ - "organization", - "user" - ], - "config": { - "url": "https://example.com", - "content_type": "json", - "insecure_ssl": "0", - "secret": "********" - }, - "updated_at": "2017-12-07T00:14:59Z", - "created_at": "2017-12-07T00:14:59Z", - "url": "https://api.github.com/admin/hooks/1", - "ping_url": "https://api.github.com/admin/hooks/1/pings" - }, - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "content_type": { - "type": "string" - }, - "insecure_ssl": { - "type": "string" - }, - "secret": { - "type": "string" - } - } - }, - "updated_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "ping_url": { - "type": "string" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/admin/hooks/{hook_id}", - "title": "Update a global webhook", - "category": "enterprise-admin", - "subcategory": "global-webhooks", - "parameters": [ - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "object", - "name": "config", - "description": "

Key/value pairs to provide settings for this webhook.

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL to which the payloads will be delivered.

", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

" - }, - { - "type": "string", - "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

" - }, - { - "type": "string", - "name": "insecure_ssl", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

" - }, - { - "type": "boolean", - "name": "active", - "description": "

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

", - "default": true - } - ], - "descriptionHTML": "

Parameters that are not provided will be overwritten with the default value or removed if no default exists.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "events": [ - "organization" - ], - "config": { - "url": "https://example.com/webhook" - } - }, - "parameters": { - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "type": "Global", - "id": 1, - "name": "web", - "active": true, - "events": [ - "organization" - ], - "config": { - "url": "https://example.com", - "content_type": "form", - "insecure_ssl": "0" - }, - "updated_at": "2017-12-07T00:14:59Z", - "created_at": "2017-12-07T00:14:59Z", - "url": "https://api.github.com/admin/hooks/1", - "ping_url": "https://api.github.com/admin/hooks/1/pings" - }, - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "content_type": { - "type": "string" - }, - "insecure_ssl": { - "type": "string" - } - } - }, - "updated_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "ping_url": { - "type": "string" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/admin/hooks/{hook_id}", - "title": "Delete a global webhook", - "category": "enterprise-admin", - "subcategory": "global-webhooks", - "parameters": [ - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/admin/hooks/{hook_id}/pings", - "title": "Ping a global webhook", - "category": "enterprise-admin", - "subcategory": "global-webhooks", - "parameters": [ - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

This will trigger a ping event to be sent to the webhook.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ], - "ldap": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/admin/ldap/teams/{team_id}/mapping", - "title": "Update LDAP mapping for a team", - "category": "enterprise-admin", - "subcategory": "ldap", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "ldap_dn", - "description": "

The distinguished name (DN) of the LDAP entry to map to a team.

", - "isRequired": true - } - ], - "descriptionHTML": "

Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - }, - "parameters": { - "team_id": "TEAM_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com", - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - }, - "schema": { - "type": "object", - "properties": { - "ldap_dn": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string" - }, - "parent": { - "type": [ - "null" - ] - }, - "type": { - "type": "string" - }, - "organization_id": { - "type": "integer" - }, - "enterprise_id": { - "type": "integer" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/admin/ldap/teams/{team_id}/sync", - "title": "Sync LDAP mapping for a team", - "category": "enterprise-admin", - "subcategory": "ldap", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "team_id": "TEAM_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "status": "queued" - }, - "schema": { - "type": "object", - "properties": { - "status": { - "type": "string" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/admin/ldap/users/{username}/mapping", - "title": "Update LDAP mapping for a user", - "category": "enterprise-admin", - "subcategory": "ldap", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "ldap_dn", - "description": "

The distinguished name (DN) of the LDAP entry to map to a team.

", - "isRequired": true - } - ], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" - }, - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com", - "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, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z", - "private_gists": 81, - "total_private_repos": 100, - "owned_private_repos": 100, - "disk_usage": 10000, - "collaborators": 8, - "two_factor_authentication": true, - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "collaborators": 0 - } - }, - "schema": { - "title": "Ldap Private User", - "description": "Ldap Private User", - "type": "object", - "properties": { - "ldap_dn": { - "type": "string" - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "type": "integer" - }, - "two_factor_authentication": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "suspended_at": { - "type": "string", - "format": "date-time" - }, - "business_plus": { - "type": "boolean" - }, - "user_view_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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at", - "collaborators", - "disk_usage", - "owned_private_repos", - "private_gists", - "total_private_repos", - "two_factor_authentication" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/admin/ldap/users/{username}/sync", - "title": "Sync LDAP mapping for a user", - "category": "enterprise-admin", - "subcategory": "ldap", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "status": "queued" - }, - "schema": { - "type": "object", - "properties": { - "status": { - "type": "string" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ], - "licensing": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/settings/license", - "title": "Get license information", - "category": "enterprise-admin", - "subcategory": "licensing", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "seats": 1400, - "seats_used": 1316, - "seats_available": 84, - "kind": "standard", - "days_until_expiration": 365, - "expire_at": "2016/02/06 12:41:52 -0600" - }, - "schema": { - "type": "object", - "properties": { - "seats": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - }, - "seats_used": { - "type": "integer" - }, - "seats_available": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - }, - "kind": { - "type": "string" - }, - "days_until_expiration": { - "type": "integer" - }, - "expire_at": { - "type": "string" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/settings/billing/advanced-security", - "title": "Get GitHub Advanced Security active committers for an enterprise", - "category": "enterprise-admin", - "subcategory": "licensing", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the GitHub Advanced Security active committers for an enterprise per repository. The authenticated user must be an enterprise admin or billing manager.

\n

Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.

\n

The total number of repositories with committer information is tracked by the total_count field.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Success

", - "example": { - "total_advanced_security_committers": 2, - "total_count": 2, - "maximum_advanced_security_committers": 4, - "purchased_advanced_security_committers": 4, - "repositories": [ - { - "name": "octocat-org/Hello-World", - "advanced_security_committers": 2, - "advanced_security_committers_breakdown": [ - { - "user_login": "octocat", - "last_pushed_date": "2021-11-03", - "last_pushed_email": "octocat@github.com" - }, - { - "user_login": "octokitten", - "last_pushed_date": "2021-10-25", - "last_pushed_email": "octokitten@github.com" - } - ] - }, - { - "name": "octocat-org/server", - "advanced_security_committers": 1, - "advanced_security_committers_breakdown": [ - { - "user_login": "octokitten", - "last_pushed_date": "2021-10-26", - "last_pushed_email": "octokitten@github.com" - } - ] - } - ] - }, - "schema": { - "type": "object", - "properties": { - "total_advanced_security_committers": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "maximum_advanced_security_committers": { - "type": "integer", - "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security" - }, - "purchased_advanced_security_committers": { - "type": "integer", - "description": "The total number of GitHub Advanced Security licences purchased" - }, - "repositories": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "advanced_security_committers": { - "type": "integer" - }, - "advanced_security_committers_breakdown": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user_login": { - "type": "string" - }, - "last_pushed_date": { - "type": "string" - }, - "last_pushed_email": { - "type": "string" - } - }, - "required": [ - "user_login", - "last_pushed_date", - "last_pushed_email" - ] - } - } - }, - "required": [ - "name", - "advanced_security_committers", - "advanced_security_committers_breakdown" - ] - } - } - }, - "required": [ - "repositories" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Success

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise administration\" enterprise permissions": "write" - } - ], - "disabledForPatV2": true - } - } - ], - "manage-ghes": [ - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/manage/v1/access/ssh", - "title": "Get the configured SSH keys", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Gets the configured SSH keys on all available nodes. For more information, see \"Accessing the administrative shell (SSH).\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCwcd9tu20xsJVBMWbIs+JDVQTvkLtrJ8A7eblSwC+zECver22QExC9d6zHy10MAyk1Ck7Bu6/0Z+rr/31vMcAOmNOLjExzWxBCXbtDf3758Qfw7FuvkaTE1sHztwSFi/yNhZSw7uPEWeGQiRY4UldSKG9zZvrZmxpnP8mNZzPriQ==", - "fingeprint": "bd:26:d3:a2:ad:97:c0:7c:2d:57:a4:64:f3:fb:44:45" - }, - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCg73sgCdLL9rWcmVTmvcOgAWZaokZTeNnMFEoaZWZcVtsP4Ed+ICuSbT1wDuyL/XXzr0O2u2bKwx8Np/3UGHb4R9Re+qiz//l5OCBd3KonO2GFICQwKGmVeZ+ki89aN2JDKgfemHbvclHYBD/r56lnbt/kinw7JqGPp+ndzH8nBw==", - "fingeprint": "e1:1e:a0:f1:3f:a9:70:2d:99:dd:02:9d:39:1c:8b:a4" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "format": "ssh-key", - "description": "The full public key" - }, - "fingerprint": { - "type": "string", - "format": "ssh-key fingerprint", - "description": "The fingerprint of the key" - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "post", - "requestPath": "/manage/v1/access/ssh", - "title": "Set a new SSH key", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "key", - "description": "

The public SSH key to add to the authorized_keys file.

", - "isRequired": true - } - ], - "descriptionHTML": "

Adds a SSH key to the authorized_keys file for your GitHub Enterprise Server instance. This will grant access via SSH to your instance. For more information, see \"Accessing the administrative shell (SSH).\"

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADCIABAAAAgQCY/ZiDDOFWcZnYXPwMbvwQDofXPdHxLfxPK+HWGVPd1DLcDncYBUSB0bmCU2g9Sc+oHKLoHhXp0ivau9h+EpmQJ7V8vqsRdD9pc4aL/WAnUyF4o3Y7xL94rlRpVbVo/tNjzcvqxxyzBiYyy3GciCMpYQh/uKt56B94/5PNyIGEEw==" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "hostname": "ghe-local-primary", - "uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb", - "message": "SSH key added successfully", - "modified": true - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "hostname": { - "type": "string", - "format": "hostname", - "description": "Hostname of the node where the SSH key was added." - }, - "uuid": { - "type": "string", - "format": "uuid", - "description": "UUID of the SSH key that was added." - }, - "message": { - "type": "string", - "description": "Message indicating the result of the SSH key addition." - }, - "error": { - "type": "string", - "description": "Error message indicating the reason for the SSH key addition failure. This field is only present if the SSH key addition failed." - }, - "modified": { - "type": "boolean", - "description": "Whether the SSH key was already present on the `authorized_keys` file." - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - }, - { - "httpStatusCode": "500", - "description": "

Internal error

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "delete", - "requestPath": "/manage/v1/access/ssh", - "title": "Delete a SSH key", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "key", - "description": "

The public SSH key to remove from the authorized_keys file.

", - "isRequired": true - } - ], - "descriptionHTML": "

Deletes a SSH key from the authorized_keys file for your GitHub Enterprise Server instance. This will remove access via SSH to your instance. For more information, see \"Accessing the administrative shell (SSH).\"

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADCIABAAAAgQCY/ZiDDOFWcZnYXPwMbvwQDofXPdHxLfxPK+HWGVPd1DLcDncYBUSB0bmCU2g9Sc+oHKLoHhXp0ivau9h+EpmQJ7V8vqsRdD9pc4aL/WAnUyF4o3Y7xL94rlRpVbVo/tNjzcvqxxyzBiYyy3GciCMpYQh/uKt56B94/5PNyIGEEw==" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "hostname": "ghe-local-primary", - "uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb", - "message": "SSH key removed successfully" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "hostname": { - "type": "string", - "format": "hostname", - "description": "Hostname of the node where the SSH key was removed." - }, - "uuid": { - "type": "string", - "format": "uuid", - "description": "UUID of the SSH key that was removed." - }, - "message": { - "type": "string", - "description": "Message indicating the result of the SSH key removal." - }, - "error": { - "type": "string", - "description": "Error message indicating the reason for the SSH key removal failure. This field is only present if the SSH key removal failed." - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - }, - { - "httpStatusCode": "500", - "description": "

Internal error

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/manage/v1/checks/system-requirements", - "title": "Get the system requirement check results for configured cluster nodes", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Checks if the minimum requirements for system hardware resources are met on each configured cluster node.\nThis endpoint may take several seconds to reply.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "status": "OK", - "nodes": [ - { - "hostname": "ghe-local-app", - "status": "OK", - "roles_status": [ - { - "status": "OK", - "role": "ConsulServer" - }, - { - "status": "OK", - "role": "JobServer" - }, - { - "status": "OK", - "role": "WebServer" - } - ] - }, - { - "hostname": "ghe-local-app2", - "status": "OK", - "roles_status": [ - { - "status": "OK", - "role": "ConsulServer" - }, - { - "status": "OK", - "role": "GitServer" - } - ] - } - ] - }, - "schema": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "OK", - "FAILED" - ] - }, - "nodes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "hostname": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "OK", - "FAILED" - ] - }, - "roles_status": { - "type": "array", - "items": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "OK", - "FAILED" - ] - }, - "role": { - "type": "string" - } - } - } - } - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "500", - "description": "

Internal error

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/manage/v1/cluster/status", - "title": "Get the status of services running on all cluster nodes", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Gets the status of all services running on each cluster node.\nThis endpoint may take several seconds to reply.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "status": "OK", - "nodes": [ - { - "hostname": "ghe-local-app", - "status": "OK", - "services": [ - { - "status": "OK", - "name": "es", - "details": "Elasticsearch cluster is in sync (0 shards initializing, 0 shards unassigned)" - }, - { - "status": "OK", - "name": "git-replication", - "details": "Git replication is in sync" - }, - { - "status": "OK", - "name": "kafka-lite-admin-healthcheck", - "details": "" - }, - { - "status": "OK", - "name": "kafka-lite-broker-is-reachable", - "details": "" - }, - { - "status": "OK", - "name": "memcache", - "details": "" - }, - { - "status": "OK", - "name": "metrics", - "details": "" - }, - { - "status": "OK", - "name": "mysql-replication", - "details": "Replication is running" - }, - { - "status": "OK", - "name": "mysql-failover", - "details": "" - }, - { - "status": "OK", - "name": "pages", - "details": "Pages replication is in sync" - }, - { - "status": "OK", - "name": "redis", - "details": "Redis is OK" - }, - { - "status": "OK", - "name": "storage", - "details": "Storage replication is in sync" - } - ] - }, - { - "hostname": "ghe-local-app2", - "status": "OK", - "services": [ - { - "status": "OK", - "name": "kafka-lite-admin-healthcheck", - "details": "" - }, - { - "status": "OK", - "name": "kafka-lite-broker-is-reachable", - "details": "" - } - ] - } - ] - }, - "schema": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "UNKNOWN", - "OK", - "WARNING", - "CRITICAL" - ] - }, - "nodes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "hostname": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "UNKNOWN", - "OK", - "WARNING", - "CRITICAL" - ] - }, - "services": { - "type": "array", - "items": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "UNKNOWN", - "OK", - "WARNING", - "CRITICAL" - ] - }, - "name": { - "type": "string" - }, - "details": { - "type": "string" - } - } - } - } - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - }, - { - "httpStatusCode": "500", - "description": "

Internal error

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/manage/v1/config/apply", - "title": "Get the status of a ghe-config-apply run", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [ - { - "name": "run_id", - "description": "

The unique run ID of the ghe-config-apply run.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Displays the current status of ghe-config-apply in the environment or the status of a historical run by ID.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "running": true, - "successful": false, - "nodes": [ - { - "run_id": "d34db33f", - "hostname": "ghes-01.lan", - "running": true, - "successful": false - } - ] - }, - "schema": { - "type": "object", - "properties": { - "running": { - "type": "boolean", - "description": "Whether the ghe-config-apply run is still running in the environment" - }, - "successful": { - "type": "boolean", - "description": "Whether the ghe-config-apply run was successful in the environment" - }, - "nodes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "run_id": { - "type": "string", - "description": "The unique Run ID of the ghe-config-apply run on the host" - }, - "hostname": { - "type": "string", - "description": "The hostname of the node" - }, - "running": { - "type": "boolean", - "description": "Whether the ghe-config-apply run is still running on the host" - }, - "successful": { - "type": "boolean", - "description": "Whether the ghe-config-apply run was successful on the host" - } - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "post", - "requestPath": "/manage/v1/config/apply", - "title": "Trigger a ghe-config-apply run", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "run_id", - "description": "

The run ID to execute ghe-config-apply with. If not provided, a run ID will be generated randomly.

" - } - ], - "descriptionHTML": "

Triggers a run of ghe-config-apply from the ghes-manage agent on your Nomad Delegate instance.\nYou can provide a run ID or allow one to be generated randomly.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "run_id": "d34db33f" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "run_id": "d34db33f" - }, - "schema": { - "type": "object", - "properties": { - "run_id": { - "type": "string", - "description": "Run ID the job was launched with" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/manage/v1/config/apply/events", - "title": "List events from ghe-config-apply", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [ - { - "name": "last_request_id", - "description": "

The unique ID of the last response from a host, used for pagination.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists events from an in-process ghe-config-apply run on your Github Enterprise Server instance.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "nodes": [ - { - "node": "ghes-01.lan", - "last_request_id": "387cd628c06d606700e79be368e5e574:0cde553750689c76:0000000000000000", - "events": [ - { - "timestamp": "2023-01-01T13:00:00+00:00", - "severity_text": "INFO", - "body": "Validating services", - "event_name": "Enterprise::ConfigApply::PhaseValidation#config_phase_validation", - "topology": "multinode", - "hostname": "ghes-01.lan", - "config_run_id": "d34db33f", - "trace_id": "387cd628c06d606700e79be368e5e574", - "span_id": "0cde553750689c76", - "span_parent_id": 0, - "span_depth": 0 - } - ] - } - ] - }, - "schema": { - "type": "object", - "properties": { - "nodes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "node": { - "type": "string", - "description": "Hostname of the node" - }, - "last_request_id": { - "type": "string", - "description": "Unique ID of the last response from a host used for pagination" - }, - "events": { - "type": "array", - "items": { - "type": "object", - "properties": { - "timestamp": { - "type": "string" - }, - "severity_text": { - "type": "string" - }, - "body": { - "type": "string" - }, - "event_name": { - "type": "string" - }, - "topology": { - "type": "string" - }, - "hostname": { - "type": "string" - }, - "config_run_id": { - "type": "string" - }, - "trace_id": { - "type": "string" - }, - "span_id": { - "type": "string" - }, - "span_parent_id": { - "type": "string" - }, - "span_depth": { - "type": "integer" - } - } - } - } - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "post", - "requestPath": "/manage/v1/config/init", - "title": "Initialize instance configuration with license and password", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "license", - "description": "

The content of your .ghl license file.

", - "isRequired": true - }, - { - "type": "string", - "name": "password", - "description": "

The root site administrator password.

", - "isRequired": true - } - ], - "descriptionHTML": "

When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.

\n

Important

\n

\nTo start the configuration process and apply the license, you need to POST to /manage/v1/config/apply

\n
\n

The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.

\n

Note

\n

\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "multipart/form-data", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "license": "@enterprise.ghl", - "password": "provide-password-here!" - } - }, - "response": { - "statusCode": "202", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - }, - { - "httpStatusCode": "500", - "description": "

Internal error

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/manage/v1/config/license", - "title": "Get the enterprise license information", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Gets information about the license that is currently set for the enterprise.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "advancedSecurityEnabled": true, - "advancedSecuritySeats": 0, - "clusterSupport": false, - "company": "GitHub", - "croquetSupport": true, - "customTerms": true, - "evaluation": false, - "expireAt": "2025-01-02T07:59:59Z", - "insightsEnabled": true, - "insightsExpireAt": "2025-01-02T07:59:59.999Z", - "learningLabEvaluationExpires": "2023-01-02T07:59:59Z", - "learningLabSeats": 100, - "perpetual": false, - "referenceNumber": "32a145", - "seats": 0, - "sshAllowed": true, - "supportKey\"": "", - "unlimitedSeating": true - } - ], - "schema": { - "type": "object", - "properties": { - "advancedSecurityEnabled": { - "description": "Whether the GitHub Advanced Security feature is enabled.", - "type": "boolean" - }, - "advancedSecuritySeats": { - "description": "If the GitHub Advanced Security feature is enabled, the seat count.", - "type": "integer" - }, - "clusterSupport": { - "description": "Whether the cluster support feature is enabled.", - "type": "boolean" - }, - "company": { - "description": "The company under which the license is issued.", - "type": "string" - }, - "croquetSupport": { - "description": "Whether the GitHub Connect feature is enabled.", - "type": "boolean" - }, - "customTerms": { - "description": "Whether this license is issued under custom terms.", - "type": "boolean" - }, - "evaluation": { - "description": "Wheter this license is issued as an evaluation license.", - "type": "boolean" - }, - "expireAt": { - "description": "The expiration date of the license.", - "type": "string", - "format": "date-time" - }, - "insightsEnabled": { - "description": "Whether the insights feature is enabled.", - "type": "boolean" - }, - "insightsExpireAt": { - "description": "If the insights feature is enabled, the expiration date.", - "type": "string", - "format": "date-time" - }, - "learningLabEvaluationExpires": { - "description": "If the learning lab feature is enabled, the expiration date.", - "type": "string", - "format": "date-time" - }, - "learningLabSeats": { - "description": "If the learning lab feature is enabled, the seat count.", - "type": "integer" - }, - "perpetual": { - "description": "Whether the perpetual feature is enabled.", - "type": "boolean" - }, - "referenceNumber": { - "description": "The unique reference number of the license.", - "type": "string" - }, - "seats": { - "description": "If the license is issued with limited seating, the seat count.", - "type": "integer" - }, - "sshAllowed": { - "description": "Whether the SSH feature is enabled.", - "type": "boolean" - }, - "supportKey": { - "description": "The support key of the license.", - "type": "string" - }, - "unlimitedSeating": { - "description": "Whether the license is issued with unlimited seat count.", - "type": "boolean" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - }, - { - "httpStatusCode": "500", - "description": "

Internal error

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "put", - "requestPath": "/manage/v1/config/license", - "title": "Upload an enterprise license", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [ - { - "name": "apply", - "description": "

Whether to instantly apply changes from the license. Otherwise the new license can be applied using the /manage/v1/config/apply endpoint.

", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "license", - "description": "

The content of your .ghl license file.

", - "isRequired": true - } - ], - "descriptionHTML": "

Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.

\n

Note

\n

\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "multipart/form-data", - "description": "Example 1: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "license": "@enterprise.ghl" - } - }, - "response": { - "statusCode": "201", - "description": "

Created

" - } - }, - { - "request": { - "contentType": "multipart/form-data", - "description": "Example 2: Status Code 202", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "license": "@enterprise.ghl" - } - }, - "response": { - "statusCode": "202", - "description": "

Accepted

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - }, - { - "httpStatusCode": "500", - "description": "

Internal error

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/manage/v1/config/license/check", - "title": "Check a license", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Check the status of the license that is currently set for the enterprise.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "status": "valid" - } - ], - "schema": { - "type": "object", - "properties": { - "status": { - "description": "The license status of the currently active enterprise license.", - "type": "string", - "enum": [ - "valid", - "invalid", - "expired", - "cluster mode not supported" - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - }, - { - "httpStatusCode": "500", - "description": "

Internal error

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/manage/v1/config/nodes", - "title": "Get GHES node metadata for all nodes", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [ - { - "name": "uuid", - "description": "

The UUID which identifies a node.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "cluster_roles", - "description": "

The cluster roles from the cluster configuration file.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Get node metadata for all configured nodes in the current cluster. For more information, see \"About clustering.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "topology": "Cluster", - "nodes": [ - { - "hostname": "data1", - "uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb", - "cluster_roles": [ - "ConsulServer", - "ElasticsearchServer", - "GitServer", - "StorageServer" - ] - }, - { - "hostname": "data2", - "uuid": "228406d4-f97c-11ed-ab01-062281bbcf03", - "cluster_roles": [ - "ElasticsearchServer", - "StorageServer", - "PagesServer" - ] - } - ] - }, - "schema": { - "type": "object", - "properties": { - "topology": { - "type": "string", - "enum": [ - "SingleNode", - "Ha", - "Cluster" - ] - }, - "nodes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "hostname": { - "type": "string" - }, - "uuid": { - "type": "string" - }, - "replica": { - "type": "boolean" - }, - "cluster_roles": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Blank", - "ActionsServer", - "ConsulServer", - "ElasticsearchServer", - "GitServer", - "JobServer", - "LaunchServer", - "MemcacheServer", - "MetricsServer", - "MssqlServer", - "MysqlServer", - "PagesServer", - "RedisServer", - "StorageServer", - "WebServer" - ] - } - } - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - }, - { - "httpStatusCode": "500", - "description": "

Internal error

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/manage/v1/config/settings", - "title": "Get the GHES settings", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Gets a list of settings for a GitHub Enterprise Server instance.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "private_mode": false, - "public_pages": false, - "subdomain_isolation": true, - "signup_enabled": false, - "github_hostname": "ghe.local", - "identicons_host": "dotcom", - "http_proxy": null, - "auth_mode": "default", - "expire_sessions": false, - "admin_password": null, - "configuration_id": 1401777404, - "configuration_run_count": 4, - "avatar": { - "enabled": false, - "uri": "" - }, - "customer": { - "name": "GitHub", - "email": "stannis@themannis.biz", - "uuid": "af6cac80-e4e1-012e-d822-1231380e52e9", - "secret_key_data": "-----BEGIN PGP PRIVATE KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\nlQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx...\n-----END PGP PRIVATE KEY BLOCK-----\n", - "public_key_data": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\nmI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7....\n-----END PGP PUBLIC KEY BLOCK-----\n" - }, - "license": { - "seats": 0, - "evaluation": false, - "perpetual": false, - "unlimited_seating": true, - "support_key": "ssh-rsa AAAAB3N....", - "ssh_allowed": true, - "cluster_support": false, - "expire_at": "2016-04-27T00:00:00-07:00" - }, - "github_ssl": { - "enabled": false, - "cert": null, - "key": null - }, - "ldap": { - "host": null, - "port": 0, - "base": [], - "uid": null, - "bind_dn": null, - "password": null, - "method": "Plain", - "search_strategy": "detect", - "user_groups": [], - "admin_group": null, - "virtual_attribute_enabled": false, - "recursive_group_search": false, - "posix_support": true, - "user_sync_emails": false, - "user_sync_keys": false, - "user_sync_interval": 4, - "team_sync_interval": 4, - "sync_enabled": false, - "reconciliation": { - "user": null, - "org": null - }, - "profile": { - "uid": "uid", - "name": null, - "mail": null, - "key": null - } - }, - "cas": { - "url": null - }, - "saml": { - "sso_url": null, - "certificate": null, - "certificate_path": null, - "issuer": null, - "idp_initiated_sso": false, - "disable_admin_demote": false - }, - "github_oauth": { - "client_id": "12313412", - "client_secret": "kj123131132", - "organization_name": "Homestar Runners", - "organization_team": "homestarrunners/characters" - }, - "smtp": { - "enabled": true, - "address": "smtp.example.com", - "authentication": "plain", - "port": "1234", - "domain": "blah", - "username": "foo", - "user_name": "mr_foo", - "enable_starttls_auto": true, - "password": "bar", - "discard-to-noreply-address": true, - "support_address": "enterprise@github.com", - "support_address_type": "email", - "noreply_address": "noreply@github.com" - }, - "ntp": { - "primary_server": "0.pool.ntp.org", - "secondary_server": "1.pool.ntp.org" - }, - "timezone": null, - "snmp": { - "enabled": false, - "community": "" - }, - "syslog": { - "enabled": false, - "server": null, - "protocol_name": "udp" - }, - "assets": null, - "pages": { - "enabled": true - }, - "collectd": { - "enabled": false, - "server": null, - "port": 0, - "encryption": null, - "username": null, - "password": null - }, - "mapping": { - "enabled": true, - "tileserver": null, - "basemap": "company.map-qsz2zrvs", - "token": null - }, - "load_balancer": null - }, - "schema": { - "type": "object", - "properties": { - "private_mode": { - "type": "boolean" - }, - "public_pages": { - "type": "boolean" - }, - "subdomain_isolation": { - "type": "boolean" - }, - "signup_enabled": { - "type": "boolean" - }, - "github_hostname": { - "type": "string" - }, - "identicons_host": { - "type": "string" - }, - "http_proxy": { - "type": [ - "string", - "null" - ] - }, - "auth_mode": { - "type": "string" - }, - "expire_sessions": { - "type": "boolean" - }, - "admin_password": { - "type": [ - "string", - "null" - ] - }, - "configuration_id": { - "type": "integer" - }, - "configuration_run_count": { - "type": "integer" - }, - "avatar": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "uri": { - "type": "string" - } - } - }, - "customer": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "uuid": { - "type": "string" - }, - "secret_key_data": { - "type": "string" - }, - "public_key_data": { - "type": "string" - } - } - }, - "license": { - "type": "object", - "properties": { - "seats": { - "type": "integer" - }, - "evaluation": { - "type": "boolean" - }, - "perpetual": { - "type": "boolean" - }, - "unlimited_seating": { - "type": "boolean" - }, - "support_key": { - "type": "string" - }, - "ssh_allowed": { - "type": "boolean" - }, - "cluster_support": { - "type": "boolean" - }, - "expire_at": { - "type": "string" - } - } - }, - "github_ssl": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "cert": { - "type": [ - "string", - "null" - ] - }, - "key": { - "type": [ - "string", - "null" - ] - } - } - }, - "ldap": { - "type": "object", - "properties": { - "host": { - "type": [ - "string", - "null" - ] - }, - "port": { - "type": "integer" - }, - "base": { - "type": "array", - "items": { - "type": "string" - } - }, - "uid": { - "type": [ - "string", - "null" - ] - }, - "bind_dn": { - "type": [ - "string", - "null" - ] - }, - "password": { - "type": [ - "string", - "null" - ] - }, - "method": { - "type": "string" - }, - "search_strategy": { - "type": "string" - }, - "user_groups": { - "type": "array", - "items": { - "type": "string" - } - }, - "admin_group": { - "type": [ - "string", - "null" - ] - }, - "virtual_attribute_enabled": { - "type": "boolean" - }, - "recursive_group_search": { - "type": "boolean" - }, - "posix_support": { - "type": "boolean" - }, - "user_sync_emails": { - "type": "boolean" - }, - "user_sync_keys": { - "type": "boolean" - }, - "user_sync_interval": { - "type": "integer" - }, - "team_sync_interval": { - "type": "integer" - }, - "sync_enabled": { - "type": "boolean" - }, - "reconciliation": { - "type": "object", - "properties": { - "user": { - "type": [ - "string", - "null" - ] - }, - "org": { - "type": [ - "string", - "null" - ] - } - } - }, - "profile": { - "type": "object", - "properties": { - "uid": { - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "mail": { - "type": [ - "string", - "null" - ] - }, - "key": { - "type": [ - "string", - "null" - ] - } - } - } - } - }, - "cas": { - "type": "object", - "properties": { - "url": { - "type": [ - "string", - "null" - ] - } - } - }, - "saml": { - "type": "object", - "properties": { - "sso_url": { - "type": [ - "string", - "null" - ] - }, - "certificate": { - "type": [ - "string", - "null" - ] - }, - "certificate_path": { - "type": [ - "string", - "null" - ] - }, - "issuer": { - "type": [ - "string", - "null" - ] - }, - "idp_initiated_sso": { - "type": "boolean" - }, - "disable_admin_demote": { - "type": "boolean" - } - } - }, - "github_oauth": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "client_secret": { - "type": "string" - }, - "organization_name": { - "type": "string" - }, - "organization_team": { - "type": "string" - } - } - }, - "smtp": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "address": { - "type": "string" - }, - "authentication": { - "type": "string" - }, - "port": { - "type": "string" - }, - "domain": { - "type": "string" - }, - "username": { - "type": "string" - }, - "user_name": { - "type": "string" - }, - "enable_starttls_auto": { - "type": "boolean" - }, - "password": { - "type": "string" - }, - "discard-to-noreply-address": { - "type": "boolean" - }, - "support_address": { - "type": "string" - }, - "support_address_type": { - "type": "string" - }, - "noreply_address": { - "type": "string" - } - } - }, - "ntp": { - "type": "object", - "properties": { - "primary_server": { - "type": "string" - }, - "secondary_server": { - "type": "string" - } - } - }, - "timezone": { - "type": [ - "string", - "null" - ] - }, - "snmp": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "community": { - "type": "string" - } - } - }, - "syslog": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "server": { - "type": [ - "string", - "null" - ] - }, - "protocol_name": { - "type": "string" - } - } - }, - "assets": { - "type": [ - "string", - "null" - ] - }, - "pages": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "collectd": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "server": { - "type": [ - "string", - "null" - ] - }, - "port": { - "type": "integer" - }, - "encryption": { - "type": [ - "string", - "null" - ] - }, - "username": { - "type": [ - "string", - "null" - ] - }, - "password": { - "type": [ - "string", - "null" - ] - } - } - }, - "mapping": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "tileserver": { - "type": [ - "string", - "null" - ] - }, - "basemap": { - "type": "string" - }, - "token": { - "type": [ - "string", - "null" - ] - } - } - }, - "load_balancer": { - "type": [ - "string", - "null" - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "put", - "requestPath": "/manage/v1/config/settings", - "title": "Set settings", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Updates the settings on your instance. For a list of the available settings, see the Get settings endpoint.

\n

Notes:

\n
    \n
  • The request body only requires the settings parameters that should be updated to be specified, all other parameters will be unmodified or populated from the default values.
    • \n
  • You cannot set the Management Console root site administrator password with this API endpoint. Use the ghe-set-password utility to change the management console password. For more information, see \"Command-line utilities.\"
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "public_pages": true - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - }, - { - "httpStatusCode": "500", - "description": "

Internal error

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/manage/v1/maintenance", - "title": "Get the status of maintenance mode", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [ - { - "name": "uuid", - "description": "

The UUID which identifies a node.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "cluster_roles", - "description": "

The cluster roles from the cluster configuration file.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the status and details of maintenance mode on all available nodes. For more information, see \"Enabling and scheduling maintenance mode.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "hostname": "ghe-local-primary", - "uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb", - "status": "scheduled", - "scheduled_time": "2006-01-02T15:04:05+00:00", - "connection_services": [ - { - "name": "git operations", - "number": 15 - }, - { - "name": "mysql queries", - "number": 6 - }, - { - "name": "resque jobs", - "number": 10 - }, - { - "name": "aqueduct jobs", - "number": 0 - } - ], - "can_unset_maintenance": true, - "ip_exception_list": [ - "1.1.1.1" - ], - "maintenance_mode_message": "Scheduled maintenance for upgrading." - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "hostname": { - "type": "string", - "format": "hostname" - }, - "uuid": { - "type": "string", - "format": "uuid" - }, - "status": { - "type": "string", - "enum": [ - "on", - "off", - "scheduled" - ] - }, - "scheduled_time": { - "type": "string", - "format": "date" - }, - "connection_services": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "number": { - "type": "integer" - } - } - } - }, - "can_unset_maintenance": { - "type": "boolean" - }, - "ip_exception_list": { - "type": "array", - "items": { - "type": "string", - "format": "ip/cidr" - } - }, - "maintenance_mode_message": { - "type": "string" - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - }, - { - "httpStatusCode": "500", - "description": "

Internal error

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "post", - "requestPath": "/manage/v1/maintenance", - "title": "Set the status of maintenance mode", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [], - "bodyParameters": [ - { - "type": "boolean", - "name": "enabled", - "description": "

Whether to enable maintenance mode.

", - "isRequired": true - }, - { - "type": "string", - "name": "uuid", - "description": "

The UUID of the node to target. This parameter is incompatible with maintenance mode scheduling. Only use uuid if the value of when is empty or now.

" - }, - { - "type": "string", - "name": "when", - "description": "

The time to enable maintenance mode. If this parameter is empty or set to now, maintenance mode is enabled immediately. Otherwise, maintenance mode is enabled at the specified time. The format is ISO 8601.

" - }, - { - "type": "array of strings", - "name": "ip_exception_list", - "description": "

The list of IP addresses to exclude from maintenance mode. IPv4, IPv6, and CIDR addresses are supported.

" - }, - { - "type": "string", - "name": "maintenance_mode_message", - "description": "

The message to display to users when maintenance mode is enabled.

" - } - ], - "descriptionHTML": "

Sets or schedules the maintenance mode. For more information, see \"Enabling and scheduling maintenance mode.\"

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "enabled": true, - "when": "2006-01-02T15:04:05+00:00", - "ip_exception_list": [ - "192.168.1.0/24", - "1.1.1.1" - ] - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "hostname": "ghe-local-primary", - "uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb", - "message": "maintenance mode scheduled with exception list [1.1.1.1]" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "hostname": { - "type": "string", - "format": "hostname" - }, - "uuid": { - "type": "string", - "format": "uuid" - }, - "message": { - "type": "string" - }, - "error": { - "type": "string" - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - }, - { - "httpStatusCode": "500", - "description": "

Internal error

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/manage/v1/replication/status", - "title": "Get the status of services running on all replica nodes", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [ - { - "name": "uuid", - "description": "

The UUID which identifies a node.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "cluster_roles", - "description": "

The cluster roles from the cluster configuration file.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the status of all services running on each replica node.\nThis endpoint may take several seconds to reply.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "status": "OK", - "nodes": [ - { - "hostname": "ghe-local-primary", - "status": "OK", - "services": [] - }, - { - "hostname": "ghe-local-replica", - "status": "OK", - "services": [ - { - "status": "OK", - "name": "redis", - "details": "replication is in sync" - }, - { - "status": "OK", - "name": "elasticsearch", - "details": "cluster is in sync (0 shards initializing, 0 shards unassigned)" - }, - { - "status": "OK", - "name": "git", - "details": "replication is in sync" - }, - { - "status": "OK", - "name": "pages", - "details": "replication is in sync" - }, - { - "status": "OK", - "name": "alambic", - "details": "replication is in sync" - }, - { - "status": "OK", - "name": "git-hooks", - "details": "replication is in sync" - }, - { - "status": "OK", - "name": "consul", - "details": "replication is in sync" - }, - { - "status": "OK", - "name": "mysql", - "details": "replication is in sync" - } - ] - } - ] - }, - "schema": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "UNKNOWN", - "OK", - "WARNING", - "CRITICAL" - ] - }, - "nodes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "hostname": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "UNKNOWN", - "OK", - "WARNING", - "CRITICAL" - ] - }, - "services": { - "type": "array", - "items": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "UNKNOWN", - "OK", - "WARNING", - "CRITICAL" - ] - }, - "name": { - "type": "string" - }, - "details": { - "type": "string" - } - } - } - } - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - }, - { - "httpStatusCode": "500", - "description": "

Internal error

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/manage/v1/version", - "title": "Get all GHES release versions for all nodes", - "category": "enterprise-admin", - "subcategory": "manage-ghes", - "parameters": [ - { - "name": "uuid", - "description": "

The UUID which identifies a node.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "cluster_roles", - "description": "

The cluster roles from the cluster configuration file.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see \"GitHub Enterprise Server releases.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "hostname": "ghe-local-primary", - "version": { - "version": "3.9.0", - "platform": "azure", - "build_id": "fc542058b5", - "build_date": "2023-05-02" - } - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "hostname": { - "type": "string", - "format": "hostname" - }, - "version": { - "type": "object", - "properties": { - "version": { - "type": "string", - "pattern": "[0-9]\\.[0-9]{2}\\.[0-9]" - }, - "platform": { - "type": "string", - "enum": [ - "ami", - "azure", - "esx", - "gce", - "hyperv", - "kvm" - ] - }, - "build_id": { - "type": "string", - "pattern": "[0-9a-f]{8}" - }, - "build_date": { - "type": "string", - "format": "date" - } - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - }, - { - "httpStatusCode": "500", - "description": "

Internal error

" - } - ], - "previews": [] - } - ], - "management-console": [ - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/setup/api/configcheck", - "title": "Get the configuration status", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

This endpoint allows you to check the status of the most recent configuration process:

\n

Note that you may need to wait several seconds after you start a process before you can check its status.

\n

The different statuses are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusDescription
PENDINGThe job has not started yet
CONFIGURINGThe job is running
DONEThe job has finished correctly
FAILEDThe job has finished unexpectedly
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "status": "running", - "progress": [ - { - "status": "DONE", - "key": "Appliance core components" - }, - { - "status": "DONE", - "key": "GitHub utilities" - }, - { - "status": "DONE", - "key": "GitHub applications" - }, - { - "status": "CONFIGURING", - "key": "GitHub services" - }, - { - "status": "PENDING", - "key": "Reloading appliance services" - } - ] - }, - "schema": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "progress": { - "type": "array", - "items": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "key": { - "type": "string" - } - }, - "required": [ - "status", - "key" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "post", - "requestPath": "/setup/api/configure", - "title": "Start a configuration process", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

This endpoint allows you to start a configuration process at any time for your updated settings to take effect:

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "202", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/setup/api/maintenance", - "title": "Get the maintenance status", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Check your installation's maintenance status:

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "status": "scheduled", - "scheduled_time": "Tuesday, January 22 at 15:34 -0800", - "connection_services": [ - { - "name": "git operations", - "number": 0 - }, - { - "name": "mysql queries", - "number": 233 - }, - { - "name": "aqueduct jobs", - "number": 34 - }, - { - "name": "resque jobs", - "number": 54 - } - ] - }, - "schema": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "scheduled_time": { - "type": "string" - }, - "connection_services": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "number": { - "type": "integer" - } - }, - "required": [ - "name", - "number" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "post", - "requestPath": "/setup/api/maintenance", - "title": "Enable or disable maintenance mode", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "maintenance", - "description": "

A JSON string with the attributes enabled and when.

\n

The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.

\n

The possible values for when are now or any date parseable by mojombo/chronic.

", - "isRequired": true - } - ], - "descriptionHTML": "

Note

\n

\nThe request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/x-www-form-urlencoded", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "maintenance": "{\"enabled\":true, \"when\":\"now\"}" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "status": "scheduled", - "scheduled_time": "Tuesday, January 22 at 15:34 -0800", - "connection_services": [ - { - "name": "git operations", - "number": 0 - }, - { - "name": "mysql queries", - "number": 233 - }, - { - "name": "aqueduct jobs", - "number": 34 - }, - { - "name": "resque jobs", - "number": 54 - } - ] - }, - "schema": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "scheduled_time": { - "type": "string" - }, - "connection_services": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "number": { - "type": "integer" - } - }, - "required": [ - "name", - "number" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/setup/api/settings", - "title": "Get settings", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Gets the settings for your instance. To change settings, see the Set settings endpoint.

\n

Note

\n

\nYou cannot retrieve the management console password with the Enterprise administration API.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "enterprise": { - "private_mode": false, - "public_pages": false, - "subdomain_isolation": true, - "signup_enabled": false, - "github_hostname": "ghe.local", - "identicons_host": "dotcom", - "http_proxy": null, - "auth_mode": "default", - "expire_sessions": false, - "admin_password": null, - "configuration_id": 1401777404, - "configuration_run_count": 4, - "avatar": { - "enabled": false, - "uri": "" - }, - "customer": { - "name": "GitHub", - "email": "stannis@themannis.biz", - "uuid": "af6cac80-e4e1-012e-d822-1231380e52e9", - "secret_key_data": "-----BEGIN PGP PRIVATE KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\n\nlQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx...\n-----END PGP PRIVATE KEY BLOCK-----\n", - "public_key_data": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\n\nmI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7....\n-----END PGP PUBLIC KEY BLOCK-----\n" - }, - "license": { - "seats": 0, - "evaluation": false, - "perpetual": false, - "unlimited_seating": true, - "support_key": "ssh-rsa AAAAB3N....", - "ssh_allowed": true, - "cluster_support": false, - "expire_at": "2016-04-27T00:00:00-07:00" - }, - "github_ssl": { - "enabled": false, - "cert": null, - "key": null - }, - "ldap": { - "host": null, - "port": 0, - "base": [], - "uid": null, - "bind_dn": null, - "password": null, - "method": "Plain", - "search_strategy": "detect", - "user_groups": [], - "admin_group": null, - "virtual_attribute_enabled": false, - "recursive_group_search": false, - "posix_support": true, - "user_sync_emails": false, - "user_sync_keys": false, - "user_sync_interval": 4, - "team_sync_interval": 4, - "sync_enabled": false, - "reconciliation": { - "user": null, - "org": null - }, - "profile": { - "uid": "uid", - "name": null, - "mail": null, - "key": null - } - }, - "cas": { - "url": null - }, - "saml": { - "sso_url": null, - "certificate": null, - "certificate_path": null, - "issuer": null, - "idp_initiated_sso": false, - "disable_admin_demote": false - }, - "github_oauth": { - "client_id": "12313412", - "client_secret": "kj123131132", - "organization_name": "Homestar Runners", - "organization_team": "homestarrunners/characters" - }, - "smtp": { - "enabled": true, - "address": "smtp.example.com", - "authentication": "plain", - "port": "1234", - "domain": "blah", - "username": "foo", - "user_name": "mr_foo", - "enable_starttls_auto": true, - "password": "bar", - "discard-to-noreply-address": true, - "support_address": "enterprise@github.com", - "support_address_type": "email", - "noreply_address": "noreply@github.com" - }, - "ntp": { - "primary_server": "0.pool.ntp.org", - "secondary_server": "1.pool.ntp.org" - }, - "timezone": null, - "snmp": { - "enabled": false, - "community": "" - }, - "syslog": { - "enabled": false, - "server": null, - "protocol_name": "udp" - }, - "assets": null, - "pages": { - "enabled": true - }, - "collectd": { - "enabled": false, - "server": null, - "port": 0, - "encryption": null, - "username": null, - "password": null - }, - "mapping": { - "enabled": true, - "tileserver": null, - "basemap": "company.map-qsz2zrvs", - "token": null - }, - "load_balancer": null - }, - "run_list": [ - "recipe[enterprise-configure]" - ] - }, - "schema": { - "type": "object", - "properties": { - "enterprise": { - "type": "object", - "properties": { - "private_mode": { - "type": "boolean" - }, - "public_pages": { - "type": "boolean" - }, - "subdomain_isolation": { - "type": "boolean" - }, - "signup_enabled": { - "type": "boolean" - }, - "github_hostname": { - "type": "string" - }, - "identicons_host": { - "type": "string" - }, - "http_proxy": { - "type": [ - "string", - "null" - ] - }, - "auth_mode": { - "type": "string" - }, - "expire_sessions": { - "type": "boolean" - }, - "admin_password": { - "type": [ - "string", - "null" - ] - }, - "configuration_id": { - "type": "integer" - }, - "configuration_run_count": { - "type": "integer" - }, - "avatar": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "uri": { - "type": "string" - } - } - }, - "customer": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "uuid": { - "type": "string" - }, - "secret_key_data": { - "type": "string" - }, - "public_key_data": { - "type": "string" - } - } - }, - "license": { - "type": "object", - "properties": { - "seats": { - "type": "integer" - }, - "evaluation": { - "type": "boolean" - }, - "perpetual": { - "type": "boolean" - }, - "unlimited_seating": { - "type": "boolean" - }, - "support_key": { - "type": "string" - }, - "ssh_allowed": { - "type": "boolean" - }, - "cluster_support": { - "type": "boolean" - }, - "expire_at": { - "type": "string" - } - } - }, - "github_ssl": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "cert": { - "type": [ - "string", - "null" - ] - }, - "key": { - "type": [ - "string", - "null" - ] - } - } - }, - "ldap": { - "type": "object", - "properties": { - "host": { - "type": [ - "string", - "null" - ] - }, - "port": { - "type": "integer" - }, - "base": { - "type": "array", - "items": {} - }, - "uid": { - "type": [ - "string", - "null" - ] - }, - "bind_dn": { - "type": [ - "string", - "null" - ] - }, - "password": { - "type": [ - "string", - "null" - ] - }, - "method": { - "type": "string" - }, - "search_strategy": { - "type": "string" - }, - "user_groups": { - "type": "array", - "items": {} - }, - "admin_group": { - "type": [ - "string", - "null" - ] - }, - "virtual_attribute_enabled": { - "type": "boolean" - }, - "recursive_group_search": { - "type": "boolean" - }, - "posix_support": { - "type": "boolean" - }, - "user_sync_emails": { - "type": "boolean" - }, - "user_sync_keys": { - "type": "boolean" - }, - "user_sync_interval": { - "type": "integer" - }, - "team_sync_interval": { - "type": "integer" - }, - "sync_enabled": { - "type": "boolean" - }, - "reconciliation": { - "type": "object", - "properties": { - "user": { - "type": [ - "string", - "null" - ] - }, - "org": { - "type": [ - "string", - "null" - ] - } - } - }, - "profile": { - "type": "object", - "properties": { - "uid": { - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "mail": { - "type": [ - "string", - "null" - ] - }, - "key": { - "type": [ - "string", - "null" - ] - } - } - } - } - }, - "cas": { - "type": "object", - "properties": { - "url": { - "type": [ - "string", - "null" - ] - } - } - }, - "saml": { - "type": "object", - "properties": { - "sso_url": { - "type": [ - "string", - "null" - ] - }, - "certificate": { - "type": [ - "string", - "null" - ] - }, - "certificate_path": { - "type": [ - "string", - "null" - ] - }, - "issuer": { - "type": [ - "string", - "null" - ] - }, - "idp_initiated_sso": { - "type": "boolean" - }, - "disable_admin_demote": { - "type": "boolean" - } - } - }, - "github_oauth": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "client_secret": { - "type": "string" - }, - "organization_name": { - "type": "string" - }, - "organization_team": { - "type": "string" - } - } - }, - "smtp": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "address": { - "type": "string" - }, - "authentication": { - "type": "string" - }, - "port": { - "type": "string" - }, - "domain": { - "type": "string" - }, - "username": { - "type": "string" - }, - "user_name": { - "type": "string" - }, - "enable_starttls_auto": { - "type": "boolean" - }, - "password": { - "type": "string" - }, - "discard-to-noreply-address": { - "type": "boolean" - }, - "support_address": { - "type": "string" - }, - "support_address_type": { - "type": "string" - }, - "noreply_address": { - "type": "string" - } - } - }, - "ntp": { - "type": "object", - "properties": { - "primary_server": { - "type": "string" - }, - "secondary_server": { - "type": "string" - } - } - }, - "timezone": { - "type": [ - "string", - "null" - ] - }, - "snmp": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "community": { - "type": "string" - } - } - }, - "syslog": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "server": { - "type": [ - "string", - "null" - ] - }, - "protocol_name": { - "type": "string" - } - } - }, - "assets": { - "type": [ - "string", - "null" - ] - }, - "pages": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "collectd": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "server": { - "type": [ - "string", - "null" - ] - }, - "port": { - "type": "integer" - }, - "encryption": { - "type": [ - "string", - "null" - ] - }, - "username": { - "type": [ - "string", - "null" - ] - }, - "password": { - "type": [ - "string", - "null" - ] - } - } - }, - "mapping": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "tileserver": { - "type": [ - "string", - "null" - ] - }, - "basemap": { - "type": "string" - }, - "token": { - "type": [ - "string", - "null" - ] - } - } - }, - "load_balancer": { - "type": [ - "string", - "null" - ] - } - } - }, - "run_list": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "put", - "requestPath": "/setup/api/settings", - "title": "Set settings", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "settings", - "description": "

A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.

", - "isRequired": true - } - ], - "descriptionHTML": "

Applies settings on your instance. For a list of the available settings, see the Get settings endpoint.

\n

Notes:

\n
    \n
  • The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
    • \n
  • You cannot set the management console password with the Enterprise administration API. Use the ghe-set-password utility to change the management console password. For more information, see \"Command-line utilities.\"
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/x-www-form-urlencoded", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "settings": "{ \"enterprise\": { \"public_pages\": true }}" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/setup/api/settings/authorized-keys", - "title": "Get all authorized SSH keys", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - }, - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - }, - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "pretty-print": { - "type": "string" - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "post", - "requestPath": "/setup/api/settings/authorized-keys", - "title": "Add an authorized SSH key", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "authorized_key", - "description": "

The public SSH key.

", - "isRequired": true - } - ], - "descriptionHTML": "

Note: The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.

", - "codeExamples": [ - { - "request": { - "contentType": "application/x-www-form-urlencoded", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - }, - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - }, - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "pretty-print": { - "type": "string" - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "delete", - "requestPath": "/setup/api/settings/authorized-keys", - "title": "Remove an authorized SSH key", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "authorized_key", - "description": "

The public SSH key.

", - "isRequired": true - } - ], - "descriptionHTML": "

Note: The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.

", - "codeExamples": [ - { - "request": { - "contentType": "application/x-www-form-urlencoded", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - }, - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - }, - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "pretty-print": { - "type": "string" - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "post", - "requestPath": "/setup/api/start", - "title": "Create a GitHub license", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "license", - "description": "

The content of your .ghl license file.

", - "isRequired": true - }, - { - "type": "string", - "name": "password", - "description": "

You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.

" - }, - { - "type": "string", - "name": "settings", - "description": "

An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.

" - } - ], - "descriptionHTML": "

When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.

\n

Note that you need to POST to /setup/api/configure to start the actual configuration process.

\n

When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:

\n
    \n
  1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.
    2. \n
  2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.
    3. \n
\n

Note

\n

\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "multipart/form-data", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "license": "@enterprise.ghl", - "password": "secret" - } - }, - "response": { - "statusCode": "202", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "post", - "requestPath": "/setup/api/upgrade", - "title": "Upgrade a license", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "license", - "description": "

The content of your new .ghl license file.

" - } - ], - "descriptionHTML": "

This API upgrades your license and also triggers the configuration process.

\n

Note

\n

\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "multipart/form-data", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "license": "@enterprise.ghl" - } - }, - "response": { - "statusCode": "202", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - } - ], - "previews": [] - } - ], - "org-pre-receive-hooks": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks", - "title": "List pre-receive hooks for an organization", - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "sort", - "description": "

The sort order for the response collection.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "name" - ], - "default": "created" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 42, - "name": "Check Commits", - "enforcement": "disabled", - "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42", - "allow_downstream_configuration": true - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "configuration_url": { - "type": "string" - }, - "allow_downstream_configuration": { - "type": "boolean" - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Organization pre-receive hooks\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "title": "Get a pre-receive hook for an organization", - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pre_receive_hook_id", - "description": "

The unique identifier of the pre-receive hook.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 42, - "name": "Check Commits", - "enforcement": "disabled", - "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42", - "allow_downstream_configuration": true - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "configuration_url": { - "type": "string" - }, - "allow_downstream_configuration": { - "type": "boolean" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Organization pre-receive hooks\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "title": "Update pre-receive hook enforcement for an organization", - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pre_receive_hook_id", - "description": "

The unique identifier of the pre-receive hook.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "enforcement", - "description": "

The state of enforcement for the hook on this repository.

" - }, - { - "type": "boolean", - "name": "allow_downstream_configuration", - "description": "

Whether repositories can override enforcement.

" - } - ], - "descriptionHTML": "

For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configuration

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "enforcement": "enabled", - "allow_downstream_configuration": false - }, - "parameters": { - "org": "ORG", - "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 42, - "name": "Check Commits", - "enforcement": "enabled", - "configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42", - "allow_downstream_configuration": false - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "configuration_url": { - "type": "string" - }, - "allow_downstream_configuration": { - "type": "boolean" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Organization pre-receive hooks\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "title": "Remove pre-receive hook enforcement for an organization", - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pre_receive_hook_id", - "description": "

The unique identifier of the pre-receive hook.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes any overrides for this hook at the org level for this org.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 42, - "name": "Check Commits", - "enforcement": "disabled", - "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42", - "allow_downstream_configuration": true - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "configuration_url": { - "type": "string" - }, - "allow_downstream_configuration": { - "type": "boolean" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Organization pre-receive hooks\" organization permissions": "write" - } - ] - } - } - ], - "orgs": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/admin/organizations", - "title": "Create an organization", - "category": "enterprise-admin", - "subcategory": "orgs", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "login", - "description": "

The organization's username.

", - "isRequired": true - }, - { - "type": "string", - "name": "admin", - "description": "

The login of the user who will manage this organization.

", - "isRequired": true - }, - { - "type": "string", - "name": "profile_name", - "description": "

The organization's display name.

" - } - ], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "login": "github", - "profile_name": "GitHub, Inc.", - "admin": "monalisaoctocat" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - }, - "schema": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/admin/organizations/{org}", - "title": "Update an organization name", - "category": "enterprise-admin", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "login", - "description": "

The organization's new name.

", - "isRequired": true - } - ], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "login": "the-new-octocats" - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Response

", - "example": { - "message": "Job queued to rename organization. It may take a few minutes to complete.", - "url": "https:///api/v3/organizations/1" - }, - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "url": { - "type": "string" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ], - "pre-receive-environments": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/admin/pre-receive-environments", - "title": "List pre-receive environments", - "category": "enterprise-admin", - "subcategory": "pre-receive-environments", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "sort", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "name" - ], - "default": "created" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 1, - "name": "Default", - "image_url": "githubenterprise://internal", - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1", - "html_url": "https://github.example.com/admin/pre-receive-environments/1", - "default_environment": true, - "created_at": "2016-05-20T11:35:45-05:00", - "hooks_count": 14, - "download": { - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest", - "state": "not_started", - "downloaded_at": "2016-05-26T07:42:53-05:00", - "message": null - } - }, - { - "id": 2, - "name": "DevTools Hook Env", - "image_url": "https://my_file_server/path/to/devtools_env.tar.gz", - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2", - "html_url": "https://github.example.com/admin/pre-receive-environments/2", - "default_environment": false, - "created_at": "2016-05-20T11:35:45-05:00", - "hooks_count": 1, - "download": { - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest", - "state": "success", - "downloaded_at": "2016-05-26T07:42:53-05:00", - "message": null - } - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "image_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "default_environment": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "hooks_count": { - "type": "integer" - }, - "download": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "state": { - "type": "string" - }, - "downloaded_at": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/admin/pre-receive-environments", - "title": "Create a pre-receive environment", - "category": "enterprise-admin", - "subcategory": "pre-receive-environments", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The new pre-receive environment's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "image_url", - "description": "

URL from which to download a tarball of this environment.

", - "isRequired": true - } - ], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "DevTools Hook Env", - "image_url": "https://my_file_server/path/to/devtools_env.tar.gz" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 2, - "name": "DevTools Hook Env", - "image_url": "https://my_file_server/path/to/devtools_env.tar.gz", - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2", - "html_url": "https://github.example.com/admin/pre-receive-environments/2", - "default_environment": false, - "created_at": "2016-05-20T11:35:45-05:00", - "hooks_count": 1, - "download": { - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest", - "state": "not_started", - "downloaded_at": null, - "message": null - } - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "image_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "default_environment": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "hooks_count": { - "type": "integer" - }, - "download": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "state": { - "type": "string" - }, - "downloaded_at": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "title": "Get a pre-receive environment", - "category": "enterprise-admin", - "subcategory": "pre-receive-environments", - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "

The unique identifier of the pre-receive environment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 2, - "name": "DevTools Hook Env", - "image_url": "https://my_file_server/path/to/devtools_env.tar.gz", - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2", - "html_url": "https://github.example.com/admin/pre-receive-environments/2", - "default_environment": false, - "created_at": "2016-05-20T11:35:45-05:00", - "hooks_count": 1, - "download": { - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest", - "state": "not_started", - "downloaded_at": null, - "message": null - } - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "image_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "default_environment": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "hooks_count": { - "type": "integer" - }, - "download": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "state": { - "type": "string" - }, - "downloaded_at": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "title": "Update a pre-receive environment", - "category": "enterprise-admin", - "subcategory": "pre-receive-environments", - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "

The unique identifier of the pre-receive environment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

This pre-receive environment's new name.

" - }, - { - "type": "string", - "name": "image_url", - "description": "

URL from which to download a tarball of this environment.

" - } - ], - "descriptionHTML": "

You cannot modify the default environment. If you attempt to modify the default environment, you will receive a 422 Unprocessable Entity response.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "DevTools Hook Env", - "image_url": "https://my_file_server/path/to/devtools_env.tar.gz" - }, - "parameters": { - "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 2, - "name": "DevTools Hook Env", - "image_url": "https://my_file_server/path/to/devtools_env.tar.gz", - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2", - "html_url": "https://github.example.com/admin/pre-receive-environments/2", - "default_environment": false, - "created_at": "2016-05-20T11:35:45-05:00", - "hooks_count": 1, - "download": { - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest", - "state": "success", - "downloaded_at": "2016-05-26T07:42:53-05:00", - "message": null - } - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "image_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "default_environment": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "hooks_count": { - "type": "integer" - }, - "download": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "state": { - "type": "string" - }, - "downloaded_at": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Client Errors

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "title": "Delete a pre-receive environment", - "category": "enterprise-admin", - "subcategory": "pre-receive-environments", - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "

The unique identifier of the pre-receive environment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

If you attempt to delete an environment that cannot be deleted, you will receive a 422 Unprocessable Entity response.

\n

The possible error messages are:

\n
    \n
  • Cannot modify or delete the default environment
    • \n
  • Cannot delete environment that has hooks
    • \n
  • Cannot delete environment when download is in progress
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "422", - "description": "

Client Errors

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads", - "title": "Start a pre-receive environment download", - "category": "enterprise-admin", - "subcategory": "pre-receive-environments", - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "

The unique identifier of the pre-receive environment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Triggers a new download of the environment tarball from the environment's image_url. When the download is finished, the newly downloaded tarball will overwrite the existing environment.

\n

If a download cannot be triggered, you will receive a 422 Unprocessable Entity response.

\n

The possible error messages are:

\n
    \n
  • Cannot modify or delete the default environment
    • \n
  • Can not start a new download when a download is in progress
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest", - "state": "not_started", - "downloaded_at": null, - "message": null - }, - "schema": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "state": { - "type": "string" - }, - "downloaded_at": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "422", - "description": "

Client Errors

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest", - "title": "Get the download status for a pre-receive environment", - "category": "enterprise-admin", - "subcategory": "pre-receive-environments", - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "

The unique identifier of the pre-receive environment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

In addition to seeing the download status at the \"Get a pre-receive environment\" endpoint, there is also this separate endpoint for just the download status.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest", - "state": "success", - "downloaded_at": "2016-05-26T07:42:53-05:00", - "message": null - }, - "schema": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "state": { - "type": "string" - }, - "downloaded_at": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ], - "pre-receive-hooks": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/admin/pre-receive-hooks", - "title": "List pre-receive hooks", - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "sort", - "description": "

The property to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "name" - ], - "default": "created" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 1, - "name": "Check Commits", - "enforcement": "disabled", - "script": "scripts/commmit_check.sh", - "script_repository": { - "id": 595, - "full_name": "DevIT/hooks", - "url": "https://github.example.com/api/v3/repos/DevIT/hooks", - "html_url": "https://github.example.com/DevIT/hooks" - }, - "environment": { - "id": 2, - "name": "DevTools Hook Env", - "image_url": "https://my_file_server/path/to/devtools_env.tar.gz", - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2", - "html_url": "https://github.example.com/admin/pre-receive-environments/2", - "default_environment": false, - "created_at": "2016-05-20T11:35:45-05:00", - "hooks_count": 1, - "download": { - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest", - "state": "success", - "downloaded_at": "2016-05-26T07:42:53-05:00", - "message": null - } - }, - "allow_downstream_configuration": false - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "script": { - "type": "string" - }, - "script_repository": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "full_name": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - }, - "environment": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "image_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "default_environment": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "hooks_count": { - "type": "integer" - }, - "download": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "state": { - "type": "string" - }, - "downloaded_at": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - } - } - } - }, - "allow_downstream_configuration": { - "type": "boolean" - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/admin/pre-receive-hooks", - "title": "Create a pre-receive hook", - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the hook.

", - "isRequired": true - }, - { - "type": "string", - "name": "script", - "description": "

The script that the hook runs.

", - "isRequired": true - }, - { - "type": "object", - "name": "script_repository", - "description": "

The GitHub repository where the script is kept.

", - "isRequired": true - }, - { - "type": "object", - "name": "environment", - "description": "

The pre-receive environment where the script is executed.

", - "isRequired": true - }, - { - "type": "string", - "name": "enforcement", - "description": "

The state of enforcement for this hook. default: disabled

" - }, - { - "type": "boolean", - "name": "allow_downstream_configuration", - "description": "

Whether enforcement can be overridden at the org or repo level. default: false

" - } - ], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Check Commits", - "script": "scripts/commit_check.sh", - "enforcement": "disabled", - "allow_downstream_configuration": false, - "script_repository": { - "full_name": "DevIT/hooks" - }, - "environment": { - "id": 2 - } - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "name": "Check Commits", - "enforcement": "disabled", - "script": "scripts/commmit_check.sh", - "script_repository": { - "id": 595, - "full_name": "DevIT/hooks", - "url": "https://github.example.com/api/v3/repos/DevIT/hooks", - "html_url": "https://github.example.com/DevIT/hooks" - }, - "environment": { - "id": 2, - "name": "DevTools Hook Env", - "image_url": "https://my_file_server/path/to/devtools_env.tar.gz", - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2", - "html_url": "https://github.example.com/admin/pre-receive-environments/2", - "default_environment": false, - "created_at": "2016-05-20T11:35:45-05:00", - "hooks_count": 1, - "download": { - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest", - "state": "success", - "downloaded_at": "2016-05-26T07:42:53-05:00", - "message": null - } - }, - "allow_downstream_configuration": false - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "script": { - "type": "string" - }, - "script_repository": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "full_name": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - }, - "environment": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "image_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "default_environment": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "hooks_count": { - "type": "integer" - }, - "download": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "state": { - "type": "string" - }, - "downloaded_at": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - } - } - } - }, - "allow_downstream_configuration": { - "type": "boolean" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "title": "Get a pre-receive hook", - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks", - "parameters": [ - { - "name": "pre_receive_hook_id", - "description": "

The unique identifier of the pre-receive hook.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "name": "Check Commits", - "enforcement": "disabled", - "script": "scripts/commmit_check.sh", - "script_repository": { - "id": 595, - "full_name": "DevIT/hooks", - "url": "https://github.example.com/api/v3/repos/DevIT/hooks", - "html_url": "https://github.example.com/DevIT/hooks" - }, - "environment": { - "id": 2, - "name": "DevTools Hook Env", - "image_url": "https://my_file_server/path/to/devtools_env.tar.gz", - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2", - "html_url": "https://github.example.com/admin/pre-receive-environments/2", - "default_environment": false, - "created_at": "2016-05-20T11:35:45-05:00", - "hooks_count": 1, - "download": { - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest", - "state": "success", - "downloaded_at": "2016-05-26T07:42:53-05:00", - "message": null - } - }, - "allow_downstream_configuration": false - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "script": { - "type": "string" - }, - "script_repository": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "full_name": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - }, - "environment": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "image_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "default_environment": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "hooks_count": { - "type": "integer" - }, - "download": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "state": { - "type": "string" - }, - "downloaded_at": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - } - } - } - }, - "allow_downstream_configuration": { - "type": "boolean" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "title": "Update a pre-receive hook", - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks", - "parameters": [ - { - "name": "pre_receive_hook_id", - "description": "

The unique identifier of the pre-receive hook.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the hook.

" - }, - { - "type": "string", - "name": "script", - "description": "

The script that the hook runs.

" - }, - { - "type": "object", - "name": "script_repository", - "description": "

The GitHub repository where the script is kept.

" - }, - { - "type": "object", - "name": "environment", - "description": "

The pre-receive environment where the script is executed.

" - }, - { - "type": "string", - "name": "enforcement", - "description": "

The state of enforcement for this hook.

" - }, - { - "type": "boolean", - "name": "allow_downstream_configuration", - "description": "

Whether enforcement can be overridden at the org or repo level.

" - } - ], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Check Commits", - "environment": { - "id": 1 - }, - "allow_downstream_configuration": true - }, - "parameters": { - "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "name": "Check Commits", - "enforcement": "disabled", - "script": "scripts/commmit_check.sh", - "script_repository": { - "id": 595, - "full_name": "DevIT/hooks", - "url": "https://github.example.com/api/v3/repos/DevIT/hooks", - "html_url": "https://github.example.com/DevIT/hooks" - }, - "environment": { - "id": 1, - "name": "Default", - "image_url": "githubenterprise://internal", - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1", - "html_url": "https://github.example.com/admin/pre-receive-environments/1", - "default_environment": true, - "created_at": "2016-05-20T11:35:45-05:00", - "hooks_count": 1, - "download": { - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest", - "state": "success", - "downloaded_at": "2016-05-26T07:42:53-05:00", - "message": null - } - }, - "allow_downstream_configuration": true - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "script": { - "type": "string" - }, - "script_repository": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "full_name": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - }, - "environment": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "image_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "default_environment": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "hooks_count": { - "type": "integer" - }, - "download": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "state": { - "type": "string" - }, - "downloaded_at": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - } - } - } - }, - "allow_downstream_configuration": { - "type": "boolean" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "title": "Delete a pre-receive hook", - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks", - "parameters": [ - { - "name": "pre_receive_hook_id", - "description": "

The unique identifier of the pre-receive hook.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ], - "repo-pre-receive-hooks": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", - "title": "List pre-receive hooks for a repository", - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "sort", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "name" - ], - "default": "created" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 42, - "name": "Check Commits", - "enforcement": "disabled", - "configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "configuration_url": { - "type": "string" - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Repository pre-receive hooks\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "title": "Get a pre-receive hook for a repository", - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pre_receive_hook_id", - "description": "

The unique identifier of the pre-receive hook.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 42, - "name": "Check Commits", - "enforcement": "disabled", - "configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42" - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "configuration_url": { - "type": "string" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Repository pre-receive hooks\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "title": "Update pre-receive hook enforcement for a repository", - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pre_receive_hook_id", - "description": "

The unique identifier of the pre-receive hook.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "enforcement", - "description": "

The state of enforcement for the hook on this repository.

", - "enum": [ - "enabled", - "disabled", - "testing" - ] - } - ], - "descriptionHTML": "

For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "enforcement": "enabled" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 42, - "name": "Check Commits", - "enforcement": "enabled", - "configuration_url": "https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42" - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "configuration_url": { - "type": "string" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Repository pre-receive hooks\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "title": "Remove pre-receive hook enforcement for a repository", - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pre_receive_hook_id", - "description": "

The unique identifier of the pre-receive hook.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes any overridden enforcement on this repository for the specified hook.

\n

Responds with effective values inherited from owner and/or global level.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Responds with effective values inherited from owner and/or global level.

", - "example": { - "id": 42, - "name": "Check Commits", - "enforcement": "disabled", - "configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42" - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "configuration_url": { - "type": "string" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Responds with effective values inherited from owner and/or global level.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Repository pre-receive hooks\" repository permissions": "write" - } - ] - } - } - ], - "scim": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups", - "title": "List provisioned SCIM groups for an enterprise", - "category": "enterprise-admin", - "subcategory": "scim", - "parameters": [ - { - "name": "filter", - "description": "

If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are externalId, id, and displayName. For example, ?filter=externalId eq \"9138790-10932-109120392-12321\".

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "excludedAttributes", - "description": "

Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "members" - ] - } - }, - { - "name": "startIndex", - "description": "

Used for pagination: the starting index of the first result to return when paginating through values.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "default": 1, - "format": "int32", - "examples": [ - 1 - ] - } - }, - { - "name": "count", - "description": "

Used for pagination: the number of results to return per page.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "default": 30, - "format": "int32", - "examples": [ - 1 - ] - } - }, - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Lists provisioned SCIM groups in an enterprise.

\n

You can improve query search time by using the excludedAttributes query parameter with a value of members to exclude members from the response.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/scim+json", - "description": "

Success, either groups were found or not found

", - "example": { - "schemas": [ - "urn:ietf:params:scim:api:messages:2.0:ListResponse" - ], - "totalResults": 1, - "Resources": [ - { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:Group" - ], - "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", - "id": "24b28bbb-5fc4-4686-a153-a020debb1155", - "displayName": "Engineering", - "members": [ - { - "value": "879db59-3bdf-4490-ad68-ab880a2694745", - "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", - "displayName": "User 1" - }, - { - "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", - "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", - "displayName": "User 2" - } - ], - "meta": { - "resourceType": "Group", - "created": "2012-03-27T19:59:26.000Z", - "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155" - } - } - ], - "startIndex": 1, - "itemsPerPage": 20 - }, - "schema": { - "type": "object", - "required": [ - "schemas", - "totalResults", - "Resources", - "startIndex", - "itemsPerPage" - ], - "properties": { - "schemas": { - "type": "array", - "description": "The URIs that are used to indicate the namespaces of the list SCIM schemas.", - "items": { - "type": "string", - "enum": [ - "urn:ietf:params:scim:api:messages:2.0:ListResponse" - ] - } - }, - "totalResults": { - "type": "integer", - "description": "Number of results found" - }, - "Resources": { - "type": "array", - "description": "Information about each provisioned group.", - "items": { - "allOf": [ - { - "type": "object", - "required": [ - "schemas" - ], - "properties": { - "schemas": { - "type": "array", - "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", - "items": { - "type": "string", - "enum": [ - "urn:ietf:params:scim:schemas:core:2.0:Group", - "urn:ietf:params:scim:api:messages:2.0:ListResponse" - ] - } - }, - "externalId": { - "type": [ - "string", - "null" - ], - "description": "A unique identifier for the resource as defined by the provisioning client." - }, - "displayName": { - "type": [ - "string", - "null" - ], - "description": "A human-readable name for a security group." - }, - "members": { - "type": "array", - "description": "The group members.", - "items": { - "type": "object", - "required": [ - "value", - "$ref" - ], - "properties": { - "value": { - "type": "string", - "description": "The local unique identifier for the member" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string", - "description": "The display name associated with the member" - } - } - } - } - } - }, - { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The internally generated id for the group object." - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string" - } - } - }, - "description": "The security group members." - }, - "meta": { - "type": "object", - "description": "The metadata associated with the creation/updates to the user.", - "required": [ - "resourceType" - ], - "properties": { - "resourceType": { - "type": "string", - "description": "A type of a resource", - "enum": [ - "User", - "Group" - ] - }, - "created": { - "type": "string", - "description": "A date and time when the user was created." - }, - "lastModified": { - "type": "string", - "description": "A data and time when the user was last modified." - }, - "location": { - "type": "string", - "description": "A URL location of an object" - } - } - } - } - } - ] - } - }, - "startIndex": { - "type": "integer", - "description": "A starting index for the returned page" - }, - "itemsPerPage": { - "type": "integer", - "description": "Number of objects per page" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Success, either groups were found or not found

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Authorization failure

" - }, - { - "httpStatusCode": "403", - "description": "

Permission denied

" - }, - { - "httpStatusCode": "429", - "description": "

Too many requests

" - }, - { - "httpStatusCode": "500", - "description": "

Internal server error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise SCIM\" enterprise permissions": "read" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups", - "title": "Provision a SCIM enterprise group", - "category": "enterprise-admin", - "subcategory": "scim", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "schemas", - "description": "

The URIs that are used to indicate the namespaces of the SCIM schemas.\nSupported values are: urn:ietf:params:scim:schemas:core:2.0:Group

", - "isRequired": true - }, - { - "type": "string", - "name": "externalId", - "description": "

A unique identifier for the resource as defined by the provisioning client.

", - "isRequired": true - }, - { - "type": "string", - "name": "displayName", - "description": "

A human-readable name for a security group.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "members", - "description": "

The group members.

", - "childParamsGroups": [ - { - "type": "string", - "name": "value", - "description": "

The local unique identifier for the member

", - "isRequired": true - }, - { - "type": "string", - "name": "displayName", - "description": "

The display name associated with the member

", - "isRequired": true - } - ] - } - ], - "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Creates a SCIM group for an enterprise.

\n

If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the externalId and id of each user.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:Group" - ], - "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", - "displayName": "Engineering", - "members": [ - { - "value": "879db59-3bdf-4490-ad68-ab880a2694745", - "displayName": "User 1" - }, - { - "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", - "displayName": "User 2" - } - ] - }, - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/scim+json", - "description": "

Group has been created

", - "example": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:Group" - ], - "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", - "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", - "displayName": "Engineering", - "members": [ - { - "value": "879db59-3bdf-4490-ad68-ab880a2694745", - "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", - "displayName": "User 1" - }, - { - "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", - "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", - "displayName": "User 2" - } - ], - "meta": { - "resourceType": "Group", - "created": "2012-03-27T19:59:26.000Z", - "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155" - } - }, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "schemas" - ], - "properties": { - "schemas": { - "type": "array", - "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", - "items": { - "type": "string", - "enum": [ - "urn:ietf:params:scim:schemas:core:2.0:Group", - "urn:ietf:params:scim:api:messages:2.0:ListResponse" - ] - } - }, - "externalId": { - "type": [ - "string", - "null" - ], - "description": "A unique identifier for the resource as defined by the provisioning client." - }, - "displayName": { - "type": [ - "string", - "null" - ], - "description": "A human-readable name for a security group." - }, - "members": { - "type": "array", - "description": "The group members.", - "items": { - "type": "object", - "required": [ - "value", - "$ref" - ], - "properties": { - "value": { - "type": "string", - "description": "The local unique identifier for the member" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string", - "description": "The display name associated with the member" - } - } - } - } - } - }, - { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The internally generated id for the group object." - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string" - } - } - }, - "description": "The security group members." - }, - "meta": { - "type": "object", - "description": "The metadata associated with the creation/updates to the user.", - "required": [ - "resourceType" - ], - "properties": { - "resourceType": { - "type": "string", - "description": "A type of a resource", - "enum": [ - "User", - "Group" - ] - }, - "created": { - "type": "string", - "description": "A date and time when the user was created." - }, - "lastModified": { - "type": "string", - "description": "A data and time when the user was last modified." - }, - "location": { - "type": "string", - "description": "A URL location of an object" - } - } - } - } - } - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Group has been created

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Authorization failure

" - }, - { - "httpStatusCode": "403", - "description": "

Permission denied

" - }, - { - "httpStatusCode": "409", - "description": "

Duplicate record detected

" - }, - { - "httpStatusCode": "429", - "description": "

Too many requests

" - }, - { - "httpStatusCode": "500", - "description": "

Internal server error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise SCIM\" enterprise permissions": "write" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - "title": "Get SCIM provisioning information for an enterprise group", - "category": "enterprise-admin", - "subcategory": "scim", - "parameters": [ - { - "name": "scim_group_id", - "description": "

A unique identifier of the SCIM group.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "examples": [ - "7fce0092-d52e-4f76-b727-3955bd72c939" - ] - } - }, - { - "name": "excludedAttributes", - "description": "

Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "members" - ] - } - }, - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Gets information about a SCIM group.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "scim_group_id": "SCIM_GROUP_ID", - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/scim+json", - "description": "

Success, a group was found

", - "example": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:Group" - ], - "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", - "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", - "displayName": "Engineering", - "members": [ - { - "value": "879db59-3bdf-4490-ad68-ab880a2694745", - "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", - "displayName": "User 1" - }, - { - "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", - "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", - "displayName": "User 2" - } - ], - "meta": { - "resourceType": "Group", - "created": "2012-03-27T19:59:26.000Z", - "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155" - } - }, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "schemas" - ], - "properties": { - "schemas": { - "type": "array", - "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", - "items": { - "type": "string", - "enum": [ - "urn:ietf:params:scim:schemas:core:2.0:Group", - "urn:ietf:params:scim:api:messages:2.0:ListResponse" - ] - } - }, - "externalId": { - "type": [ - "string", - "null" - ], - "description": "A unique identifier for the resource as defined by the provisioning client." - }, - "displayName": { - "type": [ - "string", - "null" - ], - "description": "A human-readable name for a security group." - }, - "members": { - "type": "array", - "description": "The group members.", - "items": { - "type": "object", - "required": [ - "value", - "$ref" - ], - "properties": { - "value": { - "type": "string", - "description": "The local unique identifier for the member" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string", - "description": "The display name associated with the member" - } - } - } - } - } - }, - { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The internally generated id for the group object." - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string" - } - } - }, - "description": "The security group members." - }, - "meta": { - "type": "object", - "description": "The metadata associated with the creation/updates to the user.", - "required": [ - "resourceType" - ], - "properties": { - "resourceType": { - "type": "string", - "description": "A type of a resource", - "enum": [ - "User", - "Group" - ] - }, - "created": { - "type": "string", - "description": "A date and time when the user was created." - }, - "lastModified": { - "type": "string", - "description": "A data and time when the user was last modified." - }, - "location": { - "type": "string", - "description": "A URL location of an object" - } - } - } - } - } - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Success, a group was found

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Authorization failure

" - }, - { - "httpStatusCode": "403", - "description": "

Permission denied

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "429", - "description": "

Too many requests

" - }, - { - "httpStatusCode": "500", - "description": "

Internal server error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise SCIM\" enterprise permissions": "read" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - "title": "Set SCIM information for a provisioned enterprise group", - "category": "enterprise-admin", - "subcategory": "scim", - "parameters": [ - { - "name": "scim_group_id", - "description": "

A unique identifier of the SCIM group.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "examples": [ - "7fce0092-d52e-4f76-b727-3955bd72c939" - ] - } - }, - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "schemas", - "description": "

The URIs that are used to indicate the namespaces of the SCIM schemas.\nSupported values are: urn:ietf:params:scim:schemas:core:2.0:Group

", - "isRequired": true - }, - { - "type": "string", - "name": "externalId", - "description": "

A unique identifier for the resource as defined by the provisioning client.

", - "isRequired": true - }, - { - "type": "string", - "name": "displayName", - "description": "

A human-readable name for a security group.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "members", - "description": "

The group members.

", - "childParamsGroups": [ - { - "type": "string", - "name": "value", - "description": "

The local unique identifier for the member

", - "isRequired": true - }, - { - "type": "string", - "name": "displayName", - "description": "

The display name associated with the member

", - "isRequired": true - } - ] - } - ], - "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Replaces an existing provisioned group’s information.

\n

You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Group", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:Group" - ], - "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", - "displayName": "Engineering" - }, - "parameters": { - "scim_group_id": "SCIM_GROUP_ID", - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/scim+json", - "description": "

Group was updated

", - "example": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:Group" - ], - "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", - "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", - "displayName": "Engineering", - "members": [ - { - "value": "879db59-3bdf-4490-ad68-ab880a2694745", - "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", - "displayName": "User 1" - }, - { - "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", - "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", - "displayName": "User 2" - } - ], - "meta": { - "resourceType": "Group", - "created": "2012-03-27T19:59:26.000Z", - "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155" - } - }, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "schemas" - ], - "properties": { - "schemas": { - "type": "array", - "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", - "items": { - "type": "string", - "enum": [ - "urn:ietf:params:scim:schemas:core:2.0:Group", - "urn:ietf:params:scim:api:messages:2.0:ListResponse" - ] - } - }, - "externalId": { - "type": [ - "string", - "null" - ], - "description": "A unique identifier for the resource as defined by the provisioning client." - }, - "displayName": { - "type": [ - "string", - "null" - ], - "description": "A human-readable name for a security group." - }, - "members": { - "type": "array", - "description": "The group members.", - "items": { - "type": "object", - "required": [ - "value", - "$ref" - ], - "properties": { - "value": { - "type": "string", - "description": "The local unique identifier for the member" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string", - "description": "The display name associated with the member" - } - } - } - } - } - }, - { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The internally generated id for the group object." - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string" - } - } - }, - "description": "The security group members." - }, - "meta": { - "type": "object", - "description": "The metadata associated with the creation/updates to the user.", - "required": [ - "resourceType" - ], - "properties": { - "resourceType": { - "type": "string", - "description": "A type of a resource", - "enum": [ - "User", - "Group" - ] - }, - "created": { - "type": "string", - "description": "A date and time when the user was created." - }, - "lastModified": { - "type": "string", - "description": "A data and time when the user was last modified." - }, - "location": { - "type": "string", - "description": "A URL location of an object" - } - } - } - } - } - ] - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Group with member", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:Group" - ], - "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", - "displayName": "Engineering", - "members": [ - { - "value": "879db59-3bdf-4490-ad68-ab880a2694745", - "displayName": "User 1" - }, - { - "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", - "displayName": "User 2" - } - ] - }, - "parameters": { - "scim_group_id": "SCIM_GROUP_ID", - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/scim+json", - "description": "

Group was updated

", - "example": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:Group" - ], - "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", - "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", - "displayName": "Engineering", - "members": [ - { - "value": "879db59-3bdf-4490-ad68-ab880a2694745", - "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", - "displayName": "User 1" - }, - { - "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", - "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", - "displayName": "User 2" - } - ], - "meta": { - "resourceType": "Group", - "created": "2012-03-27T19:59:26.000Z", - "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155" - } - }, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "schemas" - ], - "properties": { - "schemas": { - "type": "array", - "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", - "items": { - "type": "string", - "enum": [ - "urn:ietf:params:scim:schemas:core:2.0:Group", - "urn:ietf:params:scim:api:messages:2.0:ListResponse" - ] - } - }, - "externalId": { - "type": [ - "string", - "null" - ], - "description": "A unique identifier for the resource as defined by the provisioning client." - }, - "displayName": { - "type": [ - "string", - "null" - ], - "description": "A human-readable name for a security group." - }, - "members": { - "type": "array", - "description": "The group members.", - "items": { - "type": "object", - "required": [ - "value", - "$ref" - ], - "properties": { - "value": { - "type": "string", - "description": "The local unique identifier for the member" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string", - "description": "The display name associated with the member" - } - } - } - } - } - }, - { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The internally generated id for the group object." - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string" - } - } - }, - "description": "The security group members." - }, - "meta": { - "type": "object", - "description": "The metadata associated with the creation/updates to the user.", - "required": [ - "resourceType" - ], - "properties": { - "resourceType": { - "type": "string", - "description": "A type of a resource", - "enum": [ - "User", - "Group" - ] - }, - "created": { - "type": "string", - "description": "A date and time when the user was created." - }, - "lastModified": { - "type": "string", - "description": "A data and time when the user was last modified." - }, - "location": { - "type": "string", - "description": "A URL location of an object" - } - } - } - } - } - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Group was updated

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Authorization failure

" - }, - { - "httpStatusCode": "403", - "description": "

Permission denied

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Duplicate record detected

" - }, - { - "httpStatusCode": "429", - "description": "

Too many requests

" - }, - { - "httpStatusCode": "500", - "description": "

Internal server error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise SCIM\" enterprise permissions": "write" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - "title": "Update an attribute for a SCIM enterprise group", - "category": "enterprise-admin", - "subcategory": "scim", - "parameters": [ - { - "name": "scim_group_id", - "description": "

A unique identifier of the SCIM group.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "examples": [ - "7fce0092-d52e-4f76-b727-3955bd72c939" - ] - } - }, - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of objects", - "name": "Operations", - "description": "

patch operations list

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "op", - "description": "", - "isRequired": true, - "enum": [ - "add", - "replace", - "remove" - ] - }, - { - "type": "string", - "name": "path", - "description": "" - }, - { - "type": "string", - "name": "value", - "description": "

Corresponding 'value' of that field specified by 'path'

" - } - ] - }, - { - "type": "array of strings", - "name": "schemas", - "description": "

undefinedSupported values are: urn:ietf:params:scim:api:messages:2.0:PatchOp

", - "isRequired": true - } - ], - "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Update a provisioned group’s individual attributes.

\n

To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification. Update can also be used to add group memberships.

\n

Group memberships can be sent one at a time or in batches for faster performance. Note: The memberships are referenced through a local user id, and the user will need to be created before they are referenced here.

", - "codeExamples": [ - { - "response": { - "statusCode": "200", - "contentType": "application/scim+json", - "description": "

Success, group was updated

", - "example": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:Group" - ], - "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", - "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", - "displayName": "Engineering", - "members": [ - { - "value": "879db59-3bdf-4490-ad68-ab880a2694745", - "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", - "displayName": "User 1" - }, - { - "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", - "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", - "displayName": "User 2" - } - ], - "meta": { - "resourceType": "Group", - "created": "2012-03-27T19:59:26.000Z", - "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155" - } - }, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "schemas" - ], - "properties": { - "schemas": { - "type": "array", - "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", - "items": { - "type": "string", - "enum": [ - "urn:ietf:params:scim:schemas:core:2.0:Group", - "urn:ietf:params:scim:api:messages:2.0:ListResponse" - ] - } - }, - "externalId": { - "type": [ - "string", - "null" - ], - "description": "A unique identifier for the resource as defined by the provisioning client." - }, - "displayName": { - "type": [ - "string", - "null" - ], - "description": "A human-readable name for a security group." - }, - "members": { - "type": "array", - "description": "The group members.", - "items": { - "type": "object", - "required": [ - "value", - "$ref" - ], - "properties": { - "value": { - "type": "string", - "description": "The local unique identifier for the member" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string", - "description": "The display name associated with the member" - } - } - } - } - } - }, - { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The internally generated id for the group object." - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string" - } - } - }, - "description": "The security group members." - }, - "meta": { - "type": "object", - "description": "The metadata associated with the creation/updates to the user.", - "required": [ - "resourceType" - ], - "properties": { - "resourceType": { - "type": "string", - "description": "A type of a resource", - "enum": [ - "User", - "Group" - ] - }, - "created": { - "type": "string", - "description": "A date and time when the user was created." - }, - "lastModified": { - "type": "string", - "description": "A data and time when the user was last modified." - }, - "location": { - "type": "string", - "description": "A URL location of an object" - } - } - } - } - } - ] - } - }, - "request": { - "contentType": "application/json", - "description": "Update Group", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "schemas": [ - "urn:ietf:params:scim:api:messages:2.0:PatchOp" - ], - "Operations": [ - { - "op": "replace", - "path": "displayName", - "value": "Employees" - } - ] - }, - "parameters": { - "scim_group_id": "SCIM_GROUP_ID", - "enterprise": "ENTERPRISE" - } - } - }, - { - "response": { - "statusCode": "200", - "contentType": "application/scim+json", - "description": "

Success, group was updated

", - "example": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:Group" - ], - "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", - "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", - "displayName": "Engineering", - "members": [ - { - "value": "879db59-3bdf-4490-ad68-ab880a2694745", - "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", - "displayName": "User 1" - }, - { - "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", - "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", - "displayName": "User 2" - } - ], - "meta": { - "resourceType": "Group", - "created": "2012-03-27T19:59:26.000Z", - "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155" - } - }, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "schemas" - ], - "properties": { - "schemas": { - "type": "array", - "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", - "items": { - "type": "string", - "enum": [ - "urn:ietf:params:scim:schemas:core:2.0:Group", - "urn:ietf:params:scim:api:messages:2.0:ListResponse" - ] - } - }, - "externalId": { - "type": [ - "string", - "null" - ], - "description": "A unique identifier for the resource as defined by the provisioning client." - }, - "displayName": { - "type": [ - "string", - "null" - ], - "description": "A human-readable name for a security group." - }, - "members": { - "type": "array", - "description": "The group members.", - "items": { - "type": "object", - "required": [ - "value", - "$ref" - ], - "properties": { - "value": { - "type": "string", - "description": "The local unique identifier for the member" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string", - "description": "The display name associated with the member" - } - } - } - } - } - }, - { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The internally generated id for the group object." - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string" - } - } - }, - "description": "The security group members." - }, - "meta": { - "type": "object", - "description": "The metadata associated with the creation/updates to the user.", - "required": [ - "resourceType" - ], - "properties": { - "resourceType": { - "type": "string", - "description": "A type of a resource", - "enum": [ - "User", - "Group" - ] - }, - "created": { - "type": "string", - "description": "A date and time when the user was created." - }, - "lastModified": { - "type": "string", - "description": "A data and time when the user was last modified." - }, - "location": { - "type": "string", - "description": "A URL location of an object" - } - } - } - } - } - ] - } - }, - "request": { - "contentType": "application/json", - "description": "Add Members", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "schemas": [ - "urn:ietf:params:scim:api:messages:2.0:PatchOp" - ], - "Operations": [ - { - "op": "add", - "path": "members", - "value": [ - { - "value": "879db59-3bdf-4490-ad68-ab880a2694745" - }, - { - "value": "0db508eb-91e2-46e4-809c-30dcbda0c685" - } - ] - } - ] - }, - "parameters": { - "scim_group_id": "SCIM_GROUP_ID", - "enterprise": "ENTERPRISE" - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Success, group was updated

" - }, - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Authorization failure

" - }, - { - "httpStatusCode": "403", - "description": "

Permission denied

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Duplicate record detected

" - }, - { - "httpStatusCode": "429", - "description": "

Too many requests

" - }, - { - "httpStatusCode": "500", - "description": "

Internal server error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise SCIM\" enterprise permissions": "write" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - "title": "Delete a SCIM group from an enterprise", - "category": "enterprise-admin", - "subcategory": "scim", - "parameters": [ - { - "name": "scim_group_id", - "description": "

A unique identifier of the SCIM group.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "examples": [ - "7fce0092-d52e-4f76-b727-3955bd72c939" - ] - } - }, - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Deletes a SCIM group from an enterprise.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "scim_group_id": "SCIM_GROUP_ID", - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "204", - "description": "

Group was deleted, no content

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Group was deleted, no content

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Authorization failure

" - }, - { - "httpStatusCode": "403", - "description": "

Permission denied

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "429", - "description": "

Too many requests

" - }, - { - "httpStatusCode": "500", - "description": "

Internal server error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise SCIM\" enterprise permissions": "write" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users", - "title": "List SCIM provisioned identities for an enterprise", - "category": "enterprise-admin", - "subcategory": "scim", - "parameters": [ - { - "name": "filter", - "description": "

If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are userName, externalId, id, and displayName. For example, ?filter=externalId eq \"9138790-10932-109120392-12321\".

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "startIndex", - "description": "

Used for pagination: the starting index of the first result to return when paginating through values.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "default": 1, - "format": "int32", - "examples": [ - 1 - ] - } - }, - { - "name": "count", - "description": "

Used for pagination: the number of results to return per page.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "default": 30, - "format": "int32", - "examples": [ - 1 - ] - } - }, - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Lists provisioned SCIM enterprise members.

\n

When a user with a SCIM-provisioned external identity is removed from an enterprise through a patch with active flag set to false, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the delete request. Users that were not permanently deleted will be visible in the returned results.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/scim+json", - "description": "

Success, either users were found or not found

", - "example": { - "schemas": [ - "urn:ietf:params:scim:api:messages:2.0:ListResponse" - ], - "totalResults": 1, - "Resources": [ - { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ], - "externalId": "E012345", - "id": "7fce0092-d52e-4f76-b727-3955bd72c939", - "active": true, - "userName": "E012345", - "name": { - "formatted": "Ms. Mona Lisa Octocat", - "familyName": "Octocat", - "givenName": "Mona", - "middleName": "Lisa" - }, - "displayName": "Mona Lisa", - "emails": [ - { - "value": "mlisa@example.com", - "type": "work", - "primary": true - } - ], - "roles": [ - { - "value": "User", - "primary": false - } - ] - } - ], - "startIndex": 1, - "itemsPerPage": 20 - }, - "schema": { - "type": "object", - "required": [ - "schemas", - "totalResults", - "Resources", - "startIndex", - "itemsPerPage" - ], - "properties": { - "schemas": { - "type": "array", - "description": "The URIs that are used to indicate the namespaces of the list SCIM schemas.", - "items": { - "type": "string", - "enum": [ - "urn:ietf:params:scim:api:messages:2.0:ListResponse" - ] - } - }, - "totalResults": { - "type": "integer", - "description": "Number of results found" - }, - "Resources": { - "type": "array", - "description": "Information about each provisioned account.", - "items": { - "allOf": [ - { - "type": "object", - "required": [ - "schemas", - "active", - "emails" - ], - "properties": { - "schemas": { - "type": "array", - "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", - "items": { - "type": "string", - "enum": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ] - } - }, - "externalId": { - "type": [ - "string", - "null" - ], - "description": "A unique identifier for the resource as defined by the provisioning client." - }, - "active": { - "type": "boolean", - "description": "Whether the user active in the IdP." - }, - "userName": { - "type": "string", - "description": "The username for the user." - }, - "name": { - "type": "object", - "properties": { - "formatted": { - "type": "string", - "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display." - }, - "familyName": { - "type": "string", - "description": "The family name of the user." - }, - "givenName": { - "type": "string", - "description": "The given name of the user." - }, - "middleName": { - "type": "string", - "description": "The middle name(s) of the user." - } - } - }, - "displayName": { - "type": [ - "string", - "null" - ], - "description": "A human-readable name for the user." - }, - "emails": { - "type": "array", - "description": "The emails for the user.", - "items": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "string", - "description": "The email address." - }, - "type": { - "type": "string", - "description": "The type of email address." - }, - "primary": { - "type": "boolean", - "description": "Whether this email address is the primary address." - } - } - } - }, - "roles": { - "type": "array", - "description": "The roles assigned to the user.", - "items": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "display": { - "type": "string" - }, - "type": { - "type": "string" - }, - "value": { - "type": "string", - "description": "The role value representing a user role in GitHub.", - "enum": [ - "user", - "27d9891d-2c17-4f45-a262-781a0e55c80a", - "guest_collaborator", - "1ebc4a02-e56c-43a6-92a5-02ee09b90824", - "enterprise_owner", - "981df190-8801-4618-a08a-d91f6206c954", - "ba4987ab-a1c3-412a-b58c-360fc407cb10", - "billing_manager", - "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", - "e6be2762-e4ad-4108-b72d-1bbe884a0f91" - ] - }, - "primary": { - "type": "boolean", - "description": "Is the role a primary role for the user." - } - } - } - } - } - }, - { - "type": "object", - "required": [ - "id", - "meta" - ], - "properties": { - "id": { - "type": "string", - "description": "The internally generated id for the user object." - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string" - } - } - }, - "description": "Provisioned SCIM groups that the user is a member of." - }, - "meta": { - "type": "object", - "description": "The metadata associated with the creation/updates to the user.", - "required": [ - "resourceType" - ], - "properties": { - "resourceType": { - "type": "string", - "description": "A type of a resource", - "enum": [ - "User", - "Group" - ] - }, - "created": { - "type": "string", - "description": "A date and time when the user was created." - }, - "lastModified": { - "type": "string", - "description": "A data and time when the user was last modified." - }, - "location": { - "type": "string", - "description": "A URL location of an object" - } - } - } - } - } - ] - } - }, - "startIndex": { - "type": "integer", - "description": "A starting index for the returned page" - }, - "itemsPerPage": { - "type": "integer", - "description": "Number of objects per page" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Success, either users were found or not found

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Authorization failure

" - }, - { - "httpStatusCode": "403", - "description": "

Permission denied

" - }, - { - "httpStatusCode": "429", - "description": "

Too many requests

" - }, - { - "httpStatusCode": "500", - "description": "

Internal server error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise SCIM\" enterprise permissions": "read" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users", - "title": "Provision a SCIM enterprise user", - "category": "enterprise-admin", - "subcategory": "scim", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "schemas", - "description": "

The URIs that are used to indicate the namespaces of the SCIM schemas.\nSupported values are: urn:ietf:params:scim:schemas:core:2.0:User

", - "isRequired": true - }, - { - "type": "string", - "name": "externalId", - "description": "

A unique identifier for the resource as defined by the provisioning client.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "active", - "description": "

Whether the user active in the IdP.

", - "isRequired": true - }, - { - "type": "string", - "name": "userName", - "description": "

The username for the user.

", - "isRequired": true - }, - { - "type": "object", - "name": "name", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "formatted", - "description": "

The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

" - }, - { - "type": "string", - "name": "familyName", - "description": "

The family name of the user.

", - "isRequired": true - }, - { - "type": "string", - "name": "givenName", - "description": "

The given name of the user.

", - "isRequired": true - }, - { - "type": "string", - "name": "middleName", - "description": "

The middle name(s) of the user.

" - } - ] - }, - { - "type": "string", - "name": "displayName", - "description": "

A human-readable name for the user.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "emails", - "description": "

The emails for the user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "value", - "description": "

The email address.

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The type of email address.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "primary", - "description": "

Whether this email address is the primary address.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "roles", - "description": "

The roles assigned to the user.

", - "childParamsGroups": [ - { - "type": "string", - "name": "display", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "value", - "description": "

The role value representing a user role in GitHub.

", - "isRequired": true, - "enum": [ - "user", - "27d9891d-2c17-4f45-a262-781a0e55c80a", - "guest_collaborator", - "1ebc4a02-e56c-43a6-92a5-02ee09b90824", - "enterprise_owner", - "981df190-8801-4618-a08a-d91f6206c954", - "ba4987ab-a1c3-412a-b58c-360fc407cb10", - "billing_manager", - "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", - "e6be2762-e4ad-4108-b72d-1bbe884a0f91" - ] - }, - { - "type": "boolean", - "name": "primary", - "description": "

Is the role a primary role for the user.

" - } - ] - } - ], - "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Creates an external identity for a new SCIM enterprise user.

\n

SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response NameID to SCIM userName.

\n

When converting existing enterprise to use SCIM, the user handle (userName) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "User", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ], - "externalId": "E012345", - "active": true, - "userName": "E012345", - "name": { - "formatted": "Ms. Mona Lisa Octocat", - "familyName": "Octocat", - "givenName": "Mona", - "middleName": "Lisa" - }, - "displayName": "Mona Lisa", - "emails": [ - { - "value": "mlisa@example.com", - "type": "work", - "primary": true - } - ], - "roles": [ - { - "value": "user", - "primary": false - } - ] - }, - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/scim+json", - "description": "

User has been created

", - "example": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ], - "id": "7fce0092-d52e-4f76-b727-3955bd72c939", - "externalId": "E012345", - "active": true, - "userName": "E012345", - "name": { - "formatted": "Ms. Mona Lisa Octocat", - "familyName": "Octocat", - "givenName": "Mona", - "middleName": "Lisa" - }, - "displayName": "Mona Lisa", - "emails": [ - { - "value": "mlisa@example.com", - "type": "work", - "primary": true - } - ], - "roles": [ - { - "value": "User", - "primary": false - } - ], - "meta": { - "resourceType": "User", - "created": "2012-03-27T19:59:26.000Z", - "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939" - } - }, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "schemas", - "active", - "emails" - ], - "properties": { - "schemas": { - "type": "array", - "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", - "items": { - "type": "string", - "enum": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ] - } - }, - "externalId": { - "type": [ - "string", - "null" - ], - "description": "A unique identifier for the resource as defined by the provisioning client." - }, - "active": { - "type": "boolean", - "description": "Whether the user active in the IdP." - }, - "userName": { - "type": "string", - "description": "The username for the user." - }, - "name": { - "type": "object", - "properties": { - "formatted": { - "type": "string", - "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display." - }, - "familyName": { - "type": "string", - "description": "The family name of the user." - }, - "givenName": { - "type": "string", - "description": "The given name of the user." - }, - "middleName": { - "type": "string", - "description": "The middle name(s) of the user." - } - } - }, - "displayName": { - "type": [ - "string", - "null" - ], - "description": "A human-readable name for the user." - }, - "emails": { - "type": "array", - "description": "The emails for the user.", - "items": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "string", - "description": "The email address." - }, - "type": { - "type": "string", - "description": "The type of email address." - }, - "primary": { - "type": "boolean", - "description": "Whether this email address is the primary address." - } - } - } - }, - "roles": { - "type": "array", - "description": "The roles assigned to the user.", - "items": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "display": { - "type": "string" - }, - "type": { - "type": "string" - }, - "value": { - "type": "string", - "description": "The role value representing a user role in GitHub.", - "enum": [ - "user", - "27d9891d-2c17-4f45-a262-781a0e55c80a", - "guest_collaborator", - "1ebc4a02-e56c-43a6-92a5-02ee09b90824", - "enterprise_owner", - "981df190-8801-4618-a08a-d91f6206c954", - "ba4987ab-a1c3-412a-b58c-360fc407cb10", - "billing_manager", - "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", - "e6be2762-e4ad-4108-b72d-1bbe884a0f91" - ] - }, - "primary": { - "type": "boolean", - "description": "Is the role a primary role for the user." - } - } - } - } - } - }, - { - "type": "object", - "required": [ - "id", - "meta" - ], - "properties": { - "id": { - "type": "string", - "description": "The internally generated id for the user object." - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string" - } - } - }, - "description": "Provisioned SCIM groups that the user is a member of." - }, - "meta": { - "type": "object", - "description": "The metadata associated with the creation/updates to the user.", - "required": [ - "resourceType" - ], - "properties": { - "resourceType": { - "type": "string", - "description": "A type of a resource", - "enum": [ - "User", - "Group" - ] - }, - "created": { - "type": "string", - "description": "A date and time when the user was created." - }, - "lastModified": { - "type": "string", - "description": "A data and time when the user was last modified." - }, - "location": { - "type": "string", - "description": "A URL location of an object" - } - } - } - } - } - ] - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Enterprise Owner", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ], - "externalId": "E012345", - "active": true, - "userName": "E012345", - "name": { - "formatted": "Ms. Mona Lisa Octocat", - "familyName": "Octocat", - "givenName": "Mona", - "middleName": "Lisa" - }, - "displayName": "Mona Lisa", - "emails": [ - { - "value": "mlisa@example.com", - "type": "work", - "primary": true - } - ], - "roles": [ - { - "value": "enterprise_owner", - "primary": false - } - ] - }, - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/scim+json", - "description": "

User has been created

", - "example": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ], - "id": "7fce0092-d52e-4f76-b727-3955bd72c939", - "externalId": "E012345", - "active": true, - "userName": "E012345", - "name": { - "formatted": "Ms. Mona Lisa Octocat", - "familyName": "Octocat", - "givenName": "Mona", - "middleName": "Lisa" - }, - "displayName": "Mona Lisa", - "emails": [ - { - "value": "mlisa@example.com", - "type": "work", - "primary": true - } - ], - "roles": [ - { - "value": "User", - "primary": false - } - ], - "meta": { - "resourceType": "User", - "created": "2012-03-27T19:59:26.000Z", - "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939" - } - }, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "schemas", - "active", - "emails" - ], - "properties": { - "schemas": { - "type": "array", - "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", - "items": { - "type": "string", - "enum": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ] - } - }, - "externalId": { - "type": [ - "string", - "null" - ], - "description": "A unique identifier for the resource as defined by the provisioning client." - }, - "active": { - "type": "boolean", - "description": "Whether the user active in the IdP." - }, - "userName": { - "type": "string", - "description": "The username for the user." - }, - "name": { - "type": "object", - "properties": { - "formatted": { - "type": "string", - "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display." - }, - "familyName": { - "type": "string", - "description": "The family name of the user." - }, - "givenName": { - "type": "string", - "description": "The given name of the user." - }, - "middleName": { - "type": "string", - "description": "The middle name(s) of the user." - } - } - }, - "displayName": { - "type": [ - "string", - "null" - ], - "description": "A human-readable name for the user." - }, - "emails": { - "type": "array", - "description": "The emails for the user.", - "items": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "string", - "description": "The email address." - }, - "type": { - "type": "string", - "description": "The type of email address." - }, - "primary": { - "type": "boolean", - "description": "Whether this email address is the primary address." - } - } - } - }, - "roles": { - "type": "array", - "description": "The roles assigned to the user.", - "items": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "display": { - "type": "string" - }, - "type": { - "type": "string" - }, - "value": { - "type": "string", - "description": "The role value representing a user role in GitHub.", - "enum": [ - "user", - "27d9891d-2c17-4f45-a262-781a0e55c80a", - "guest_collaborator", - "1ebc4a02-e56c-43a6-92a5-02ee09b90824", - "enterprise_owner", - "981df190-8801-4618-a08a-d91f6206c954", - "ba4987ab-a1c3-412a-b58c-360fc407cb10", - "billing_manager", - "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", - "e6be2762-e4ad-4108-b72d-1bbe884a0f91" - ] - }, - "primary": { - "type": "boolean", - "description": "Is the role a primary role for the user." - } - } - } - } - } - }, - { - "type": "object", - "required": [ - "id", - "meta" - ], - "properties": { - "id": { - "type": "string", - "description": "The internally generated id for the user object." - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string" - } - } - }, - "description": "Provisioned SCIM groups that the user is a member of." - }, - "meta": { - "type": "object", - "description": "The metadata associated with the creation/updates to the user.", - "required": [ - "resourceType" - ], - "properties": { - "resourceType": { - "type": "string", - "description": "A type of a resource", - "enum": [ - "User", - "Group" - ] - }, - "created": { - "type": "string", - "description": "A date and time when the user was created." - }, - "lastModified": { - "type": "string", - "description": "A data and time when the user was last modified." - }, - "location": { - "type": "string", - "description": "A URL location of an object" - } - } - } - } - } - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

User has been created

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Authorization failure

" - }, - { - "httpStatusCode": "403", - "description": "

Permission denied

" - }, - { - "httpStatusCode": "409", - "description": "

Duplicate record detected

" - }, - { - "httpStatusCode": "429", - "description": "

Too many requests

" - }, - { - "httpStatusCode": "500", - "description": "

Internal server error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise SCIM\" enterprise permissions": "write" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", - "title": "Get SCIM provisioning information for an enterprise user", - "category": "enterprise-admin", - "subcategory": "scim", - "parameters": [ - { - "name": "scim_user_id", - "description": "

The unique identifier of the SCIM user.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Gets information about a SCIM user.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "scim_user_id": "SCIM_USER_ID", - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/scim+json", - "description": "

Success, a user was found

", - "example": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ], - "id": "7fce0092-d52e-4f76-b727-3955bd72c939", - "externalId": "E012345", - "active": true, - "userName": "E012345", - "name": { - "formatted": "Ms. Mona Lisa Octocat", - "familyName": "Octocat", - "givenName": "Mona", - "middleName": "Lisa" - }, - "displayName": "Mona Lisa", - "emails": [ - { - "value": "mlisa@example.com", - "type": "work", - "primary": true - } - ], - "roles": [ - { - "value": "User", - "primary": false - } - ], - "meta": { - "resourceType": "User", - "created": "2012-03-27T19:59:26.000Z", - "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939" - } - }, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "schemas", - "active", - "emails" - ], - "properties": { - "schemas": { - "type": "array", - "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", - "items": { - "type": "string", - "enum": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ] - } - }, - "externalId": { - "type": [ - "string", - "null" - ], - "description": "A unique identifier for the resource as defined by the provisioning client." - }, - "active": { - "type": "boolean", - "description": "Whether the user active in the IdP." - }, - "userName": { - "type": "string", - "description": "The username for the user." - }, - "name": { - "type": "object", - "properties": { - "formatted": { - "type": "string", - "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display." - }, - "familyName": { - "type": "string", - "description": "The family name of the user." - }, - "givenName": { - "type": "string", - "description": "The given name of the user." - }, - "middleName": { - "type": "string", - "description": "The middle name(s) of the user." - } - } - }, - "displayName": { - "type": [ - "string", - "null" - ], - "description": "A human-readable name for the user." - }, - "emails": { - "type": "array", - "description": "The emails for the user.", - "items": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "string", - "description": "The email address." - }, - "type": { - "type": "string", - "description": "The type of email address." - }, - "primary": { - "type": "boolean", - "description": "Whether this email address is the primary address." - } - } - } - }, - "roles": { - "type": "array", - "description": "The roles assigned to the user.", - "items": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "display": { - "type": "string" - }, - "type": { - "type": "string" - }, - "value": { - "type": "string", - "description": "The role value representing a user role in GitHub.", - "enum": [ - "user", - "27d9891d-2c17-4f45-a262-781a0e55c80a", - "guest_collaborator", - "1ebc4a02-e56c-43a6-92a5-02ee09b90824", - "enterprise_owner", - "981df190-8801-4618-a08a-d91f6206c954", - "ba4987ab-a1c3-412a-b58c-360fc407cb10", - "billing_manager", - "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", - "e6be2762-e4ad-4108-b72d-1bbe884a0f91" - ] - }, - "primary": { - "type": "boolean", - "description": "Is the role a primary role for the user." - } - } - } - } - } - }, - { - "type": "object", - "required": [ - "id", - "meta" - ], - "properties": { - "id": { - "type": "string", - "description": "The internally generated id for the user object." - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string" - } - } - }, - "description": "Provisioned SCIM groups that the user is a member of." - }, - "meta": { - "type": "object", - "description": "The metadata associated with the creation/updates to the user.", - "required": [ - "resourceType" - ], - "properties": { - "resourceType": { - "type": "string", - "description": "A type of a resource", - "enum": [ - "User", - "Group" - ] - }, - "created": { - "type": "string", - "description": "A date and time when the user was created." - }, - "lastModified": { - "type": "string", - "description": "A data and time when the user was last modified." - }, - "location": { - "type": "string", - "description": "A URL location of an object" - } - } - } - } - } - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Success, a user was found

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Authorization failure

" - }, - { - "httpStatusCode": "403", - "description": "

Permission denied

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "429", - "description": "

Too many requests

" - }, - { - "httpStatusCode": "500", - "description": "

Internal server error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise SCIM\" enterprise permissions": "read" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", - "title": "Set SCIM information for a provisioned enterprise user", - "category": "enterprise-admin", - "subcategory": "scim", - "parameters": [ - { - "name": "scim_user_id", - "description": "

The unique identifier of the SCIM user.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "schemas", - "description": "

The URIs that are used to indicate the namespaces of the SCIM schemas.\nSupported values are: urn:ietf:params:scim:schemas:core:2.0:User

", - "isRequired": true - }, - { - "type": "string", - "name": "externalId", - "description": "

A unique identifier for the resource as defined by the provisioning client.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "active", - "description": "

Whether the user active in the IdP.

", - "isRequired": true - }, - { - "type": "string", - "name": "userName", - "description": "

The username for the user.

", - "isRequired": true - }, - { - "type": "object", - "name": "name", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "formatted", - "description": "

The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

" - }, - { - "type": "string", - "name": "familyName", - "description": "

The family name of the user.

", - "isRequired": true - }, - { - "type": "string", - "name": "givenName", - "description": "

The given name of the user.

", - "isRequired": true - }, - { - "type": "string", - "name": "middleName", - "description": "

The middle name(s) of the user.

" - } - ] - }, - { - "type": "string", - "name": "displayName", - "description": "

A human-readable name for the user.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "emails", - "description": "

The emails for the user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "value", - "description": "

The email address.

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The type of email address.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "primary", - "description": "

Whether this email address is the primary address.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "roles", - "description": "

The roles assigned to the user.

", - "childParamsGroups": [ - { - "type": "string", - "name": "display", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "value", - "description": "

The role value representing a user role in GitHub.

", - "isRequired": true, - "enum": [ - "user", - "27d9891d-2c17-4f45-a262-781a0e55c80a", - "guest_collaborator", - "1ebc4a02-e56c-43a6-92a5-02ee09b90824", - "enterprise_owner", - "981df190-8801-4618-a08a-d91f6206c954", - "ba4987ab-a1c3-412a-b58c-360fc407cb10", - "billing_manager", - "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", - "e6be2762-e4ad-4108-b72d-1bbe884a0f91" - ] - }, - { - "type": "boolean", - "name": "primary", - "description": "

Is the role a primary role for the user.

" - } - ] - } - ], - "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Replaces an existing provisioned user's information.

\n

You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.

\n

Warning

\n

\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "User", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ], - "externalId": "E012345", - "active": true, - "userName": "E012345", - "name": { - "formatted": "Ms. Mona Lisa Octocat", - "familyName": "Octocat", - "givenName": "Mona", - "middleName": "Lisa" - }, - "displayName": "Mona Lisa", - "emails": [ - { - "value": "mlisa@example.com", - "type": "work", - "primary": true - } - ], - "roles": [ - { - "value": "user", - "primary": false - } - ] - }, - "parameters": { - "scim_user_id": "SCIM_USER_ID", - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/scim+json", - "description": "

User was updated

", - "example": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ], - "id": "7fce0092-d52e-4f76-b727-3955bd72c939", - "externalId": "E012345", - "active": true, - "userName": "E012345", - "name": { - "formatted": "Ms. Mona Lisa Octocat", - "familyName": "Octocat", - "givenName": "Mona", - "middleName": "Lisa" - }, - "displayName": "Mona Lisa", - "emails": [ - { - "value": "mlisa@example.com", - "type": "work", - "primary": true - } - ], - "roles": [ - { - "value": "User", - "primary": false - } - ], - "meta": { - "resourceType": "User", - "created": "2012-03-27T19:59:26.000Z", - "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939" - } - }, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "schemas", - "active", - "emails" - ], - "properties": { - "schemas": { - "type": "array", - "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", - "items": { - "type": "string", - "enum": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ] - } - }, - "externalId": { - "type": [ - "string", - "null" - ], - "description": "A unique identifier for the resource as defined by the provisioning client." - }, - "active": { - "type": "boolean", - "description": "Whether the user active in the IdP." - }, - "userName": { - "type": "string", - "description": "The username for the user." - }, - "name": { - "type": "object", - "properties": { - "formatted": { - "type": "string", - "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display." - }, - "familyName": { - "type": "string", - "description": "The family name of the user." - }, - "givenName": { - "type": "string", - "description": "The given name of the user." - }, - "middleName": { - "type": "string", - "description": "The middle name(s) of the user." - } - } - }, - "displayName": { - "type": [ - "string", - "null" - ], - "description": "A human-readable name for the user." - }, - "emails": { - "type": "array", - "description": "The emails for the user.", - "items": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "string", - "description": "The email address." - }, - "type": { - "type": "string", - "description": "The type of email address." - }, - "primary": { - "type": "boolean", - "description": "Whether this email address is the primary address." - } - } - } - }, - "roles": { - "type": "array", - "description": "The roles assigned to the user.", - "items": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "display": { - "type": "string" - }, - "type": { - "type": "string" - }, - "value": { - "type": "string", - "description": "The role value representing a user role in GitHub.", - "enum": [ - "user", - "27d9891d-2c17-4f45-a262-781a0e55c80a", - "guest_collaborator", - "1ebc4a02-e56c-43a6-92a5-02ee09b90824", - "enterprise_owner", - "981df190-8801-4618-a08a-d91f6206c954", - "ba4987ab-a1c3-412a-b58c-360fc407cb10", - "billing_manager", - "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", - "e6be2762-e4ad-4108-b72d-1bbe884a0f91" - ] - }, - "primary": { - "type": "boolean", - "description": "Is the role a primary role for the user." - } - } - } - } - } - }, - { - "type": "object", - "required": [ - "id", - "meta" - ], - "properties": { - "id": { - "type": "string", - "description": "The internally generated id for the user object." - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string" - } - } - }, - "description": "Provisioned SCIM groups that the user is a member of." - }, - "meta": { - "type": "object", - "description": "The metadata associated with the creation/updates to the user.", - "required": [ - "resourceType" - ], - "properties": { - "resourceType": { - "type": "string", - "description": "A type of a resource", - "enum": [ - "User", - "Group" - ] - }, - "created": { - "type": "string", - "description": "A date and time when the user was created." - }, - "lastModified": { - "type": "string", - "description": "A data and time when the user was last modified." - }, - "location": { - "type": "string", - "description": "A URL location of an object" - } - } - } - } - } - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

User was updated

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Authorization failure

" - }, - { - "httpStatusCode": "403", - "description": "

Permission denied

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Duplicate record detected

" - }, - { - "httpStatusCode": "429", - "description": "

Too many requests

" - }, - { - "httpStatusCode": "500", - "description": "

Internal server error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise SCIM\" enterprise permissions": "write" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", - "title": "Update an attribute for a SCIM enterprise user", - "category": "enterprise-admin", - "subcategory": "scim", - "parameters": [ - { - "name": "scim_user_id", - "description": "

The unique identifier of the SCIM user.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of objects", - "name": "Operations", - "description": "

patch operations list

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "op", - "description": "", - "isRequired": true, - "enum": [ - "add", - "replace", - "remove" - ] - }, - { - "type": "string", - "name": "path", - "description": "" - }, - { - "type": "string", - "name": "value", - "description": "

Corresponding 'value' of that field specified by 'path'

" - } - ] - }, - { - "type": "array of strings", - "name": "schemas", - "description": "

undefinedSupported values are: urn:ietf:params:scim:api:messages:2.0:PatchOp

", - "isRequired": true - } - ], - "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Update a provisioned user's individual attributes.

\n

To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.

\n

Note

\n

\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.

\n
\n

Warning

\n

\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers (Okta, for example), the user GDPR data in the SCIM metadata will not be purged and the credentials will not be removed.

\n
{\n  \"Operations\":[{\n    \"op\":\"replace\",\n    \"value\":{\n      \"active\":false\n    }\n  }]\n}\n
\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Multi Valued Property", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "schemas": [ - "urn:ietf:params:scim:api:messages:2.0:PatchOp" - ], - "Operations": [ - { - "op": "replace", - "path": "emails[type eq 'work'].value", - "value": "updatedEmail@microsoft.com" - }, - { - "op": "replace", - "path": "name.familyName", - "value": "updatedFamilyName" - } - ] - }, - "parameters": { - "scim_user_id": "SCIM_USER_ID", - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/scim+json", - "description": "

Success, user was updated

", - "example": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ], - "id": "7fce0092-d52e-4f76-b727-3955bd72c939", - "externalId": "E012345", - "active": true, - "userName": "E012345", - "name": { - "formatted": "Ms. Mona Lisa Octocat", - "familyName": "Octocat", - "givenName": "Mona", - "middleName": "Lisa" - }, - "displayName": "Mona Lisa", - "emails": [ - { - "value": "mlisa@example.com", - "type": "work", - "primary": true - } - ], - "roles": [ - { - "value": "User", - "primary": false - } - ], - "meta": { - "resourceType": "User", - "created": "2012-03-27T19:59:26.000Z", - "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939" - } - }, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "schemas", - "active", - "emails" - ], - "properties": { - "schemas": { - "type": "array", - "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", - "items": { - "type": "string", - "enum": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ] - } - }, - "externalId": { - "type": [ - "string", - "null" - ], - "description": "A unique identifier for the resource as defined by the provisioning client." - }, - "active": { - "type": "boolean", - "description": "Whether the user active in the IdP." - }, - "userName": { - "type": "string", - "description": "The username for the user." - }, - "name": { - "type": "object", - "properties": { - "formatted": { - "type": "string", - "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display." - }, - "familyName": { - "type": "string", - "description": "The family name of the user." - }, - "givenName": { - "type": "string", - "description": "The given name of the user." - }, - "middleName": { - "type": "string", - "description": "The middle name(s) of the user." - } - } - }, - "displayName": { - "type": [ - "string", - "null" - ], - "description": "A human-readable name for the user." - }, - "emails": { - "type": "array", - "description": "The emails for the user.", - "items": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "string", - "description": "The email address." - }, - "type": { - "type": "string", - "description": "The type of email address." - }, - "primary": { - "type": "boolean", - "description": "Whether this email address is the primary address." - } - } - } - }, - "roles": { - "type": "array", - "description": "The roles assigned to the user.", - "items": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "display": { - "type": "string" - }, - "type": { - "type": "string" - }, - "value": { - "type": "string", - "description": "The role value representing a user role in GitHub.", - "enum": [ - "user", - "27d9891d-2c17-4f45-a262-781a0e55c80a", - "guest_collaborator", - "1ebc4a02-e56c-43a6-92a5-02ee09b90824", - "enterprise_owner", - "981df190-8801-4618-a08a-d91f6206c954", - "ba4987ab-a1c3-412a-b58c-360fc407cb10", - "billing_manager", - "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", - "e6be2762-e4ad-4108-b72d-1bbe884a0f91" - ] - }, - "primary": { - "type": "boolean", - "description": "Is the role a primary role for the user." - } - } - } - } - } - }, - { - "type": "object", - "required": [ - "id", - "meta" - ], - "properties": { - "id": { - "type": "string", - "description": "The internally generated id for the user object." - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string" - } - } - }, - "description": "Provisioned SCIM groups that the user is a member of." - }, - "meta": { - "type": "object", - "description": "The metadata associated with the creation/updates to the user.", - "required": [ - "resourceType" - ], - "properties": { - "resourceType": { - "type": "string", - "description": "A type of a resource", - "enum": [ - "User", - "Group" - ] - }, - "created": { - "type": "string", - "description": "A date and time when the user was created." - }, - "lastModified": { - "type": "string", - "description": "A data and time when the user was last modified." - }, - "location": { - "type": "string", - "description": "A URL location of an object" - } - } - } - } - } - ] - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Single Valued Property", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "schemas": [ - "urn:ietf:params:scim:api:messages:2.0:PatchOp" - ], - "Operations": [ - { - "op": "replace", - "path": "userName", - "value": "5b50642d-79fc-4410-9e90-4c077cdd1a59@testuser.com" - }, - { - "op": "replace", - "path": "displayName", - "value": "Monalisa Octocat" - } - ] - }, - "parameters": { - "scim_user_id": "SCIM_USER_ID", - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/scim+json", - "description": "

Success, user was updated

", - "example": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ], - "id": "7fce0092-d52e-4f76-b727-3955bd72c939", - "externalId": "E012345", - "active": true, - "userName": "E012345", - "name": { - "formatted": "Ms. Mona Lisa Octocat", - "familyName": "Octocat", - "givenName": "Mona", - "middleName": "Lisa" - }, - "displayName": "Mona Lisa", - "emails": [ - { - "value": "mlisa@example.com", - "type": "work", - "primary": true - } - ], - "roles": [ - { - "value": "User", - "primary": false - } - ], - "meta": { - "resourceType": "User", - "created": "2012-03-27T19:59:26.000Z", - "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939" - } - }, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "schemas", - "active", - "emails" - ], - "properties": { - "schemas": { - "type": "array", - "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", - "items": { - "type": "string", - "enum": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ] - } - }, - "externalId": { - "type": [ - "string", - "null" - ], - "description": "A unique identifier for the resource as defined by the provisioning client." - }, - "active": { - "type": "boolean", - "description": "Whether the user active in the IdP." - }, - "userName": { - "type": "string", - "description": "The username for the user." - }, - "name": { - "type": "object", - "properties": { - "formatted": { - "type": "string", - "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display." - }, - "familyName": { - "type": "string", - "description": "The family name of the user." - }, - "givenName": { - "type": "string", - "description": "The given name of the user." - }, - "middleName": { - "type": "string", - "description": "The middle name(s) of the user." - } - } - }, - "displayName": { - "type": [ - "string", - "null" - ], - "description": "A human-readable name for the user." - }, - "emails": { - "type": "array", - "description": "The emails for the user.", - "items": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "string", - "description": "The email address." - }, - "type": { - "type": "string", - "description": "The type of email address." - }, - "primary": { - "type": "boolean", - "description": "Whether this email address is the primary address." - } - } - } - }, - "roles": { - "type": "array", - "description": "The roles assigned to the user.", - "items": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "display": { - "type": "string" - }, - "type": { - "type": "string" - }, - "value": { - "type": "string", - "description": "The role value representing a user role in GitHub.", - "enum": [ - "user", - "27d9891d-2c17-4f45-a262-781a0e55c80a", - "guest_collaborator", - "1ebc4a02-e56c-43a6-92a5-02ee09b90824", - "enterprise_owner", - "981df190-8801-4618-a08a-d91f6206c954", - "ba4987ab-a1c3-412a-b58c-360fc407cb10", - "billing_manager", - "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", - "e6be2762-e4ad-4108-b72d-1bbe884a0f91" - ] - }, - "primary": { - "type": "boolean", - "description": "Is the role a primary role for the user." - } - } - } - } - } - }, - { - "type": "object", - "required": [ - "id", - "meta" - ], - "properties": { - "id": { - "type": "string", - "description": "The internally generated id for the user object." - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string" - } - } - }, - "description": "Provisioned SCIM groups that the user is a member of." - }, - "meta": { - "type": "object", - "description": "The metadata associated with the creation/updates to the user.", - "required": [ - "resourceType" - ], - "properties": { - "resourceType": { - "type": "string", - "description": "A type of a resource", - "enum": [ - "User", - "Group" - ] - }, - "created": { - "type": "string", - "description": "A date and time when the user was created." - }, - "lastModified": { - "type": "string", - "description": "A data and time when the user was last modified." - }, - "location": { - "type": "string", - "description": "A URL location of an object" - } - } - } - } - } - ] - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Disable User", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "schemas": [ - "urn:ietf:params:scim:api:messages:2.0:PatchOp" - ], - "Operations": [ - { - "op": "replace", - "path": "active", - "value": false - } - ] - }, - "parameters": { - "scim_user_id": "SCIM_USER_ID", - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/scim+json", - "description": "

Success, user was updated

", - "example": { - "schemas": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ], - "id": "7fce0092-d52e-4f76-b727-3955bd72c939", - "externalId": "E012345", - "active": true, - "userName": "E012345", - "name": { - "formatted": "Ms. Mona Lisa Octocat", - "familyName": "Octocat", - "givenName": "Mona", - "middleName": "Lisa" - }, - "displayName": "Mona Lisa", - "emails": [ - { - "value": "mlisa@example.com", - "type": "work", - "primary": true - } - ], - "roles": [ - { - "value": "User", - "primary": false - } - ], - "meta": { - "resourceType": "User", - "created": "2012-03-27T19:59:26.000Z", - "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939" - } - }, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "schemas", - "active", - "emails" - ], - "properties": { - "schemas": { - "type": "array", - "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", - "items": { - "type": "string", - "enum": [ - "urn:ietf:params:scim:schemas:core:2.0:User" - ] - } - }, - "externalId": { - "type": [ - "string", - "null" - ], - "description": "A unique identifier for the resource as defined by the provisioning client." - }, - "active": { - "type": "boolean", - "description": "Whether the user active in the IdP." - }, - "userName": { - "type": "string", - "description": "The username for the user." - }, - "name": { - "type": "object", - "properties": { - "formatted": { - "type": "string", - "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display." - }, - "familyName": { - "type": "string", - "description": "The family name of the user." - }, - "givenName": { - "type": "string", - "description": "The given name of the user." - }, - "middleName": { - "type": "string", - "description": "The middle name(s) of the user." - } - } - }, - "displayName": { - "type": [ - "string", - "null" - ], - "description": "A human-readable name for the user." - }, - "emails": { - "type": "array", - "description": "The emails for the user.", - "items": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "string", - "description": "The email address." - }, - "type": { - "type": "string", - "description": "The type of email address." - }, - "primary": { - "type": "boolean", - "description": "Whether this email address is the primary address." - } - } - } - }, - "roles": { - "type": "array", - "description": "The roles assigned to the user.", - "items": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "display": { - "type": "string" - }, - "type": { - "type": "string" - }, - "value": { - "type": "string", - "description": "The role value representing a user role in GitHub.", - "enum": [ - "user", - "27d9891d-2c17-4f45-a262-781a0e55c80a", - "guest_collaborator", - "1ebc4a02-e56c-43a6-92a5-02ee09b90824", - "enterprise_owner", - "981df190-8801-4618-a08a-d91f6206c954", - "ba4987ab-a1c3-412a-b58c-360fc407cb10", - "billing_manager", - "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", - "e6be2762-e4ad-4108-b72d-1bbe884a0f91" - ] - }, - "primary": { - "type": "boolean", - "description": "Is the role a primary role for the user." - } - } - } - } - } - }, - { - "type": "object", - "required": [ - "id", - "meta" - ], - "properties": { - "id": { - "type": "string", - "description": "The internally generated id for the user object." - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "$ref": { - "type": "string" - }, - "display": { - "type": "string" - } - } - }, - "description": "Provisioned SCIM groups that the user is a member of." - }, - "meta": { - "type": "object", - "description": "The metadata associated with the creation/updates to the user.", - "required": [ - "resourceType" - ], - "properties": { - "resourceType": { - "type": "string", - "description": "A type of a resource", - "enum": [ - "User", - "Group" - ] - }, - "created": { - "type": "string", - "description": "A date and time when the user was created." - }, - "lastModified": { - "type": "string", - "description": "A data and time when the user was last modified." - }, - "location": { - "type": "string", - "description": "A URL location of an object" - } - } - } - } - } - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Success, user was updated

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Authorization failure

" - }, - { - "httpStatusCode": "403", - "description": "

Permission denied

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Duplicate record detected

" - }, - { - "httpStatusCode": "429", - "description": "

Too many requests

" - }, - { - "httpStatusCode": "500", - "description": "

Internal server error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise SCIM\" enterprise permissions": "write" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", - "title": "Delete a SCIM user from an enterprise", - "category": "enterprise-admin", - "subcategory": "scim", - "parameters": [ - { - "name": "scim_user_id", - "description": "

The unique identifier of the SCIM user.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "scim_user_id": "SCIM_USER_ID", - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "204", - "description": "

User was deleted, no content

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

User was deleted, no content

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request

" - }, - { - "httpStatusCode": "401", - "description": "

Authorization failure

" - }, - { - "httpStatusCode": "403", - "description": "

Permission denied

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "429", - "description": "

Too many requests

" - }, - { - "httpStatusCode": "500", - "description": "

Internal server error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise SCIM\" enterprise permissions": "write" - } - ], - "disabledForPatV2": true - } - } - ], - "users": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/admin/keys", - "title": "List public keys", - "category": "enterprise-admin", - "subcategory": "users", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "sort", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "accessed" - ], - "default": "created" - }, - "description": "" - }, - { - "name": "since", - "description": "

Only show public keys accessed after the given time.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "id": 2, - "url": "https://api.github.com/user/keys/2", - "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", - "created_at": "2020-06-11T21:31:57Z", - "verified": false, - "read_only": false, - "last_used": "2020-06-11T22:31:57Z", - "user_id": 1, - "repository_id": 2 - }, - { - "key": "9Og8iYjAyymI9LvABpJerYrMxURPc8r+dB7TJyvv1234", - "id": 3, - "url": "https://api.github.com/user/keys/2", - "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", - "created_at": "2020-06-11T21:31:57Z", - "verified": false, - "read_only": false, - "last_used": "2020-06-11T22:31:57Z", - "user_id": 1, - "repository_id": 2 - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "key": { - "type": "string" - }, - "user_id": { - "type": [ - "integer", - "null" - ] - }, - "repository_id": { - "type": [ - "integer", - "null" - ], - "format": "int64" - }, - "url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "read_only": { - "type": "boolean" - }, - "verified": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "added_by": { - "type": [ - "string", - "null" - ] - }, - "last_used": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "key", - "url", - "title", - "verified", - "created_at", - "read_only", - "last_used", - "user_id", - "repository_id" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/admin/keys/{key_ids}", - "title": "Delete a public key", - "category": "enterprise-admin", - "subcategory": "users", - "parameters": [ - { - "name": "key_ids", - "description": "

The unique identifier of the key.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "key_ids": "KEY_IDS" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/admin/tokens", - "title": "List personal access tokens", - "category": "enterprise-admin", - "subcategory": "users", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists personal access tokens for all users, including admin users.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 2, - "url": "https://enterprise.octocat.com/api/v3/authorizations/2", - "app": { - "name": "My personal access token", - "url": "https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens", - "client_id": "00000000000000000000" - }, - "token": "ghp_16C7e42F292c6912E7710c838347Ae178B4a", - "hashed_token": "23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45", - "token_last_eight": "Ae178B4a", - "note": "My personal access token", - "note_url": null, - "created_at": "2019-04-24T21:49:02Z", - "updated_at": "2019-04-24T21:49:02Z", - "scopes": [ - "admin:business", - "admin:gpg_key", - "admin:org", - "admin:org_hook", - "admin:pre_receive_hook", - "admin:public_key", - "admin:repo_hook", - "delete_repo", - "gist", - "notifications", - "repo", - "user", - "write:discussion" - ], - "fingerprint": null - } - ], - "schema": { - "type": "array", - "items": { - "title": "Authorization", - "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string", - "format": "uri" - }, - "scopes": { - "description": "A list of scopes that this authorization is in.", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "token": { - "type": "string" - }, - "token_last_eight": { - "type": [ - "string", - "null" - ] - }, - "hashed_token": { - "type": [ - "string", - "null" - ] - }, - "app": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "client_id", - "name", - "url" - ] - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "note_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "fingerprint": { - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "installation": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Scoped Installation", - "type": "object", - "properties": { - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "single_file_name": { - "type": [ - "string", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "account": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "permissions", - "repository_selection", - "single_file_name", - "repositories_url", - "account" - ] - } - ] - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "app", - "id", - "note", - "note_url", - "scopes", - "token", - "hashed_token", - "token_last_eight", - "fingerprint", - "url", - "created_at", - "updated_at", - "expires_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/admin/tokens/{token_id}", - "title": "Delete a personal access token", - "category": "enterprise-admin", - "subcategory": "users", - "parameters": [ - { - "name": "token_id", - "description": "

The unique identifier of the token.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a personal access token. Returns a 403 - Forbidden status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "token_id": "TOKEN_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/admin/users", - "title": "Create a user", - "category": "enterprise-admin", - "subcategory": "users", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "login", - "description": "

The user's username.

", - "isRequired": true - }, - { - "type": "string", - "name": "email", - "description": "

Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

" - }, - { - "type": "boolean", - "name": "suspended", - "description": "

Whether to set the user as suspended when the user is created.

", - "default": false - } - ], - "descriptionHTML": "

If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also update the LDAP mapping for the user.

\n

The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send \"octo_cat\" as the login, a user named \"octo-cat\" will be created.

\n

If the login name or email address is already associated with an account, the server will return a 422 response.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "login": "monalisa", - "email": "octocat@github.com" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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 - }, - "schema": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/admin/users/{username}", - "title": "Update the username for a user", - "category": "enterprise-admin", - "subcategory": "users", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "login", - "description": "

The user's new username.

", - "isRequired": true - } - ], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "login": "thenewmonalisa" - }, - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Response

", - "example": { - "message": "Job queued to rename user. It may take a few minutes to complete.", - "url": "https://api.github.com/user/1" - }, - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "url": { - "type": "string" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/admin/users/{username}", - "title": "Delete a user", - "category": "enterprise-admin", - "subcategory": "users", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deleting a user will delete all their repositories, gists, applications, and personal settings. Suspending a user is often a better option.

\n

You can delete any user account except your own.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/admin/users/{username}/authorizations", - "title": "Create an impersonation OAuth token", - "category": "enterprise-admin", - "subcategory": "users", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "scopes", - "description": "

A list of scopes.

", - "isRequired": true - } - ], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "scopes": [ - "public_repo" - ] - }, - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response when getting an existing impersonation OAuth token

", - "example": { - "id": 1, - "url": "https://api.github.com/authorizations/1", - "scopes": [ - "public_repo" - ], - "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", - "token_last_eight": "Ae178B4a", - "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", - "app": { - "url": "http://my-github-app.com", - "name": "my github app", - "client_id": "abcde12345fghij67890" - }, - "note": "optional note", - "note_url": "http://optional/note/url", - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "expires_at": "2011-10-06T17:26:27Z", - "fingerprint": "jklmnop12345678" - }, - "schema": { - "title": "Authorization", - "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string", - "format": "uri" - }, - "scopes": { - "description": "A list of scopes that this authorization is in.", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "token": { - "type": "string" - }, - "token_last_eight": { - "type": [ - "string", - "null" - ] - }, - "hashed_token": { - "type": [ - "string", - "null" - ] - }, - "app": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "client_id", - "name", - "url" - ] - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "note_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "fingerprint": { - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "installation": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Scoped Installation", - "type": "object", - "properties": { - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "single_file_name": { - "type": [ - "string", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "account": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "permissions", - "repository_selection", - "single_file_name", - "repositories_url", - "account" - ] - } - ] - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "app", - "id", - "note", - "note_url", - "scopes", - "token", - "hashed_token", - "token_last_eight", - "fingerprint", - "url", - "created_at", - "updated_at", - "expires_at" - ] - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "scopes": [ - "public_repo" - ] - }, - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response when creating a new impersonation OAuth token

", - "example": { - "id": 1, - "url": "https://api.github.com/authorizations/1", - "scopes": [ - "public_repo" - ], - "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", - "token_last_eight": "Ae178B4a", - "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", - "app": { - "url": "http://my-github-app.com", - "name": "my github app", - "client_id": "abcde12345fghij67890" - }, - "note": "optional note", - "note_url": "http://optional/note/url", - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "expires_at": "2011-10-06T17:26:27Z", - "fingerprint": "jklmnop12345678" - }, - "schema": { - "title": "Authorization", - "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string", - "format": "uri" - }, - "scopes": { - "description": "A list of scopes that this authorization is in.", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "token": { - "type": "string" - }, - "token_last_eight": { - "type": [ - "string", - "null" - ] - }, - "hashed_token": { - "type": [ - "string", - "null" - ] - }, - "app": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "client_id", - "name", - "url" - ] - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "note_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "fingerprint": { - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "installation": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Scoped Installation", - "type": "object", - "properties": { - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "single_file_name": { - "type": [ - "string", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "account": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "permissions", - "repository_selection", - "single_file_name", - "repositories_url", - "account" - ] - } - ] - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "app", - "id", - "note", - "note_url", - "scopes", - "token", - "hashed_token", - "token_last_eight", - "fingerprint", - "url", - "created_at", - "updated_at", - "expires_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Response when getting an existing impersonation OAuth token

" - }, - { - "httpStatusCode": "201", - "description": "

Response when creating a new impersonation OAuth token

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/admin/users/{username}/authorizations", - "title": "Delete an impersonation OAuth token", - "category": "enterprise-admin", - "subcategory": "users", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/users/{username}/site_admin", - "title": "Promote a user to be a site administrator", - "category": "enterprise-admin", - "subcategory": "users", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/users/{username}/site_admin", - "title": "Demote a site administrator", - "category": "enterprise-admin", - "subcategory": "users", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

You can demote any user account except your own.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/users/{username}/suspended", - "title": "Suspend a user", - "category": "enterprise-admin", - "subcategory": "users", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "reason", - "description": "

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

" - } - ], - "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

\n

You can suspend any user account except your own.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "reason": "Suspended during leave of absence." - }, - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/users/{username}/suspended", - "title": "Unsuspend a user", - "category": "enterprise-admin", - "subcategory": "users", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "reason", - "description": "

The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

" - } - ], - "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "reason": "Unsuspended after leave of absence." - }, - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/gists.json b/src/rest/data/ghes-3.14-2022-11-28/gists.json deleted file mode 100644 index ec0b6d5676b4..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/gists.json +++ /dev/null @@ -1,11888 +0,0 @@ -{ - "gists": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/gists", - "title": "List gists for the authenticated user", - "category": "gists", - "subcategory": "gists", - "parameters": [ - { - "name": "since", - "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", - "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", - "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", - "id": "aa5a315d61ae9438b18d", - "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", - "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", - "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", - "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", - "files": { - "hello_world.rb": { - "filename": "hello_world.rb", - "type": "application/x-ruby", - "language": "Ruby", - "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", - "size": 167 - } - }, - "public": true, - "created_at": "2010-04-14T02:15:15Z", - "updated_at": "2011-06-20T11:34:15Z", - "description": "Hello World Examples", - "comments": 0, - "user": null, - "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", - "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 - }, - "truncated": false - } - ], - "schema": { - "type": "array", - "items": { - "title": "Base Gist", - "description": "Base Gist", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string", - "format": "uri" - }, - "git_push_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "encoding": { - "type": "string", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "utf-8" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "truncated": { - "type": "boolean" - }, - "forks": { - "type": "array", - "items": {} - }, - "history": { - "type": "array", - "items": {} - } - }, - "required": [ - "id", - "node_id", - "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", - "user", - "files", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/gists", - "title": "Create a gist", - "category": "gists", - "subcategory": "gists", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "description", - "description": "

Description of the gist

" - }, - { - "type": "object", - "name": "files", - "description": "

Names and content for the files that make up the gist

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "key", - "description": "

A user-defined key to represent an item in files.

", - "childParamsGroups": [ - { - "type": "string", - "name": "content", - "description": "

Content of the file

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "boolean or string", - "name": "public", - "description": "

Flag indicating whether the gist is public

" - } - ], - "descriptionHTML": "

Allows you to add a new gist with one or more files.

\n

Note

\n

\nDon't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Creating a gist", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "description": "Example of a gist", - "public": false, - "files": { - "README.md": { - "content": "Hello World" - } - } - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/gists/2decf6c462d9b4418f2", - "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks", - "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits", - "id": "2decf6c462d9b4418f2", - "node_id": "G_kwDOBhHyLdZDliNDQxOGYy", - "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git", - "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git", - "html_url": "https://gist.github.com/2decf6c462d9b4418f2", - "files": { - "README.md": { - "filename": "README.md", - "type": "text/markdown", - "language": "Markdown", - "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", - "size": 23, - "truncated": false, - "content": "Hello world from GitHub", - "encoding": "utf-8" - } - }, - "public": true, - "created_at": "2022-09-20T12:11:58Z", - "updated_at": "2022-09-21T10:28:06Z", - "description": "An updated gist description.", - "comments": 0, - "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", - "owner": { - "login": "monalisa", - "id": 104456405, - "node_id": "U_kgDOBhHyLQ", - "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "forks": [], - "history": [ - { - "user": { - "login": "monalisa", - "id": 104456405, - "node_id": "U_kgyLQ", - "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "version": "468aac8caed5f0c3b859b8286968", - "committed_at": "2022-09-21T10:28:06Z", - "change_status": { - "total": 2, - "additions": 1, - "deletions": 1 - }, - "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968" - } - ], - "truncated": false - }, - "schema": { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "forks": { - "deprecated": true, - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } - }, - "history": { - "deprecated": true, - "type": [ - "array", - "null" - ], - "items": { - "title": "Gist History", - "description": "Gist History", - "type": "object", - "properties": { - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "version": { - "type": "string" - }, - "committed_at": { - "type": "string", - "format": "date-time" - }, - "change_status": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - } - } - }, - "url": { - "type": "string", - "format": "uri" - } - } - } - }, - "fork_of": { - "title": "Gist", - "description": "Gist", - "type": [ - "object", - "null" - ], - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string", - "format": "uri" - }, - "git_push_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "truncated": { - "type": "boolean" - }, - "forks": { - "type": "array", - "items": {} - }, - "history": { - "type": "array", - "items": {} - } - }, - "required": [ - "id", - "node_id", - "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", - "user", - "files", - "created_at", - "updated_at" - ] - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": [ - "object", - "null" - ], - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - }, - "encoding": { - "type": "string", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "utf-8" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "type": [ - "string", - "null" - ] - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "truncated": { - "type": "boolean" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Gists\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/gists/public", - "title": "List public gists", - "category": "gists", - "subcategory": "gists", - "parameters": [ - { - "name": "since", - "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "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.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", - "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", - "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", - "id": "aa5a315d61ae9438b18d", - "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", - "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", - "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", - "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", - "files": { - "hello_world.rb": { - "filename": "hello_world.rb", - "type": "application/x-ruby", - "language": "Ruby", - "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", - "size": 167 - } - }, - "public": true, - "created_at": "2010-04-14T02:15:15Z", - "updated_at": "2011-06-20T11:34:15Z", - "description": "Hello World Examples", - "comments": 0, - "user": null, - "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", - "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 - }, - "truncated": false - } - ], - "schema": { - "type": "array", - "items": { - "title": "Base Gist", - "description": "Base Gist", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string", - "format": "uri" - }, - "git_push_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "encoding": { - "type": "string", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "utf-8" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "truncated": { - "type": "boolean" - }, - "forks": { - "type": "array", - "items": {} - }, - "history": { - "type": "array", - "items": {} - } - }, - "required": [ - "id", - "node_id", - "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", - "user", - "files", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/gists/starred", - "title": "List starred gists", - "category": "gists", - "subcategory": "gists", - "parameters": [ - { - "name": "since", - "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List the authenticated user's starred gists:

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", - "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", - "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", - "id": "aa5a315d61ae9438b18d", - "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", - "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", - "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", - "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", - "files": { - "hello_world.rb": { - "filename": "hello_world.rb", - "type": "application/x-ruby", - "language": "Ruby", - "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", - "size": 167 - } - }, - "public": true, - "created_at": "2010-04-14T02:15:15Z", - "updated_at": "2011-06-20T11:34:15Z", - "description": "Hello World Examples", - "comments": 0, - "user": null, - "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", - "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 - }, - "truncated": false - } - ], - "schema": { - "type": "array", - "items": { - "title": "Base Gist", - "description": "Base Gist", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string", - "format": "uri" - }, - "git_push_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "encoding": { - "type": "string", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "utf-8" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "truncated": { - "type": "boolean" - }, - "forks": { - "type": "array", - "items": {} - }, - "history": { - "type": "array", - "items": {} - } - }, - "required": [ - "id", - "node_id", - "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", - "user", - "files", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/gists/{gist_id}", - "title": "Get a gist", - "category": "gists", - "subcategory": "gists", - "parameters": [ - { - "name": "gist_id", - "description": "

The unique identifier of the gist.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "gist_id": "GIST_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/gists/2decf6c462d9b4418f2", - "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks", - "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits", - "id": "2decf6c462d9b4418f2", - "node_id": "G_kwDOBhHyLdZDliNDQxOGYy", - "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git", - "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git", - "html_url": "https://gist.github.com/2decf6c462d9b4418f2", - "files": { - "README.md": { - "filename": "README.md", - "type": "text/markdown", - "language": "Markdown", - "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", - "size": 23, - "truncated": false, - "content": "Hello world from GitHub", - "encoding": "utf-8" - } - }, - "public": true, - "created_at": "2022-09-20T12:11:58Z", - "updated_at": "2022-09-21T10:28:06Z", - "description": "An updated gist description.", - "comments": 0, - "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", - "owner": { - "login": "monalisa", - "id": 104456405, - "node_id": "U_kgDOBhHyLQ", - "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "forks": [], - "history": [ - { - "user": { - "login": "monalisa", - "id": 104456405, - "node_id": "U_kgyLQ", - "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "version": "468aac8caed5f0c3b859b8286968", - "committed_at": "2022-09-21T10:28:06Z", - "change_status": { - "total": 2, - "additions": 1, - "deletions": 1 - }, - "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968" - } - ], - "truncated": false - }, - "schema": { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "forks": { - "deprecated": true, - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } - }, - "history": { - "deprecated": true, - "type": [ - "array", - "null" - ], - "items": { - "title": "Gist History", - "description": "Gist History", - "type": "object", - "properties": { - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "version": { - "type": "string" - }, - "committed_at": { - "type": "string", - "format": "date-time" - }, - "change_status": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - } - } - }, - "url": { - "type": "string", - "format": "uri" - } - } - } - }, - "fork_of": { - "title": "Gist", - "description": "Gist", - "type": [ - "object", - "null" - ], - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string", - "format": "uri" - }, - "git_push_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "truncated": { - "type": "boolean" - }, - "forks": { - "type": "array", - "items": {} - }, - "history": { - "type": "array", - "items": {} - } - }, - "required": [ - "id", - "node_id", - "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", - "user", - "files", - "created_at", - "updated_at" - ] - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": [ - "object", - "null" - ], - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - }, - "encoding": { - "type": "string", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "utf-8" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "type": [ - "string", - "null" - ] - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "truncated": { - "type": "boolean" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden Gist

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/gists/{gist_id}", - "title": "Update a gist", - "category": "gists", - "subcategory": "gists", - "parameters": [ - { - "name": "gist_id", - "description": "

The unique identifier of the gist.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "description", - "description": "

The description of the gist.

" - }, - { - "type": "object", - "name": "files", - "description": "

The gist files to be updated, renamed, or deleted. Each key must match the current filename\n(including extension) of the targeted gist file. For example: hello.py.

\n

To delete a file, set the whole file to null. For example: hello.py : null. The file will also be\ndeleted if the specified object does not contain at least one of content or filename.

", - "childParamsGroups": [ - { - "type": "object", - "name": "key", - "description": "

A user-defined key to represent an item in files.

", - "childParamsGroups": [ - { - "type": "string", - "name": "content", - "description": "

The new content of the file.

" - }, - { - "type": "string or null", - "name": "filename", - "description": "

The new filename for the file.

" - } - ] - } - ] - } - ], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Updating a gist", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "description": "An updated gist description", - "files": { - "README.md": { - "content": "Hello World from GitHub" - } - } - }, - "parameters": { - "gist_id": "GIST_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/gists/2decf6c462d9b4418f2", - "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks", - "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits", - "id": "2decf6c462d9b4418f2", - "node_id": "G_kwDOBhHyLdZDliNDQxOGYy", - "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git", - "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git", - "html_url": "https://gist.github.com/2decf6c462d9b4418f2", - "files": { - "README.md": { - "filename": "README.md", - "type": "text/markdown", - "language": "Markdown", - "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", - "size": 23, - "truncated": false, - "content": "Hello world from GitHub", - "encoding": "utf-8" - } - }, - "public": true, - "created_at": "2022-09-20T12:11:58Z", - "updated_at": "2022-09-21T10:28:06Z", - "description": "An updated gist description.", - "comments": 0, - "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", - "owner": { - "login": "monalisa", - "id": 104456405, - "node_id": "U_kgDOBhHyLQ", - "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "forks": [], - "history": [ - { - "user": { - "login": "monalisa", - "id": 104456405, - "node_id": "U_kgyLQ", - "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "version": "468aac8caed5f0c3b859b8286968", - "committed_at": "2022-09-21T10:28:06Z", - "change_status": { - "total": 2, - "additions": 1, - "deletions": 1 - }, - "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968" - } - ], - "truncated": false - }, - "schema": { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "forks": { - "deprecated": true, - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } - }, - "history": { - "deprecated": true, - "type": [ - "array", - "null" - ], - "items": { - "title": "Gist History", - "description": "Gist History", - "type": "object", - "properties": { - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "version": { - "type": "string" - }, - "committed_at": { - "type": "string", - "format": "date-time" - }, - "change_status": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - } - } - }, - "url": { - "type": "string", - "format": "uri" - } - } - } - }, - "fork_of": { - "title": "Gist", - "description": "Gist", - "type": [ - "object", - "null" - ], - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string", - "format": "uri" - }, - "git_push_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "truncated": { - "type": "boolean" - }, - "forks": { - "type": "array", - "items": {} - }, - "history": { - "type": "array", - "items": {} - } - }, - "required": [ - "id", - "node_id", - "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", - "user", - "files", - "created_at", - "updated_at" - ] - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": [ - "object", - "null" - ], - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - }, - "encoding": { - "type": "string", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "utf-8" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "type": [ - "string", - "null" - ] - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "truncated": { - "type": "boolean" - } - } - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Deleting a gist file", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "files": { - "hello.py": null - } - }, - "parameters": { - "gist_id": "GIST_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/gists/2decf6c462d9b4418f2", - "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks", - "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits", - "id": "2decf6c462d9b4418f2", - "node_id": "G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy", - "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git", - "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git", - "html_url": "https://gist.github.com/2decf6c462d9b4418f2", - "files": null, - "public": true, - "created_at": "2022-09-20T12:11:58Z", - "updated_at": "2022-09-21T10:28:06Z", - "description": "A gist description.", - "comments": 0, - "user": null, - "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", - "owner": { - "login": "monalisa", - "id": 104456405, - "node_id": "U_kgDOBhHyLQ", - "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "forks": [], - "history": [ - { - "user": { - "login": "monalisa", - "id": 104456405, - "node_id": "U_kgyLQ", - "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "version": "9cc352a89178a6d4", - "committed_at": "2022-09-21T10:28:06Z", - "change_status": { - "total": 1, - "additions": 0, - "deletions": 1 - }, - "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968" - } - ], - "truncated": false - }, - "schema": { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "forks": { - "deprecated": true, - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } - }, - "history": { - "deprecated": true, - "type": [ - "array", - "null" - ], - "items": { - "title": "Gist History", - "description": "Gist History", - "type": "object", - "properties": { - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "version": { - "type": "string" - }, - "committed_at": { - "type": "string", - "format": "date-time" - }, - "change_status": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - } - } - }, - "url": { - "type": "string", - "format": "uri" - } - } - } - }, - "fork_of": { - "title": "Gist", - "description": "Gist", - "type": [ - "object", - "null" - ], - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string", - "format": "uri" - }, - "git_push_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "truncated": { - "type": "boolean" - }, - "forks": { - "type": "array", - "items": {} - }, - "history": { - "type": "array", - "items": {} - } - }, - "required": [ - "id", - "node_id", - "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", - "user", - "files", - "created_at", - "updated_at" - ] - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": [ - "object", - "null" - ], - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - }, - "encoding": { - "type": "string", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "utf-8" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "type": [ - "string", - "null" - ] - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "truncated": { - "type": "boolean" - } - } - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Renaming a gist file", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "files": { - "hello.py": { - "filename": "goodbye.py" - } - } - }, - "parameters": { - "gist_id": "GIST_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/gists/2decf6c462d9b4418f2", - "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks", - "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits", - "id": "2decf6c462d9b4418f2", - "node_id": "G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy", - "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git", - "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git", - "html_url": "https://gist.github.com/2decf6c462d9b4418f2", - "files": { - "goodbye.py": { - "filename": "goodbye.py", - "type": "application/x-python", - "language": "Python", - "raw_url": "https://gist.githubusercontent.com/monalisa/8481a81af6b7a2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/goodbye.py", - "size": 4, - "truncated": false, - "content": "# Hello world" - } - }, - "public": true, - "created_at": "2022-09-20T12:11:58Z", - "updated_at": "2022-09-21T10:28:06Z", - "description": "A gist description.", - "comments": 0, - "user": null, - "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", - "owner": { - "login": "monalisa", - "id": 104456405, - "node_id": "U_kgDOBhHyLQ", - "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "forks": [], - "history": [ - { - "user": { - "login": "monalisa", - "id": 104456405, - "node_id": "U_kgyLQ", - "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "version": "468aac8caed5f0c3b859b8286968", - "committed_at": "2022-09-21T10:28:06Z", - "change_status": { - "total": 0, - "additions": 0, - "deletions": 0 - }, - "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968" - } - ], - "truncated": false - }, - "schema": { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "forks": { - "deprecated": true, - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } - }, - "history": { - "deprecated": true, - "type": [ - "array", - "null" - ], - "items": { - "title": "Gist History", - "description": "Gist History", - "type": "object", - "properties": { - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "version": { - "type": "string" - }, - "committed_at": { - "type": "string", - "format": "date-time" - }, - "change_status": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - } - } - }, - "url": { - "type": "string", - "format": "uri" - } - } - } - }, - "fork_of": { - "title": "Gist", - "description": "Gist", - "type": [ - "object", - "null" - ], - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string", - "format": "uri" - }, - "git_push_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "truncated": { - "type": "boolean" - }, - "forks": { - "type": "array", - "items": {} - }, - "history": { - "type": "array", - "items": {} - } - }, - "required": [ - "id", - "node_id", - "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", - "user", - "files", - "created_at", - "updated_at" - ] - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": [ - "object", - "null" - ], - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - }, - "encoding": { - "type": "string", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "utf-8" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "type": [ - "string", - "null" - ] - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "truncated": { - "type": "boolean" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Gists\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/gists/{gist_id}", - "title": "Delete a gist", - "category": "gists", - "subcategory": "gists", - "parameters": [ - { - "name": "gist_id", - "description": "

The unique identifier of the gist.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "gist_id": "GIST_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Gists\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/gists/{gist_id}/commits", - "title": "List gist commits", - "category": "gists", - "subcategory": "gists", - "parameters": [ - { - "name": "gist_id", - "description": "

The unique identifier of the gist.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "gist_id": "GIST_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f", - "version": "57a7f021a713b1c5a6a199b54cc514735d2d462f", - "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 - }, - "change_status": { - "deletions": 0, - "additions": 180, - "total": 180 - }, - "committed_at": "2010-04-14T02:15:15Z" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Gist Commit", - "description": "Gist Commit", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "version": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "change_status": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - } - } - }, - "committed_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "url", - "user", - "version", - "committed_at", - "change_status" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/gists/{gist_id}/forks", - "title": "List gist forks", - "category": "gists", - "subcategory": "gists", - "parameters": [ - { - "name": "gist_id", - "description": "

The unique identifier of the gist.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "gist_id": "GIST_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", - "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", - "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", - "id": "aa5a315d61ae9438b18d", - "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", - "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", - "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", - "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", - "files": { - "hello_world.rb": { - "filename": "hello_world.rb", - "type": "application/x-ruby", - "language": "Ruby", - "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", - "size": 167 - } - }, - "public": true, - "created_at": "2010-04-14T02:15:15Z", - "updated_at": "2011-06-20T11:34:15Z", - "description": "Hello World Examples", - "comments": 1, - "user": null, - "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", - "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 - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "forks": { - "deprecated": true, - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } - }, - "history": { - "deprecated": true, - "type": [ - "array", - "null" - ], - "items": { - "title": "Gist History", - "description": "Gist History", - "type": "object", - "properties": { - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "version": { - "type": "string" - }, - "committed_at": { - "type": "string", - "format": "date-time" - }, - "change_status": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - } - } - }, - "url": { - "type": "string", - "format": "uri" - } - } - } - }, - "fork_of": { - "title": "Gist", - "description": "Gist", - "type": [ - "object", - "null" - ], - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string", - "format": "uri" - }, - "git_push_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "truncated": { - "type": "boolean" - }, - "forks": { - "type": "array", - "items": {} - }, - "history": { - "type": "array", - "items": {} - } - }, - "required": [ - "id", - "node_id", - "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", - "user", - "files", - "created_at", - "updated_at" - ] - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": [ - "object", - "null" - ], - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - }, - "encoding": { - "type": "string", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "utf-8" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "type": [ - "string", - "null" - ] - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "truncated": { - "type": "boolean" - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/gists/{gist_id}/forks", - "title": "Fork a gist", - "category": "gists", - "subcategory": "gists", - "parameters": [ - { - "name": "gist_id", - "description": "

The unique identifier of the gist.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "gist_id": "GIST_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", - "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", - "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", - "id": "aa5a315d61ae9438b18d", - "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", - "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", - "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", - "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", - "files": { - "hello_world.rb": { - "filename": "hello_world.rb", - "type": "application/x-ruby", - "language": "Ruby", - "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", - "size": 167 - } - }, - "public": true, - "created_at": "2010-04-14T02:15:15Z", - "updated_at": "2011-06-20T11:34:15Z", - "description": "Hello World Examples", - "comments": 0, - "user": null, - "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", - "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 - }, - "truncated": false - }, - "schema": { - "title": "Base Gist", - "description": "Base Gist", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string", - "format": "uri" - }, - "git_push_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "encoding": { - "type": "string", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "utf-8" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "truncated": { - "type": "boolean" - }, - "forks": { - "type": "array", - "items": {} - }, - "history": { - "type": "array", - "items": {} - } - }, - "required": [ - "id", - "node_id", - "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", - "user", - "files", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Gists\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/gists/{gist_id}/star", - "title": "Check if a gist is starred", - "category": "gists", - "subcategory": "gists", - "parameters": [ - { - "name": "gist_id", - "description": "

The unique identifier of the gist.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "gist_id": "GIST_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response if gist is starred

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Response if gist is starred

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found if gist is not starred

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/gists/{gist_id}/star", - "title": "Star a gist", - "category": "gists", - "subcategory": "gists", - "parameters": [ - { - "name": "gist_id", - "description": "

The unique identifier of the gist.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "gist_id": "GIST_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Gists\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/gists/{gist_id}/star", - "title": "Unstar a gist", - "category": "gists", - "subcategory": "gists", - "parameters": [ - { - "name": "gist_id", - "description": "

The unique identifier of the gist.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "gist_id": "GIST_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Gists\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/gists/{gist_id}/{sha}", - "title": "Get a gist revision", - "category": "gists", - "subcategory": "gists", - "parameters": [ - { - "name": "gist_id", - "description": "

The unique identifier of the gist.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sha", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist revision.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "gist_id": "GIST_ID", - "sha": "SHA" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/gists/2decf6c462d9b4418f2", - "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks", - "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits", - "id": "2decf6c462d9b4418f2", - "node_id": "G_kwDOBhHyLdZDliNDQxOGYy", - "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git", - "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git", - "html_url": "https://gist.github.com/2decf6c462d9b4418f2", - "files": { - "README.md": { - "filename": "README.md", - "type": "text/markdown", - "language": "Markdown", - "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", - "size": 23, - "truncated": false, - "content": "Hello world from GitHub", - "encoding": "utf-8" - } - }, - "public": true, - "created_at": "2022-09-20T12:11:58Z", - "updated_at": "2022-09-21T10:28:06Z", - "description": "An updated gist description.", - "comments": 0, - "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", - "owner": { - "login": "monalisa", - "id": 104456405, - "node_id": "U_kgDOBhHyLQ", - "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "forks": [], - "history": [ - { - "user": { - "login": "monalisa", - "id": 104456405, - "node_id": "U_kgyLQ", - "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "version": "468aac8caed5f0c3b859b8286968", - "committed_at": "2022-09-21T10:28:06Z", - "change_status": { - "total": 2, - "additions": 1, - "deletions": 1 - }, - "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968" - } - ], - "truncated": false - }, - "schema": { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "forks": { - "deprecated": true, - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } - }, - "history": { - "deprecated": true, - "type": [ - "array", - "null" - ], - "items": { - "title": "Gist History", - "description": "Gist History", - "type": "object", - "properties": { - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "version": { - "type": "string" - }, - "committed_at": { - "type": "string", - "format": "date-time" - }, - "change_status": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - } - } - }, - "url": { - "type": "string", - "format": "uri" - } - } - } - }, - "fork_of": { - "title": "Gist", - "description": "Gist", - "type": [ - "object", - "null" - ], - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string", - "format": "uri" - }, - "git_push_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "truncated": { - "type": "boolean" - }, - "forks": { - "type": "array", - "items": {} - }, - "history": { - "type": "array", - "items": {} - } - }, - "required": [ - "id", - "node_id", - "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", - "user", - "files", - "created_at", - "updated_at" - ] - }, - "url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string" - }, - "git_push_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": [ - "object", - "null" - ], - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - }, - "encoding": { - "type": "string", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "utf-8" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "type": [ - "string", - "null" - ] - }, - "comments_url": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "truncated": { - "type": "boolean" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/gists", - "title": "List gists for a user", - "category": "gists", - "subcategory": "gists", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "since", - "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists public gists for the specified user:

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", - "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", - "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", - "id": "aa5a315d61ae9438b18d", - "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", - "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", - "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", - "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", - "files": { - "hello_world.rb": { - "filename": "hello_world.rb", - "type": "application/x-ruby", - "language": "Ruby", - "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", - "size": 167 - } - }, - "public": true, - "created_at": "2010-04-14T02:15:15Z", - "updated_at": "2011-06-20T11:34:15Z", - "description": "Hello World Examples", - "comments": 0, - "user": null, - "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", - "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 - }, - "truncated": false - } - ], - "schema": { - "type": "array", - "items": { - "title": "Base Gist", - "description": "Base Gist", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "git_pull_url": { - "type": "string", - "format": "uri" - }, - "git_push_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "encoding": { - "type": "string", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "utf-8" - } - } - } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "truncated": { - "type": "boolean" - }, - "forks": { - "type": "array", - "items": {} - }, - "history": { - "type": "array", - "items": {} - } - }, - "required": [ - "id", - "node_id", - "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", - "user", - "files", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - } - ], - "comments": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/gists/{gist_id}/comments", - "title": "List gist comments", - "category": "gists", - "subcategory": "comments", - "parameters": [ - { - "name": "gist_id", - "description": "

The unique identifier of the gist.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the comments on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "gist_id": "GIST_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 1, - "node_id": "MDExOkdpc3RDb21tZW50MQ==", - "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", - "body": "Just commenting for the sake of commenting", - "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 - }, - "created_at": "2011-04-18T23:23:56Z", - "updated_at": "2011-04-18T23:23:56Z", - "author_association": "COLLABORATOR" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Gist Comment", - "description": "A comment made to a gist.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "description": "The comment text.", - "type": "string", - "maxLength": 65535 - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - }, - "required": [ - "url", - "id", - "node_id", - "user", - "body", - "author_association", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/gists/{gist_id}/comments", - "title": "Create a gist comment", - "category": "gists", - "subcategory": "comments", - "parameters": [ - { - "name": "gist_id", - "description": "

The unique identifier of the gist.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "body", - "description": "

The comment text.

", - "isRequired": true - } - ], - "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Creating a comment in a gist", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "body": "This is a comment to a gist" - }, - "parameters": { - "gist_id": "GIST_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "node_id": "MDExOkdpc3RDb21tZW50MQ==", - "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", - "body": "Just commenting for the sake of commenting", - "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 - }, - "created_at": "2011-04-18T23:23:56Z", - "updated_at": "2011-04-18T23:23:56Z", - "author_association": "COLLABORATOR" - }, - "schema": { - "title": "Gist Comment", - "description": "A comment made to a gist.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "description": "The comment text.", - "type": "string", - "maxLength": 65535 - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - }, - "required": [ - "url", - "id", - "node_id", - "user", - "body", - "author_association", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Gists\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "title": "Get a gist comment", - "category": "gists", - "subcategory": "comments", - "parameters": [ - { - "name": "gist_id", - "description": "

The unique identifier of the gist.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "gist_id": "GIST_ID", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "node_id": "MDExOkdpc3RDb21tZW50MQ==", - "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", - "body": "Just commenting for the sake of commenting", - "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 - }, - "created_at": "2011-04-18T23:23:56Z", - "updated_at": "2011-04-18T23:23:56Z", - "author_association": "COLLABORATOR" - }, - "schema": { - "title": "Gist Comment", - "description": "A comment made to a gist.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "description": "The comment text.", - "type": "string", - "maxLength": 65535 - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - }, - "required": [ - "url", - "id", - "node_id", - "user", - "body", - "author_association", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden Gist

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "title": "Update a gist comment", - "category": "gists", - "subcategory": "comments", - "parameters": [ - { - "name": "gist_id", - "description": "

The unique identifier of the gist.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "body", - "description": "

The comment text.

", - "isRequired": true - } - ], - "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Updating a comment in a gist", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "body": "This is an update to a comment in a gist" - }, - "parameters": { - "gist_id": "GIST_ID", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "node_id": "MDExOkdpc3RDb21tZW50MQ==", - "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", - "body": "Just commenting for the sake of commenting", - "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 - }, - "created_at": "2011-04-18T23:23:56Z", - "updated_at": "2011-04-18T23:23:56Z", - "author_association": "COLLABORATOR" - }, - "schema": { - "title": "Gist Comment", - "description": "A comment made to a gist.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "description": "The comment text.", - "type": "string", - "maxLength": 65535 - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - }, - "required": [ - "url", - "id", - "node_id", - "user", - "body", - "author_association", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Gists\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/gists/{gist_id}/comments/{comment_id}", - "title": "Delete a gist comment", - "category": "gists", - "subcategory": "comments", - "parameters": [ - { - "name": "gist_id", - "description": "

The unique identifier of the gist.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "gist_id": "GIST_ID", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Gists\" user permissions": "write" - } - ] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/git.json b/src/rest/data/ghes-3.14-2022-11-28/git.json deleted file mode 100644 index b41094ac4d6b..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/git.json +++ /dev/null @@ -1,2521 +0,0 @@ -{ - "blobs": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/blobs", - "title": "Create a blob", - "category": "git", - "subcategory": "blobs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "content", - "description": "

The new blob's content.

", - "isRequired": true - }, - { - "type": "string", - "name": "encoding", - "description": "

The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.

", - "default": "utf-8" - } - ], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "content": "Content of the blob", - "encoding": "utf-8" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", - "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" - }, - "schema": { - "title": "Short Blob", - "description": "Short Blob", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "sha": { - "type": "string" - } - }, - "required": [ - "url", - "sha" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/blobs/{file_sha}", - "title": "Get a blob", - "category": "git", - "subcategory": "blobs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "file_sha", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw blob data.
    • \n
  • application/vnd.github+json: Returns a JSON representation of the blob with content as a base64 encoded string. This is the default if no media type is specified.
    • \n
\n

Note This endpoint supports blobs up to 100 megabytes in size.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "file_sha": "FILE_SHA" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "content": "Q29udGVudCBvZiB0aGUgYmxvYg==", - "encoding": "base64", - "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", - "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", - "size": 19, - "node_id": "Q29udGVudCBvZiB0aGUgYmxvYg==" - }, - "schema": { - "title": "Blob", - "description": "Blob", - "type": "object", - "properties": { - "content": { - "type": "string" - }, - "encoding": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "size": { - "type": [ - "integer", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "highlighted_content": { - "type": "string" - } - }, - "required": [ - "sha", - "url", - "node_id", - "size", - "content", - "encoding" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ], - "commits": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/commits", - "title": "Create a commit", - "category": "git", - "subcategory": "commits", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "message", - "description": "

The commit message

", - "isRequired": true - }, - { - "type": "string", - "name": "tree", - "description": "

The SHA of the tree object this commit points to

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "parents", - "description": "

The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

" - }, - { - "type": "object", - "name": "author", - "description": "

Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the author (or committer) of the commit

", - "isRequired": true - }, - { - "type": "string", - "name": "email", - "description": "

The email of the author (or committer) of the commit

", - "isRequired": true - }, - { - "type": "string", - "name": "date", - "description": "

Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - } - ] - }, - { - "type": "object", - "name": "committer", - "description": "

Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the author (or committer) of the commit

" - }, - { - "type": "string", - "name": "email", - "description": "

The email of the author (or committer) of the commit

" - }, - { - "type": "string", - "name": "date", - "description": "

Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - } - ] - }, - { - "type": "string", - "name": "signature", - "description": "

The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

" - } - ], - "descriptionHTML": "

Creates a new Git commit object.

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in the table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "message": "my commit message", - "author": { - "name": "Mona Octocat", - "email": "octocat@github.com", - "date": "2008-07-09T16:13:30+12:00" - }, - "parents": [ - "7d1b31e74ee336d15cbd21741bc88a537ed063a0" - ], - "tree": "827efc6d56897b048c772eb4087f854f46256132", - "signature": "-----BEGIN PGP SIGNATURE-----\n\niQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv\n7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI\nDkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n\n2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA\nOQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k\nnrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU\n+NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB\njHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ\n3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+\nUpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr\nX11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp\neSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc=\n=5Io4\n-----END PGP SIGNATURE-----\n" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", - "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", - "author": { - "date": "2014-11-07T22:01:45Z", - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "committer": { - "date": "2014-11-07T22:01:45Z", - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "message": "my commit message", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132", - "sha": "827efc6d56897b048c772eb4087f854f46256132" - }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0", - "sha": "7d1b31e74ee336d15cbd21741bc88a537ed063a0", - "html_url": "https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0" - } - ], - "verification": { - "verified": false, - "reason": "unsigned" - }, - "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" - }, - "schema": { - "title": "Git Commit", - "description": "Low-level Git commit operations within a repository", - "type": "object", - "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "author": { - "description": "Identifying information for the git-user", - "type": "object", - "properties": { - "date": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string" - }, - "email": { - "type": "string", - "description": "Git email address of the user" - }, - "name": { - "description": "Name of the git user", - "type": "string" - } - }, - "required": [ - "email", - "name", - "date" - ] - }, - "committer": { - "description": "Identifying information for the git-user", - "type": "object", - "properties": { - "date": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string" - }, - "email": { - "type": "string", - "description": "Git email address of the user" - }, - "name": { - "description": "Name of the git user", - "type": "string" - } - }, - "required": [ - "email", - "name", - "date" - ] - }, - "message": { - "description": "Message describing the purpose of the commit", - "type": "string" - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url", - "html_url" - ] - } - }, - "verification": { - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "signature": { - "type": [ - "string", - "null" - ] - }, - "payload": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "signature", - "payload" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "node_id", - "url", - "html_url", - "author", - "committer", - "tree", - "message", - "parents", - "verification" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}", - "title": "Get a commit object", - "category": "git", - "subcategory": "commits", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "commit_sha", - "description": "

The SHA of the commit.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a Git commit object.

\n

To get the contents of a commit, see \"Get a commit.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in the table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "commit_sha": "COMMIT_SHA" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", - "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", - "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd", - "author": { - "date": "2014-11-07T22:01:45Z", - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "committer": { - "date": "2014-11-07T22:01:45Z", - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "message": "added readme, because im a good github citizen", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", - "sha": "691272480426f78a0138979dd3ce63b77f706feb" - }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", - "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5", - "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" - } - ], - "verification": { - "verified": false, - "reason": "unsigned" - } - }, - "schema": { - "title": "Git Commit", - "description": "Low-level Git commit operations within a repository", - "type": "object", - "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "author": { - "description": "Identifying information for the git-user", - "type": "object", - "properties": { - "date": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string" - }, - "email": { - "type": "string", - "description": "Git email address of the user" - }, - "name": { - "description": "Name of the git user", - "type": "string" - } - }, - "required": [ - "email", - "name", - "date" - ] - }, - "committer": { - "description": "Identifying information for the git-user", - "type": "object", - "properties": { - "date": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string" - }, - "email": { - "type": "string", - "description": "Git email address of the user" - }, - "name": { - "description": "Name of the git user", - "type": "string" - } - }, - "required": [ - "email", - "name", - "date" - ] - }, - "message": { - "description": "Message describing the purpose of the commit", - "type": "string" - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url", - "html_url" - ] - } - }, - "verification": { - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "signature": { - "type": [ - "string", - "null" - ] - }, - "payload": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "signature", - "payload" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "node_id", - "url", - "html_url", - "author", - "committer", - "tree", - "message", - "parents", - "verification" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ], - "refs": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/matching-refs/{ref}", - "title": "List matching references", - "category": "git", - "subcategory": "refs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "description": "

The Git reference. For more information, see \"Git References\" in the Git documentation.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note

\n

\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n
\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "ref": "REF" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "ref": "refs/heads/feature-a", - "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE=", - "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a", - "object": { - "type": "commit", - "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" - } - }, - { - "ref": "refs/heads/feature-b", - "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI=", - "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b", - "object": { - "type": "commit", - "sha": "612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac" - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Git Reference", - "description": "Git references within a repository", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "object": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "sha": { - "description": "SHA for the reference", - "type": "string", - "minLength": 40, - "maxLength": 40 - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "type", - "sha", - "url" - ] - } - }, - "required": [ - "ref", - "node_id", - "url", - "object" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/ref/{ref}", - "title": "Get a reference", - "category": "git", - "subcategory": "refs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "description": "

The Git reference. For more information, see \"Git References\" in the Git documentation.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note

\n

\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "ref": "REF" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "ref": "refs/heads/featureA", - "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", - "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", - "object": { - "type": "commit", - "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" - } - }, - "schema": { - "title": "Git Reference", - "description": "Git references within a repository", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "object": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "sha": { - "description": "SHA for the reference", - "type": "string", - "minLength": 40, - "maxLength": 40 - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "type", - "sha", - "url" - ] - } - }, - "required": [ - "ref", - "node_id", - "url", - "object" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/refs", - "title": "Create a reference", - "category": "git", - "subcategory": "refs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "ref", - "description": "

The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "

The SHA1 value for this reference.

", - "isRequired": true - } - ], - "descriptionHTML": "

Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "ref": "refs/heads/featureA", - "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "ref": "refs/heads/featureA", - "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", - "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", - "object": { - "type": "commit", - "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" - } - }, - "schema": { - "title": "Git Reference", - "description": "Git references within a repository", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "object": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "sha": { - "description": "SHA for the reference", - "type": "string", - "minLength": 40, - "maxLength": 40 - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "type", - "sha", - "url" - ] - } - }, - "required": [ - "ref", - "node_id", - "url", - "object" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - }, - { - "\"Contents\" repository permissions": "write", - "\"Workflows\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "title": "Update a reference", - "category": "git", - "subcategory": "refs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "description": "

The Git reference. For more information, see \"Git References\" in the Git documentation.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "sha", - "description": "

The SHA1 value to set this reference to

", - "isRequired": true - }, - { - "type": "boolean", - "name": "force", - "description": "

Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

", - "default": false - } - ], - "descriptionHTML": "

Updates the provided reference to point to a new SHA. For more information, see \"Git References\" in the Git documentation.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", - "force": true - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "ref": "REF" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "ref": "refs/heads/featureA", - "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", - "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", - "object": { - "type": "commit", - "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" - } - }, - "schema": { - "title": "Git Reference", - "description": "Git references within a repository", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "object": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "sha": { - "description": "SHA for the reference", - "type": "string", - "minLength": 40, - "maxLength": 40 - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "type", - "sha", - "url" - ] - } - }, - "required": [ - "ref", - "node_id", - "url", - "object" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - }, - { - "\"Contents\" repository permissions": "write", - "\"Workflows\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", - "title": "Delete a reference", - "category": "git", - "subcategory": "refs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "description": "

The Git reference. For more information, see \"Git References\" in the Git documentation.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes the provided reference.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "ref": "REF" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - } - ], - "tags": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/tags", - "title": "Create a tag object", - "category": "git", - "subcategory": "tags", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "tag", - "description": "

The tag's name. This is typically a version (e.g., \"v0.0.1\").

", - "isRequired": true - }, - { - "type": "string", - "name": "message", - "description": "

The tag message.

", - "isRequired": true - }, - { - "type": "string", - "name": "object", - "description": "

The SHA of the git object this is tagging.

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.

", - "isRequired": true, - "enum": [ - "commit", - "tree", - "blob" - ] - }, - { - "type": "object", - "name": "tagger", - "description": "

An object with information about the individual creating the tag.

", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the author of the tag

", - "isRequired": true - }, - { - "type": "string", - "name": "email", - "description": "

The email of the author of the tag

", - "isRequired": true - }, - { - "type": "string", - "name": "date", - "description": "

When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - } - ] - } - ], - "descriptionHTML": "

Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "tag": "v0.0.1", - "message": "initial version", - "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", - "type": "commit", - "tagger": { - "name": "Monalisa Octocat", - "email": "octocat@github.com", - "date": "2011-06-17T14:53:35-07:00" - } - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", - "tag": "v0.0.1", - "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", - "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", - "message": "initial version", - "tagger": { - "name": "Monalisa Octocat", - "email": "octocat@github.com", - "date": "2014-11-07T22:01:45Z" - }, - "object": { - "type": "commit", - "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" - }, - "verification": { - "verified": false, - "reason": "unsigned" - } - }, - "schema": { - "title": "Git Tag", - "description": "Metadata for a Git tag", - "type": "object", - "properties": { - "node_id": { - "type": "string" - }, - "tag": { - "description": "Name of the tag", - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "description": "URL for the tag", - "type": "string", - "format": "uri" - }, - "message": { - "description": "Message describing the purpose of the tag", - "type": "string" - }, - "tagger": { - "type": "object", - "properties": { - "date": { - "type": "string" - }, - "email": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "date", - "email", - "name" - ] - }, - "object": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "type", - "url" - ] - }, - "verification": { - "title": "Verification", - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "payload": { - "type": [ - "string", - "null" - ] - }, - "signature": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "sha", - "url", - "node_id", - "tagger", - "object", - "tag", - "message" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/tags/{tag_sha}", - "title": "Get a tag", - "category": "git", - "subcategory": "tags", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "tag_sha", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "tag_sha": "TAG_SHA" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", - "tag": "v0.0.1", - "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", - "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", - "message": "initial version", - "tagger": { - "name": "Monalisa Octocat", - "email": "octocat@github.com", - "date": "2014-11-07T22:01:45Z" - }, - "object": { - "type": "commit", - "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" - }, - "verification": { - "verified": false, - "reason": "unsigned" - } - }, - "schema": { - "title": "Git Tag", - "description": "Metadata for a Git tag", - "type": "object", - "properties": { - "node_id": { - "type": "string" - }, - "tag": { - "description": "Name of the tag", - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "description": "URL for the tag", - "type": "string", - "format": "uri" - }, - "message": { - "description": "Message describing the purpose of the tag", - "type": "string" - }, - "tagger": { - "type": "object", - "properties": { - "date": { - "type": "string" - }, - "email": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "date", - "email", - "name" - ] - }, - "object": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "type", - "url" - ] - }, - "verification": { - "title": "Verification", - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "payload": { - "type": [ - "string", - "null" - ] - }, - "signature": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "sha", - "url", - "node_id", - "tagger", - "object", - "tag", - "message" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ], - "trees": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/git/trees", - "title": "Create a tree", - "category": "git", - "subcategory": "trees", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of objects", - "name": "tree", - "description": "

Objects (of path, mode, type, and sha) specifying a tree structure.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "

The file referenced in the tree.

" - }, - { - "type": "string", - "name": "mode", - "description": "

The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

", - "enum": [ - "100644", - "100755", - "040000", - "160000", - "120000" - ] - }, - { - "type": "string", - "name": "type", - "description": "

Either blob, tree, or commit.

", - "enum": [ - "blob", - "tree", - "commit" - ] - }, - { - "type": "string or null", - "name": "sha", - "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

" - }, - { - "type": "string", - "name": "content", - "description": "

The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

" - } - ] - }, - { - "type": "string", - "name": "base_tree", - "description": "

The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

" - } - ], - "descriptionHTML": "

The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

\n

If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"Create a commit\" and \"Update a reference.\"

\n

Returns an error if you try to delete a file that does not exist.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", - "tree": [ - { - "path": "file.rb", - "mode": "100644", - "type": "blob", - "sha": "44b4fc6d56897b048c772eb4087f854f46256132" - } - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "sha": "cd8274d15fa3ae2ab983129fb037999f264ba9a7", - "url": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", - "tree": [ - { - "path": "file.rb", - "mode": "100644", - "type": "blob", - "size": 132, - "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", - "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" - } - ], - "truncated": true - }, - "schema": { - "title": "Git Tree", - "description": "The hierarchy between files in a Git repository.", - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "truncated": { - "type": "boolean" - }, - "tree": { - "description": "Objects specifying a tree structure", - "type": "array", - "items": { - "type": "object", - "required": [ - "path", - "mode", - "type", - "sha" - ], - "properties": { - "path": { - "type": "string" - }, - "mode": { - "type": "string" - }, - "type": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "url": { - "type": "string" - } - } - } - } - }, - "required": [ - "sha", - "tree", - "truncated" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/git/trees/{tree_sha}", - "title": "Get a tree", - "category": "git", - "subcategory": "trees", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "tree_sha", - "description": "

The SHA1 value or ref (branch or tag) name of the tree.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "recursive", - "description": "

Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in :tree_sha. For example, setting recursive to any of the following will enable returning objects or subtrees: 0, 1, \"true\", and \"false\". Omit this parameter to prevent recursively returning objects or subtrees.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns a single tree using the SHA1 value or ref name for that tree.

\n

If truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.

\n

Note

\n

\nThe limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "tree_sha": "TREE_SHA" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Default response

", - "example": { - "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", - "url": "https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312", - "tree": [ - { - "path": "file.rb", - "mode": "100644", - "type": "blob", - "size": 30, - "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" - }, - { - "path": "subdir", - "mode": "040000", - "type": "tree", - "sha": "f484d249c660418515fb01c2b9662073663c242e", - "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e" - }, - { - "path": "exec_file", - "mode": "100755", - "type": "blob", - "size": 75, - "sha": "45b983be36b73c0788dc9cbcb76cbb80fc7bb057", - "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057" - } - ], - "truncated": false - }, - "schema": { - "title": "Git Tree", - "description": "The hierarchy between files in a Git repository.", - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "truncated": { - "type": "boolean" - }, - "tree": { - "description": "Objects specifying a tree structure", - "type": "array", - "items": { - "type": "object", - "required": [ - "path", - "mode", - "type", - "sha" - ], - "properties": { - "path": { - "type": "string" - }, - "mode": { - "type": "string" - }, - "type": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "url": { - "type": "string" - } - } - } - } - }, - "required": [ - "sha", - "tree", - "truncated" - ] - } - } - }, - { - "request": { - "description": "Example 2: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "tree_sha": "TREE_SHA" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response recursively retrieving a tree

", - "example": { - "sha": "fc6274d15fa3ae2ab983129fb037999f264ba9a7", - "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7", - "tree": [ - { - "path": "subdir/file.txt", - "mode": "100644", - "type": "blob", - "size": 132, - "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", - "url": "https://api.github.com/repos/octocat/Hello-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" - } - ], - "truncated": false - }, - "schema": { - "title": "Git Tree", - "description": "The hierarchy between files in a Git repository.", - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "truncated": { - "type": "boolean" - }, - "tree": { - "description": "Objects specifying a tree structure", - "type": "array", - "items": { - "type": "object", - "required": [ - "path", - "mode", - "type", - "sha" - ], - "properties": { - "path": { - "type": "string" - }, - "mode": { - "type": "string" - }, - "type": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "url": { - "type": "string" - } - } - } - } - }, - "required": [ - "sha", - "tree", - "truncated" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/gitignore.json b/src/rest/data/ghes-3.14-2022-11-28/gitignore.json deleted file mode 100644 index 3193e9384617..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/gitignore.json +++ /dev/null @@ -1,139 +0,0 @@ -{ - "gitignore": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/gitignore/templates", - "title": "Get all gitignore templates", - "category": "gitignore", - "subcategory": "gitignore", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

List all templates available to pass as an option when creating a repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - "Actionscript", - "Android", - "AppceleratorTitanium", - "Autotools", - "Bancha", - "C", - "C++" - ], - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/gitignore/templates/{name}", - "title": "Get a gitignore template", - "category": "gitignore", - "subcategory": "gitignore", - "parameters": [ - { - "name": "name", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Get the content of a gitignore template.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw .gitignore contents.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "name": "NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "name": "C", - "source": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" - }, - "schema": { - "title": "Gitignore Template", - "description": "Gitignore Template", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "source": { - "type": "string" - } - }, - "required": [ - "name", - "source" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/issues.json b/src/rest/data/ghes-3.14-2022-11-28/issues.json deleted file mode 100644 index 2a5e20364d46..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/issues.json +++ /dev/null @@ -1,69879 +0,0 @@ -{ - "issues": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/issues", - "title": "List issues assigned to the authenticated user", - "category": "issues", - "subcategory": "issues", - "parameters": [ - { - "name": "filter", - "description": "

Indicates which sorts of issues to return. assigned means issues assigned to you. created means issues created by you. mentioned means issues mentioning you. subscribed means issues you're subscribed to updates for. all or repos means all issues you can see, regardless of participation or creation.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "assigned", - "created", - "mentioned", - "subscribed", - "repos", - "all" - ], - "default": "assigned" - } - }, - { - "name": "state", - "description": "

Indicates the state of the issues to return.

", - "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.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "comments" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "since", - "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "collab", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - }, - "description": "" - }, - { - "name": "orgs", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - }, - "description": "" - }, - { - "name": "owned", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - }, - "description": "" - }, - { - "name": "pulls", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - }, - "description": "" - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "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

\n

\nGitHub's REST API 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. 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.

\n
\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - }, - "pinned_comment": null, - "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, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "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 - }, - "author_association": "COLLABORATOR" - } - ], - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/issues", - "title": "List organization issues assigned to the authenticated user", - "category": "issues", - "subcategory": "issues", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "

Indicates which sorts of issues to return. assigned means issues assigned to you. created means issues created by you. mentioned means issues mentioning you. subscribed means issues you're subscribed to updates for. all or repos means all issues you can see, regardless of participation or creation.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "assigned", - "created", - "mentioned", - "subscribed", - "repos", - "all" - ], - "default": "assigned" - } - }, - { - "name": "state", - "description": "

Indicates the state of the issues to return.

", - "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": "type", - "description": "

Can be the name of an issue type.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "

What to sort results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "comments" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "since", - "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note

\n

\nGitHub's REST API 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. 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.

\n
\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - }, - "pinned_comment": null, - "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, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "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 - }, - "author_association": "COLLABORATOR" - } - ], - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues", - "title": "List repository issues", - "category": "issues", - "subcategory": "issues", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "milestone", - "description": "

If an integer is passed, it should refer to a milestone by its number field. If the string * is passed, issues with any milestone are accepted. If the string none is passed, issues without milestones are returned.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "

Indicates the state of the issues to return.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "name": "assignee", - "description": "

Can be the name of a user. Pass in none for issues with no assigned user, and * for issues assigned to any user.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "type", - "description": "

Can be the name of an issue type. If the string * is passed, issues with any type are accepted. If the string none is passed, issues without type are returned.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "creator", - "description": "

The user that created the issue.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "mentioned", - "description": "

A user that's mentioned in the issue.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "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.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "comments" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "since", - "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note

\n

\nGitHub's REST API 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. 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.

\n
\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - }, - "pinned_comment": null, - "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", - "closed_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 - }, - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - ], - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues", - "title": "Create an issue", - "category": "issues", - "subcategory": "issues", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string or integer", - "name": "title", - "description": "

The title of the issue.

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

The contents of the issue.

" - }, - { - "type": "string or null", - "name": "assignee", - "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is closing down.

" - }, - { - "type": "null or string or integer", - "name": "milestone", - "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

" - }, - { - "type": "array", - "name": "labels", - "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

" - }, - { - "type": "array of strings", - "name": "assignees", - "description": "

Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

" - }, - { - "type": "string or null", - "name": "type", - "description": "

The name of the issue type to associate with this issue. NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise.

" - } - ], - "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "title": "Found a bug", - "body": "I'm having a problem with this.", - "assignees": [ - "octocat" - ], - "milestone": 1, - "labels": [ - "bug" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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 - }, - "pinned_comment": null, - "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", - "closed_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 - }, - "author_association": "COLLABORATOR", - "state_reason": "completed" - }, - "schema": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "title": "Get an issue", - "category": "issues", - "subcategory": "issues", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note

\n

\nGitHub's REST API 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. 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.

\n
\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Issue

", - "example": { - "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 - }, - "pinned_comment": null, - "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", - "closed_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 - }, - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - }, - "schema": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - } - } - }, - { - "request": { - "description": "Example 2: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Issue with pinned comment

", - "example": { - "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 - }, - "pinned_comment": { - "id": 1, - "node_id": "MDEyOklzc3VlQ29tbWVudDE=", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", - "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", - "body": "Me too", - "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 - }, - "pin": { - "pinned_at": "2021-01-01T00:00:00Z", - "pinned_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 - } - }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "author_association": "COLLABORATOR" - }, - "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": 1, - "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", - "closed_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 - }, - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - }, - "schema": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", - "title": "Update an issue", - "category": "issues", - "subcategory": "issues", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "null or string or integer", - "name": "title", - "description": "

The title of the issue.

" - }, - { - "type": "string or null", - "name": "body", - "description": "

The contents of the issue.

" - }, - { - "type": "string or null", - "name": "assignee", - "description": "

Username to assign to this issue. This field is closing down.

" - }, - { - "type": "string", - "name": "state", - "description": "

The open or closed state of the issue.

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the state change. Ignored unless state is changed.

", - "enum": [ - "completed", - "not_planned", - "duplicate", - "reopened", - null - ] - }, - { - "type": "null or string or integer", - "name": "milestone", - "description": "

The number of the milestone to associate this issue with or use null to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped.

" - }, - { - "type": "array", - "name": "labels", - "description": "

Labels to associate with this issue. Pass one or more labels to replace the set of labels on this issue. Send an empty array ([]) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.

" - }, - { - "type": "array of strings", - "name": "assignees", - "description": "

Usernames to assign to this issue. Pass one or more user logins to replace the set of assignees on this issue. Send an empty array ([]) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.

" - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "

An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Only users with push access can set field values for issues

", - "childParamsGroups": [ - { - "type": "integer", - "name": "field_id", - "description": "

The ID of the issue field to set

", - "isRequired": true - }, - { - "type": "string or number", - "name": "value", - "description": "

The value to set for the field

", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "type", - "description": "

The name of the issue type to associate with this issue or use null to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.

" - } - ], - "descriptionHTML": "

Issue owners and users with push access or Triage role can edit an issue.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "title": "Found a bug", - "body": "I'm having a problem with this.", - "assignees": [ - "octocat" - ], - "milestone": 1, - "state": "open", - "labels": [ - "bug" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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 - }, - "pinned_comment": null, - "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", - "closed_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 - }, - "author_association": "COLLABORATOR", - "state_reason": "completed" - }, - "schema": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - }, - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "title": "Lock an issue", - "category": "issues", - "subcategory": "issues", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "lock_reason", - "description": "

The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:

\n
    \n
  • off-topic
    • \n
  • too heated
    • \n
  • resolved
    • \n
  • spam
    • \n
", - "enum": [ - "off-topic", - "too heated", - "resolved", - "spam" - ] - } - ], - "descriptionHTML": "

Users with push access can lock an issue or pull request's conversation.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example of locking an issue as off-topic", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "lock_reason": "off-topic" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - }, - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "title": "Unlock an issue", - "category": "issues", - "subcategory": "issues", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Users with push access can unlock an issue's conversation.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - }, - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/issues", - "title": "List user account issues assigned to the authenticated user", - "category": "issues", - "subcategory": "issues", - "parameters": [ - { - "name": "filter", - "description": "

Indicates which sorts of issues to return. assigned means issues assigned to you. created means issues created by you. mentioned means issues mentioning you. subscribed means issues you're subscribed to updates for. all or repos means all issues you can see, regardless of participation or creation.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "assigned", - "created", - "mentioned", - "subscribed", - "repos", - "all" - ], - "default": "assigned" - } - }, - { - "name": "state", - "description": "

Indicates the state of the issues to return.

", - "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.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "comments" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "since", - "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note

\n

\nGitHub's REST API 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. 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.

\n
\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - }, - "pinned_comment": null, - "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, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "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 - }, - "author_association": "COLLABORATOR" - } - ], - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - } - ], - "assignees": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/assignees", - "title": "List assignees", - "category": "issues", - "subcategory": "assignees", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the available assignees for issues in a repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - }, - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/assignees/{assignee}", - "title": "Check if a user can be assigned", - "category": "issues", - "subcategory": "assignees", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assignee", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Checks if a user has permission to be assigned to an issue in this repository.

\n

If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.

\n

Otherwise a 404 status code is returned.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "assignee": "ASSIGNEE" - } - }, - "response": { - "statusCode": "204", - "description": "

If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.

" - }, - { - "httpStatusCode": "404", - "description": "

Otherwise a 404 status code is returned.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - }, - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "title": "Add assignees to an issue", - "category": "issues", - "subcategory": "assignees", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "assignees", - "description": "

Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

" - } - ], - "descriptionHTML": "

Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "assignees": [ - "hubot", - "other_user" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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 - }, - "pinned_comment": null, - "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", - "closed_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 - }, - "author_association": "COLLABORATOR", - "state_reason": "completed" - }, - "schema": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - }, - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "title": "Remove assignees from an issue", - "category": "issues", - "subcategory": "assignees", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "assignees", - "description": "

Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

" - } - ], - "descriptionHTML": "

Removes one or more assignees from an issue.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "assignees": [ - "hubot", - "other_user" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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 - }, - "pinned_comment": null, - "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", - "closed_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 - }, - "author_association": "COLLABORATOR", - "state_reason": "completed" - }, - "schema": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - }, - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}", - "title": "Check if a user can be assigned to a issue", - "category": "issues", - "subcategory": "assignees", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "assignee", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Checks if a user has permission to be assigned to a specific issue.

\n

If the assignee can be assigned to this issue, a 204 status code with no content is returned.

\n

Otherwise a 404 status code is returned.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER", - "assignee": "ASSIGNEE" - } - }, - "response": { - "statusCode": "204", - "description": "

Response if assignee can be assigned to issue_number

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Response if assignee can be assigned to issue_number

" - }, - { - "httpStatusCode": "404", - "description": "

Response if assignee can not be assigned to issue_number

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - }, - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ], - "comments": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments", - "title": "List issue comments for a repository", - "category": "issues", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "

The property to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "

Either asc or desc. Ignored without the sort parameter.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ] - } - }, - { - "name": "since", - "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.

\n

By default, issue comments are ordered by ascending ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 1, - "node_id": "MDEyOklzc3VlQ29tbWVudDE=", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", - "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", - "body": "Me too", - "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 - }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "author_association": "COLLABORATOR" - } - ], - "schema": { - "type": "array", - "items": { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - }, - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "title": "Get an issue comment", - "category": "issues", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "node_id": "MDEyOklzc3VlQ29tbWVudDE=", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", - "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", - "body": "Me too", - "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 - }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "author_association": "COLLABORATOR", - "pin": null - }, - "schema": { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - }, - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "title": "Update an issue comment", - "category": "issues", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "body", - "description": "

The contents of the comment.

", - "isRequired": true - } - ], - "descriptionHTML": "

You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "body": "Me too" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "node_id": "MDEyOklzc3VlQ29tbWVudDE=", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", - "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", - "body": "Me too", - "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 - }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "author_association": "COLLABORATOR", - "pin": null - }, - "schema": { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - }, - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "title": "Delete an issue comment", - "category": "issues", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - }, - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "title": "List issue comments", - "category": "issues", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "since", - "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

Issue comments are ordered by ascending ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 1, - "node_id": "MDEyOklzc3VlQ29tbWVudDE=", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", - "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", - "body": "Me too", - "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 - }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "author_association": "COLLABORATOR" - } - ], - "schema": { - "type": "array", - "items": { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - }, - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "title": "Create an issue comment", - "category": "issues", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "body", - "description": "

The contents of the comment.

", - "isRequired": true - } - ], - "descriptionHTML": "

You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "body": "Me too" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "node_id": "MDEyOklzc3VlQ29tbWVudDE=", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", - "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", - "body": "Me too", - "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 - }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "author_association": "COLLABORATOR", - "pin": null - }, - "schema": { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - }, - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - } - ], - "events": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/events", - "title": "List issue events for a repository", - "category": "issues", - "subcategory": "events", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists events for a repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 1, - "node_id": "MDEwOklzc3VlRXZlbnQx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", - "actor": { - "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 - }, - "event": "closed", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "created_at": "2011-04-14T16:00:49Z", - "issue": { - "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 - }, - "pinned_comment": null, - "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", - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Issue Event", - "description": "Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "actor": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "issue": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - } - ] - }, - "label": { - "title": "Issue Event Label", - "description": "Issue Event Label", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "name", - "color" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assigner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "review_requester": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "requested_reviewer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "requested_team": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - }, - "dismissed_review": { - "title": "Issue Event Dismissed Review", - "type": "object", - "properties": { - "state": { - "type": "string" - }, - "review_id": { - "type": "integer" - }, - "dismissal_message": { - "type": [ - "string", - "null" - ] - }, - "dismissal_commit_id": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "state", - "review_id", - "dismissal_message" - ] - }, - "milestone": { - "title": "Issue Event Milestone", - "description": "Issue Event Milestone", - "type": "object", - "properties": { - "title": { - "type": "string" - } - }, - "required": [ - "title" - ] - }, - "project_card": { - "title": "Issue Event Project Card", - "description": "Issue Event Project Card", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "project_id": { - "type": "integer" - }, - "column_name": { - "type": "string" - }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "url", - "id", - "project_url", - "project_id", - "column_name" - ] - }, - "rename": { - "title": "Issue Event Rename", - "description": "Issue Event Rename", - "type": "object", - "properties": { - "from": { - "type": "string" - }, - "to": { - "type": "string" - } - }, - "required": [ - "from", - "to" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "lock_reason": { - "type": [ - "string", - "null" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}", - "title": "Get an issue event", - "category": "issues", - "subcategory": "events", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "event_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a single event by the event id.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "event_id": "EVENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "node_id": "MDEwOklzc3VlRXZlbnQx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", - "actor": { - "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 - }, - "event": "closed", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "created_at": "2011-04-14T16:00:49Z", - "issue": { - "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 - }, - "pinned_comment": null, - "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, - "performed_via_github_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" - }, - "events": [ - "push", - "pull_request" - ] - }, - "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", - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - }, - "schema": { - "title": "Issue Event", - "description": "Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "actor": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "issue": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - } - ] - }, - "label": { - "title": "Issue Event Label", - "description": "Issue Event Label", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "name", - "color" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assigner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "review_requester": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "requested_reviewer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "requested_team": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - }, - "dismissed_review": { - "title": "Issue Event Dismissed Review", - "type": "object", - "properties": { - "state": { - "type": "string" - }, - "review_id": { - "type": "integer" - }, - "dismissal_message": { - "type": [ - "string", - "null" - ] - }, - "dismissal_commit_id": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "state", - "review_id", - "dismissal_message" - ] - }, - "milestone": { - "title": "Issue Event Milestone", - "description": "Issue Event Milestone", - "type": "object", - "properties": { - "title": { - "type": "string" - } - }, - "required": [ - "title" - ] - }, - "project_card": { - "title": "Issue Event Project Card", - "description": "Issue Event Project Card", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "project_id": { - "type": "integer" - }, - "column_name": { - "type": "string" - }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "url", - "id", - "project_url", - "project_id", - "column_name" - ] - }, - "rename": { - "title": "Issue Event Rename", - "description": "Issue Event Rename", - "type": "object", - "properties": { - "from": { - "type": "string" - }, - "to": { - "type": "string" - } - }, - "required": [ - "from", - "to" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "lock_reason": { - "type": [ - "string", - "null" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - }, - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events", - "title": "List issue events", - "category": "issues", - "subcategory": "events", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all events for an issue.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 1, - "node_id": "MDEwOklzc3VlRXZlbnQx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", - "actor": { - "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 - }, - "event": "closed", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "created_at": "2011-04-14T16:00:49Z", - "performed_via_github_app": null, - "label": { - "name": "label", - "color": "red" - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Issue Event for Issue", - "description": "Issue Event for Issue", - "anyOf": [ - { - "title": "Labeled Issue Event", - "description": "Labeled Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "label": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "color": { - "type": "string" - } - }, - "required": [ - "name", - "color" - ] - } - }, - "required": [ - "label", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Unlabeled Issue Event", - "description": "Unlabeled Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "label": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "color": { - "type": "string" - } - }, - "required": [ - "name", - "color" - ] - } - }, - "required": [ - "label", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Assigned Issue Event", - "description": "Assigned Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assigner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app", - "assignee", - "assigner" - ] - }, - { - "title": "Unassigned Issue Event", - "description": "Unassigned Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assigner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app", - "assignee", - "assigner" - ] - }, - { - "title": "Milestoned Issue Event", - "description": "Milestoned Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "milestone": { - "type": "object", - "properties": { - "title": { - "type": "string" - } - }, - "required": [ - "title" - ] - } - }, - "required": [ - "milestone", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Demilestoned Issue Event", - "description": "Demilestoned Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "milestone": { - "type": "object", - "properties": { - "title": { - "type": "string" - } - }, - "required": [ - "title" - ] - } - }, - "required": [ - "milestone", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Renamed Issue Event", - "description": "Renamed Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "rename": { - "type": "object", - "properties": { - "from": { - "type": "string" - }, - "to": { - "type": "string" - } - }, - "required": [ - "from", - "to" - ] - } - }, - "required": [ - "rename", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Review Requested Issue Event", - "description": "Review Requested Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "review_requester": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "requested_team": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - }, - "requested_reviewer": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "review_requester", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Review Request Removed Issue Event", - "description": "Review Request Removed Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "review_requester": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "requested_team": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - }, - "requested_reviewer": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "review_requester", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Review Dismissed Issue Event", - "description": "Review Dismissed Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "dismissed_review": { - "type": "object", - "properties": { - "state": { - "type": "string" - }, - "review_id": { - "type": "integer" - }, - "dismissal_message": { - "type": [ - "string", - "null" - ] - }, - "dismissal_commit_id": { - "type": "string" - } - }, - "required": [ - "state", - "review_id", - "dismissal_message" - ] - } - }, - "required": [ - "dismissed_review", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Locked Issue Event", - "description": "Locked Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "lock_reason": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "lock_reason", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Added to Project Issue Event", - "description": "Added to Project Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "project_card": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "project_id": { - "type": "integer" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "column_name": { - "type": "string" - }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "project_id", - "project_url", - "column_name" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Moved Column in Project Issue Event", - "description": "Moved Column in Project Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "project_card": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "project_id": { - "type": "integer" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "column_name": { - "type": "string" - }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "project_id", - "project_url", - "column_name" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Removed from Project Issue Event", - "description": "Removed from Project Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "project_card": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "project_id": { - "type": "integer" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "column_name": { - "type": "string" - }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "project_id", - "project_url", - "column_name" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Converted Note to Issue Issue Event", - "description": "Converted Note to Issue Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "project_card": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "project_id": { - "type": "integer" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "column_name": { - "type": "string" - }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "project_id", - "project_url", - "column_name" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - } - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - }, - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ], - "issue-field-values": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values", - "title": "List issue field values for an issue", - "category": "issues", - "subcategory": "issue-field-values", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all issue field values for an issue.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "issue_field_id": 1, - "node_id": "IFT_GDKND", - "data_type": "text", - "value": "DRI" - }, - { - "issue_field_id": 2, - "node_id": "IFSS_SADMS", - "data_type": "single_select", - "value": 1, - "single_select_option": { - "id": 1, - "name": "High", - "color": "red" - } - }, - { - "issue_field_id": 3, - "node_id": "IFN_POINTS", - "data_type": "number", - "value": 42 - }, - { - "issue_field_id": 4, - "node_id": "IFD_DUEDATE", - "data_type": "date", - "value": "2025-12-25" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ], - "labels": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "title": "List labels for an issue", - "category": "issues", - "subcategory": "labels", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all labels for an issue.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - }, - { - "id": 208045947, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", - "name": "enhancement", - "description": "New feature or request", - "color": "a2eeef", - "default": false - } - ], - "schema": { - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - }, - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "title": "Add labels to an issue", - "category": "issues", - "subcategory": "labels", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "labels", - "description": "

The names of the labels to add to the issue's existing labels. You can also pass an array of labels directly, but GitHub recommends passing an object with the labels key. To replace all of the labels for an issue, use \"Set labels for an issue.\"

" - } - ], - "descriptionHTML": "

Adds labels to an issue.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "labels": [ - "bug", - "enhancement" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - }, - { - "id": 208045947, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", - "name": "enhancement", - "description": "New feature or request", - "color": "a2eeef", - "default": false - } - ], - "schema": { - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - }, - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "title": "Set labels for an issue", - "category": "issues", - "subcategory": "labels", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "labels", - "description": "

The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

" - } - ], - "descriptionHTML": "

Removes any previous labels and sets the new labels for an issue.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "labels": [ - "bug", - "enhancement" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - }, - { - "id": 208045947, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", - "name": "enhancement", - "description": "New feature or request", - "color": "a2eeef", - "default": false - } - ], - "schema": { - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - }, - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "title": "Remove all labels from an issue", - "category": "issues", - "subcategory": "labels", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes all labels from an issue.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - }, - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - "title": "Remove a label from an issue", - "category": "issues", - "subcategory": "labels", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "name", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER", - "name": "NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - }, - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/labels", - "title": "List labels for a repository", - "category": "issues", - "subcategory": "labels", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all labels for a repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - }, - { - "id": 208045947, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", - "name": "enhancement", - "description": "New feature or request", - "color": "a2eeef", - "default": false - } - ], - "schema": { - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - }, - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/labels", - "title": "Create a label", - "category": "issues", - "subcategory": "labels", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The hexadecimal color code for the label, without the leading #.

" - }, - { - "type": "string", - "name": "description", - "description": "

A short description of the label. Must be 100 characters or fewer.

" - } - ], - "descriptionHTML": "

Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid hexadecimal color code.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "bug", - "description": "Something isn't working", - "color": "f29513" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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 - }, - "schema": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - }, - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "title": "Get a label", - "category": "issues", - "subcategory": "labels", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a label using the given name.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "name": "NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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 - }, - "schema": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - }, - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "title": "Update a label", - "category": "issues", - "subcategory": "labels", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "new_name", - "description": "

The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

" - }, - { - "type": "string", - "name": "color", - "description": "

The hexadecimal color code for the label, without the leading #.

" - }, - { - "type": "string", - "name": "description", - "description": "

A short description of the label. Must be 100 characters or fewer.

" - } - ], - "descriptionHTML": "

Updates a label using the given label name.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "new_name": "bug :bug:", - "description": "Small bug fix required", - "color": "b01f26" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "name": "NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:", - "name": "bug :bug:", - "description": "Small bug fix required", - "color": "b01f26", - "default": true - }, - "schema": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - }, - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/labels/{name}", - "title": "Delete a label", - "category": "issues", - "subcategory": "labels", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a label using the given label name.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "name": "NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - }, - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", - "title": "List labels for issues in a milestone", - "category": "issues", - "subcategory": "labels", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "milestone_number", - "description": "

The number that identifies the milestone.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists labels for issues in a milestone.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "milestone_number": "MILESTONE_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - }, - { - "id": 208045947, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", - "name": "enhancement", - "description": "New feature or request", - "color": "a2eeef", - "default": false - } - ], - "schema": { - "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": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - }, - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ], - "milestones": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones", - "title": "List milestones", - "category": "issues", - "subcategory": "milestones", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "

The state of the milestone. Either open, closed, or all.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "name": "sort", - "description": "

What to sort results by. Either due_on or completeness.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "due_on", - "completeness" - ], - "default": "due_on" - } - }, - { - "name": "direction", - "description": "

The direction of the sort. Either asc or desc.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "asc" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists milestones for a repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "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" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - }, - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/milestones", - "title": "Create a milestone", - "category": "issues", - "subcategory": "milestones", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone. Either open or closed.

", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - { - "type": "string", - "name": "description", - "description": "

A description of the milestone.

" - }, - { - "type": "string", - "name": "due_on", - "description": "

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - } - ], - "descriptionHTML": "

Creates a milestone.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "title": "v1.0", - "state": "open", - "description": "Tracking milestone for version 1.0", - "due_on": "2012-10-09T23:39:01Z" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "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" - }, - "schema": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - }, - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "title": "Get a milestone", - "category": "issues", - "subcategory": "milestones", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "milestone_number", - "description": "

The number that identifies the milestone.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a milestone using the given milestone number.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "milestone_number": "MILESTONE_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "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" - }, - "schema": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - }, - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "title": "Update a milestone", - "category": "issues", - "subcategory": "milestones", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "milestone_number", - "description": "

The number that identifies the milestone.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

" - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone. Either open or closed.

", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - { - "type": "string", - "name": "description", - "description": "

A description of the milestone.

" - }, - { - "type": "string", - "name": "due_on", - "description": "

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - } - ], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "title": "v1.0", - "state": "open", - "description": "Tracking milestone for version 1.0", - "due_on": "2012-10-09T23:39:01Z" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "milestone_number": "MILESTONE_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "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" - }, - "schema": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - }, - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "title": "Delete a milestone", - "category": "issues", - "subcategory": "milestones", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "milestone_number", - "description": "

The number that identifies the milestone.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a milestone using the given milestone number.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "milestone_number": "MILESTONE_NUMBER" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - }, - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - } - ], - "timeline": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", - "title": "List timeline events for an issue", - "category": "issues", - "subcategory": "timeline", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List all timeline events for an issue.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 6430295168, - "node_id": "LOE_lADODwFebM5HwC0kzwAAAAF_RoSA", - "url": "https://api.github.com/repos/github/roadmap/issues/events/6430295168", - "actor": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/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/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 - }, - "event": "locked", - "commit_id": null, - "commit_url": null, - "created_at": "2022-04-13T20:49:13Z", - "lock_reason": null, - "performed_via_github_app": null - }, - { - "id": 6430296748, - "node_id": "LE_lADODwFebM5HwC0kzwAAAAF_Roqs", - "url": "https://api.github.com/repos/github/roadmap/issues/events/6430296748", - "actor": { - "login": "github-product-roadmap", - "id": 67656570, - "node_id": "MDQ6VXNlcjY3NjU2NTcw", - "avatar_url": "https://avatars.githubusercontent.com/u/67656570?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/github-product-roadmap", - "html_url": "https://github.com/github-product-roadmap", - "followers_url": "https://api.github.com/users/github-product-roadmap/followers", - "following_url": "https://api.github.com/users/github-product-roadmap/following{/other_user}", - "gists_url": "https://api.github.com/users/github-product-roadmap/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github-product-roadmap/subscriptions", - "organizations_url": "https://api.github.com/users/github-product-roadmap/orgs", - "repos_url": "https://api.github.com/users/github-product-roadmap/repos", - "events_url": "https://api.github.com/users/github-product-roadmap/events{/privacy}", - "received_events_url": "https://api.github.com/users/github-product-roadmap/received_events", - "type": "User", - "site_admin": false - }, - "event": "labeled", - "commit_id": null, - "commit_url": null, - "created_at": "2022-04-13T20:49:34Z", - "label": { - "name": "beta", - "color": "99dd88" - }, - "performed_via_github_app": null - }, - { - "id": 6635165802, - "node_id": "RTE_lADODwFebM5HwC0kzwAAAAGLfJhq", - "url": "https://api.github.com/repos/github/roadmap/issues/events/6635165802", - "actor": { - "login": "github-product-roadmap", - "id": 67656570, - "node_id": "MDQ6VXNlcjY3NjU2NTcw", - "avatar_url": "https://avatars.githubusercontent.com/u/67656570?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/github-product-roadmap", - "html_url": "https://github.com/github-product-roadmap", - "followers_url": "https://api.github.com/users/github-product-roadmap/followers", - "following_url": "https://api.github.com/users/github-product-roadmap/following{/other_user}", - "gists_url": "https://api.github.com/users/github-product-roadmap/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github-product-roadmap/subscriptions", - "organizations_url": "https://api.github.com/users/github-product-roadmap/orgs", - "repos_url": "https://api.github.com/users/github-product-roadmap/repos", - "events_url": "https://api.github.com/users/github-product-roadmap/events{/privacy}", - "received_events_url": "https://api.github.com/users/github-product-roadmap/received_events", - "type": "User", - "site_admin": false - }, - "event": "renamed", - "commit_id": null, - "commit_url": null, - "created_at": "2022-05-18T19:29:01Z", - "rename": { - "from": "Secret scanning: dry-runs for enterprise-level custom patterns (cloud)", - "to": "Secret scanning: dry-runs for enterprise-level custom patterns" - }, - "performed_via_github_app": null - }, - { - "url": "https://api.github.com/repos/github/roadmap/issues/comments/1130876857", - "html_url": "https://github.com/github/roadmap/issues/493#issuecomment-1130876857", - "issue_url": "https://api.github.com/repos/github/roadmap/issues/493", - "id": 1130876857, - "node_id": "IC_kwDODwFebM5DZ8-5", - "user": { - "login": "octocat", - "id": 94867353, - "node_id": "U_kgDOBaePmQ", - "avatar_url": "https://avatars.githubusercontent.com/u/94867353?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "created_at": "2022-05-19T00:52:15Z", - "updated_at": "2022-05-19T00:52:15Z", - "author_association": "COLLABORATOR", - "body": "🚢 Shipped to the cloud: https://github.blog/changelog/2022-05-12-secret-scanning-dry-runs-for-enterprise-level-custom-patterns/", - "reactions": { - "url": "https://api.github.com/repos/github/roadmap/issues/comments/1130876857/reactions", - "total_count": 0, - "+1": 0, - "-1": 0, - "laugh": 0, - "hooray": 0, - "confused": 0, - "heart": 0, - "rocket": 0, - "eyes": 0 - }, - "performed_via_github_app": null, - "event": "commented", - "actor": { - "login": "octocat", - "id": 94867353, - "node_id": "U_kgDOBaePmQ", - "avatar_url": "https://avatars.githubusercontent.com/u/94867353?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Timeline Event", - "description": "Timeline Event", - "type": "object", - "anyOf": [ - { - "title": "Labeled Issue Event", - "description": "Labeled Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "label": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "color": { - "type": "string" - } - }, - "required": [ - "name", - "color" - ] - } - }, - "required": [ - "label", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Unlabeled Issue Event", - "description": "Unlabeled Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "label": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "color": { - "type": "string" - } - }, - "required": [ - "name", - "color" - ] - } - }, - "required": [ - "label", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Milestoned Issue Event", - "description": "Milestoned Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "milestone": { - "type": "object", - "properties": { - "title": { - "type": "string" - } - }, - "required": [ - "title" - ] - } - }, - "required": [ - "milestone", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Demilestoned Issue Event", - "description": "Demilestoned Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "milestone": { - "type": "object", - "properties": { - "title": { - "type": "string" - } - }, - "required": [ - "title" - ] - } - }, - "required": [ - "milestone", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Renamed Issue Event", - "description": "Renamed Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "rename": { - "type": "object", - "properties": { - "from": { - "type": "string" - }, - "to": { - "type": "string" - } - }, - "required": [ - "from", - "to" - ] - } - }, - "required": [ - "rename", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Review Requested Issue Event", - "description": "Review Requested Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "review_requester": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "requested_team": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - }, - "requested_reviewer": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "review_requester", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Review Request Removed Issue Event", - "description": "Review Request Removed Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "review_requester": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "requested_team": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - }, - "requested_reviewer": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "review_requester", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Review Dismissed Issue Event", - "description": "Review Dismissed Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "dismissed_review": { - "type": "object", - "properties": { - "state": { - "type": "string" - }, - "review_id": { - "type": "integer" - }, - "dismissal_message": { - "type": [ - "string", - "null" - ] - }, - "dismissal_commit_id": { - "type": "string" - } - }, - "required": [ - "state", - "review_id", - "dismissal_message" - ] - } - }, - "required": [ - "dismissed_review", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Locked Issue Event", - "description": "Locked Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "lock_reason": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "lock_reason", - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Added to Project Issue Event", - "description": "Added to Project Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "project_card": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "project_id": { - "type": "integer" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "column_name": { - "type": "string" - }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "project_id", - "project_url", - "column_name" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Moved Column in Project Issue Event", - "description": "Moved Column in Project Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "project_card": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "project_id": { - "type": "integer" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "column_name": { - "type": "string" - }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "project_id", - "project_url", - "column_name" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Removed from Project Issue Event", - "description": "Removed from Project Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "project_card": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "project_id": { - "type": "integer" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "column_name": { - "type": "string" - }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "project_id", - "project_url", - "column_name" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Converted Note to Issue Issue Event", - "description": "Converted Note to Issue Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "project_card": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "project_id": { - "type": "integer" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "column_name": { - "type": "string" - }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "project_id", - "project_url", - "column_name" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Timeline Comment Event", - "description": "Timeline Comment Event", - "type": "object", - "properties": { - "event": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "id": { - "description": "Unique identifier of the issue comment", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "event", - "actor", - "id", - "node_id", - "html_url", - "issue_url", - "author_association", - "user", - "url", - "created_at", - "updated_at" - ] - }, - { - "title": "Timeline Cross Referenced Event", - "description": "Timeline Cross Referenced Event", - "type": "object", - "properties": { - "event": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "source": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "issue": { - "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", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "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": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ] - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "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" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "parent_issue_url": { - "description": "URL to get the parent issue of this issue, if it is a sub-issue", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - } - }, - "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", - "created_at", - "updated_at" - ] - } - } - } - }, - "required": [ - "event", - "created_at", - "updated_at", - "source" - ] - }, - { - "title": "Timeline Committed Event", - "description": "Timeline Committed Event", - "type": "object", - "properties": { - "event": { - "type": "string" - }, - "sha": { - "description": "SHA for the commit", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "author": { - "description": "Identifying information for the git-user", - "type": "object", - "properties": { - "date": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string" - }, - "email": { - "type": "string", - "description": "Git email address of the user" - }, - "name": { - "description": "Name of the git user", - "type": "string" - } - }, - "required": [ - "email", - "name", - "date" - ] - }, - "committer": { - "description": "Identifying information for the git-user", - "type": "object", - "properties": { - "date": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string" - }, - "email": { - "type": "string", - "description": "Git email address of the user" - }, - "name": { - "description": "Name of the git user", - "type": "string" - } - }, - "required": [ - "email", - "name", - "date" - ] - }, - "message": { - "description": "Message describing the purpose of the commit", - "type": "string" - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url", - "html_url" - ] - } - }, - "verification": { - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "signature": { - "type": [ - "string", - "null" - ] - }, - "payload": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "signature", - "payload" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "node_id", - "url", - "html_url", - "author", - "committer", - "tree", - "message", - "parents", - "verification" - ] - }, - { - "title": "Timeline Reviewed Event", - "description": "Timeline Reviewed Event", - "type": "object", - "properties": { - "event": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the review", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "description": "The text of the review.", - "type": [ - "string", - "null" - ] - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "submitted_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "commit_id": { - "description": "A commit SHA for the review.", - "type": "string" - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - }, - "required": [ - "event", - "id", - "node_id", - "user", - "body", - "state", - "commit_id", - "html_url", - "pull_request_url", - "_links", - "author_association" - ] - }, - { - "title": "Timeline Line Commented Event", - "description": "Timeline Line Commented Event", - "type": "object", - "properties": { - "event": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "comments": { - "type": "array", - "items": { - "title": "Pull Request Review Comment", - "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.", - "type": "object", - "properties": { - "url": { - "description": "URL for the pull request review comment", - "type": "string" - }, - "pull_request_review_id": { - "description": "The ID of the pull request review to which the comment belongs.", - "type": [ - "integer", - "null" - ], - "format": "int64" - }, - "id": { - "description": "The ID of the pull request review comment.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "description": "The node ID of the pull request review comment.", - "type": "string" - }, - "diff_hunk": { - "description": "The diff of the line that the comment refers to.", - "type": "string" - }, - "path": { - "description": "The relative path of the file to which the comment applies.", - "type": "string" - }, - "position": { - "description": "The line index in the diff to which the comment applies. This field is closing down; use `line` instead.", - "type": "integer" - }, - "original_position": { - "description": "The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.", - "type": "integer" - }, - "commit_id": { - "description": "The SHA of the commit to which the comment applies.", - "type": "string" - }, - "original_commit_id": { - "description": "The SHA of the original commit to which the comment applies.", - "type": "string" - }, - "in_reply_to_id": { - "description": "The comment ID to reply to.", - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "description": "The text of the comment.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "description": "HTML URL for the pull request review comment.", - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "description": "URL for the pull request that the review comment belongs to.", - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - }, - "html": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "start_line": { - "type": [ - "integer", - "null" - ], - "description": "The first line of the range for a multi-line comment." - }, - "original_start_line": { - "type": [ - "integer", - "null" - ], - "description": "The first line of the range for a multi-line comment." - }, - "start_side": { - "type": [ - "string", - "null" - ], - "description": "The side of the first line of the range for a multi-line comment.", - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - "line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "original_line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "side": { - "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", - "enum": [ - "LEFT", - "RIGHT" - ], - "default": "RIGHT", - "type": "string" - }, - "subject_type": { - "description": "The level at which the comment is targeted, can be a diff line or a file.", - "type": "string", - "enum": [ - "line", - "file" - ] - }, - "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" - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - } - }, - "required": [ - "url", - "id", - "node_id", - "pull_request_review_id", - "diff_hunk", - "path", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "author_association", - "_links" - ] - } - } - } - }, - { - "title": "Timeline Commit Commented Event", - "description": "Timeline Commit Commented Event", - "type": "object", - "properties": { - "event": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "commit_id": { - "type": "string" - }, - "comments": { - "type": "array", - "items": { - "title": "Commit Comment", - "description": "Commit Comment", - "type": "object", - "properties": { - "html_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "body": { - "type": "string" - }, - "path": { - "type": [ - "string", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": [ - "url", - "html_url", - "id", - "node_id", - "user", - "position", - "line", - "path", - "commit_id", - "body", - "author_association", - "created_at", - "updated_at" - ] - } - } - } - }, - { - "title": "Timeline Assigned Issue Event", - "description": "Timeline Assigned Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app", - "assignee" - ] - }, - { - "title": "Timeline Unassigned Issue Event", - "description": "Timeline Unassigned Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app", - "assignee" - ] - }, - { - "title": "State Change Issue Event", - "description": "State Change Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - } - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - }, - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/licenses.json b/src/rest/data/ghes-3.14-2022-11-28/licenses.json deleted file mode 100644 index 187ea07be552..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/licenses.json +++ /dev/null @@ -1,583 +0,0 @@ -{ - "licenses": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/licenses", - "title": "Get all commonly used licenses", - "category": "licenses", - "subcategory": "licenses", - "parameters": [ - { - "name": "featured", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - }, - "description": "" - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the most commonly used licenses on GitHub. For more information, see \"Licensing a repository .\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "key": "mit", - "name": "MIT License", - "spdx_id": "MIT", - "url": "https://api.github.com/licenses/mit", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - { - "key": "lgpl-3.0", - "name": "GNU Lesser General Public License v3.0", - "spdx_id": "LGPL-3.0", - "url": "https://api.github.com/licenses/lgpl-3.0", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - { - "key": "mpl-2.0", - "name": "Mozilla Public License 2.0", - "spdx_id": "MPL-2.0", - "url": "https://api.github.com/licenses/mpl-2.0", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - { - "key": "agpl-3.0", - "name": "GNU Affero General Public License v3.0", - "spdx_id": "AGPL-3.0", - "url": "https://api.github.com/licenses/agpl-3.0", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - { - "key": "unlicense", - "name": "The Unlicense", - "spdx_id": "Unlicense", - "url": "https://api.github.com/licenses/unlicense", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - { - "key": "apache-2.0", - "name": "Apache License 2.0", - "spdx_id": "Apache-2.0", - "url": "https://api.github.com/licenses/apache-2.0", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - { - "key": "gpl-3.0", - "name": "GNU General Public License v3.0", - "spdx_id": "GPL-3.0", - "url": "https://api.github.com/licenses/gpl-3.0", - "node_id": "MDc6TGljZW5zZW1pdA==" - } - ], - "schema": { - "type": "array", - "items": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/licenses/{license}", - "title": "Get a license", - "category": "licenses", - "subcategory": "licenses", - "parameters": [ - { - "name": "license", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets information about a specific license. For more information, see \"Licensing a repository .\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "license": "LICENSE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "key": "mit", - "name": "MIT License", - "spdx_id": "MIT", - "url": "https://api.github.com/licenses/mit", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "http://choosealicense.com/licenses/mit/", - "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.", - "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.", - "permissions": [ - "commercial-use", - "modifications", - "distribution", - "sublicense", - "private-use" - ], - "conditions": [ - "include-copyright" - ], - "limitations": [ - "no-liability" - ], - "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", - "featured": true - }, - "schema": { - "title": "License", - "description": "License", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string" - }, - "implementation": { - "type": "string" - }, - "permissions": { - "type": "array", - "items": { - "type": "string" - } - }, - "conditions": { - "type": "array", - "items": { - "type": "string" - } - }, - "limitations": { - "type": "array", - "items": { - "type": "string" - } - }, - "body": { - "type": "string" - }, - "featured": { - "type": "boolean" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id", - "html_url", - "description", - "implementation", - "permissions", - "conditions", - "limitations", - "body", - "featured" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/license", - "title": "Get the license for a repository", - "category": "licenses", - "subcategory": "licenses", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

This method returns the contents of the repository's license file, if one is detected.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw contents of the license.
    • \n
  • application/vnd.github.html+json: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "name": "LICENSE", - "path": "LICENSE", - "sha": "401c59dcc4570b954dd6d345e76199e1f4e76266", - "size": 1077, - "url": "https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master", - "html_url": "https://github.com/benbalter/gman/blob/master/LICENSE", - "git_url": "https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266", - "download_url": "https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true", - "type": "file", - "content": "VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu\nIEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv\nZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0\naGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls\nZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg\nd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh\ndGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg\ncHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg\nY29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z\nIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK\nc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv\ndmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj\nZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50\naWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ\nUyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL\nSU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ\nTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG\nSVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO\nR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ\nUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF\nUyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G\nIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP\nVVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU\nSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K\n", - "encoding": "base64", - "_links": { - "self": "https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master", - "git": "https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266", - "html": "https://github.com/benbalter/gman/blob/master/LICENSE" - }, - "license": { - "key": "mit", - "name": "MIT License", - "spdx_id": "MIT", - "url": "https://api.github.com/licenses/mit", - "node_id": "MDc6TGljZW5zZW1pdA==" - } - }, - "schema": { - "title": "License Content", - "description": "License Content", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "type": { - "type": "string" - }, - "content": { - "type": "string" - }, - "encoding": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url", - "content", - "encoding", - "license" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/markdown.json b/src/rest/data/ghes-3.14-2022-11-28/markdown.json deleted file mode 100644 index 082123008398..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/markdown.json +++ /dev/null @@ -1,151 +0,0 @@ -{ - "markdown": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/markdown", - "title": "Render a Markdown document", - "category": "markdown", - "subcategory": "markdown", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "text", - "description": "

The Markdown text to render in HTML.

", - "isRequired": true - }, - { - "type": "string", - "name": "mode", - "description": "

The rendering mode.

", - "enum": [ - "markdown", - "gfm" - ], - "default": "markdown" - }, - { - "type": "string", - "name": "context", - "description": "

The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

" - } - ], - "descriptionHTML": "

Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as issues:read or pull_requests:read.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Rendering markdown", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "text": "Hello **world**" - } - }, - "response": { - "statusCode": "200", - "contentType": "text/html", - "description": "

Example response

", - "example": "

Hello world

", - "schema": { - "type": "string" - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/markdown/raw", - "title": "Render a Markdown document in raw mode", - "category": "markdown", - "subcategory": "markdown", - "parameters": [], - "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.

", - "codeExamples": [ - { - "request": { - "contentType": "text/plain", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "text": "Hello **world**" - } - }, - "response": { - "statusCode": "200", - "contentType": "text/html", - "description": "

Example response

", - "example": "

Hello world

", - "schema": { - "type": "string" - } - } - }, - { - "request": { - "contentType": "text/x-markdown", - "description": "Rendering markdown", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "text": "Hello **world**" - } - }, - "response": { - "statusCode": "200", - "contentType": "text/html", - "description": "

Example response

", - "example": "

Hello world

", - "schema": { - "type": "string" - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/meta.json b/src/rest/data/ghes-3.14-2022-11-28/meta.json deleted file mode 100644 index 0894f977e2cf..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/meta.json +++ /dev/null @@ -1,497 +0,0 @@ -{ - "meta": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/", - "title": "GitHub API Root", - "category": "meta", - "subcategory": "meta", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Get Hypermedia links to resources accessible in GitHub's REST API

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "current_user_url": "https://api.github.com/user", - "current_user_authorizations_html_url": "https://github.com/settings/connections/applications{/client_id}", - "authorizations_url": "https://api.github.com/authorizations", - "code_search_url": "https://api.github.com/search/code?q={query}{&page,per_page,sort,order}", - "commit_search_url": "https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}", - "emails_url": "https://api.github.com/user/emails", - "emojis_url": "https://api.github.com/emojis", - "events_url": "https://api.github.com/events", - "feeds_url": "https://api.github.com/feeds", - "followers_url": "https://api.github.com/user/followers", - "following_url": "https://api.github.com/user/following{/target}", - "gists_url": "https://api.github.com/gists{/gist_id}", - "hub_url": "https://api.github.com/hub", - "issue_search_url": "https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}", - "issues_url": "https://api.github.com/issues", - "keys_url": "https://api.github.com/user/keys", - "label_search_url": "https://api.github.com/search/labels?q={query}&repository_id={repository_id}{&page,per_page}", - "notifications_url": "https://api.github.com/notifications", - "organization_url": "https://api.github.com/orgs/{org}", - "organization_repositories_url": "https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}", - "organization_teams_url": "https://api.github.com/orgs/{org}/teams", - "public_gists_url": "https://api.github.com/gists/public", - "rate_limit_url": "https://api.github.com/rate_limit", - "repository_url": "https://api.github.com/repos/{owner}/{repo}", - "repository_search_url": "https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}", - "current_user_repositories_url": "https://api.github.com/user/repos{?type,page,per_page,sort}", - "starred_url": "https://api.github.com/user/starred{/owner}{/repo}", - "starred_gists_url": "https://api.github.com/gists/starred", - "topic_search_url": "https://api.github.com/search/topics?q={query}{&page,per_page}", - "user_url": "https://api.github.com/users/{user}", - "user_organizations_url": "https://api.github.com/user/orgs", - "user_repositories_url": "https://api.github.com/users/{user}/repos{?type,page,per_page,sort}", - "user_search_url": "https://api.github.com/search/users?q={query}{&page,per_page,sort,order}" - }, - "schema": { - "type": "object", - "properties": { - "current_user_url": { - "type": "string", - "format": "uri-template" - }, - "current_user_authorizations_html_url": { - "type": "string", - "format": "uri-template" - }, - "authorizations_url": { - "type": "string", - "format": "uri-template" - }, - "code_search_url": { - "type": "string", - "format": "uri-template" - }, - "commit_search_url": { - "type": "string", - "format": "uri-template" - }, - "emails_url": { - "type": "string", - "format": "uri-template" - }, - "emojis_url": { - "type": "string", - "format": "uri-template" - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "feeds_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri-template" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "hub_url": { - "type": "string", - "format": "uri-template", - "deprecated": true - }, - "issue_search_url": { - "type": "string", - "format": "uri-template" - }, - "issues_url": { - "type": "string", - "format": "uri-template" - }, - "keys_url": { - "type": "string", - "format": "uri-template" - }, - "label_search_url": { - "type": "string", - "format": "uri-template" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "organization_url": { - "type": "string", - "format": "uri-template" - }, - "organization_repositories_url": { - "type": "string", - "format": "uri-template" - }, - "organization_teams_url": { - "type": "string", - "format": "uri-template" - }, - "public_gists_url": { - "type": "string", - "format": "uri-template" - }, - "rate_limit_url": { - "type": "string", - "format": "uri-template" - }, - "repository_url": { - "type": "string", - "format": "uri-template" - }, - "repository_search_url": { - "type": "string", - "format": "uri-template" - }, - "current_user_repositories_url": { - "type": "string", - "format": "uri-template" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "starred_gists_url": { - "type": "string", - "format": "uri-template" - }, - "topic_search_url": { - "type": "string", - "format": "uri-template" - }, - "user_url": { - "type": "string", - "format": "uri-template" - }, - "user_organizations_url": { - "type": "string", - "format": "uri-template" - }, - "user_repositories_url": { - "type": "string", - "format": "uri-template" - }, - "user_search_url": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "current_user_url", - "current_user_authorizations_html_url", - "authorizations_url", - "code_search_url", - "commit_search_url", - "emails_url", - "emojis_url", - "events_url", - "feeds_url", - "followers_url", - "following_url", - "gists_url", - "issue_search_url", - "issues_url", - "keys_url", - "label_search_url", - "notifications_url", - "organization_url", - "organization_repositories_url", - "organization_teams_url", - "public_gists_url", - "rate_limit_url", - "repository_url", - "repository_search_url", - "current_user_repositories_url", - "starred_url", - "starred_gists_url", - "user_url", - "user_organizations_url", - "user_repositories_url", - "user_search_url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/meta", - "title": "Get GitHub Enterprise Server meta information", - "category": "meta", - "subcategory": "meta", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "verifiable_password_authentication": true, - "packages": [ - "192.0.2.1" - ], - "domains": { - "website": [ - "*.example.com" - ], - "codespaces": [ - "*.example.com" - ], - "copilot": [ - "*.example.com" - ], - "packages": [ - "*.example.com" - ] - }, - "installed_version": "3.14.0" - }, - "schema": { - "title": "Api Overview", - "description": "Api Overview", - "type": "object", - "properties": { - "verifiable_password_authentication": { - "type": "boolean" - }, - "packages": { - "type": "array", - "items": { - "type": "string" - } - }, - "domains": { - "type": "object", - "properties": { - "website": { - "type": "array", - "items": { - "type": "string" - } - }, - "codespaces": { - "type": "array", - "items": { - "type": "string" - } - }, - "copilot": { - "type": "array", - "items": { - "type": "string" - } - }, - "packages": { - "type": "array", - "items": { - "type": "string" - } - }, - "actions": { - "type": "array", - "items": { - "type": "string" - } - }, - "actions_inbound": { - "type": "object", - "properties": { - "full_domains": { - "type": "array", - "items": { - "type": "string" - } - }, - "wildcard_domains": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "artifact_attestations": { - "type": "object", - "properties": { - "trust_domain": { - "type": "string" - }, - "services": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "installed_version": { - "type": "string" - } - }, - "required": [ - "verifiable_password_authentication" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/octocat", - "title": "Get Octocat", - "category": "meta", - "subcategory": "meta", - "parameters": [ - { - "name": "s", - "in": "query", - "description": "

The words to show in Octocat's speech bubble

", - "schema": { - "type": "string" - }, - "required": false - } - ], - "bodyParameters": [], - "descriptionHTML": "

Get the octocat as ASCII art

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/octocat-stream", - "description": "

Response

", - "example": " MMM. .MMM\n MMMMMMMMMMMMMMMMMMM\n MMMMMMMMMMMMMMMMMMM ___________________________________\n MMMMMMMMMMMMMMMMMMMMM | |\n MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. |\n MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________|\n MMMM::- -:::::::- -::MMMM |/\n MM~:~ 00~:::::~ 00~:~MM\n .. MMMMM::.00:::+:::.00::MMMMM ..\n .MM::::: ._. :::::MM.\n MMMM;:::::;MMMM\n -MM MMMMMMM\n ^ M+ MMMMMMMMM\n MMMMMMM MM MM MM\n MM MM MM MM\n MM MM MM MM\n .~~MM~MM~MM~MM~~.\n ~~~~MM:~MM~~~MM~:MM~~~~\n ~~~~~~==~==~~~==~==~~~~~~\n ~~~~~~==~==~==~==~~~~~~\n :~==~==~==~==~~\n", - "schema": { - "type": "string" - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/zen", - "title": "Get the Zen of GitHub", - "category": "meta", - "subcategory": "meta", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Get a random sentence from the Zen of GitHub

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "text/plain", - "description": "

Example response

", - "example": "Responsive is better than fast", - "schema": { - "type": "string" - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/metrics.json b/src/rest/data/ghes-3.14-2022-11-28/metrics.json deleted file mode 100644 index eed8a54d638f..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/metrics.json +++ /dev/null @@ -1,770 +0,0 @@ -{ - "statistics": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/code_frequency", - "title": "Get the weekly commit activity", - "category": "metrics", - "subcategory": "statistics", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

", - "example": [ - [ - 1302998400, - 1124, - -435 - ] - ], - "schema": { - "type": "array", - "items": { - "title": "Code Frequency Stat", - "description": "Code Frequency Stat", - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

" - }, - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "204", - "description": "

A header with no content is returned.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/commit_activity", - "title": "Get the last year of commit activity", - "category": "metrics", - "subcategory": "statistics", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "days": [ - 0, - 3, - 26, - 20, - 39, - 1, - 0 - ], - "total": 89, - "week": 1336280400 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Commit Activity", - "description": "Commit Activity", - "type": "object", - "properties": { - "days": { - "type": "array", - "items": { - "type": "integer" - } - }, - "total": { - "type": "integer" - }, - "week": { - "type": "integer" - } - }, - "required": [ - "days", - "total", - "week" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "204", - "description": "

A header with no content is returned.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/contributors", - "title": "Get all contributor commit activity", - "category": "metrics", - "subcategory": "statistics", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:

\n
    \n
  • w - Start of the week, given as a Unix timestamp.
    • \n
  • a - Number of additions
    • \n
  • d - Number of deletions
    • \n
  • c - Number of commits
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - }, - "total": 135, - "weeks": [ - { - "w": 1367712000, - "a": 6898, - "d": 77, - "c": 10 - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "title": "Contributor Activity", - "description": "Contributor Activity", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "total": { - "type": "integer" - }, - "weeks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "w": { - "type": "integer" - }, - "a": { - "type": "integer" - }, - "d": { - "type": "integer" - }, - "c": { - "type": "integer" - } - } - } - } - }, - "required": [ - "author", - "total", - "weeks" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "204", - "description": "

A header with no content is returned.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/participation", - "title": "Get the weekly commit count", - "category": "metrics", - "subcategory": "statistics", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns the total commit counts for the owner and total commit counts in all. all is everyone combined, including the owner in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract owner from all.

\n

The array order is oldest week (index 0) to most recent week.

\n

The most recent week is seven days ago at UTC midnight to today at UTC midnight.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

The array order is oldest week (index 0) to most recent week.

", - "example": { - "all": [ - 11, - 21, - 15, - 2, - 8, - 1, - 8, - 23, - 17, - 21, - 11, - 10, - 33, - 91, - 38, - 34, - 22, - 23, - 32, - 3, - 43, - 87, - 71, - 18, - 13, - 5, - 13, - 16, - 66, - 27, - 12, - 45, - 110, - 117, - 13, - 8, - 18, - 9, - 19, - 26, - 39, - 12, - 20, - 31, - 46, - 91, - 45, - 10, - 24, - 9, - 29, - 7 - ], - "owner": [ - 3, - 2, - 3, - 0, - 2, - 0, - 5, - 14, - 7, - 9, - 1, - 5, - 0, - 48, - 19, - 2, - 0, - 1, - 10, - 2, - 23, - 40, - 35, - 8, - 8, - 2, - 10, - 6, - 30, - 0, - 2, - 9, - 53, - 104, - 3, - 3, - 10, - 4, - 7, - 11, - 21, - 4, - 4, - 22, - 26, - 63, - 11, - 2, - 14, - 1, - 10, - 3 - ] - }, - "schema": { - "title": "Participation Stats", - "type": "object", - "properties": { - "all": { - "type": "array", - "items": { - "type": "integer" - } - }, - "owner": { - "type": "array", - "items": { - "type": "integer" - } - } - }, - "required": [ - "all", - "owner" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

The array order is oldest week (index 0) to most recent week.

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/punch_card", - "title": "Get the hourly commit count for each day", - "category": "metrics", - "subcategory": "statistics", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Each array contains the day number, hour number, and number of commits:

\n
    \n
  • 0-6: Sunday - Saturday
    • \n
  • 0-23: Hour of day
    • \n
  • Number of commits
    • \n
\n

For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

", - "example": [ - [ - 0, - 0, - 5 - ], - [ - 0, - 1, - 43 - ], - [ - 0, - 2, - 21 - ] - ], - "schema": { - "type": "array", - "items": { - "title": "Code Frequency Stat", - "description": "Code Frequency Stat", - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

" - }, - { - "httpStatusCode": "204", - "description": "

A header with no content is returned.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/migrations.json b/src/rest/data/ghes-3.14-2022-11-28/migrations.json deleted file mode 100644 index b25b6376abd8..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/migrations.json +++ /dev/null @@ -1,7535 +0,0 @@ -{ - "orgs": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/migrations", - "title": "List organization migrations", - "category": "migrations", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "exclude", - "description": "

Exclude attributes from the API response to improve performance

", - "in": "query", - "schema": { - "type": "array", - "items": { - "description": "Allowed values that can be passed to the exclude param.", - "enum": [ - "repositories" - ], - "type": "string", - "examples": [ - "repositories" - ] - } - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).

\n

A list of repositories is only returned for export migrations.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 79, - "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 - }, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "state": "pending", - "lock_repositories": true, - "exclude_attachments": false, - "exclude_releases": false, - "exclude_owner_projects": false, - "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, - "allow_auto_merge": false, - "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 - } - ], - "url": "https://api.github.com/orgs/octo-org/migrations/79", - "created_at": "2015-07-06T15:33:38-07:00", - "updated_at": "2015-07-06T15:33:38-07:00", - "node_id": "MDQ6VXNlcjE=" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Migration", - "description": "A migration.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "guid": { - "type": "string" - }, - "state": { - "type": "string" - }, - "lock_repositories": { - "type": "boolean" - }, - "exclude_metadata": { - "type": "boolean" - }, - "exclude_git_data": { - "type": "boolean" - }, - "exclude_attachments": { - "type": "boolean" - }, - "exclude_releases": { - "type": "boolean" - }, - "exclude_owner_projects": { - "type": "boolean" - }, - "org_metadata_only": { - "type": "boolean" - }, - "repositories": { - "type": "array", - "description": "The repositories included in the migration. Only returned for export migrations.", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - }, - "url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "node_id": { - "type": "string" - }, - "archive_url": { - "type": "string", - "format": "uri" - }, - "exclude": { - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", - "type": "array", - "items": { - "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", - "type": "string" - } - } - }, - "required": [ - "id", - "node_id", - "owner", - "guid", - "state", - "lock_repositories", - "exclude_metadata", - "exclude_git_data", - "exclude_attachments", - "exclude_releases", - "exclude_owner_projects", - "org_metadata_only", - "repositories", - "url", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/migrations", - "title": "Start an organization migration", - "category": "migrations", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "repositories", - "description": "

A list of arrays indicating which repositories should be migrated.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "lock_repositories", - "description": "

Indicates whether repositories should be locked (to prevent manipulation) while migrating data.

", - "default": false - }, - { - "type": "boolean", - "name": "exclude_metadata", - "description": "

Indicates whether metadata should be excluded and only git source should be included for the migration.

", - "default": false - }, - { - "type": "boolean", - "name": "exclude_git_data", - "description": "

Indicates whether the repository git data should be excluded from the migration.

", - "default": false - }, - { - "type": "boolean", - "name": "exclude_attachments", - "description": "

Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).

", - "default": false - }, - { - "type": "boolean", - "name": "exclude_releases", - "description": "

Indicates whether releases should be excluded from the migration (to reduce migration archive file size).

", - "default": false - }, - { - "type": "boolean", - "name": "exclude_owner_projects", - "description": "

Indicates whether projects owned by the organization or users should be excluded. from the migration.

", - "default": false - }, - { - "type": "boolean", - "name": "org_metadata_only", - "description": "

Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

", - "default": false - }, - { - "type": "array of strings", - "name": "exclude", - "description": "

Exclude related items from being returned in the response in order to improve performance of the request.\nSupported values are: repositories

" - } - ], - "descriptionHTML": "

Initiates the generation of a migration archive.

\n

Before you can use this endpoint, you must configure a blob storage provider in the \"Migrations\" section in the Management Console. For more details, see \"Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud.\"

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "repositories": [ - "github/Hello-World" - ], - "lock_repositories": true - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 79, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "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 - }, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "state": "pending", - "lock_repositories": true, - "exclude_attachments": false, - "exclude_releases": false, - "exclude_owner_projects": false, - "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, - "allow_auto_merge": false, - "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 - } - ], - "url": "https://api.github.com/orgs/octo-org/migrations/79", - "created_at": "2015-07-06T15:33:38-07:00", - "updated_at": "2015-07-06T15:33:38-07:00" - }, - "schema": { - "title": "Migration", - "description": "A migration.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "guid": { - "type": "string" - }, - "state": { - "type": "string" - }, - "lock_repositories": { - "type": "boolean" - }, - "exclude_metadata": { - "type": "boolean" - }, - "exclude_git_data": { - "type": "boolean" - }, - "exclude_attachments": { - "type": "boolean" - }, - "exclude_releases": { - "type": "boolean" - }, - "exclude_owner_projects": { - "type": "boolean" - }, - "org_metadata_only": { - "type": "boolean" - }, - "repositories": { - "type": "array", - "description": "The repositories included in the migration. Only returned for export migrations.", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - }, - "url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "node_id": { - "type": "string" - }, - "archive_url": { - "type": "string", - "format": "uri" - }, - "exclude": { - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", - "type": "array", - "items": { - "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", - "type": "string" - } - } - }, - "required": [ - "id", - "node_id", - "owner", - "guid", - "state", - "lock_repositories", - "exclude_metadata", - "exclude_git_data", - "exclude_attachments", - "exclude_releases", - "exclude_owner_projects", - "org_metadata_only", - "repositories", - "url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/migrations/{migration_id}", - "title": "Get an organization migration status", - "category": "migrations", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "migration_id", - "description": "

The unique identifier of the migration.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "exclude", - "description": "

Exclude attributes from the API response to improve performance

", - "in": "query", - "schema": { - "type": "array", - "items": { - "description": "Allowed values that can be passed to the exclude param.", - "enum": [ - "repositories" - ], - "type": "string", - "examples": [ - "repositories" - ] - } - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Fetches the status of a migration.

\n

The state of a migration can be one of the following values:

\n
    \n
  • pending, which means the migration hasn't started yet.
    • \n
  • exporting, which means the migration is in progress.
    • \n
  • exported, which means the migration finished successfully.
    • \n
  • failed, which means the migration failed.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "migration_id": "MIGRATION_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "
    \n
  • pending, which means the migration hasn't started yet.
    • \n
  • exporting, which means the migration is in progress.
    • \n
  • exported, which means the migration finished successfully.
    • \n
  • failed, which means the migration failed.
    • \n
", - "example": { - "id": 79, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "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 - }, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "state": "exported", - "lock_repositories": true, - "exclude_attachments": false, - "exclude_releases": false, - "exclude_owner_projects": false, - "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, - "allow_auto_merge": false, - "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 - } - ], - "url": "https://api.github.com/orgs/octo-org/migrations/79", - "created_at": "2015-07-06T15:33:38-07:00", - "updated_at": "2015-07-06T15:33:38-07:00" - }, - "schema": { - "title": "Migration", - "description": "A migration.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "guid": { - "type": "string" - }, - "state": { - "type": "string" - }, - "lock_repositories": { - "type": "boolean" - }, - "exclude_metadata": { - "type": "boolean" - }, - "exclude_git_data": { - "type": "boolean" - }, - "exclude_attachments": { - "type": "boolean" - }, - "exclude_releases": { - "type": "boolean" - }, - "exclude_owner_projects": { - "type": "boolean" - }, - "org_metadata_only": { - "type": "boolean" - }, - "repositories": { - "type": "array", - "description": "The repositories included in the migration. Only returned for export migrations.", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - }, - "url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "node_id": { - "type": "string" - }, - "archive_url": { - "type": "string", - "format": "uri" - }, - "exclude": { - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", - "type": "array", - "items": { - "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", - "type": "string" - } - } - }, - "required": [ - "id", - "node_id", - "owner", - "guid", - "state", - "lock_repositories", - "exclude_metadata", - "exclude_git_data", - "exclude_attachments", - "exclude_releases", - "exclude_owner_projects", - "org_metadata_only", - "repositories", - "url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "
    \n
  • pending, which means the migration hasn't started yet.
    • \n
  • exporting, which means the migration is in progress.
    • \n
  • exported, which means the migration finished successfully.
    • \n
  • failed, which means the migration failed.
    • \n
" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/migrations/{migration_id}/archive", - "title": "Download an organization migration archive", - "category": "migrations", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "migration_id", - "description": "

The unique identifier of the migration.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Fetches the URL to a migration archive.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "migration_id": "MIGRATION_ID" - } - }, - "response": { - "statusCode": "302", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "302", - "description": "

Found

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/migrations/{migration_id}/archive", - "title": "Delete an organization migration archive", - "category": "migrations", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "migration_id", - "description": "

The unique identifier of the migration.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a previous migration archive. Migration archives are automatically deleted after seven days.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "migration_id": "MIGRATION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", - "title": "Unlock an organization repository", - "category": "migrations", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "migration_id", - "description": "

The unique identifier of the migration.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "repo_name", - "description": "

repo_name parameter

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "migration_id": "MIGRATION_ID", - "repo_name": "REPO_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/migrations/{migration_id}/repositories", - "title": "List repositories in an organization migration", - "category": "migrations", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "migration_id", - "description": "

The unique identifier of the migration.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List all the repositories for this organization migration.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "migration_id": "MIGRATION_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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, - "has_discussions": false, - "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 - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ], - "users": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/migrations", - "title": "List user migrations", - "category": "migrations", - "subcategory": "users", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all migrations a user has started.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 79, - "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 - }, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "state": "pending", - "lock_repositories": true, - "exclude_attachments": false, - "exclude_releases": false, - "exclude_owner_projects": false, - "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, - "allow_auto_merge": false, - "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 - } - ], - "url": "https://api.github.com/orgs/octo-org/migrations/79", - "created_at": "2015-07-06T15:33:38-07:00", - "updated_at": "2015-07-06T15:33:38-07:00", - "node_id": "MDQ6VXNlcjE=" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Migration", - "description": "A migration.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "guid": { - "type": "string" - }, - "state": { - "type": "string" - }, - "lock_repositories": { - "type": "boolean" - }, - "exclude_metadata": { - "type": "boolean" - }, - "exclude_git_data": { - "type": "boolean" - }, - "exclude_attachments": { - "type": "boolean" - }, - "exclude_releases": { - "type": "boolean" - }, - "exclude_owner_projects": { - "type": "boolean" - }, - "org_metadata_only": { - "type": "boolean" - }, - "repositories": { - "type": "array", - "description": "The repositories included in the migration. Only returned for export migrations.", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - }, - "url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "node_id": { - "type": "string" - }, - "archive_url": { - "type": "string", - "format": "uri" - }, - "exclude": { - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", - "type": "array", - "items": { - "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", - "type": "string" - } - } - }, - "required": [ - "id", - "node_id", - "owner", - "guid", - "state", - "lock_repositories", - "exclude_metadata", - "exclude_git_data", - "exclude_attachments", - "exclude_releases", - "exclude_owner_projects", - "org_metadata_only", - "repositories", - "url", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/user/migrations", - "title": "Start a user migration", - "category": "migrations", - "subcategory": "users", - "parameters": [], - "bodyParameters": [ - { - "type": "boolean", - "name": "lock_repositories", - "description": "

Lock the repositories being migrated at the start of the migration

" - }, - { - "type": "boolean", - "name": "exclude_metadata", - "description": "

Indicates whether metadata should be excluded and only git source should be included for the migration.

" - }, - { - "type": "boolean", - "name": "exclude_git_data", - "description": "

Indicates whether the repository git data should be excluded from the migration.

" - }, - { - "type": "boolean", - "name": "exclude_attachments", - "description": "

Do not include attachments in the migration

" - }, - { - "type": "boolean", - "name": "exclude_releases", - "description": "

Do not include releases in the migration

" - }, - { - "type": "boolean", - "name": "exclude_owner_projects", - "description": "

Indicates whether projects owned by the organization or users should be excluded.

" - }, - { - "type": "boolean", - "name": "org_metadata_only", - "description": "

Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

", - "default": false - }, - { - "type": "array of strings", - "name": "exclude", - "description": "

Exclude attributes from the API response to improve performance\nSupported values are: repositories

" - }, - { - "type": "array of strings", - "name": "repositories", - "description": "", - "isRequired": true - } - ], - "descriptionHTML": "

Initiates the generation of a user migration archive.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "repositories": [ - "octocat/Hello-World" - ], - "lock_repositories": true - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 79, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "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 - }, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "state": "pending", - "lock_repositories": true, - "exclude_attachments": false, - "exclude_releases": false, - "exclude_owner_projects": false, - "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, - "allow_auto_merge": false, - "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 - } - ], - "url": "https://api.github.com/orgs/octo-org/migrations/79", - "created_at": "2015-07-06T15:33:38-07:00", - "updated_at": "2015-07-06T15:33:38-07:00" - }, - "schema": { - "title": "Migration", - "description": "A migration.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "guid": { - "type": "string" - }, - "state": { - "type": "string" - }, - "lock_repositories": { - "type": "boolean" - }, - "exclude_metadata": { - "type": "boolean" - }, - "exclude_git_data": { - "type": "boolean" - }, - "exclude_attachments": { - "type": "boolean" - }, - "exclude_releases": { - "type": "boolean" - }, - "exclude_owner_projects": { - "type": "boolean" - }, - "org_metadata_only": { - "type": "boolean" - }, - "repositories": { - "type": "array", - "description": "The repositories included in the migration. Only returned for export migrations.", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - }, - "url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "node_id": { - "type": "string" - }, - "archive_url": { - "type": "string", - "format": "uri" - }, - "exclude": { - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", - "type": "array", - "items": { - "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", - "type": "string" - } - } - }, - "required": [ - "id", - "node_id", - "owner", - "guid", - "state", - "lock_repositories", - "exclude_metadata", - "exclude_git_data", - "exclude_attachments", - "exclude_releases", - "exclude_owner_projects", - "org_metadata_only", - "repositories", - "url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/migrations/{migration_id}/archive", - "title": "Download a user migration archive", - "category": "migrations", - "subcategory": "users", - "parameters": [ - { - "name": "migration_id", - "description": "

The unique identifier of the migration.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Fetches the URL to download the migration archive as a tar.gz file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:

\n
    \n
  • attachments
    • \n
  • bases
    • \n
  • commit_comments
    • \n
  • issue_comments
    • \n
  • issue_events
    • \n
  • issues
    • \n
  • milestones
    • \n
  • organizations
    • \n
  • projects
    • \n
  • protected_branches
    • \n
  • pull_request_reviews
    • \n
  • pull_requests
    • \n
  • releases
    • \n
  • repositories
    • \n
  • review_comments
    • \n
  • schema
    • \n
  • users
    • \n
\n

The archive will also contain an attachments directory that includes all attachment files uploaded to GitHub.com and a repositories directory that contains the repository's Git data.

", - "codeExamples": [], - "statusCodes": [ - { - "httpStatusCode": "302", - "description": "

Found

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/migrations/{migration_id}/repositories", - "title": "List repositories for a user migration", - "category": "migrations", - "subcategory": "users", - "parameters": [ - { - "name": "migration_id", - "description": "

The unique identifier of the migration.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all the repositories for this user migration.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "migration_id": "MIGRATION_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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, - "has_discussions": false, - "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 - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/oauth-authorizations.json b/src/rest/data/ghes-3.14-2022-11-28/oauth-authorizations.json deleted file mode 100644 index 96d097dc6874..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/oauth-authorizations.json +++ /dev/null @@ -1,7872 +0,0 @@ -{ - "oauth-authorizations": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/applications/grants", - "title": "List your grants", - "category": "oauth-authorizations", - "subcategory": "oauth-authorizations", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "client_id", - "in": "query", - "required": false, - "description": "

The client ID of your GitHub app.

", - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.

\n
\n

You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 1, - "url": "https://api.github.com/applications/grants/1", - "app": { - "url": "http://my-github-app.com", - "name": "my github app", - "client_id": "abcde12345fghij67890" - }, - "created_at": "2011-09-06T17:26:27Z", - "updated_at": "2011-09-06T20:39:23Z", - "scopes": [ - "public_repo" - ] - } - ], - "schema": { - "type": "array", - "items": { - "title": "Application Grant", - "description": "The authorization associated with an OAuth Access.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string", - "format": "uri" - }, - "app": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "client_id", - "name", - "url" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "scopes": { - "type": "array", - "items": { - "type": "string" - } - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "app", - "id", - "scopes", - "url", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/applications/grants/{grant_id}", - "title": "Get a single grant", - "category": "oauth-authorizations", - "subcategory": "oauth-authorizations", - "parameters": [ - { - "name": "grant_id", - "description": "

The unique identifier of the grant.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "grant_id": "GRANT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "url": "https://api.github.com/applications/grants/1", - "app": { - "url": "http://my-github-app.com", - "name": "my github app", - "client_id": "abcde12345fghij67890" - }, - "created_at": "2011-09-06T17:26:27Z", - "updated_at": "2011-09-06T20:39:23Z", - "scopes": [ - "public_repo" - ] - }, - "schema": { - "title": "Application Grant", - "description": "The authorization associated with an OAuth Access.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string", - "format": "uri" - }, - "app": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "client_id", - "name", - "url" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "scopes": { - "type": "array", - "items": { - "type": "string" - } - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "app", - "id", - "scopes", - "url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/applications/grants/{grant_id}", - "title": "Delete a grant", - "category": "oauth-authorizations", - "subcategory": "oauth-authorizations", - "parameters": [ - { - "name": "grant_id", - "description": "

The unique identifier of the grant.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.

\n
\n

Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "grant_id": "GRANT_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/authorizations", - "title": "List your authorizations", - "category": "oauth-authorizations", - "subcategory": "oauth-authorizations", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "client_id", - "in": "query", - "required": false, - "description": "

The client ID of your GitHub app.

", - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 2, - "url": "https://enterprise.octocat.com/api/v3/authorizations/2", - "app": { - "name": "My personal access token", - "url": "https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens", - "client_id": "00000000000000000000" - }, - "token": "ghp_16C7e42F292c6912E7710c838347Ae178B4a", - "hashed_token": "23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45", - "token_last_eight": "Ae178B4a", - "note": "My personal access token", - "note_url": null, - "created_at": "2019-04-24T21:49:02Z", - "updated_at": "2019-04-24T21:49:02Z", - "scopes": [ - "admin:business", - "admin:gpg_key", - "admin:org", - "admin:org_hook", - "admin:pre_receive_hook", - "admin:public_key", - "admin:repo_hook", - "delete_repo", - "gist", - "notifications", - "repo", - "user", - "write:discussion" - ], - "fingerprint": null - } - ], - "schema": { - "type": "array", - "items": { - "title": "Authorization", - "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string", - "format": "uri" - }, - "scopes": { - "description": "A list of scopes that this authorization is in.", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "token": { - "type": "string" - }, - "token_last_eight": { - "type": [ - "string", - "null" - ] - }, - "hashed_token": { - "type": [ - "string", - "null" - ] - }, - "app": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "client_id", - "name", - "url" - ] - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "note_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "fingerprint": { - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "installation": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Scoped Installation", - "type": "object", - "properties": { - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "single_file_name": { - "type": [ - "string", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "account": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "permissions", - "repository_selection", - "single_file_name", - "repositories_url", - "account" - ] - } - ] - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "app", - "id", - "note", - "note_url", - "scopes", - "token", - "hashed_token", - "token_last_eight", - "fingerprint", - "url", - "created_at", - "updated_at", - "expires_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/authorizations", - "title": "Create a new authorization", - "category": "oauth-authorizations", - "subcategory": "oauth-authorizations", - "parameters": [], - "bodyParameters": [ - { - "type": "array of strings or null", - "name": "scopes", - "description": "

A list of scopes that this authorization is in.

" - }, - { - "type": "string", - "name": "note", - "description": "

A note to remind you what the OAuth token is for.

" - }, - { - "type": "string", - "name": "note_url", - "description": "

A URL to remind you what app the OAuth token is for.

" - }, - { - "type": "string", - "name": "client_id", - "description": "

The OAuth app client key for which to create the token.

" - }, - { - "type": "string", - "name": "client_secret", - "description": "

The OAuth app client secret for which to create the token.

" - }, - { - "type": "string", - "name": "fingerprint", - "description": "

A unique string to distinguish an authorization from others created for the same client ID and user.

" - } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13 2020. For more information, including scheduled brownouts, see the blog post.

\n
\n

Warning

\n

\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.

\n
\n

Creates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"

\n

To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.

\n

You can also create tokens on GitHub Enterprise Server from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.

\n

Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see \"About identity and access management with SAML single sign-on\" in the GitHub Enterprise Cloud documentation.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Create an authorization", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "scopes": [ - "public_repo" - ], - "note": "optional note", - "note_url": "http://optional/note/url", - "client_id": "abcde12345fghij67890", - "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "url": "https://api.github.com/authorizations/1", - "scopes": [ - "public_repo" - ], - "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", - "token_last_eight": "Ae178B4a", - "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", - "app": { - "url": "http://my-github-app.com", - "name": "my github app", - "client_id": "abcde12345fghij67890" - }, - "note": "optional note", - "note_url": "http://optional/note/url", - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "expires_at": "2011-10-06T17:26:27Z", - "fingerprint": "jklmnop12345678" - }, - "schema": { - "title": "Authorization", - "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string", - "format": "uri" - }, - "scopes": { - "description": "A list of scopes that this authorization is in.", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "token": { - "type": "string" - }, - "token_last_eight": { - "type": [ - "string", - "null" - ] - }, - "hashed_token": { - "type": [ - "string", - "null" - ] - }, - "app": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "client_id", - "name", - "url" - ] - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "note_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "fingerprint": { - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "installation": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Scoped Installation", - "type": "object", - "properties": { - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "single_file_name": { - "type": [ - "string", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "account": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "permissions", - "repository_selection", - "single_file_name", - "repositories_url", - "account" - ] - } - ] - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "app", - "id", - "note", - "note_url", - "scopes", - "token", - "hashed_token", - "token_last_eight", - "fingerprint", - "url", - "created_at", - "updated_at", - "expires_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/authorizations/clients/{client_id}", - "title": "Get-or-create an authorization for a specific app", - "category": "oauth-authorizations", - "subcategory": "oauth-authorizations", - "parameters": [ - { - "name": "client_id", - "in": "path", - "required": true, - "description": "

The client ID of the OAuth app.

", - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "client_secret", - "description": "

The OAuth app client secret for which to create the token.

", - "isRequired": true - }, - { - "type": "array of strings or null", - "name": "scopes", - "description": "

A list of scopes that this authorization is in.

" - }, - { - "type": "string", - "name": "note", - "description": "

A note to remind you what the OAuth token is for.

" - }, - { - "type": "string", - "name": "note_url", - "description": "

A URL to remind you what app the OAuth token is for.

" - }, - { - "type": "string", - "name": "fingerprint", - "description": "

A unique string to distinguish an authorization from others created for the same client ID and user.

" - } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.

\n
\n

Warning

\n

\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.

\n
\n

Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.

\n

If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Create an authorization for an app 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", - "scopes": [ - "public_repo" - ], - "note": "optional note", - "note_url": "http://optional/note/url" - }, - "parameters": { - "client_id": "abcde12345fghij67890" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

if returning an existing token

", - "example": { - "id": 1, - "url": "https://api.github.com/authorizations/1", - "scopes": [ - "public_repo" - ], - "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", - "token_last_eight": "Ae178B4a", - "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", - "app": { - "url": "http://my-github-app.com", - "name": "my github app", - "client_id": "abcde12345fghij67890" - }, - "note": "optional note", - "note_url": "http://optional/note/url", - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "expires_at": "2011-10-06T17:26:27Z", - "fingerprint": "" - }, - "schema": { - "title": "Authorization", - "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string", - "format": "uri" - }, - "scopes": { - "description": "A list of scopes that this authorization is in.", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "token": { - "type": "string" - }, - "token_last_eight": { - "type": [ - "string", - "null" - ] - }, - "hashed_token": { - "type": [ - "string", - "null" - ] - }, - "app": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "client_id", - "name", - "url" - ] - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "note_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "fingerprint": { - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "installation": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Scoped Installation", - "type": "object", - "properties": { - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "single_file_name": { - "type": [ - "string", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "account": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "permissions", - "repository_selection", - "single_file_name", - "repositories_url", - "account" - ] - } - ] - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "app", - "id", - "note", - "note_url", - "scopes", - "token", - "hashed_token", - "token_last_eight", - "fingerprint", - "url", - "created_at", - "updated_at", - "expires_at" - ] - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Create an authorization for an app 2: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", - "scopes": [ - "public_repo" - ], - "note": "optional note", - "note_url": "http://optional/note/url" - }, - "parameters": { - "client_id": "abcde12345fghij67890" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Warning

\n

\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.

\n
", - "example": { - "id": 1, - "url": "https://api.github.com/authorizations/1", - "scopes": [ - "public_repo" - ], - "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", - "token_last_eight": "Ae178B4a", - "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", - "app": { - "url": "http://my-github-app.com", - "name": "my github app", - "client_id": "abcde12345fghij67890" - }, - "note": "optional note", - "note_url": "http://optional/note/url", - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "expires_at": "2011-10-06T17:26:27Z", - "fingerprint": "jklmnop12345678" - }, - "schema": { - "title": "Authorization", - "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string", - "format": "uri" - }, - "scopes": { - "description": "A list of scopes that this authorization is in.", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "token": { - "type": "string" - }, - "token_last_eight": { - "type": [ - "string", - "null" - ] - }, - "hashed_token": { - "type": [ - "string", - "null" - ] - }, - "app": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "client_id", - "name", - "url" - ] - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "note_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "fingerprint": { - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "installation": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Scoped Installation", - "type": "object", - "properties": { - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "single_file_name": { - "type": [ - "string", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "account": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "permissions", - "repository_selection", - "single_file_name", - "repositories_url", - "account" - ] - } - ] - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "app", - "id", - "note", - "note_url", - "scopes", - "token", - "hashed_token", - "token_last_eight", - "fingerprint", - "url", - "created_at", - "updated_at", - "expires_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

if returning an existing token

" - }, - { - "httpStatusCode": "201", - "description": "

Warning

\n

\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.

\n
" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/authorizations/clients/{client_id}/{fingerprint}", - "title": "Get-or-create an authorization for a specific app and fingerprint", - "category": "oauth-authorizations", - "subcategory": "oauth-authorizations", - "parameters": [ - { - "name": "client_id", - "in": "path", - "required": true, - "description": "

The client ID of the OAuth app.

", - "schema": { - "type": "string" - } - }, - { - "name": "fingerprint", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "client_secret", - "description": "

The OAuth app client secret for which to create the token.

", - "isRequired": true - }, - { - "type": "array of strings or null", - "name": "scopes", - "description": "

A list of scopes that this authorization is in.

" - }, - { - "type": "string", - "name": "note", - "description": "

A note to remind you what the OAuth token is for.

" - }, - { - "type": "string", - "name": "note_url", - "description": "

A URL to remind you what app the OAuth token is for.

" - } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.

\n
\n

Warning

\n

\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.

\n
\n

This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.

\n

If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Create an authorization for an app and fingerprint 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", - "scopes": [ - "public_repo" - ], - "note": "optional note", - "note_url": "http://optional/note/url" - }, - "parameters": { - "client_id": "abcde12345fghij67890", - "fingerprint": "FINGERPRINT" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

if returning an existing token

", - "example": { - "id": 1, - "url": "https://api.github.com/authorizations/1", - "scopes": [ - "public_repo" - ], - "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", - "token_last_eight": "Ae178B4a", - "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", - "app": { - "url": "http://my-github-app.com", - "name": "my github app", - "client_id": "abcde12345fghij67890" - }, - "note": "optional note", - "note_url": "http://optional/note/url", - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "expires_at": "2011-10-06T17:26:27Z", - "fingerprint": "jklmnop12345678" - }, - "schema": { - "title": "Authorization", - "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string", - "format": "uri" - }, - "scopes": { - "description": "A list of scopes that this authorization is in.", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "token": { - "type": "string" - }, - "token_last_eight": { - "type": [ - "string", - "null" - ] - }, - "hashed_token": { - "type": [ - "string", - "null" - ] - }, - "app": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "client_id", - "name", - "url" - ] - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "note_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "fingerprint": { - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "installation": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Scoped Installation", - "type": "object", - "properties": { - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "single_file_name": { - "type": [ - "string", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "account": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "permissions", - "repository_selection", - "single_file_name", - "repositories_url", - "account" - ] - } - ] - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "app", - "id", - "note", - "note_url", - "scopes", - "token", - "hashed_token", - "token_last_eight", - "fingerprint", - "url", - "created_at", - "updated_at", - "expires_at" - ] - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Create an authorization for an app and fingerprint 2: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", - "scopes": [ - "public_repo" - ], - "note": "optional note", - "note_url": "http://optional/note/url" - }, - "parameters": { - "client_id": "abcde12345fghij67890", - "fingerprint": "FINGERPRINT" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response if returning a new token

", - "example": { - "id": 1, - "url": "https://api.github.com/authorizations/1", - "scopes": [ - "public_repo" - ], - "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", - "token_last_eight": "Ae178B4a", - "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", - "app": { - "url": "http://my-github-app.com", - "name": "my github app", - "client_id": "abcde12345fghij67890" - }, - "note": "optional note", - "note_url": "http://optional/note/url", - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "expires_at": "2012-10-06T17:26:27Z", - "fingerprint": "jklmnop12345678" - }, - "schema": { - "title": "Authorization", - "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string", - "format": "uri" - }, - "scopes": { - "description": "A list of scopes that this authorization is in.", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "token": { - "type": "string" - }, - "token_last_eight": { - "type": [ - "string", - "null" - ] - }, - "hashed_token": { - "type": [ - "string", - "null" - ] - }, - "app": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "client_id", - "name", - "url" - ] - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "note_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "fingerprint": { - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "installation": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Scoped Installation", - "type": "object", - "properties": { - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "single_file_name": { - "type": [ - "string", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "account": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "permissions", - "repository_selection", - "single_file_name", - "repositories_url", - "account" - ] - } - ] - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "app", - "id", - "note", - "note_url", - "scopes", - "token", - "hashed_token", - "token_last_eight", - "fingerprint", - "url", - "created_at", - "updated_at", - "expires_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

if returning an existing token

" - }, - { - "httpStatusCode": "201", - "description": "

Response if returning a new token

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/authorizations/{authorization_id}", - "title": "Get a single authorization", - "category": "oauth-authorizations", - "subcategory": "oauth-authorizations", - "parameters": [ - { - "name": "authorization_id", - "description": "

The unique identifier of the authorization.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "authorization_id": "AUTHORIZATION_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "url": "https://api.github.com/authorizations/1", - "scopes": [ - "public_repo" - ], - "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", - "token_last_eight": "Ae178B4a", - "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", - "app": { - "url": "http://my-github-app.com", - "name": "my github app", - "client_id": "abcde12345fghij67890" - }, - "note": "optional note", - "note_url": "http://optional/note/url", - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "expires_at": "2011-10-06T17:26:27Z", - "fingerprint": "jklmnop12345678" - }, - "schema": { - "title": "Authorization", - "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string", - "format": "uri" - }, - "scopes": { - "description": "A list of scopes that this authorization is in.", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "token": { - "type": "string" - }, - "token_last_eight": { - "type": [ - "string", - "null" - ] - }, - "hashed_token": { - "type": [ - "string", - "null" - ] - }, - "app": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "client_id", - "name", - "url" - ] - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "note_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "fingerprint": { - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "installation": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Scoped Installation", - "type": "object", - "properties": { - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "single_file_name": { - "type": [ - "string", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "account": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "permissions", - "repository_selection", - "single_file_name", - "repositories_url", - "account" - ] - } - ] - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "app", - "id", - "note", - "note_url", - "scopes", - "token", - "hashed_token", - "token_last_eight", - "fingerprint", - "url", - "created_at", - "updated_at", - "expires_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/authorizations/{authorization_id}", - "title": "Update an existing authorization", - "category": "oauth-authorizations", - "subcategory": "oauth-authorizations", - "parameters": [ - { - "name": "authorization_id", - "description": "

The unique identifier of the authorization.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings or null", - "name": "scopes", - "description": "

A list of scopes that this authorization is in.

" - }, - { - "type": "array of strings", - "name": "add_scopes", - "description": "

A list of scopes to add to this authorization.

" - }, - { - "type": "array of strings", - "name": "remove_scopes", - "description": "

A list of scopes to remove from this authorization.

" - }, - { - "type": "string", - "name": "note", - "description": "

A note to remind you what the OAuth token is for.

" - }, - { - "type": "string", - "name": "note_url", - "description": "

A URL to remind you what app the OAuth token is for.

" - }, - { - "type": "string", - "name": "fingerprint", - "description": "

A unique string to distinguish an authorization from others created for the same client ID and user.

" - } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.

\n
\n

If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"

\n

You can only send one of these scope keys at a time.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example of updating scopes and note", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "add_scopes": [ - "public_repo" - ], - "remove_scopes": [ - "user" - ], - "note": "optional note" - }, - "parameters": { - "authorization_id": "AUTHORIZATION_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "url": "https://api.github.com/authorizations/1", - "scopes": [ - "public_repo" - ], - "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", - "token_last_eight": "Ae178B4a", - "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", - "app": { - "url": "http://my-github-app.com", - "name": "my github app", - "client_id": "abcde12345fghij67890" - }, - "note": "optional note", - "note_url": "http://optional/note/url", - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "expires_at": "2011-10-06T17:26:27Z", - "fingerprint": "jklmnop12345678" - }, - "schema": { - "title": "Authorization", - "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string", - "format": "uri" - }, - "scopes": { - "description": "A list of scopes that this authorization is in.", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "token": { - "type": "string" - }, - "token_last_eight": { - "type": [ - "string", - "null" - ] - }, - "hashed_token": { - "type": [ - "string", - "null" - ] - }, - "app": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "client_id", - "name", - "url" - ] - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "note_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "fingerprint": { - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "installation": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Scoped Installation", - "type": "object", - "properties": { - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "single_file_name": { - "type": [ - "string", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "account": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "permissions", - "repository_selection", - "single_file_name", - "repositories_url", - "account" - ] - } - ] - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "app", - "id", - "note", - "note_url", - "scopes", - "token", - "hashed_token", - "token_last_eight", - "fingerprint", - "url", - "created_at", - "updated_at", - "expires_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/authorizations/{authorization_id}", - "title": "Delete an authorization", - "category": "oauth-authorizations", - "subcategory": "oauth-authorizations", - "parameters": [ - { - "name": "authorization_id", - "description": "

The unique identifier of the authorization.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "authorization_id": "AUTHORIZATION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/orgs.json b/src/rest/data/ghes-3.14-2022-11-28/orgs.json deleted file mode 100644 index d9b86358544b..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/orgs.json +++ /dev/null @@ -1,23744 +0,0 @@ -{ - "orgs": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/organizations", - "title": "List organizations", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "since", - "description": "

An organization ID. Only return organizations with an ID greater than this ID.

", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all organizations, in the order that they were created.

\n

Note

\n

\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}", - "title": "Get an organization", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets information about an organization.

\n

When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable two-factor authentication.

\n

To see the full details about an organization, the authenticated user must be an organization owner.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.

\n

To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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", - "twitter_username": "github", - "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", - "type": "Organization", - "total_private_repos": 100, - "owned_private_repos": 100, - "private_gists": 81, - "disk_usage": 10000, - "collaborators": 8, - "billing_email": "mona@github.com", - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "filled_seats": 4, - "seats": 5 - }, - "default_repository_permission": "read", - "default_repository_branch": "main", - "members_can_create_repositories": true, - "two_factor_requirement_enabled": true, - "members_allowed_repository_creation_type": "all", - "members_can_create_public_repositories": false, - "members_can_create_private_repositories": false, - "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_create_public_pages": true, - "members_can_create_private_pages": true, - "members_can_delete_repositories": true, - "members_can_change_repo_visibility": true, - "members_can_invite_outside_collaborators": true, - "members_can_delete_issues": false, - "display_commenter_full_name_setting_enabled": false, - "readers_can_create_discussions": true, - "members_can_create_teams": true, - "members_can_view_dependency_insights": true, - "members_can_fork_private_repositories": false, - "web_commit_signoff_required": false, - "updated_at": "2014-03-03T18:58:10Z", - "dependency_graph_enabled_for_new_repositories": false, - "dependabot_alerts_enabled_for_new_repositories": false, - "dependabot_security_updates_enabled_for_new_repositories": false, - "advanced_security_enabled_for_new_repositories": false, - "secret_scanning_enabled_for_new_repositories": false, - "secret_scanning_push_protection_enabled_for_new_repositories": false, - "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", - "secret_scanning_push_protection_custom_link_enabled": false - }, - "schema": { - "title": "Organization Full", - "description": "Organization Full", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "company": { - "type": "string" - }, - "blog": { - "type": "string", - "format": "uri" - }, - "location": { - "type": "string" - }, - "email": { - "type": "string", - "format": "email" - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "is_verified": { - "type": "boolean" - }, - "has_organization_projects": { - "type": "boolean" - }, - "has_repository_projects": { - "type": "boolean" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "private_gists": { - "type": [ - "integer", - "null" - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "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", - "null" - ] - }, - "default_repository_branch": { - "type": [ - "string", - "null" - ], - "description": "The default branch for repositories created in this organization." - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ] - }, - "members_allowed_repository_creation_type": { - "type": "string" - }, - "members_can_create_public_repositories": { - "type": "boolean" - }, - "members_can_create_private_repositories": { - "type": "boolean" - }, - "members_can_create_internal_repositories": { - "type": "boolean" - }, - "members_can_create_pages": { - "type": "boolean" - }, - "members_can_create_public_pages": { - "type": "boolean" - }, - "members_can_create_private_pages": { - "type": "boolean" - }, - "members_can_delete_repositories": { - "type": "boolean" - }, - "members_can_change_repo_visibility": { - "type": "boolean" - }, - "members_can_invite_outside_collaborators": { - "type": "boolean" - }, - "members_can_delete_issues": { - "type": "boolean" - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean" - }, - "readers_can_create_discussions": { - "type": "boolean" - }, - "members_can_create_teams": { - "type": "boolean" - }, - "members_can_view_dependency_insights": { - "type": "boolean" - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." - }, - "secret_scanning_push_protection_custom_link": { - "type": [ - "string", - "null" - ], - "description": "An optional URL string to display to contributors who are blocked from pushing a secret." - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "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", - "archived_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/orgs/{org}", - "title": "Update an organization", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "billing_email", - "description": "

Billing email address. This address is not publicized.

" - }, - { - "type": "string", - "name": "company", - "description": "

The company name.

" - }, - { - "type": "string", - "name": "email", - "description": "

The publicly visible email address.

" - }, - { - "type": "string", - "name": "twitter_username", - "description": "

The Twitter username of the company.

" - }, - { - "type": "string", - "name": "location", - "description": "

The location.

" - }, - { - "type": "string", - "name": "name", - "description": "

The shorthand name of the company.

" - }, - { - "type": "string", - "name": "description", - "description": "

The description of the company. The maximum size is 160 characters.

" - }, - { - "type": "boolean", - "name": "has_organization_projects", - "description": "

Whether an organization can use organization projects.

" - }, - { - "type": "boolean", - "name": "has_repository_projects", - "description": "

Whether repositories that belong to the organization can use repository projects.

" - }, - { - "type": "string", - "name": "default_repository_permission", - "description": "

Default permission level members have for organization repositories.

", - "enum": [ - "read", - "write", - "admin", - "none" - ], - "default": "read" - }, - { - "type": "boolean", - "name": "members_can_create_repositories", - "description": "

Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

", - "default": true - }, - { - "type": "boolean", - "name": "members_can_create_internal_repositories", - "description": "

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+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

" - }, - { - "type": "boolean", - "name": "members_can_create_private_repositories", - "description": "

Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

" - }, - { - "type": "boolean", - "name": "members_can_create_public_repositories", - "description": "

Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

" - }, - { - "type": "string", - "name": "members_allowed_repository_creation_type", - "description": "

Specifies which types of repositories non-admin organization members can create.\nNote: This parameter is closing down 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" - ] - }, - { - "type": "boolean", - "name": "members_can_create_pages", - "description": "

Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.

", - "default": true - }, - { - "type": "boolean", - "name": "members_can_fork_private_repositories", - "description": "

Whether organization members can fork private organization repositories.

", - "default": false - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.

", - "default": false - }, - { - "type": "string", - "name": "blog", - "description": "" - }, - { - "type": "boolean", - "name": "advanced_security_enabled_for_new_repositories", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" - }, - { - "type": "boolean", - "name": "dependabot_alerts_enabled_for_new_repositories", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" - }, - { - "type": "boolean", - "name": "dependabot_security_updates_enabled_for_new_repositories", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" - }, - { - "type": "boolean", - "name": "dependency_graph_enabled_for_new_repositories", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" - }, - { - "type": "boolean", - "name": "secret_scanning_enabled_for_new_repositories", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" - }, - { - "type": "boolean", - "name": "secret_scanning_push_protection_enabled_for_new_repositories", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" - }, - { - "type": "boolean", - "name": "secret_scanning_push_protection_custom_link_enabled", - "description": "

Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.

" - }, - { - "type": "string", - "name": "secret_scanning_push_protection_custom_link", - "description": "

If secret_scanning_push_protection_custom_link_enabled is true, the URL that will be displayed to contributors who are blocked from pushing a secret.

" - } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: GitHub Enterprise Server 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
\n

Warning

\n

\nClosing down notice: Code security product enablement for new repositories through the organization API is closing down and will be replaced with code security configurations in a future GitHub Enterprise Server version.

\n
\n

Updates the organization's profile and member privileges.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "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" - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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", - "twitter_username": "github", - "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", - "type": "Organization", - "total_private_repos": 100, - "owned_private_repos": 100, - "private_gists": 81, - "disk_usage": 10000, - "collaborators": 8, - "billing_email": "mona@github.com", - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "filled_seats": 4, - "seats": 5 - }, - "default_repository_permission": "read", - "default_repository_branch": "main", - "members_can_create_repositories": true, - "two_factor_requirement_enabled": true, - "members_allowed_repository_creation_type": "all", - "members_can_create_public_repositories": false, - "members_can_create_private_repositories": false, - "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_create_public_pages": true, - "members_can_create_private_pages": true, - "members_can_delete_repositories": true, - "members_can_change_repo_visibility": true, - "members_can_invite_outside_collaborators": true, - "members_can_delete_issues": false, - "display_commenter_full_name_setting_enabled": false, - "readers_can_create_discussions": true, - "members_can_create_teams": true, - "members_can_view_dependency_insights": true, - "members_can_fork_private_repositories": false, - "web_commit_signoff_required": false, - "updated_at": "2014-03-03T18:58:10Z", - "dependency_graph_enabled_for_new_repositories": false, - "dependabot_alerts_enabled_for_new_repositories": false, - "dependabot_security_updates_enabled_for_new_repositories": false, - "advanced_security_enabled_for_new_repositories": false, - "secret_scanning_enabled_for_new_repositories": false, - "secret_scanning_push_protection_enabled_for_new_repositories": false, - "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", - "secret_scanning_push_protection_custom_link_enabled": false - }, - "schema": { - "title": "Organization Full", - "description": "Organization Full", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "company": { - "type": "string" - }, - "blog": { - "type": "string", - "format": "uri" - }, - "location": { - "type": "string" - }, - "email": { - "type": "string", - "format": "email" - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "is_verified": { - "type": "boolean" - }, - "has_organization_projects": { - "type": "boolean" - }, - "has_repository_projects": { - "type": "boolean" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "private_gists": { - "type": [ - "integer", - "null" - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "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", - "null" - ] - }, - "default_repository_branch": { - "type": [ - "string", - "null" - ], - "description": "The default branch for repositories created in this organization." - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ] - }, - "members_allowed_repository_creation_type": { - "type": "string" - }, - "members_can_create_public_repositories": { - "type": "boolean" - }, - "members_can_create_private_repositories": { - "type": "boolean" - }, - "members_can_create_internal_repositories": { - "type": "boolean" - }, - "members_can_create_pages": { - "type": "boolean" - }, - "members_can_create_public_pages": { - "type": "boolean" - }, - "members_can_create_private_pages": { - "type": "boolean" - }, - "members_can_delete_repositories": { - "type": "boolean" - }, - "members_can_change_repo_visibility": { - "type": "boolean" - }, - "members_can_invite_outside_collaborators": { - "type": "boolean" - }, - "members_can_delete_issues": { - "type": "boolean" - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean" - }, - "readers_can_create_discussions": { - "type": "boolean" - }, - "members_can_create_teams": { - "type": "boolean" - }, - "members_can_view_dependency_insights": { - "type": "boolean" - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." - }, - "secret_scanning_push_protection_custom_link": { - "type": [ - "string", - "null" - ], - "description": "An optional URL string to display to contributors who are blocked from pushing a secret." - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "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", - "archived_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}", - "title": "Delete an organization", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes an organization and all its repositories.

\n

The organization login will be unavailable for 90 days after deletion.

\n

Please review the Terms of Service regarding account deletion before using this endpoint:

\n

https://docs.github.com/enterprise-server@3.14/site-policy/github-terms/github-terms-of-service

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Accepted

", - "example": null, - "schema": { - "type": "object" - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/audit-log", - "title": "Get the audit log for an organization", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "phrase", - "description": "

A search phrase. For more information, see Searching the audit log.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "include", - "description": "

The event types to include:

\n
    \n
  • web - returns web (non-Git) events.
    • \n
  • git - returns Git events.
    • \n
  • all - returns both web and Git events.
    • \n
\n

The default is web.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "web", - "git", - "all" - ] - } - }, - { - "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "order", - "description": "

The order of audit log events. To list newest events first, specify desc. To list oldest events first, specify asc.

\n

The default is desc.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "desc", - "asc" - ] - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"

\n

By default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"

\n

Use pagination to retrieve fewer or more than 30 events. For more information, see \"Using pagination in the REST API.\"

\n

The authenticated user must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:audit_log scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "actor_ip": "88.123.45.123", - "from": "pull_requests#merge", - "device_cookie": null, - "actor": "mona-admin", - "actor_id": 7, - "repo": "octo-org/octo-repo", - "repo_id": 17, - "business": "github", - "business_id": 1, - "org": "octo-org", - "org_id": 8, - "action": "pull_request.merge", - "@timestamp": 1635940599755, - "created_at": 1635940599755, - "operation_type": "modify", - "actor_location": { - "country_code": "GB", - "country_name": "United Kingdom", - "region": "ENG", - "region_name": "England", - "city": "Louth", - "postal_code": "LN11", - "location": { - "lat": 53.4457, - "lon": 0.141 - } - }, - "data": { - "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", - "method": "POST", - "request_id": "e4dabc4d-ba16-4bca-1234-649be7ae1188", - "server_id": "5d17aab5-fd9f-abcd-a820-16bed246441b", - "request_category": "other", - "controller_action": "merge", - "url": "https://example.com/octo-org/octo-repo/pull/1/merge", - "client_id": 322299977.1635936, - "referrer": "https://example.com/octo-org/octo-repo/pull/1", - "actor_session": 1, - "pull_request_id": 1, - "category_type": "Resource Management" - } - }, - { - "actor_ip": "88.123.45.123", - "from": "pull_request_review_events#create", - "device_cookie": null, - "actor": "mona-admin", - "actor_id": 7, - "business_id": 1, - "org_id": 8, - "action": "pull_request_review.submit", - "@timestamp": 1635940593079, - "created_at": 1635940593079, - "operation_type": "modify", - "actor_location": { - "country_code": "GB", - "country_name": "United Kingdom", - "region": "ENG", - "region_name": "England", - "city": "Louth", - "postal_code": "LN11", - "location": { - "lat": 53.4457, - "lon": 0.141 - } - }, - "data": { - "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", - "method": "PUT", - "request_id": "c0f63bb7-17b6-4796-940c-12345c5a581b", - "server_id": "2abc1234-f651-43e3-9696-e942ad5f8c89", - "request_category": "other", - "controller_action": "create", - "url": "https://example.com/octo-org/octo-repo/pull/1/reviews", - "client_id": 322299977.1635936, - "referrer": "https://example.com/octo-org/octo-repo/pull/1/files", - "actor_session": 1, - "spammy": false, - "pull_request_id": 1, - "body": null, - "allowed": true, - "id": 1, - "state": 40, - "issue_id": 1, - "review_id": 1, - "category_type": "Resource Management" - } - }, - { - "actor_ip": "88.123.45.123", - "from": "pull_requests#create", - "device_cookie": null, - "actor": "mona", - "actor_id": 9, - "user_id": 9, - "repo": "octo-org/octo-repo", - "repo_id": 17, - "business": "github", - "business_id": 1, - "org": "octo-org", - "org_id": 8, - "action": "pull_request.create", - "@timestamp": 1635940554161, - "created_at": 1635940554161, - "operation_type": "create", - "actor_location": { - "country_code": "GB", - "country_name": "United Kingdom", - "region": "ENG", - "region_name": "England", - "city": "Louth", - "postal_code": "LN11", - "location": { - "lat": 53.4457, - "lon": 0.141 - } - }, - "data": { - "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", - "method": "POST", - "request_id": "2773abeb-477f-4ebf-a017-f8e8a206c305", - "server_id": "796e3115-4ce8-4606-8fd0-99ea57a2e12b", - "request_category": "other", - "controller_action": "create", - "url": "https://example.com/octo-org/octo-repo/pull/create?base=octo-org%3Amain&head=mona%3Apatch-1", - "client_id": 386351111.163594, - "referrer": "https://example.com/octo-org/octo-repo/compare/main...mona:patch-1", - "actor_session": 2, - "pull_request_id": 1, - "category_type": "Resource Management" - } - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "@timestamp": { - "type": "integer", - "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." - }, - "action": { - "type": "string", - "description": "The name of the action that was performed, for example `user.login` or `repo.create`." - }, - "active": { - "type": "boolean" - }, - "active_was": { - "type": "boolean" - }, - "actor": { - "type": "string", - "description": "The actor who performed the action." - }, - "actor_id": { - "type": "integer", - "description": "The id of the actor who performed the action." - }, - "actor_location": { - "type": "object", - "properties": { - "country_name": { - "type": "string" - } - } - }, - "data": { - "type": "object", - "additionalProperties": true - }, - "org_id": { - "type": "integer" - }, - "user_id": { - "type": "integer" - }, - "business_id": { - "type": "integer" - }, - "blocked_user": { - "type": "string", - "description": "The username of the account being blocked." - }, - "business": { - "type": "string" - }, - "config": { - "type": "array", - "items": { - "type": "object" - } - }, - "config_was": { - "type": "array", - "items": { - "type": "object" - } - }, - "content_type": { - "type": "string" - }, - "operation_type": { - "type": "string" - }, - "created_at": { - "type": "integer", - "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." - }, - "deploy_key_fingerprint": { - "type": "string" - }, - "_document_id": { - "type": "string", - "description": "A unique identifier for an audit event." - }, - "emoji": { - "type": "string" - }, - "events": { - "type": "array", - "items": { - "type": "object" - } - }, - "events_were": { - "type": "array", - "items": { - "type": "object" - } - }, - "explanation": { - "type": "string" - }, - "fingerprint": { - "type": "string" - }, - "hook_id": { - "type": "integer" - }, - "limited_availability": { - "type": "boolean" - }, - "message": { - "type": "string" - }, - "name": { - "type": "string" - }, - "old_user": { - "type": "string" - }, - "openssh_public_key": { - "type": "string" - }, - "org": { - "type": "string" - }, - "previous_visibility": { - "type": "string" - }, - "read_only": { - "type": "boolean" - }, - "repo": { - "type": "string", - "description": "The name of the repository." - }, - "repository": { - "type": "string", - "description": "The name of the repository." - }, - "repository_public": { - "type": "boolean" - }, - "target_login": { - "type": "string" - }, - "team": { - "type": "string" - }, - "transport_protocol": { - "type": "integer", - "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." - }, - "transport_protocol_name": { - "type": "string", - "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." - }, - "user": { - "type": "string", - "description": "The user that was affected by the action performed (if available)." - }, - "visibility": { - "type": "string", - "description": "The repository visibility, for example `public` or `private`." - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/installations", - "title": "List app installations for an organization", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:read scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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", - "suspended_at": null, - "suspended_by": null - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "installations" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "installations": { - "type": "array", - "items": { - "title": "Installation", - "description": "Installation", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer" - }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "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" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "app_id": { - "type": "integer" - }, - "client_id": { - "type": "string" - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string" - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_copilot_agent_settings": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - } - }, - "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", - "null" - ] - }, - "has_multiple_single_files": { - "type": "boolean" - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - } - }, - "app_slug": { - "type": "string" - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ] - } - }, - "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", - "suspended_by", - "suspended_at" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/{security_product}/{enablement}", - "title": "Enable or disable a security feature for an organization", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "security_product", - "in": "path", - "description": "

The security feature to enable or disable.

", - "required": true, - "schema": { - "type": "string", - "enum": [ - "dependency_graph", - "dependabot_alerts", - "dependabot_security_updates", - "advanced_security", - "code_scanning_default_setup", - "secret_scanning", - "secret_scanning_push_protection" - ] - } - }, - { - "name": "enablement", - "in": "path", - "description": "

The action to take.

\n

enable_all means to enable the specified security feature for all repositories in the organization.\ndisable_all means to disable the specified security feature for all repositories in the organization.

", - "required": true, - "schema": { - "type": "string", - "enum": [ - "enable_all", - "disable_all" - ] - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "query_suite", - "description": "

CodeQL query suite to be used. If you specify the query_suite parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any query_suite in your request, the preferred query suite of the organization will be applied.

", - "enum": [ - "default", - "extended" - ] - } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org, write:org, or repo scopes to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": null, - "parameters": { - "org": "ORG", - "security_product": "SECURITY_PRODUCT", - "enablement": "ENABLEMENT" - } - }, - "response": { - "statusCode": "204", - "description": "

Action started

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Action started

" - }, - { - "httpStatusCode": "422", - "description": "

The action could not be taken due to an in progress enablement, or a policy is preventing enablement

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/orgs", - "title": "List organizations for the authenticated user", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List organizations for the authenticated user.

\n

For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.

\n

Note

\n

\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/orgs", - "title": "List organizations for a user", - "category": "orgs", - "subcategory": "orgs", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List public organization memberships for the specified user.

\n

This method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - } - ], - "custom-properties": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema", - "title": "Get all custom properties for an organization", - "category": "orgs", - "subcategory": "custom-properties", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets all custom properties defined for an organization.\nOrganization members can read these properties.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ], - "values_editable_by": "org_actors", - "require_explicit_values": true - }, - { - "property_name": "service", - "url": "https://api.github.com/orgs/github/properties/schema/service", - "source_type": "organization", - "value_type": "string" - }, - { - "property_name": "team", - "url": "https://api.github.com/orgs/github/properties/schema/team", - "source_type": "organization", - "value_type": "string", - "description": "Team owning the repository" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property" - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - }, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property" - } - }, - "required": [ - "property_name", - "value_type" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema", - "title": "Create or update custom properties for an organization", - "category": "orgs", - "subcategory": "custom-properties", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of objects", - "name": "properties", - "description": "

The array of custom properties to create or update.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "property_name", - "description": "

The name of the property

", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

The URL that can be used to fetch, update, or delete info about this property via the API.

" - }, - { - "type": "string", - "name": "source_type", - "description": "

The source type of the property

", - "enum": [ - "organization", - "enterprise" - ] - }, - { - "type": "string", - "name": "value_type", - "description": "

The type of the value for the property

", - "isRequired": true, - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ] - }, - { - "type": "boolean", - "name": "required", - "description": "

Whether the property is required.

" - }, - { - "type": "null or string or array", - "name": "default_value", - "description": "

Default value of the property

" - }, - { - "type": "string or null", - "name": "description", - "description": "

Short description of the property

" - }, - { - "type": "array of strings or null", - "name": "allowed_values", - "description": "

An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.

" - }, - { - "type": "string or null", - "name": "values_editable_by", - "description": "

Who can edit the values of the property

", - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ] - } - ] - } - ], - "descriptionHTML": "

Creates new or updates existing custom properties defined for an organization in a batch.

\n

If the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with values_editable_by: org_and_repo_actors and it's updated without specifying values_editable_by, it will be updated to default value org_actors.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permission of custom_properties_org_definitions_manager in the organization.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "properties": [ - { - "property_name": "environment", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ], - "values_editable_by": "org_actors" - }, - { - "property_name": "service", - "value_type": "string" - }, - { - "property_name": "team", - "value_type": "string", - "description": "Team owning the repository" - } - ] - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ], - "values_editable_by": "org_actors", - "require_explicit_values": true - }, - { - "property_name": "service", - "url": "https://api.github.com/orgs/github/properties/schema/service", - "source_type": "organization", - "value_type": "string" - }, - { - "property_name": "team", - "url": "https://api.github.com/orgs/github/properties/schema/team", - "source_type": "organization", - "value_type": "string", - "description": "Team owning the repository" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property" - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - }, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property" - } - }, - "required": [ - "property_name", - "value_type" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "title": "Get a custom property for an organization", - "category": "orgs", - "subcategory": "custom-properties", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "custom_property_name", - "description": "

The custom property name

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a custom property that is defined for an organization.\nOrganization members can read these properties.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "custom_property_name": "CUSTOM_PROPERTY_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ] - }, - "schema": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property" - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - }, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property" - } - }, - "required": [ - "property_name", - "value_type" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "title": "Create or update a custom property for an organization", - "category": "orgs", - "subcategory": "custom-properties", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "custom_property_name", - "description": "

The custom property name

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "value_type", - "description": "

The type of the value for the property

", - "isRequired": true, - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ] - }, - { - "type": "boolean", - "name": "required", - "description": "

Whether the property is required.

" - }, - { - "type": "null or string or array", - "name": "default_value", - "description": "

Default value of the property

" - }, - { - "type": "string or null", - "name": "description", - "description": "

Short description of the property

" - }, - { - "type": "array of strings or null", - "name": "allowed_values", - "description": "

An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.

" - }, - { - "type": "string or null", - "name": "values_editable_by", - "description": "

Who can edit the values of the property

", - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ] - } - ], - "descriptionHTML": "

Creates a new or updates an existing custom property that is defined for an organization.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permission of custom_properties_org_definitions_manager in the organization.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ] - }, - "parameters": { - "org": "ORG", - "custom_property_name": "CUSTOM_PROPERTY_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ] - }, - "schema": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property" - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - }, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property" - } - }, - "required": [ - "property_name", - "value_type" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "title": "Remove a custom property for an organization", - "category": "orgs", - "subcategory": "custom-properties", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "custom_property_name", - "description": "

The custom property name

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes a custom property that is defined for an organization.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permission of custom_properties_org_definitions_manager in the organization.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "custom_property_name": "CUSTOM_PROPERTY_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

A header with no content is returned.

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

A header with no content is returned.

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/properties/values", - "title": "List custom property values for organization repositories", - "category": "orgs", - "subcategory": "custom-properties", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "repository_query", - "description": "

Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching for repositories\" for a detailed list of qualifiers.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "repository_id": 1296269, - "repository_name": "Hello-World", - "repository_full_name": "octocat/Hello-World", - "properties": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "title": "Organization Repository Custom Property Values", - "description": "List of custom property values for a repository", - "type": "object", - "properties": { - "repository_id": { - "type": "integer" - }, - "repository_name": { - "type": "string" - }, - "repository_full_name": { - "type": "string" - }, - "properties": { - "type": "array", - "items": { - "title": "Custom Property Value", - "description": "Custom property name and associated value", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The value assigned to the property", - "type": [ - "null", - "string", - "array" - ] - } - }, - "required": [ - "property_name", - "value" - ] - }, - "description": "List of custom property names and associated values" - } - }, - "required": [ - "repository_id", - "repository_name", - "repository_full_name", - "properties" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/values", - "title": "Create or update custom property values for organization repositories", - "category": "orgs", - "subcategory": "custom-properties", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "repository_names", - "description": "

The names of repositories that the custom property values will be applied to.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "properties", - "description": "

List of custom property names and associated values to apply to the repositories.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "property_name", - "description": "

The name of the property

", - "isRequired": true - }, - { - "type": "null or string or array", - "name": "value", - "description": "

The value assigned to the property

", - "isRequired": true - } - ] - } - ], - "descriptionHTML": "

Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.

\n

A maximum of 30 repositories can be updated in a single request.

\n

Using a value of null for a custom property will remove or 'unset' the property value from the repository.

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • A user, or a user on a team, with the fine-grained permission of custom_properties_org_values_editor in the organization.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "repository_names": [ - "Hello-World", - "octo-repo" - ], - "properties": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "204", - "description": "

No Content when custom property values are successfully created or updated

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content when custom property values are successfully created or updated

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "write" - } - ] - } - } - ], - "custom-roles": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/organizations/{organization_id}/custom_roles", - "title": "Closing down - List custom repository roles in an organization", - "category": "orgs", - "subcategory": "custom-roles", - "parameters": [ - { - "name": "organization_id", - "description": "

The unique identifier of the organization.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.

\n
\n

List the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "organization_id": "ORGANIZATION_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response - list of custom role names

", - "example": { - "id": 8030, - "name": "Security Engineer", - "description": "Able to contribute code and maintain the security pipeline", - "base_role": "maintain", - "permissions": [ - "delete_alerts_code_scanning" - ], - "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" - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" - }, - "schema": { - "type": "object", - "properties": { - "total_count": { - "description": "The number of custom roles in this organization", - "type": "integer" - }, - "custom_roles": { - "type": "array", - "items": { - "title": "Organization Custom Repository Role", - "description": "Custom repository roles created by organization owners", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the custom role.", - "type": "integer" - }, - "name": { - "description": "The name of the custom role.", - "type": "string" - }, - "description": { - "description": "A short description about who this role is for or what permissions it grants.", - "type": [ - "string", - "null" - ] - }, - "base_role": { - "type": "string", - "description": "The system role from which this role inherits permissions.", - "enum": [ - "read", - "triage", - "write", - "maintain" - ] - }, - "permissions": { - "description": "A list of additional permissions included in this role.", - "type": "array", - "items": { - "type": "string" - } - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "base_role", - "permissions", - "organization", - "created_at", - "updated_at" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Response - list of custom role names

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom repository roles\" organization permissions": "read" - }, - { - "\"Administration\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/custom-repository-roles", - "title": "List custom repository roles in an organization", - "category": "orgs", - "subcategory": "custom-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response - list of custom role names

", - "example": { - "total_count": 2, - "custom_roles": [ - { - "id": 8030, - "name": "Security Engineer", - "description": "Able to contribute code and maintain the security pipeline", - "base_role": "maintain", - "permissions": [ - "delete_alerts_code_scanning" - ], - "organization": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/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/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 - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" - }, - { - "id": 8031, - "name": "Community manager", - "description": "Able to handle all the community interactions without being able to contribute code", - "base_role": "read", - "permissions": [ - "mark_as_duplicate", - "manage_settings_pages", - "manage_settings_wiki", - "set_social_preview", - "edit_repo_metadata", - "toggle_discussion_comment_minimize" - ], - "organization": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/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/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 - }, - "created_at": "2022-07-05T12:01:11Z", - "updated_at": "2022-07-05T12:20:11Z" - } - ] - }, - "schema": { - "type": "object", - "properties": { - "total_count": { - "description": "The number of custom roles in this organization", - "type": "integer" - }, - "custom_roles": { - "type": "array", - "items": { - "title": "Organization Custom Repository Role", - "description": "Custom repository roles created by organization owners", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the custom role.", - "type": "integer" - }, - "name": { - "description": "The name of the custom role.", - "type": "string" - }, - "description": { - "description": "A short description about who this role is for or what permissions it grants.", - "type": [ - "string", - "null" - ] - }, - "base_role": { - "type": "string", - "description": "The system role from which this role inherits permissions.", - "enum": [ - "read", - "triage", - "write", - "maintain" - ] - }, - "permissions": { - "description": "A list of additional permissions included in this role.", - "type": "array", - "items": { - "type": "string" - } - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "base_role", - "permissions", - "organization", - "created_at", - "updated_at" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Response - list of custom role names

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom repository roles\" organization permissions": "read" - }, - { - "\"Administration\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/custom-repository-roles", - "title": "Create a custom repository role", - "category": "orgs", - "subcategory": "custom-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the custom role.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

A short description about who this role is for or what permissions it grants.

" - }, - { - "type": "string", - "name": "base_role", - "description": "

The system role from which this role inherits permissions.

", - "isRequired": true, - "enum": [ - "read", - "triage", - "write", - "maintain" - ] - }, - { - "type": "array of strings", - "name": "permissions", - "description": "

A list of additional permissions included in this role.

", - "isRequired": true - } - ], - "descriptionHTML": "

Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Labeler", - "description": "A role for issue and pull request labelers", - "base_role": "read", - "permissions": [ - "add_label" - ] - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 8030, - "name": "Security Engineer", - "description": "Able to contribute code and maintain the security pipeline", - "base_role": "maintain", - "permissions": [ - "delete_alerts_code_scanning" - ], - "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" - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" - }, - "schema": { - "title": "Organization Custom Repository Role", - "description": "Custom repository roles created by organization owners", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the custom role.", - "type": "integer" - }, - "name": { - "description": "The name of the custom role.", - "type": "string" - }, - "description": { - "description": "A short description about who this role is for or what permissions it grants.", - "type": [ - "string", - "null" - ] - }, - "base_role": { - "type": "string", - "description": "The system role from which this role inherits permissions.", - "enum": [ - "read", - "triage", - "write", - "maintain" - ] - }, - "permissions": { - "description": "A list of additional permissions included in this role.", - "type": "array", - "items": { - "type": "string" - } - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "base_role", - "permissions", - "organization", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom repository roles\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}", - "title": "Get a custom repository role", - "category": "orgs", - "subcategory": "custom-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "

The unique identifier of the role.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "role_id": "ROLE_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 8030, - "name": "Security Engineer", - "description": "Able to contribute code and maintain the security pipeline", - "base_role": "maintain", - "permissions": [ - "delete_alerts_code_scanning" - ], - "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" - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" - }, - "schema": { - "title": "Organization Custom Repository Role", - "description": "Custom repository roles created by organization owners", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the custom role.", - "type": "integer" - }, - "name": { - "description": "The name of the custom role.", - "type": "string" - }, - "description": { - "description": "A short description about who this role is for or what permissions it grants.", - "type": [ - "string", - "null" - ] - }, - "base_role": { - "type": "string", - "description": "The system role from which this role inherits permissions.", - "enum": [ - "read", - "triage", - "write", - "maintain" - ] - }, - "permissions": { - "description": "A list of additional permissions included in this role.", - "type": "array", - "items": { - "type": "string" - } - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "base_role", - "permissions", - "organization", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom repository roles\" organization permissions": "read" - }, - { - "\"Administration\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}", - "title": "Update a custom repository role", - "category": "orgs", - "subcategory": "custom-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "

The unique identifier of the role.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the custom role.

" - }, - { - "type": "string or null", - "name": "description", - "description": "

A short description about who this role is for or what permissions it grants.

" - }, - { - "type": "string", - "name": "base_role", - "description": "

The system role from which this role inherits permissions.

", - "enum": [ - "read", - "triage", - "write", - "maintain" - ] - }, - { - "type": "array of strings", - "name": "permissions", - "description": "

A list of additional permissions included in this role.

" - } - ], - "descriptionHTML": "

Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Labeler", - "description": "A role for issue and PR labelers", - "base_role": "read", - "permissions": [ - "add_label", - "remove_label" - ] - }, - "parameters": { - "org": "ORG", - "role_id": "ROLE_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 8030, - "name": "Security Engineer", - "description": "Able to contribute code and maintain the security pipeline", - "base_role": "maintain", - "permissions": [ - "delete_alerts_code_scanning" - ], - "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" - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" - }, - "schema": { - "title": "Organization Custom Repository Role", - "description": "Custom repository roles created by organization owners", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the custom role.", - "type": "integer" - }, - "name": { - "description": "The name of the custom role.", - "type": "string" - }, - "description": { - "description": "A short description about who this role is for or what permissions it grants.", - "type": [ - "string", - "null" - ] - }, - "base_role": { - "type": "string", - "description": "The system role from which this role inherits permissions.", - "enum": [ - "read", - "triage", - "write", - "maintain" - ] - }, - "permissions": { - "description": "A list of additional permissions included in this role.", - "type": "array", - "items": { - "type": "string" - } - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "base_role", - "permissions", - "organization", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom repository roles\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/custom-repository-roles/{role_id}", - "title": "Delete a custom repository role", - "category": "orgs", - "subcategory": "custom-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "

The unique identifier of the role.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "role_id": "ROLE_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom repository roles\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/repository-fine-grained-permissions", - "title": "List repository fine-grained permissions for an organization", - "category": "orgs", - "subcategory": "custom-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "name": "add_assignee", - "description": "Assign or remove a user" - }, - { - "name": "remove_assignee", - "description": "Remove an assigned user" - }, - { - "name": "add_label", - "description": "Add or remove a label" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Repository Fine-Grained Permission", - "description": "A fine-grained permission that protects repository resources.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - } - }, - "required": [ - "name", - "description" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom repository roles\" organization permissions": "read" - }, - { - "\"Administration\" organization permissions": "read" - } - ] - } - } - ], - "members": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/members", - "title": "List organization members", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. 2fa_insecure means that only members with insecure 2FA methods will be returned. These options are only available for organization owners.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "2fa_disabled", - "2fa_insecure", - "all" - ], - "default": "all" - } - }, - { - "name": "role", - "description": "

Filter members returned by their role.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "admin", - "member" - ], - "default": "all" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "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.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/members/{username}", - "title": "Check organization membership for a user", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Check if a user is, publicly or privately, a member of the organization.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response if requester is an organization member and user is a member

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Response if requester is an organization member and user is a member

" - }, - { - "httpStatusCode": "302", - "description": "

Response if requester is not an organization member

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found if requester is an organization member and user is not a member

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/members/{username}", - "title": "Remove an organization member", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "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.

\n

Note

\n

\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/memberships/{username}", - "title": "Get organization membership for a user", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response if user has an active admin membership with organization

", - "example": { - "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 - } - }, - "schema": { - "title": "Org Membership", - "description": "Org Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "state": { - "type": "string", - "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", - "enum": [ - "active", - "pending" - ] - }, - "role": { - "type": "string", - "description": "The user's membership type in the organization.", - "enum": [ - "admin", - "member", - "billing_manager" - ] - }, - "direct_membership": { - "type": "boolean", - "description": "Whether the user has direct membership in the organization." - }, - "enterprise_teams_providing_indirect_membership": { - "type": "array", - "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", - "maxItems": 100, - "items": { - "type": "string" - } - }, - "organization_url": { - "type": "string", - "format": "uri" - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "can_create_repository": { - "type": "boolean" - } - }, - "required": [ - "can_create_repository" - ] - } - }, - "required": [ - "state", - "role", - "organization_url", - "url", - "organization", - "user" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/memberships/{username}", - "title": "Set organization membership for a user", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "role", - "description": "

The role to give the user in the organization. Can be one of:

\n
    \n
  • admin - The user will become an owner of the organization.
    • \n
  • member - The user will become a non-owner member of the organization.
    • \n
", - "enum": [ - "admin", - "member" - ], - "default": "member" - } - ], - "descriptionHTML": "

Only authenticated organization owners can add a member to the organization or update the member's role. 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. 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. The same rate limits as set on the appliance are applied to this endpoint. Most commonly, you will hit the secondary rate limit (if configured) due to CPU usage.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Set an organization membership role for a user", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "role": "member" - }, - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response if user has an active admin membership with organization

", - "example": { - "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 - } - }, - "schema": { - "title": "Org Membership", - "description": "Org Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "state": { - "type": "string", - "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", - "enum": [ - "active", - "pending" - ] - }, - "role": { - "type": "string", - "description": "The user's membership type in the organization.", - "enum": [ - "admin", - "member", - "billing_manager" - ] - }, - "direct_membership": { - "type": "boolean", - "description": "Whether the user has direct membership in the organization." - }, - "enterprise_teams_providing_indirect_membership": { - "type": "array", - "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", - "maxItems": 100, - "items": { - "type": "string" - } - }, - "organization_url": { - "type": "string", - "format": "uri" - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "can_create_repository": { - "type": "boolean" - } - }, - "required": [ - "can_create_repository" - ] - } - }, - "required": [ - "state", - "role", - "organization_url", - "url", - "organization", - "user" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/memberships/{username}", - "title": "Remove organization membership for a user", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "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.

\n

Note

\n

\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/public_members", - "title": "List public organization members", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Members of an organization can choose to have their membership publicized or not.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/public_members/{username}", - "title": "Check public organization membership for a user", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Check if the provided user is a public member of the organization.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response if user is a public member

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Response if user is a public member

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found if user is not a public member

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/public_members/{username}", - "title": "Set public organization membership for the authenticated user", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "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 method.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/public_members/{username}", - "title": "Remove public organization membership for the authenticated user", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/memberships/orgs", - "title": "List organization memberships for the authenticated user", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "state", - "description": "

Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all of the authenticated user's organization memberships.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - }, - { - "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 - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Org Membership", - "description": "Org Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "state": { - "type": "string", - "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", - "enum": [ - "active", - "pending" - ] - }, - "role": { - "type": "string", - "description": "The user's membership type in the organization.", - "enum": [ - "admin", - "member", - "billing_manager" - ] - }, - "direct_membership": { - "type": "boolean", - "description": "Whether the user has direct membership in the organization." - }, - "enterprise_teams_providing_indirect_membership": { - "type": "array", - "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", - "maxItems": 100, - "items": { - "type": "string" - } - }, - "organization_url": { - "type": "string", - "format": "uri" - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "can_create_repository": { - "type": "boolean" - } - }, - "required": [ - "can_create_repository" - ] - } - }, - "required": [ - "state", - "role", - "organization_url", - "url", - "organization", - "user" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/memberships/orgs/{org}", - "title": "Get an organization membership for the authenticated user", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a 404 is returned. This endpoint will return a 403 if the request is made by a GitHub App that is blocked by the organization.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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 - } - }, - "schema": { - "title": "Org Membership", - "description": "Org Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "state": { - "type": "string", - "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", - "enum": [ - "active", - "pending" - ] - }, - "role": { - "type": "string", - "description": "The user's membership type in the organization.", - "enum": [ - "admin", - "member", - "billing_manager" - ] - }, - "direct_membership": { - "type": "boolean", - "description": "Whether the user has direct membership in the organization." - }, - "enterprise_teams_providing_indirect_membership": { - "type": "array", - "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", - "maxItems": 100, - "items": { - "type": "string" - } - }, - "organization_url": { - "type": "string", - "format": "uri" - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "can_create_repository": { - "type": "boolean" - } - }, - "required": [ - "can_create_repository" - ] - } - }, - "required": [ - "state", - "role", - "organization_url", - "url", - "organization", - "user" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/user/memberships/orgs/{org}", - "title": "Update an organization membership for the authenticated user", - "category": "orgs", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "state", - "description": "

The state that the membership should be in. Only \"active\" will be accepted.

", - "isRequired": true, - "enum": [ - "active" - ] - } - ], - "descriptionHTML": "

Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "state": "active" - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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 - } - }, - "schema": { - "title": "Org Membership", - "description": "Org Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "state": { - "type": "string", - "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", - "enum": [ - "active", - "pending" - ] - }, - "role": { - "type": "string", - "description": "The user's membership type in the organization.", - "enum": [ - "admin", - "member", - "billing_manager" - ] - }, - "direct_membership": { - "type": "boolean", - "description": "Whether the user has direct membership in the organization." - }, - "enterprise_teams_providing_indirect_membership": { - "type": "array", - "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", - "maxItems": 100, - "items": { - "type": "string" - } - }, - "organization_url": { - "type": "string", - "format": "uri" - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "can_create_repository": { - "type": "boolean" - } - }, - "required": [ - "can_create_repository" - ] - } - }, - "required": [ - "state", - "role", - "organization_url", - "url", - "organization", - "user" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - } - ], - "organization-roles": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/organization-fine-grained-permissions", - "title": "List organization fine-grained permissions for an organization", - "category": "orgs", - "subcategory": "organization-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "name": "read_organization_custom_org_role", - "description": "View organization roles" - }, - { - "name": "write_organization_custom_org_role", - "description": "Manage custom organization roles" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Organization Fine-Grained Permission", - "description": "A fine-grained permission that protects organization resources.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - } - }, - "required": [ - "name", - "description" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom organization roles\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles", - "title": "Get all organization roles for an organization", - "category": "orgs", - "subcategory": "organization-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response - list of organization roles

", - "example": { - "total_count": 2, - "roles": [ - { - "id": 8030, - "name": "Custom Role Manager", - "description": "Permissions to manage custom roles within an org", - "permissions": [ - "write_organization_custom_repo_role", - "write_organization_custom_org_role", - "read_organization_custom_repo_role", - "read_organization_custom_org_role" - ], - "organization": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/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/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 - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" - }, - { - "id": 8031, - "name": "Auditor", - "description": "Permissions to read the organization audit log", - "permissions": [ - "read_audit_logs" - ], - "organization": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/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/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 - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" - } - ] - }, - "schema": { - "type": "object", - "properties": { - "total_count": { - "type": "integer", - "description": "The total number of organization roles available to the organization." - }, - "roles": { - "type": "array", - "description": "The list of organization roles available to the organization.", - "items": { - "title": "Organization Role", - "description": "Organization roles", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the role.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the role.", - "type": "string" - }, - "description": { - "description": "A short description about who this role is for or what permissions it grants.", - "type": [ - "string", - "null" - ] - }, - "base_role": { - "type": [ - "string", - "null" - ], - "description": "The system role from which this role inherits permissions.", - "enum": [ - "read", - "triage", - "write", - "maintain", - "admin", - null - ] - }, - "source": { - "type": [ - "string", - "null" - ], - "description": "Source answers the question, \"where did this role come from?\"", - "enum": [ - "Organization", - "Enterprise", - "Predefined", - null - ] - }, - "permissions": { - "description": "A list of permissions included in this role.", - "type": "array", - "items": { - "type": "string" - } - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "description": "The date and time the role was created.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time the role was last updated.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "permissions", - "organization", - "created_at", - "updated_at" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Response - list of organization roles

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom organization roles\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/organization-roles", - "title": "Create a custom organization role", - "category": "orgs", - "subcategory": "organization-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the custom role.

", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

A short description about the intended usage of this role or what permissions it grants.

" - }, - { - "type": "array of strings", - "name": "permissions", - "description": "

A list of additional permissions included in this role.

", - "isRequired": true - } - ], - "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Custom Role Manager", - "description": "Permissions to manage custom roles within an org", - "permissions": [ - "write_organization_custom_repo_role", - "write_organization_custom_org_role", - "read_organization_custom_repo_role", - "read_organization_custom_org_role" - ] - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 8030, - "name": "Custom Role Manager", - "description": "Permissions to manage custom roles within an org", - "permissions": [ - "write_organization_custom_repo_role", - "write_organization_custom_org_role", - "read_organization_custom_repo_role", - "read_organization_custom_org_role" - ], - "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" - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:19:11Z" - }, - "schema": { - "title": "Organization Role", - "description": "Organization roles", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the role.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the role.", - "type": "string" - }, - "description": { - "description": "A short description about who this role is for or what permissions it grants.", - "type": [ - "string", - "null" - ] - }, - "base_role": { - "type": [ - "string", - "null" - ], - "description": "The system role from which this role inherits permissions.", - "enum": [ - "read", - "triage", - "write", - "maintain", - "admin", - null - ] - }, - "source": { - "type": [ - "string", - "null" - ], - "description": "Source answers the question, \"where did this role come from?\"", - "enum": [ - "Organization", - "Enterprise", - "Predefined", - null - ] - }, - "permissions": { - "description": "A list of permissions included in this role.", - "type": "array", - "items": { - "type": "string" - } - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "description": "The date and time the role was created.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time the role was last updated.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "permissions", - "organization", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom organization roles\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/teams/{team_slug}", - "title": "Remove all organization roles for a team", - "category": "orgs", - "subcategory": "organization-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes all assigned organization roles from a team. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}", - "title": "Assign an organization role to a team", - "category": "orgs", - "subcategory": "organization-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "

The unique identifier of the role.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Assigns an organization role to a team in an organization. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG", - "role_id": "ROLE_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Response if the organization, team or role does not exist.

" - }, - { - "httpStatusCode": "422", - "description": "

Response if the organization roles feature is not enabled for the organization, or validation failed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}", - "title": "Remove an organization role from a team", - "category": "orgs", - "subcategory": "organization-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "

The unique identifier of the role.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes an organization role from a team. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG", - "role_id": "ROLE_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/users/{username}", - "title": "Remove all organization roles for a user", - "category": "orgs", - "subcategory": "organization-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Revokes all assigned organization roles from a user. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/organization-roles/users/{username}/{role_id}", - "title": "Assign an organization role to a user", - "category": "orgs", - "subcategory": "organization-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "

The unique identifier of the role.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Assigns an organization role to a member of an organization. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME", - "role_id": "ROLE_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Response if the organization, user or role does not exist.

" - }, - { - "httpStatusCode": "422", - "description": "

Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/users/{username}/{role_id}", - "title": "Remove an organization role from a user", - "category": "orgs", - "subcategory": "organization-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "

The unique identifier of the role.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Remove an organization role from a user. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME", - "role_id": "ROLE_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles/{role_id}", - "title": "Get an organization role", - "category": "orgs", - "subcategory": "organization-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "

The unique identifier of the role.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "role_id": "ROLE_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 8030, - "name": "Custom Role Manager", - "description": "Permissions to manage custom roles within an org", - "permissions": [ - "write_organization_custom_repo_role", - "write_organization_custom_org_role", - "read_organization_custom_repo_role", - "read_organization_custom_org_role" - ], - "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" - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" - }, - "schema": { - "title": "Organization Role", - "description": "Organization roles", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the role.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the role.", - "type": "string" - }, - "description": { - "description": "A short description about who this role is for or what permissions it grants.", - "type": [ - "string", - "null" - ] - }, - "base_role": { - "type": [ - "string", - "null" - ], - "description": "The system role from which this role inherits permissions.", - "enum": [ - "read", - "triage", - "write", - "maintain", - "admin", - null - ] - }, - "source": { - "type": [ - "string", - "null" - ], - "description": "Source answers the question, \"where did this role come from?\"", - "enum": [ - "Organization", - "Enterprise", - "Predefined", - null - ] - }, - "permissions": { - "description": "A list of permissions included in this role.", - "type": "array", - "items": { - "type": "string" - } - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "description": "The date and time the role was created.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time the role was last updated.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "permissions", - "organization", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom organization roles\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/orgs/{org}/organization-roles/{role_id}", - "title": "Update a custom organization role", - "category": "orgs", - "subcategory": "organization-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "

The unique identifier of the role.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the custom role.

" - }, - { - "type": "string", - "name": "description", - "description": "

A short description about the intended use of this role or the permissions it grants.

" - }, - { - "type": "array of strings", - "name": "permissions", - "description": "

A list of additional permissions included in this role.

" - } - ], - "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "description": "Permissions to manage custom roles within an org." - }, - "parameters": { - "org": "ORG", - "role_id": "ROLE_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 8030, - "name": "Custom Role Manager", - "description": "Permissions to manage custom roles within an org", - "permissions": [ - "write_organization_custom_repo_role", - "write_organization_custom_org_role", - "read_organization_custom_repo_role", - "read_organization_custom_org_role" - ], - "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" - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:19:11Z" - }, - "schema": { - "title": "Organization Role", - "description": "Organization roles", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the role.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the role.", - "type": "string" - }, - "description": { - "description": "A short description about who this role is for or what permissions it grants.", - "type": [ - "string", - "null" - ] - }, - "base_role": { - "type": [ - "string", - "null" - ], - "description": "The system role from which this role inherits permissions.", - "enum": [ - "read", - "triage", - "write", - "maintain", - "admin", - null - ] - }, - "source": { - "type": [ - "string", - "null" - ], - "description": "Source answers the question, \"where did this role come from?\"", - "enum": [ - "Organization", - "Enterprise", - "Predefined", - null - ] - }, - "permissions": { - "description": "A list of permissions included in this role.", - "type": "array", - "items": { - "type": "string" - } - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "description": "The date and time the role was created.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time the role was last updated.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "permissions", - "organization", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom organization roles\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/organization-roles/{role_id}", - "title": "Delete a custom organization role.", - "category": "orgs", - "subcategory": "organization-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "

The unique identifier of the role.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n
    \n
  • An administrator for the organization.
    • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
    • \n
\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "role_id": "ROLE_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom organization roles\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles/{role_id}/teams", - "title": "List teams that are assigned to an organization role", - "category": "orgs", - "subcategory": "organization-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "

The unique identifier of the role.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the teams that are assigned to an organization role. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, you must be an administrator for the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "role_id": "ROLE_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response - List of assigned teams

", - "example": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "schema": { - "type": "array", - "description": "List of teams assigned to the organization role", - "items": { - "title": "A Role Assignment for a Team", - "description": "The Relationship a Team has with a role.", - "type": "object", - "properties": { - "assignment": { - "type": "string", - "description": "Determines if the team has a direct, indirect, or mixed relationship to a role", - "enum": [ - "direct", - "indirect", - "mixed" - ] - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "parent" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Response - List of assigned teams

" - }, - { - "httpStatusCode": "404", - "description": "

Response if the organization or role does not exist.

" - }, - { - "httpStatusCode": "422", - "description": "

Response if the organization roles feature is not enabled or validation failed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/organization-roles/{role_id}/users", - "title": "List users that are assigned to an organization role", - "category": "orgs", - "subcategory": "organization-roles", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "

The unique identifier of the role.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists organization members that are assigned to an organization role. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, you must be an administrator for the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "role_id": "ROLE_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response - List of assigned users

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "description": "List of users assigned to the organization role", - "items": { - "title": "A Role Assignment for a User", - "description": "The Relationship a User has with a role.", - "type": "object", - "properties": { - "assignment": { - "type": "string", - "description": "Determines if the user has a direct, indirect, or mixed relationship to a role", - "enum": [ - "direct", - "indirect", - "mixed" - ] - }, - "inherited_from": { - "description": "Team the user has gotten the role through", - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Response - List of assigned users

" - }, - { - "httpStatusCode": "404", - "description": "

Response if the organization or role does not exist.

" - }, - { - "httpStatusCode": "422", - "description": "

Response if the organization roles feature is not enabled or validation failed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - } - ], - "outside-collaborators": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/outside_collaborators", - "title": "List outside collaborators for an organization", - "category": "orgs", - "subcategory": "outside-collaborators", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned. 2fa_insecure means that only outside collaborators with insecure 2FA methods will be returned.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "2fa_disabled", - "2fa_insecure", - "all" - ], - "default": "all" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List all users who are outside collaborators of an organization.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "title": "Convert an organization member to outside collaborator", - "category": "orgs", - "subcategory": "outside-collaborators", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "async", - "description": "

When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

", - "default": false - } - ], - "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\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Status code 202, asynchronous request", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "async": true - }, - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

User is getting converted asynchronously

", - "example": null, - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Status code 204, synchronous request", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": null, - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

User was converted

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

User is getting converted asynchronously

" - }, - { - "httpStatusCode": "204", - "description": "

User was converted

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"Enforcing repository management policies in your enterprise.\"

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/outside_collaborators/{username}", - "title": "Remove outside collaborator from an organization", - "category": "orgs", - "subcategory": "outside-collaborators", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removing a user from this list will remove them from all the organization's repositories.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "422", - "description": "

Unprocessable Entity if user is a member of the organization

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - } - ], - "personal-access-tokens": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/personal-access-token-requests", - "title": "List requests to access organization resources with fine-grained personal access tokens", - "category": "orgs", - "subcategory": "personal-access-tokens", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "sort", - "description": "

The property by which to sort the results.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created_at" - ], - "default": "created_at" - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "owner", - "description": "

A list of owner usernames to use to filter the results.

", - "in": "query", - "required": false, - "schema": { - "type": "array", - "maxItems": 10, - "items": { - "type": "string" - }, - "examples": [ - "owner[]=octocat1,owner[]=octocat2" - ] - } - }, - { - "name": "repository", - "description": "

The name of the repository to use to filter the results.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "Hello-World" - ] - } - }, - { - "name": "permission", - "description": "

The permission to use to filter the results.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "issues_read" - ] - } - }, - { - "name": "last_used_before", - "description": "

Only show fine-grained personal access tokens used before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "last_used_after", - "description": "

Only show fine-grained personal access tokens used after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "token_id", - "description": "

The ID of the token

", - "in": "query", - "required": false, - "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "examples": [ - "token_id[]=1,token_id[]=2" - ] - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists requests from organization members to access organization resources with a fine-grained personal access token.

\n

Only GitHub Apps can use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 25381, - "reason": "I need to access the GitHub API", - "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 - }, - "repository_selection": "all", - "repositories_url": "https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories", - "permissions": { - "organization": { - "members": "read" - }, - "repository": { - "metadata": "read" - } - }, - "created_at": "2023-05-16T08:47:09.000-07:00", - "token_id": 98716, - "token_name": "Some Token", - "token_expired": false, - "token_expires_at": "2023-11-16T08:47:09.000-07:00", - "token_last_used_at": null - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple Organization Programmatic Access Grant Request", - "description": "Minimal representation of an organization programmatic access grant request for enumerations", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests." - }, - "reason": { - "type": [ - "string", - "null" - ], - "description": "Reason for requesting access." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "repository_selection": { - "type": "string", - "enum": [ - "none", - "all", - "subset" - ], - "description": "Type of repository selection requested." - }, - "repositories_url": { - "type": "string", - "description": "URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`." - }, - "permissions": { - "type": "object", - "description": "Permissions requested, categorized by type of permission.", - "properties": { - "organization": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "repository": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "other": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "created_at": { - "type": "string", - "description": "Date and time when the request for access was created." - }, - "token_id": { - "type": "integer", - "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." - }, - "token_name": { - "type": "string", - "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." - }, - "token_expired": { - "type": "boolean", - "description": "Whether the associated fine-grained personal access token has expired." - }, - "token_expires_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token expires." - }, - "token_last_used_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token was last used for authentication." - } - }, - "required": [ - "id", - "reason", - "owner", - "repository_selection", - "repositories_url", - "permissions", - "created_at", - "token_id", - "token_name", - "token_expired", - "token_expires_at", - "token_last_used_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Personal access token requests\" organization permissions": "read" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/personal-access-token-requests", - "title": "Review requests to access organization resources with fine-grained personal access tokens", - "category": "orgs", - "subcategory": "personal-access-tokens", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of integers", - "name": "pat_request_ids", - "description": "

Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 pat_request_id values.

" - }, - { - "type": "string", - "name": "action", - "description": "

Action to apply to the requests.

", - "isRequired": true, - "enum": [ - "approve", - "deny" - ] - }, - { - "type": "string or null", - "name": "reason", - "description": "

Reason for approving or denying the requests. Max 1024 characters.

" - } - ], - "descriptionHTML": "

Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token.

\n

Only GitHub Apps can use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example of denying a request", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "pat_request_ids": [ - 42, - 73 - ], - "action": "deny", - "reason": "Access is too broad." - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Accepted

", - "example": null, - "schema": { - "type": "object" - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Personal access token requests\" organization permissions": "write" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/personal-access-token-requests/{pat_request_id}", - "title": "Review a request to access organization resources with a fine-grained personal access token", - "category": "orgs", - "subcategory": "personal-access-tokens", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pat_request_id", - "in": "path", - "description": "

Unique identifier of the request for access via fine-grained personal access token.

", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "

Action to apply to the request.

", - "isRequired": true, - "enum": [ - "approve", - "deny" - ] - }, - { - "type": "string or null", - "name": "reason", - "description": "

Reason for approving or denying the request. Max 1024 characters.

" - } - ], - "descriptionHTML": "

Approves or denies a pending request to access organization resources via a fine-grained personal access token.

\n

Only GitHub Apps can use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example of denying a request", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "action": "deny", - "reason": "This request is denied because the access is too broad." - }, - "parameters": { - "org": "ORG", - "pat_request_id": "PAT_REQUEST_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

A header with no content is returned.

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

A header with no content is returned.

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Personal access token requests\" organization permissions": "write" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories", - "title": "List repositories requested to be accessed by a fine-grained personal access token", - "category": "orgs", - "subcategory": "personal-access-tokens", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pat_request_id", - "in": "path", - "description": "

Unique identifier of the request for access via fine-grained personal access token.

", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the repositories a fine-grained personal access token request is requesting access to.

\n

Only GitHub Apps can use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "pat_request_id": "PAT_REQUEST_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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, - "has_discussions": false, - "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 - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Personal access token requests\" organization permissions": "read" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/personal-access-tokens", - "title": "List fine-grained personal access tokens with access to organization resources", - "category": "orgs", - "subcategory": "personal-access-tokens", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "sort", - "description": "

The property by which to sort the results.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created_at" - ], - "default": "created_at" - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "owner", - "description": "

A list of owner usernames to use to filter the results.

", - "in": "query", - "required": false, - "schema": { - "type": "array", - "maxItems": 10, - "items": { - "type": "string" - }, - "examples": [ - "owner[]=octocat1,owner[]=octocat2" - ] - } - }, - { - "name": "repository", - "description": "

The name of the repository to use to filter the results.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "Hello-World" - ] - } - }, - { - "name": "permission", - "description": "

The permission to use to filter the results.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "issues_read" - ] - } - }, - { - "name": "last_used_before", - "description": "

Only show fine-grained personal access tokens used before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "last_used_after", - "description": "

Only show fine-grained personal access tokens used after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "token_id", - "description": "

The ID of the token

", - "in": "query", - "required": false, - "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "examples": [ - "token_id[]=1,token_id[]=2" - ] - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists approved fine-grained personal access tokens owned by organization members that can access organization resources.

\n

Only GitHub Apps can use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 25381, - "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 - }, - "repository_selection": "all", - "repositories_url": "https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories", - "permissions": { - "organization": { - "members": "read" - }, - "repository": { - "metadata": "read" - } - }, - "access_granted_at": "2023-05-16T08:47:09.000-07:00", - "token_id": 98716, - "token_name": "Some Token", - "token_expired": false, - "token_expires_at": "2023-11-16T08:47:09.000-07:00", - "token_last_used_at": null - } - ], - "schema": { - "type": "array", - "items": { - "title": "Organization Programmatic Access Grant", - "description": "Minimal representation of an organization programmatic access grant for enumerations", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "repository_selection": { - "type": "string", - "enum": [ - "none", - "all", - "subset" - ], - "description": "Type of repository selection requested." - }, - "repositories_url": { - "type": "string", - "description": "URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`." - }, - "permissions": { - "type": "object", - "description": "Permissions requested, categorized by type of permission.", - "properties": { - "organization": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "repository": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "other": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "access_granted_at": { - "type": "string", - "description": "Date and time when the fine-grained personal access token was approved to access the organization." - }, - "token_id": { - "type": "integer", - "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." - }, - "token_name": { - "type": "string", - "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." - }, - "token_expired": { - "type": "boolean", - "description": "Whether the associated fine-grained personal access token has expired." - }, - "token_expires_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token expires." - }, - "token_last_used_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token was last used for authentication." - } - }, - "required": [ - "id", - "owner", - "repository_selection", - "repositories_url", - "permissions", - "access_granted_at", - "token_id", - "token_name", - "token_expired", - "token_expires_at", - "token_last_used_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Personal access tokens\" organization permissions": "read" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/personal-access-tokens", - "title": "Update the access to organization resources via fine-grained personal access tokens", - "category": "orgs", - "subcategory": "personal-access-tokens", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "

Action to apply to the fine-grained personal access token.

", - "isRequired": true, - "enum": [ - "revoke" - ] - }, - { - "type": "array of integers", - "name": "pat_ids", - "description": "

The IDs of the fine-grained personal access tokens.

", - "isRequired": true - } - ], - "descriptionHTML": "

Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.

\n

Only GitHub Apps can use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example of revoking a fine-grained personal access token.", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "action": "revoke", - "pat_ids": [ - 1296269, - 1296280 - ] - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Accepted

", - "example": null, - "schema": { - "type": "object" - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Personal access tokens\" organization permissions": "write" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}", - "title": "Update the access a fine-grained personal access token has to organization resources", - "category": "orgs", - "subcategory": "personal-access-tokens", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pat_id", - "description": "

The unique identifier of the fine-grained personal access token.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "

Action to apply to the fine-grained personal access token.

", - "isRequired": true, - "enum": [ - "revoke" - ] - } - ], - "descriptionHTML": "

Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.

\n

Only GitHub Apps can use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example of revoking a fine-grained personal access token.", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "action": "revoke" - }, - "parameters": { - "org": "ORG", - "pat_id": "PAT_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

A header with no content is returned.

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

A header with no content is returned.

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Personal access tokens\" organization permissions": "write" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories", - "title": "List repositories a fine-grained personal access token has access to", - "category": "orgs", - "subcategory": "personal-access-tokens", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pat_id", - "in": "path", - "description": "

Unique identifier of the fine-grained personal access token.

", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the repositories a fine-grained personal access token has access to.

\n

Only GitHub Apps can use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "pat_id": "PAT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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, - "has_discussions": false, - "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 - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [ - { - "\"Personal access tokens\" organization permissions": "read" - } - ], - "disabledForPatV2": true - } - } - ], - "rule-suites": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets/rule-suites", - "title": "List organization rule suites", - "category": "orgs", - "subcategory": "rule-suites", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "description": "

The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned.

", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "repository_name", - "description": "

The name of the repository to filter on.

", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "time_period", - "description": "

The time period to filter by.

\n

For example, day will filter for rule suites that occurred in the past 24 hours, and week will filter for rule suites that occurred in the past 7 days (168 hours).

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "hour", - "day", - "week", - "month" - ], - "default": "day" - } - }, - { - "name": "actor_name", - "description": "

The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.

", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "rule_suite_result", - "description": "

The rule suite results to filter on. When specified, only suites with this result will be returned.

", - "in": "query", - "schema": { - "type": "string", - "enum": [ - "pass", - "fail", - "bypass", - "all" - ], - "default": "all" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists suites of rule evaluations at the organization level.\nFor more information, see \"Managing rulesets for repositories in your organization.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 21, - "actor_id": 12, - "actor_name": "octocat", - "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", - "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", - "ref": "refs/heads/i-see-everything", - "repository_id": 404, - "repository_name": "octo-repo", - "pushed_at": "2023-07-06T08:43:03Z", - "result": "bypass" - }, - { - "id": 25, - "actor_id": 11, - "actor_name": "not-octocat", - "before_sha": "48994e4e01ccc943624c6231f172702b82b233cc", - "after_sha": "ecfd5a1025fa271a33ca5608d089476a2df3c9a1", - "ref": "refs/heads/i-am-everything", - "repository_id": 404, - "repository_name": "octo-repo", - "pushed_at": "2023-07-07T08:43:03Z", - "result": "pass", - "evaluation_result": "fail" - } - ], - "schema": { - "title": "Rule Suites", - "description": "Response", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the rule insight." - }, - "actor_id": { - "type": "integer", - "description": "The number that identifies the user." - }, - "actor_name": { - "type": "string", - "description": "The handle for the GitHub user account." - }, - "before_sha": { - "type": "string", - "description": "The first commit sha before the push evaluation." - }, - "after_sha": { - "type": "string", - "description": "The last commit sha in the push evaluation." - }, - "ref": { - "type": "string", - "description": "The ref name that the evaluation ran on." - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository associated with the rule evaluation." - }, - "repository_name": { - "type": "string", - "description": "The name of the repository without the `.git` extension." - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "result": { - "type": "string", - "enum": [ - "pass", - "fail", - "bypass" - ], - "description": "The result of the rule evaluations for rules with the `active` enforcement status." - }, - "evaluation_result": { - "type": "string", - "enum": [ - "pass", - "fail" - ], - "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`." - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}", - "title": "Get an organization rule suite", - "category": "orgs", - "subcategory": "rule-suites", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "rule_suite_id", - "description": "

The unique identifier of the rule suite result.\nTo get this ID, you can use GET /repos/{owner}/{repo}/rulesets/rule-suites\nfor repositories and GET /orgs/{org}/rulesets/rule-suites\nfor organizations.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"Managing rulesets for repositories in your organization.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "rule_suite_id": "RULE_SUITE_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 21, - "actor_id": 12, - "actor_name": "octocat", - "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", - "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", - "ref": "refs/heads/i-see-everything", - "repository_id": 404, - "repository_name": "octo-repo", - "pushed_at": "2023-07-06T08:43:03Z", - "result": "bypass", - "evaluation_result": "fail", - "rule_evaluations": [ - { - "rule_source": { - "type": "ruleset", - "id": 2, - "name": "Author email must be a GitHub email address" - }, - "enforcement": "active", - "result": "pass", - "rule_type": "commit_author_email_pattern" - }, - { - "rule_source": { - "type": "protected_branch" - }, - "enforcement": "active", - "result": "fail", - "rule_type": "pull_request", - "details": "Changes must be made through a pull request." - }, - { - "rule_source": { - "type": "ruleset", - "id": 3, - "name": "Evaluate commit message pattern" - }, - "enforcement": "evaluate", - "result": "fail", - "rule_type": "commit_message_pattern" - } - ] - }, - "schema": { - "title": "Rule Suite", - "description": "Response", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the rule insight." - }, - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The number that identifies the user." - }, - "actor_name": { - "type": [ - "string", - "null" - ], - "description": "The handle for the GitHub user account." - }, - "before_sha": { - "type": "string", - "description": "The previous commit SHA of the ref." - }, - "after_sha": { - "type": "string", - "description": "The new commit SHA of the ref." - }, - "ref": { - "type": "string", - "description": "The ref name that the evaluation ran on." - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository associated with the rule evaluation." - }, - "repository_name": { - "type": "string", - "description": "The name of the repository without the `.git` extension." - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "result": { - "type": "string", - "enum": [ - "pass", - "fail", - "bypass" - ], - "description": "The result of the rule evaluations for rules with the `active` enforcement status." - }, - "evaluation_result": { - "type": [ - "string", - "null" - ], - "enum": [ - "pass", - "fail" - ], - "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run." - }, - "rule_evaluations": { - "type": "array", - "description": "Details on the evaluated rules.", - "items": { - "type": "object", - "properties": { - "rule_source": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of rule source." - }, - "id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the rule source." - }, - "name": { - "type": [ - "string", - "null" - ], - "description": "The name of the rule source." - } - } - }, - "enforcement": { - "type": "string", - "enum": [ - "active", - "evaluate", - "deleted ruleset" - ], - "description": "The enforcement level of this rule source." - }, - "result": { - "type": "string", - "enum": [ - "pass", - "fail" - ], - "description": "The result of the evaluation of the individual rule." - }, - "rule_type": { - "type": "string", - "description": "The type of rule." - }, - "details": { - "type": [ - "string", - "null" - ], - "description": "The detailed failure message for the rule. Null if the rule passed." - } - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - } - } - ], - "rules": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets", - "title": "Get all organization repository rulesets", - "category": "orgs", - "subcategory": "rules", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "targets", - "description": "

A comma-separated list of rule targets to filter by.\nIf provided, only rulesets that apply to the specified targets will be returned.\nFor example, branch,tag,push.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "branch,tag,push" - ] - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Get all the repository rulesets for an organization.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 21, - "name": "super cool ruleset", - "source_type": "Organization", - "source": "my-org", - "enforcement": "enabled", - "node_id": "RRS_lACkVXNlcgQB", - "_links": { - "self": { - "href": "https://api.github.com/orgs/my-org/rulesets/21" - }, - "html": { - "href": "https://github.com/organizations/my-org/settings/rules/21" - } - }, - "created_at": "2023-07-15T08:43:03Z", - "updated_at": "2023-08-23T16:29:47Z" - }, - { - "id": 432, - "name": "Another ruleset", - "source_type": "Organization", - "source": "my-org", - "enforcement": "enabled", - "node_id": "RRS_lACkVXNlcgQQ", - "_links": { - "self": { - "href": "https://api.github.com/orgs/my-org/rulesets/432" - }, - "html": { - "href": "https://github.com/organizations/my-org/settings/rules/432" - } - }, - "created_at": "2023-08-15T08:43:03Z", - "updated_at": "2023-09-23T16:29:47Z" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" - }, - "name": { - "type": "string", - "description": "The name of the ruleset" - }, - "target": { - "type": "string", - "description": "The target of the ruleset.", - "enum": [ - "branch", - "tag", - "push" - ] - }, - "source_type": { - "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization" - ] - }, - "source": { - "type": "string", - "description": "The name of the source" - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset" - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } - }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" - ] - }, - "node_id": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": [ - "object", - "null" - ], - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "anyOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } - ] - } - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "rules": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." - }, - "type": { - "type": "string", - "description": "The type of the reviewer", - "enum": [ - "Team" - ] - } - }, - "required": [ - "id", - "type" - ] - } - }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - } - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/rulesets", - "title": "Create an organization repository ruleset", - "category": "orgs", - "subcategory": "rules", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the ruleset.

", - "isRequired": true - }, - { - "type": "string", - "name": "target", - "description": "

The target of the ruleset.

", - "enum": [ - "branch", - "tag", - "push" - ], - "default": "branch" - }, - { - "type": "string", - "name": "enforcement", - "description": "

The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. evaluate is not available for the repository target.

", - "isRequired": true, - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - { - "type": "array of objects", - "name": "bypass_actors", - "description": "

The actors that can bypass the rules in this ruleset

", - "childParamsGroups": [ - { - "type": "integer or null", - "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. OrganizationAdmin is not applicable for personal repositories.

" - }, - { - "type": "string", - "name": "actor_type", - "description": "

The type of actor that can bypass a ruleset

", - "isRequired": true, - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ] - }, - { - "type": "string", - "name": "bypass_mode", - "description": "

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type. Also, pull_request is only applicable to branch rulesets.

", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - ] - }, - { - "type": "object", - "name": "conditions", - "description": "

Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both repository_name and ref_name properties, or both repository_id and ref_name properties, or both repository_property and ref_name properties.\nThe push rulesets conditions object does not require the ref_name property.

", - "childParamsGroups": [ - { - "type": "object", - "name": "repository_name_and_ref_name", - "description": "

Conditions to target repositories by name and refs by name

", - "childParamsGroups": [ - { - "type": "object", - "name": "ref_name", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "include", - "description": "

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

" - }, - { - "type": "array of strings", - "name": "exclude", - "description": "

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

" - } - ] - }, - { - "type": "object", - "name": "repository_name", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of strings", - "name": "include", - "description": "

Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.

" - }, - { - "type": "array of strings", - "name": "exclude", - "description": "

Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

" - }, - { - "type": "boolean", - "name": "protected", - "description": "

Whether renaming of target repositories is prevented.

" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository_id_and_ref_name", - "description": "

Conditions to target repositories by id and refs by name

", - "childParamsGroups": [ - { - "type": "object", - "name": "ref_name", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "include", - "description": "

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

" - }, - { - "type": "array of strings", - "name": "exclude", - "description": "

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

" - } - ] - }, - { - "type": "object", - "name": "repository_id", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of integers", - "name": "repository_ids", - "description": "

The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository_property_and_ref_name", - "description": "

Conditions to target repositories by property and refs by name

", - "childParamsGroups": [ - { - "type": "object", - "name": "ref_name", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "include", - "description": "

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

" - }, - { - "type": "array of strings", - "name": "exclude", - "description": "

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

" - } - ] - }, - { - "type": "object", - "name": "repository_property", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of objects", - "name": "include", - "description": "

The repository properties and values to include. All of these properties must match for the condition to pass.

", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the repository property to target

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "property_values", - "description": "

The values to match for the repository property

", - "isRequired": true - }, - { - "type": "string", - "name": "source", - "description": "

The source of the repository property. Defaults to 'custom' if not specified.

", - "enum": [ - "custom", - "system" - ] - } - ] - }, - { - "type": "array of objects", - "name": "exclude", - "description": "

The repository properties and values to exclude. The condition will not pass if any of these properties match.

", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the repository property to target

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "property_values", - "description": "

The values to match for the repository property

", - "isRequired": true - }, - { - "type": "string", - "name": "source", - "description": "

The source of the repository property. Defaults to 'custom' if not specified.

", - "enum": [ - "custom", - "system" - ] - } - ] - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "array of objects", - "name": "rules", - "description": "

An array of rules within the ruleset.

", - "childParamsGroups": [ - { - "type": "object", - "name": "creation", - "description": "

Only allow users with bypass permission to create matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "creation" - ] - } - ] - }, - { - "type": "object", - "name": "update", - "description": "

Only allow users with bypass permission to update matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "update" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "update_allows_fetch_and_merge", - "description": "

Branch can pull changes from its upstream repository

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "deletion", - "description": "

Only allow users with bypass permissions to delete matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "deletion" - ] - } - ] - }, - { - "type": "object", - "name": "required_linear_history", - "description": "

Prevent merge commits from being pushed to matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_linear_history" - ] - } - ] - }, - { - "type": "object", - "name": "required_deployments", - "description": "

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_deployments" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "required_deployment_environments", - "description": "

The environments that must be successfully deployed to before branches can be merged.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "required_signatures", - "description": "

Commits pushed to matching refs must have verified signatures.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_signatures" - ] - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "pull_request" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "dismiss_stale_reviews_on_push", - "description": "

New, reviewable commits pushed will dismiss previous pull request review approvals.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_code_owner_review", - "description": "

Require an approving review in pull requests that modify files that have a designated code owner.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_last_push_approval", - "description": "

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

", - "isRequired": true - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

The number of approving reviews that are required before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "required_review_thread_resolution", - "description": "

All conversations on code must be resolved before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "required_reviewers", - "description": "

Note

\n

\nrequired_reviewers is in beta and subject to change.

\n
\n

A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "file_patterns", - "description": "

Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.

", - "isRequired": true - }, - { - "type": "integer", - "name": "minimum_approvals", - "description": "

Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.

", - "isRequired": true - }, - { - "type": "object", - "name": "reviewer", - "description": "

A required reviewing team

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

ID of the reviewer which must review changes to matching files.

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The type of the reviewer

", - "isRequired": true, - "enum": [ - "Team" - ] - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "required_status_checks", - "description": "

Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_status_checks" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "required_status_checks", - "description": "

Status checks that are required.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The status check context name that must be present on the commit.

", - "isRequired": true - }, - { - "type": "integer", - "name": "integration_id", - "description": "

The optional integration ID that this status check must originate from.

" - } - ] - }, - { - "type": "boolean", - "name": "strict_required_status_checks_policy", - "description": "

Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "non_fast_forward", - "description": "

Prevent users with push access from force pushing to refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "non_fast_forward" - ] - } - ] - }, - { - "type": "object", - "name": "commit_message_pattern", - "description": "

Parameters to be used for the commit_message_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_message_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "commit_author_email_pattern", - "description": "

Parameters to be used for the commit_author_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_author_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "committer_email_pattern", - "description": "

Parameters to be used for the committer_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "committer_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "branch_name_pattern", - "description": "

Parameters to be used for the branch_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "branch_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "tag_name_pattern", - "description": "

Parameters to be used for the tag_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "tag_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "workflows", - "description": "

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "workflows" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "workflows", - "description": "

Workflows that must pass for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "

The path to the workflow file

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The ref (branch or tag) of the workflow file to use

" - }, - { - "type": "integer", - "name": "repository_id", - "description": "

The ID of the repository where the workflow is defined

", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "

The commit SHA of the workflow file to use

" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "code_scanning", - "description": "

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "code_scanning" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of objects", - "name": "code_scanning_tools", - "description": "

Tools that must provide code scanning results for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - { - "type": "string", - "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - { - "type": "string", - "name": "tool", - "description": "

The name of a code scanning tool

", - "isRequired": true - } - ] - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "source_type", - "description": "

The type of the source of the ruleset

", - "enum": [ - "Repository", - "Organization" - ] - } - ], - "descriptionHTML": "

Create a repository ruleset for an organization.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "super cool ruleset", - "target": "branch", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ] - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ], - "node_id": "RRS_lACkVXNlcgQB", - "_links": { - "self": { - "href": "https://api.github.com/orgs/my-org/rulesets/21" - }, - "html": { - "href": "https://github.com/organizations/my-org/settings/rules/21" - } - }, - "created_at": "2023-08-15T08:43:03Z", - "updated_at": "2023-09-23T16:29:47Z" - }, - "schema": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" - }, - "name": { - "type": "string", - "description": "The name of the ruleset" - }, - "target": { - "type": "string", - "description": "The target of the ruleset.", - "enum": [ - "branch", - "tag", - "push" - ] - }, - "source_type": { - "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization" - ] - }, - "source": { - "type": "string", - "description": "The name of the source" - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset" - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } - }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" - ] - }, - "node_id": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": [ - "object", - "null" - ], - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "anyOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } - ] - } - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "rules": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." - }, - "type": { - "type": "string", - "description": "The type of the reviewer", - "enum": [ - "Team" - ] - } - }, - "required": [ - "id", - "type" - ] - } - }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - } - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/rulesets/{ruleset_id}", - "title": "Get an organization repository ruleset", - "category": "orgs", - "subcategory": "rules", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ruleset_id", - "description": "

The ID of the ruleset.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Get a repository ruleset for an organization.

\n

Note: To prevent leaking sensitive information, the bypass_actors property is only returned if the user\nmaking the API request has write access to the ruleset.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "ruleset_id": "RULESET_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ], - "node_id": "RRS_lACkVXNlcgQB", - "_links": { - "self": { - "href": "https://api.github.com/orgs/my-org/rulesets/21" - }, - "html": { - "href": "https://github.com/organizations/my-org/settings/rules/21" - } - }, - "created_at": "2023-08-15T08:43:03Z", - "updated_at": "2023-09-23T16:29:47Z" - }, - "schema": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" - }, - "name": { - "type": "string", - "description": "The name of the ruleset" - }, - "target": { - "type": "string", - "description": "The target of the ruleset.", - "enum": [ - "branch", - "tag", - "push" - ] - }, - "source_type": { - "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization" - ] - }, - "source": { - "type": "string", - "description": "The name of the source" - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset" - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } - }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" - ] - }, - "node_id": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": [ - "object", - "null" - ], - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "anyOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } - ] - } - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "rules": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." - }, - "type": { - "type": "string", - "description": "The type of the reviewer", - "enum": [ - "Team" - ] - } - }, - "required": [ - "id", - "type" - ] - } - }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - } - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/rulesets/{ruleset_id}", - "title": "Update an organization repository ruleset", - "category": "orgs", - "subcategory": "rules", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ruleset_id", - "description": "

The ID of the ruleset.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the ruleset.

" - }, - { - "type": "string", - "name": "target", - "description": "

The target of the ruleset.

", - "enum": [ - "branch", - "tag", - "push" - ] - }, - { - "type": "string", - "name": "enforcement", - "description": "

The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. evaluate is not available for the repository target.

", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - { - "type": "array of objects", - "name": "bypass_actors", - "description": "

The actors that can bypass the rules in this ruleset

", - "childParamsGroups": [ - { - "type": "integer or null", - "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. OrganizationAdmin is not applicable for personal repositories.

" - }, - { - "type": "string", - "name": "actor_type", - "description": "

The type of actor that can bypass a ruleset

", - "isRequired": true, - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ] - }, - { - "type": "string", - "name": "bypass_mode", - "description": "

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type. Also, pull_request is only applicable to branch rulesets.

", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - ] - }, - { - "type": "object", - "name": "conditions", - "description": "

Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both repository_name and ref_name properties, or both repository_id and ref_name properties, or both repository_property and ref_name properties.\nThe push rulesets conditions object does not require the ref_name property.

", - "childParamsGroups": [ - { - "type": "object", - "name": "repository_name_and_ref_name", - "description": "

Conditions to target repositories by name and refs by name

", - "childParamsGroups": [ - { - "type": "object", - "name": "ref_name", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "include", - "description": "

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

" - }, - { - "type": "array of strings", - "name": "exclude", - "description": "

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

" - } - ] - }, - { - "type": "object", - "name": "repository_name", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of strings", - "name": "include", - "description": "

Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.

" - }, - { - "type": "array of strings", - "name": "exclude", - "description": "

Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

" - }, - { - "type": "boolean", - "name": "protected", - "description": "

Whether renaming of target repositories is prevented.

" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository_id_and_ref_name", - "description": "

Conditions to target repositories by id and refs by name

", - "childParamsGroups": [ - { - "type": "object", - "name": "ref_name", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "include", - "description": "

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

" - }, - { - "type": "array of strings", - "name": "exclude", - "description": "

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

" - } - ] - }, - { - "type": "object", - "name": "repository_id", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of integers", - "name": "repository_ids", - "description": "

The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository_property_and_ref_name", - "description": "

Conditions to target repositories by property and refs by name

", - "childParamsGroups": [ - { - "type": "object", - "name": "ref_name", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "include", - "description": "

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

" - }, - { - "type": "array of strings", - "name": "exclude", - "description": "

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

" - } - ] - }, - { - "type": "object", - "name": "repository_property", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of objects", - "name": "include", - "description": "

The repository properties and values to include. All of these properties must match for the condition to pass.

", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the repository property to target

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "property_values", - "description": "

The values to match for the repository property

", - "isRequired": true - }, - { - "type": "string", - "name": "source", - "description": "

The source of the repository property. Defaults to 'custom' if not specified.

", - "enum": [ - "custom", - "system" - ] - } - ] - }, - { - "type": "array of objects", - "name": "exclude", - "description": "

The repository properties and values to exclude. The condition will not pass if any of these properties match.

", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the repository property to target

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "property_values", - "description": "

The values to match for the repository property

", - "isRequired": true - }, - { - "type": "string", - "name": "source", - "description": "

The source of the repository property. Defaults to 'custom' if not specified.

", - "enum": [ - "custom", - "system" - ] - } - ] - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "array of objects", - "name": "rules", - "description": "

An array of rules within the ruleset.

", - "childParamsGroups": [ - { - "type": "object", - "name": "creation", - "description": "

Only allow users with bypass permission to create matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "creation" - ] - } - ] - }, - { - "type": "object", - "name": "update", - "description": "

Only allow users with bypass permission to update matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "update" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "update_allows_fetch_and_merge", - "description": "

Branch can pull changes from its upstream repository

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "deletion", - "description": "

Only allow users with bypass permissions to delete matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "deletion" - ] - } - ] - }, - { - "type": "object", - "name": "required_linear_history", - "description": "

Prevent merge commits from being pushed to matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_linear_history" - ] - } - ] - }, - { - "type": "object", - "name": "required_deployments", - "description": "

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_deployments" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "required_deployment_environments", - "description": "

The environments that must be successfully deployed to before branches can be merged.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "required_signatures", - "description": "

Commits pushed to matching refs must have verified signatures.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_signatures" - ] - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "pull_request" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "dismiss_stale_reviews_on_push", - "description": "

New, reviewable commits pushed will dismiss previous pull request review approvals.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_code_owner_review", - "description": "

Require an approving review in pull requests that modify files that have a designated code owner.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_last_push_approval", - "description": "

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

", - "isRequired": true - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

The number of approving reviews that are required before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "required_review_thread_resolution", - "description": "

All conversations on code must be resolved before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "required_reviewers", - "description": "

Note

\n

\nrequired_reviewers is in beta and subject to change.

\n
\n

A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "file_patterns", - "description": "

Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.

", - "isRequired": true - }, - { - "type": "integer", - "name": "minimum_approvals", - "description": "

Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.

", - "isRequired": true - }, - { - "type": "object", - "name": "reviewer", - "description": "

A required reviewing team

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

ID of the reviewer which must review changes to matching files.

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The type of the reviewer

", - "isRequired": true, - "enum": [ - "Team" - ] - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "required_status_checks", - "description": "

Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_status_checks" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "required_status_checks", - "description": "

Status checks that are required.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The status check context name that must be present on the commit.

", - "isRequired": true - }, - { - "type": "integer", - "name": "integration_id", - "description": "

The optional integration ID that this status check must originate from.

" - } - ] - }, - { - "type": "boolean", - "name": "strict_required_status_checks_policy", - "description": "

Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "non_fast_forward", - "description": "

Prevent users with push access from force pushing to refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "non_fast_forward" - ] - } - ] - }, - { - "type": "object", - "name": "commit_message_pattern", - "description": "

Parameters to be used for the commit_message_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_message_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "commit_author_email_pattern", - "description": "

Parameters to be used for the commit_author_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_author_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "committer_email_pattern", - "description": "

Parameters to be used for the committer_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "committer_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "branch_name_pattern", - "description": "

Parameters to be used for the branch_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "branch_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "tag_name_pattern", - "description": "

Parameters to be used for the tag_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "tag_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "workflows", - "description": "

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "workflows" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "workflows", - "description": "

Workflows that must pass for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "

The path to the workflow file

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The ref (branch or tag) of the workflow file to use

" - }, - { - "type": "integer", - "name": "repository_id", - "description": "

The ID of the repository where the workflow is defined

", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "

The commit SHA of the workflow file to use

" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "code_scanning", - "description": "

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "code_scanning" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of objects", - "name": "code_scanning_tools", - "description": "

Tools that must provide code scanning results for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - { - "type": "string", - "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - { - "type": "string", - "name": "tool", - "description": "

The name of a code scanning tool

", - "isRequired": true - } - ] - } - ] - } - ] - } - ], - "oneOfObject": true - } - ], - "descriptionHTML": "

Update a ruleset for an organization.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "super cool ruleset", - "target": "branch", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ] - }, - "parameters": { - "org": "ORG", - "ruleset_id": "RULESET_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ], - "node_id": "RRS_lACkVXNlcgQB", - "_links": { - "self": { - "href": "https://api.github.com/orgs/my-org/rulesets/21" - }, - "html": { - "href": "https://github.com/organizations/my-org/settings/rules/21" - } - }, - "created_at": "2023-08-15T08:43:03Z", - "updated_at": "2023-09-23T16:29:47Z" - }, - "schema": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" - }, - "name": { - "type": "string", - "description": "The name of the ruleset" - }, - "target": { - "type": "string", - "description": "The target of the ruleset.", - "enum": [ - "branch", - "tag", - "push" - ] - }, - "source_type": { - "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization" - ] - }, - "source": { - "type": "string", - "description": "The name of the source" - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset" - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } - }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" - ] - }, - "node_id": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": [ - "object", - "null" - ], - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "anyOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } - ] - } - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "rules": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." - }, - "type": { - "type": "string", - "description": "The type of the reviewer", - "enum": [ - "Team" - ] - } - }, - "required": [ - "id", - "type" - ] - } - }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - } - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/rulesets/{ruleset_id}", - "title": "Delete an organization repository ruleset", - "category": "orgs", - "subcategory": "rules", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ruleset_id", - "description": "

The ID of the ruleset.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Delete a ruleset for an organization.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "ruleset_id": "RULESET_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - } - } - ], - "security-managers": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/security-managers", - "title": "List security manager teams", - "category": "orgs", - "subcategory": "security-managers", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists teams that are security managers for an organization. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/organizations/1/team/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/organizations/1/team/1/members{/member}", - "repositories_url": "https://api.github.com/organizations/1/team/1/repos", - "type": "organization", - "organization_id": 1 - } - ], - "schema": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/security-managers/teams/{team_slug}", - "title": "Add a security manager team", - "category": "orgs", - "subcategory": "security-managers", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Adds a team as a security manager for an organization. For more information, see \"Managing security for an organization for an organization.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/security-managers/teams/{team_slug}", - "title": "Remove a security manager team", - "category": "orgs", - "subcategory": "security-managers", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes the security manager role from a team for an organization. For more information, see \"Managing security managers in your organization team from an organization.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" organization permissions": "write" - } - ] - } - } - ], - "webhooks": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/hooks", - "title": "List organization webhooks", - "category": "orgs", - "subcategory": "webhooks", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List webhooks for an organization.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", - "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" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Org Hook", - "description": "Org Hook", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "ping_url": { - "type": "string", - "format": "uri" - }, - "deliveries_url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean" - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "insecure_ssl": { - "type": "string" - }, - "content_type": { - "type": "string" - }, - "secret": { - "type": "string" - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/hooks", - "title": "Create an organization webhook", - "category": "orgs", - "subcategory": "webhooks", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

Must be passed as \"web\".

", - "isRequired": true - }, - { - "type": "object", - "name": "config", - "description": "

Key/value pairs to provide settings for this webhook.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL to which the payloads will be delivered.

", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

" - }, - { - "type": "string", - "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" - }, - { - "type": "string or number", - "name": "insecure_ssl", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - }, - { - "type": "string", - "name": "username", - "description": "" - }, - { - "type": "string", - "name": "password", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "

Determines what events the hook is triggered for. Set to [\"*\"] to receive all possible events.

", - "default": [ - "push" - ] - }, - { - "type": "boolean", - "name": "active", - "description": "

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

", - "default": true - } - ], - "descriptionHTML": "

Create a hook that posts payloads in JSON format.

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or\nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "url": "http://example.com/webhook", - "content_type": "json" - } - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", - "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" - }, - "schema": { - "title": "Org Hook", - "description": "Org Hook", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "ping_url": { - "type": "string", - "format": "uri" - }, - "deliveries_url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean" - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "insecure_ssl": { - "type": "string" - }, - "content_type": { - "type": "string" - }, - "secret": { - "type": "string" - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}", - "title": "Get an organization webhook", - "category": "orgs", - "subcategory": "webhooks", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns a webhook configured in an organization. To get only the webhook\nconfig properties, see \"Get a webhook configuration for an organization.

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", - "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" - }, - "schema": { - "title": "Org Hook", - "description": "Org Hook", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "ping_url": { - "type": "string", - "format": "uri" - }, - "deliveries_url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean" - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "insecure_ssl": { - "type": "string" - }, - "content_type": { - "type": "string" - }, - "secret": { - "type": "string" - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/orgs/{org}/hooks/{hook_id}", - "title": "Update an organization webhook", - "category": "orgs", - "subcategory": "webhooks", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "object", - "name": "config", - "description": "

Key/value pairs to provide settings for this webhook.

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL to which the payloads will be delivered.

", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

" - }, - { - "type": "string", - "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" - }, - { - "type": "string or number", - "name": "insecure_ssl", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "

Determines what events the hook is triggered for.

", - "default": [ - "push" - ] - }, - { - "type": "boolean", - "name": "active", - "description": "

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

", - "default": true - }, - { - "type": "string", - "name": "name", - "description": "" - } - ], - "descriptionHTML": "

Updates a webhook configured in an organization. When you update a webhook,\nthe secret will be overwritten. If you previously had a secret set, you must\nprovide the same secret or set a new secret or the secret will be removed. If\nyou are only updating individual webhook config properties, use \"Update a webhook\nconfiguration for an organization\".

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "active": true, - "events": [ - "pull_request" - ] - }, - "parameters": { - "org": "ORG", - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", - "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" - }, - "schema": { - "title": "Org Hook", - "description": "Org Hook", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "ping_url": { - "type": "string", - "format": "uri" - }, - "deliveries_url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean" - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "insecure_ssl": { - "type": "string" - }, - "content_type": { - "type": "string" - }, - "secret": { - "type": "string" - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/hooks/{hook_id}", - "title": "Delete an organization webhook", - "category": "orgs", - "subcategory": "webhooks", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Delete a webhook for an organization.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/config", - "title": "Get a webhook configuration for an organization", - "category": "orgs", - "subcategory": "webhooks", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" - }, - "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.", - "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`." - }, - "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/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers)." - }, - "insecure_ssl": { - "oneOf": [ - { - "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.**" - }, - { - "type": "number" - } - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/orgs/{org}/hooks/{hook_id}/config", - "title": "Update a webhook configuration for an organization", - "category": "orgs", - "subcategory": "webhooks", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "url", - "description": "

The URL to which the payloads will be delivered.

" - }, - { - "type": "string", - "name": "content_type", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

" - }, - { - "type": "string", - "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" - }, - { - "type": "string or number", - "name": "insecure_ssl", - "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.

" - } - ], - "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

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Update an existing webhook", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "url": "http://example.com/webhook", - "content_type": "json", - "insecure_ssl": "0", - "secret": "********" - }, - "parameters": { - "org": "ORG", - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" - }, - "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.", - "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`." - }, - "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/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers)." - }, - "insecure_ssl": { - "oneOf": [ - { - "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.**" - }, - { - "type": "number" - } - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries", - "title": "List deliveries for an organization webhook", - "category": "orgs", - "subcategory": "webhooks", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "cursor", - "description": "

Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the link header for the next and previous page cursors.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "status", - "description": "

Returns webhook deliveries filtered by delivery outcome classification based on status_code range. A status of success returns deliveries with a status_code in the 200-399 range (inclusive). A status of failure returns deliveries with a status_code in the 400-599 range (inclusive).

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "success", - "failure" - ] - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns a list of webhook deliveries for a webhook configured in an organization.

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 12345678, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "delivered_at": "2019-06-03T00:57:16Z", - "redelivery": false, - "duration": 0.27, - "status": "OK", - "status_code": 200, - "event": "issues", - "action": "opened", - "installation_id": 123, - "repository_id": 456, - "throttled_at": "2019-06-03T00:57:16Z" - }, - { - "id": 123456789, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "delivered_at": "2019-06-04T00:57:16Z", - "redelivery": true, - "duration": 0.28, - "status": "OK", - "status_code": 200, - "event": "issues", - "action": "opened", - "installation_id": 123, - "repository_id": 456, - "throttled_at": null - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple webhook delivery", - "description": "Delivery made by a webhook, without request and response information.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the webhook delivery.", - "type": "integer", - "format": "int64" - }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", - "type": "string" - }, - "delivered_at": { - "description": "Time when the webhook delivery occurred.", - "type": "string", - "format": "date-time" - }, - "redelivery": { - "description": "Whether the webhook delivery is a redelivery.", - "type": "boolean" - }, - "duration": { - "description": "Time spent delivering.", - "type": "number" - }, - "status": { - "description": "Describes the response returned after attempting the delivery.", - "type": "string" - }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer" - }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string" - }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", - "type": [ - "string", - "null" - ] - }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": [ - "integer", - "null" - ], - "format": "int64" - }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": [ - "integer", - "null" - ], - "format": "int64" - }, - "throttled_at": { - "description": "Time when the webhook delivery was throttled.", - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "guid", - "delivered_at", - "redelivery", - "duration", - "status", - "status_code", - "event", - "action", - "installation_id", - "repository_id" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}", - "title": "Get a webhook delivery for an organization webhook", - "category": "orgs", - "subcategory": "webhooks", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "delivery_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns a delivery for a webhook configured in an organization.

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "hook_id": "HOOK_ID", - "delivery_id": "DELIVERY_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 12345678, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "delivered_at": "2019-06-03T00:57:16Z", - "redelivery": false, - "duration": 0.27, - "status": "OK", - "status_code": 200, - "event": "issues", - "action": "opened", - "installation_id": 123, - "repository_id": 456, - "url": "https://www.example.com", - "throttled_at": "2019-06-03T00:57:16Z", - "request": { - "headers": { - "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "Accept": "*/*", - "X-GitHub-Hook-ID": "42", - "User-Agent": "GitHub-Hookshot/b8c71d8", - "X-GitHub-Event": "issues", - "X-GitHub-Hook-Installation-Target-ID": "123", - "X-GitHub-Hook-Installation-Target-Type": "repository", - "content-type": "application/json", - "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" - }, - "payload": { - "action": "opened", - "issue": { - "body": "foo" - }, - "repository": { - "id": 123 - } - } - }, - "response": { - "headers": { - "Content-Type": "text/html;charset=utf-8" - }, - "payload": "ok" - } - }, - "schema": { - "title": "Webhook delivery", - "description": "Delivery made by a webhook.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the delivery.", - "type": "integer" - }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", - "type": "string" - }, - "delivered_at": { - "description": "Time when the delivery was delivered.", - "type": "string", - "format": "date-time" - }, - "redelivery": { - "description": "Whether the delivery is a redelivery.", - "type": "boolean" - }, - "duration": { - "description": "Time spent delivering.", - "type": "number" - }, - "status": { - "description": "Description of the status of the attempted delivery", - "type": "string" - }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer" - }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string" - }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", - "type": [ - "string", - "null" - ] - }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": [ - "integer", - "null" - ] - }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": [ - "integer", - "null" - ] - }, - "throttled_at": { - "description": "Time when the webhook delivery was throttled.", - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "url": { - "description": "The URL target of the delivery.", - "type": "string" - }, - "request": { - "type": "object", - "properties": { - "headers": { - "description": "The request headers sent with the webhook delivery.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - }, - "payload": { - "description": "The webhook payload.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - } - }, - "required": [ - "headers", - "payload" - ] - }, - "response": { - "type": "object", - "properties": { - "headers": { - "description": "The response headers received when the delivery was made.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - }, - "payload": { - "description": "The response payload received.", - "type": [ - "string", - "null" - ], - "additionalProperties": true - } - }, - "required": [ - "headers", - "payload" - ] - } - }, - "required": [ - "id", - "guid", - "delivered_at", - "redelivery", - "duration", - "status", - "status_code", - "event", - "action", - "installation_id", - "repository_id", - "request", - "response" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", - "title": "Redeliver a delivery for an organization webhook", - "category": "orgs", - "subcategory": "webhooks", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "delivery_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Redeliver a delivery for a webhook configured in an organization.

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "hook_id": "HOOK_ID", - "delivery_id": "DELIVERY_ID" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Accepted

", - "example": null, - "schema": { - "type": "object" - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/hooks/{hook_id}/pings", - "title": "Ping an organization webhook", - "category": "orgs", - "subcategory": "webhooks", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

This will trigger a ping event\nto be sent to the hook.

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" organization permissions": "write" - } - ] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/packages.json b/src/rest/data/ghes-3.14-2022-11-28/packages.json deleted file mode 100644 index f8fae3f4db8c..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/packages.json +++ /dev/null @@ -1,10957 +0,0 @@ -{ - "packages": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/docker/conflicts", - "title": "Get list of conflicting packages during Docker migration for organization", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 197, - "name": "hello_docker", - "package_type": "container", - "owner": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/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/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 - }, - "version_count": 1, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/hello_docker", - "created_at": "2020-05-19T22:19:11Z", - "updated_at": "2020-05-19T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" - }, - { - "id": 198, - "name": "goodbye_docker", - "package_type": "container", - "owner": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/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/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 - }, - "version_count": 2, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/goodbye_docker", - "created_at": "2020-05-20T22:19:11Z", - "updated_at": "2020-05-20T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/goodbye_docker" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Package", - "description": "A software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer" - }, - "name": { - "description": "The name of the package.", - "type": "string" - }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "version_count": { - "description": "The number of versions of the package.", - "type": "integer" - }, - "visibility": { - "type": "string", - "enum": [ - "private", - "public" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "package_type", - "visibility", - "url", - "html_url", - "version_count", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/packages", - "title": "List packages for an organization", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "query", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "visibility", - "description": "

The selected visibility of the packages. This parameter is optional and only filters an existing result set.

\n

The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "public", - "private", - "internal" - ] - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists packages in an organization readable by the user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 197, - "name": "hello_docker", - "package_type": "container", - "owner": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/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/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 - }, - "version_count": 1, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/hello_docker", - "created_at": "2020-05-19T22:19:11Z", - "updated_at": "2020-05-19T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" - }, - { - "id": 198, - "name": "goodbye_docker", - "package_type": "container", - "owner": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/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/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 - }, - "version_count": 2, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/goodbye_docker", - "created_at": "2020-05-20T22:19:11Z", - "updated_at": "2020-05-20T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/goodbye_docker" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Package", - "description": "A software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer" - }, - "name": { - "description": "The name of the package.", - "type": "string" - }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "version_count": { - "description": "The number of versions of the package.", - "type": "integer" - }, - "visibility": { - "type": "string", - "enum": [ - "private", - "public" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "package_type", - "visibility", - "url", - "html_url", - "version_count", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

The value of per_page multiplied by page cannot be greater than 10000.

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}", - "title": "Get a package for an organization", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific package in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME", - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 197, - "name": "hello_docker", - "package_type": "container", - "owner": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/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/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 - }, - "version_count": 1, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/hello_docker", - "created_at": "2020-05-19T22:19:11Z", - "updated_at": "2020-05-19T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" - }, - "schema": { - "title": "Package", - "description": "A software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer" - }, - "name": { - "description": "The name of the package.", - "type": "string" - }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "version_count": { - "description": "The number of versions of the package.", - "type": "integer" - }, - "visibility": { - "type": "string", - "enum": [ - "private", - "public" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "package_type", - "visibility", - "url", - "html_url", - "version_count", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}", - "title": "Delete a package for an organization", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

OAuth app tokens and personal access tokens (classic) need the read:packages and delete:packages scopes to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME", - "org": "ORG" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/restore", - "title": "Restore a package for an organization", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "token", - "description": "

package token

", - "schema": { - "type": "string" - }, - "required": false, - "in": "query" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Restores an entire package in an organization.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
    • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
    • \n
\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

OAuth app tokens and personal access tokens (classic) need the read:packages and write:packages scopes to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME", - "org": "ORG" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions", - "title": "List package versions for a package owned by an organization", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "state", - "in": "query", - "required": false, - "description": "

The state of the package, either active or deleted.

", - "schema": { - "type": "string", - "enum": [ - "active", - "deleted" - ], - "default": "active" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists package versions for a package owned by an organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME", - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 245301, - "name": "1.0.4", - "url": "https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/245301", - "package_html_url": "https://github.com/octo-org/hello-world-npm/packages/43752", - "created_at": "2019-11-05T22:49:04Z", - "updated_at": "2019-11-05T22:49:04Z", - "html_url": "https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.4", - "metadata": { - "package_type": "npm" - } - }, - { - "id": 209672, - "name": "1.0.3", - "url": "https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/209672", - "package_html_url": "https://github.com/octo-org/hello-world-npm/packages/43752", - "created_at": "2019-10-29T15:42:11Z", - "updated_at": "2019-10-29T15:42:12Z", - "html_url": "https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.3", - "metadata": { - "package_type": "npm" - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Package Version", - "description": "A version of a software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package version.", - "type": "integer" - }, - "name": { - "description": "The name of the package version.", - "type": "string" - }, - "url": { - "type": "string" - }, - "package_html_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "license": { - "type": "string" - }, - "description": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "deleted_at": { - "type": "string", - "format": "date-time" - }, - "metadata": { - "type": "object", - "title": "Package Version Metadata", - "properties": { - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - }, - "container": { - "type": "object", - "title": "Container Metadata", - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "tags" - ] - }, - "docker": { - "type": "object", - "title": "Docker Metadata", - "properties": { - "tag": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "tags" - ] - } - }, - "required": [ - "package_type" - ] - } - }, - "required": [ - "id", - "name", - "url", - "package_html_url", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", - "title": "Get a package version for an organization", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "package_version_id", - "description": "

Unique identifier of the package version.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific package version in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME", - "org": "ORG", - "package_version_id": "PACKAGE_VERSION_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 836, - "name": "sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344", - "url": "https://api.github.com/orgs/github/packages/container/hello_docker/versions/836", - "package_html_url": "https://github.com/orgs/github/packages/container/package/hello_docker", - "created_at": "2020-05-19T22:19:11Z", - "updated_at": "2020-05-19T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/hello_docker/836", - "metadata": { - "package_type": "container", - "container": { - "tags": [ - "latest" - ] - } - } - }, - "schema": { - "title": "Package Version", - "description": "A version of a software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package version.", - "type": "integer" - }, - "name": { - "description": "The name of the package version.", - "type": "string" - }, - "url": { - "type": "string" - }, - "package_html_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "license": { - "type": "string" - }, - "description": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "deleted_at": { - "type": "string", - "format": "date-time" - }, - "metadata": { - "type": "object", - "title": "Package Version Metadata", - "properties": { - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - }, - "container": { - "type": "object", - "title": "Container Metadata", - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "tags" - ] - }, - "docker": { - "type": "object", - "title": "Docker Metadata", - "properties": { - "tag": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "tags" - ] - } - }, - "required": [ - "package_type" - ] - } - }, - "required": [ - "id", - "name", - "url", - "package_html_url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", - "title": "Delete package version for an organization", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "package_version_id", - "description": "

Unique identifier of the package version.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

OAuth app tokens and personal access tokens (classic) need the read:packages and delete:packages scopes to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME", - "org": "ORG", - "package_version_id": "PACKAGE_VERSION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", - "title": "Restore package version for an organization", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "package_version_id", - "description": "

Unique identifier of the package version.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Restores a specific package version in an organization.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
    • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
    • \n
\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

OAuth app tokens and personal access tokens (classic) need the read:packages and write:packages scopes to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME", - "org": "ORG", - "package_version_id": "PACKAGE_VERSION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/docker/conflicts", - "title": "Get list of conflicting packages during Docker migration for authenticated-user", - "category": "packages", - "subcategory": "packages", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 197, - "name": "hello_docker", - "package_type": "container", - "owner": { - "login": "octocat", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.octocatusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "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/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": "User", - "site_admin": false - }, - "version_count": 1, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/hello_docker", - "created_at": "2020-05-19T22:19:11Z", - "updated_at": "2020-05-19T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" - }, - { - "id": 198, - "name": "goodbye_docker", - "package_type": "container", - "owner": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "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/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": "User", - "site_admin": false - }, - "version_count": 2, - "visibility": "private", - "url": "https://api.github.com/user/octocat/packages/container/goodbye_docker", - "created_at": "2020-05-20T22:19:11Z", - "updated_at": "2020-05-20T22:19:11Z", - "html_url": "https://github.com/user/octocat/packages/container/package/goodbye_docker" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Package", - "description": "A software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer" - }, - "name": { - "description": "The name of the package.", - "type": "string" - }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "version_count": { - "description": "The number of versions of the package.", - "type": "integer" - }, - "visibility": { - "type": "string", - "enum": [ - "private", - "public" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "package_type", - "visibility", - "url", - "html_url", - "version_count", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/packages", - "title": "List packages for the authenticated user's namespace", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "query", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "visibility", - "description": "

The selected visibility of the packages. This parameter is optional and only filters an existing result set.

\n

The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "public", - "private", - "internal" - ] - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists packages owned by the authenticated user within the user's namespace.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 197, - "name": "hello_docker", - "package_type": "container", - "owner": { - "login": "octocat", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.octocatusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "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/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": "User", - "site_admin": false - }, - "version_count": 1, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/hello_docker", - "created_at": "2020-05-19T22:19:11Z", - "updated_at": "2020-05-19T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" - }, - { - "id": 198, - "name": "goodbye_docker", - "package_type": "container", - "owner": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "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/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": "User", - "site_admin": false - }, - "version_count": 2, - "visibility": "private", - "url": "https://api.github.com/user/octocat/packages/container/goodbye_docker", - "created_at": "2020-05-20T22:19:11Z", - "updated_at": "2020-05-20T22:19:11Z", - "html_url": "https://github.com/user/octocat/packages/container/package/goodbye_docker" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Package", - "description": "A software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer" - }, - "name": { - "description": "The name of the package.", - "type": "string" - }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "version_count": { - "description": "The number of versions of the package.", - "type": "integer" - }, - "visibility": { - "type": "string", - "enum": [ - "private", - "public" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "package_type", - "visibility", - "url", - "html_url", - "version_count", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

The value of per_page multiplied by page cannot be greater than 10000.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/packages/{package_type}/{package_name}", - "title": "Get a package for the authenticated user", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific package for a package owned by the authenticated user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 40201, - "name": "octo-name", - "package_type": "rubygems", - "owner": { - "login": "octocat", - "id": 209477, - "node_id": "MDQ6VXNlcjIwOTQ3Nw==", - "avatar_url": "https://avatars.githubusercontent.com/u/209477?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "version_count": 3, - "visibility": "public", - "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name", - "created_at": "2019-10-20T14:17:14Z", - "updated_at": "2019-10-20T14:17:14Z", - "repository": { - "id": 216219492, - "node_id": "MDEwOlJlcG9zaXRvcnkyMTYyMTk0OTI=", - "name": "octo-name-repo", - "full_name": "octocat/octo-name-repo", - "private": false, - "owner": { - "login": "octocat", - "id": 209477, - "node_id": "MDQ6VXNlcjIwOTQ3Nw==", - "avatar_url": "https://avatars.githubusercontent.com/u/209477?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "html_url": "https://github.com/octocat/octo-name-repo", - "description": "Project for octocats", - "fork": false, - "url": "https://api.github.com/repos/octocat/octo-name-repo", - "forks_url": "https://api.github.com/repos/octocat/octo-name-repo/forks", - "keys_url": "https://api.github.com/repos/octocat/octo-name-repo/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octocat/octo-name-repo/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octocat/octo-name-repo/teams", - "hooks_url": "https://api.github.com/repos/octocat/octo-name-repo/hooks", - "issue_events_url": "https://api.github.com/repos/octocat/octo-name-repo/issues/events{/number}", - "events_url": "https://api.github.com/repos/octocat/octo-name-repo/events", - "assignees_url": "https://api.github.com/repos/octocat/octo-name-repo/assignees{/user}", - "branches_url": "https://api.github.com/repos/octocat/octo-name-repo/branches{/branch}", - "tags_url": "https://api.github.com/repos/octocat/octo-name-repo/tags", - "blobs_url": "https://api.github.com/repos/octocat/octo-name-repo/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/octo-name-repo/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/octo-name-repo/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octocat/octo-name-repo/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octocat/octo-name-repo/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octocat/octo-name-repo/languages", - "stargazers_url": "https://api.github.com/repos/octocat/octo-name-repo/stargazers", - "contributors_url": "https://api.github.com/repos/octocat/octo-name-repo/contributors", - "subscribers_url": "https://api.github.com/repos/octocat/octo-name-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/octo-name-repo/subscription", - "commits_url": "https://api.github.com/repos/octocat/octo-name-repo/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octocat/octo-name-repo/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octocat/octo-name-repo/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octocat/octo-name-repo/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octocat/octo-name-repo/contents/{+path}", - "compare_url": "https://api.github.com/repos/octocat/octo-name-repo/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octocat/octo-name-repo/merges", - "archive_url": "https://api.github.com/repos/octocat/octo-name-repo/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octocat/octo-name-repo/downloads", - "issues_url": "https://api.github.com/repos/octocat/octo-name-repo/issues{/number}", - "pulls_url": "https://api.github.com/repos/octocat/octo-name-repo/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octocat/octo-name-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/octo-name-repo/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octocat/octo-name-repo/labels{/name}", - "releases_url": "https://api.github.com/repos/octocat/octo-name-repo/releases{/id}", - "deployments_url": "https://api.github.com/repos/octocat/octo-name-repo/deployments" - }, - "html_url": "https://github.com/octocat/octo-name-repo/packages/40201" - }, - "schema": { - "title": "Package", - "description": "A software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer" - }, - "name": { - "description": "The name of the package.", - "type": "string" - }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "version_count": { - "description": "The number of versions of the package.", - "type": "integer" - }, - "visibility": { - "type": "string", - "enum": [ - "private", - "public" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "package_type", - "visibility", - "url", - "html_url", - "version_count", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/user/packages/{package_type}/{package_name}", - "title": "Delete a package for the authenticated user", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages and delete:packages scopes to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/user/packages/{package_type}/{package_name}/restore", - "title": "Restore a package for the authenticated user", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "token", - "description": "

package token

", - "schema": { - "type": "string" - }, - "required": false, - "in": "query" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Restores a package owned by the authenticated user.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
    • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
    • \n
\n

OAuth app tokens and personal access tokens (classic) need the read:packages and write:packages scopes to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/packages/{package_type}/{package_name}/versions", - "title": "List package versions for a package owned by the authenticated user", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "state", - "in": "query", - "required": false, - "description": "

The state of the package, either active or deleted.

", - "schema": { - "type": "string", - "enum": [ - "active", - "deleted" - ], - "default": "active" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists package versions for a package owned by the authenticated user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 45763, - "name": "sha256:08a44bab0bddaddd8837a8b381aebc2e4b933768b981685a9e088360af0d3dd9", - "url": "https://api.github.com/users/octocat/packages/container/hello_docker/versions/45763", - "package_html_url": "https://github.com/users/octocat/packages/container/package/hello_docker", - "created_at": "2020-09-11T21:56:40Z", - "updated_at": "2021-02-05T21:32:32Z", - "html_url": "https://github.com/users/octocat/packages/container/hello_docker/45763", - "metadata": { - "package_type": "container", - "container": { - "tags": [ - "latest" - ] - } - } - }, - { - "id": 881, - "name": "sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344", - "url": "https://api.github.com/users/octocat/packages/container/hello_docker/versions/881", - "package_html_url": "https://github.com/users/octocat/packages/container/package/hello_docker", - "created_at": "2020-05-21T22:22:20Z", - "updated_at": "2021-02-05T21:32:32Z", - "html_url": "https://github.com/users/octocat/packages/container/hello_docker/881", - "metadata": { - "package_type": "container", - "container": { - "tags": [] - } - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Package Version", - "description": "A version of a software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package version.", - "type": "integer" - }, - "name": { - "description": "The name of the package version.", - "type": "string" - }, - "url": { - "type": "string" - }, - "package_html_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "license": { - "type": "string" - }, - "description": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "deleted_at": { - "type": "string", - "format": "date-time" - }, - "metadata": { - "type": "object", - "title": "Package Version Metadata", - "properties": { - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - }, - "container": { - "type": "object", - "title": "Container Metadata", - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "tags" - ] - }, - "docker": { - "type": "object", - "title": "Docker Metadata", - "properties": { - "tag": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "tags" - ] - } - }, - "required": [ - "package_type" - ] - } - }, - "required": [ - "id", - "name", - "url", - "package_html_url", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}", - "title": "Get a package version for the authenticated user", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "package_version_id", - "description": "

Unique identifier of the package version.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific package version for a package owned by the authenticated user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME", - "package_version_id": "PACKAGE_VERSION_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 214, - "name": "sha256:3561f0cff06caccddb99c93bd26e712fcc56a811de0f8ea7a17bb865f30b176a", - "url": "https://api.github.com/users/octocat/packages/container/hello_docker/versions/214", - "package_html_url": "https://github.com/users/octocat/packages/container/package/hello_docker", - "created_at": "2020-05-15T03:46:45Z", - "updated_at": "2020-05-15T03:46:45Z", - "html_url": "https://github.com/users/octocat/packages/container/hello_docker/214", - "metadata": { - "package_type": "container", - "container": { - "tags": [ - "1.13.6" - ] - } - } - }, - "schema": { - "title": "Package Version", - "description": "A version of a software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package version.", - "type": "integer" - }, - "name": { - "description": "The name of the package version.", - "type": "string" - }, - "url": { - "type": "string" - }, - "package_html_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "license": { - "type": "string" - }, - "description": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "deleted_at": { - "type": "string", - "format": "date-time" - }, - "metadata": { - "type": "object", - "title": "Package Version Metadata", - "properties": { - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - }, - "container": { - "type": "object", - "title": "Container Metadata", - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "tags" - ] - }, - "docker": { - "type": "object", - "title": "Docker Metadata", - "properties": { - "tag": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "tags" - ] - } - }, - "required": [ - "package_type" - ] - } - }, - "required": [ - "id", - "name", - "url", - "package_html_url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}", - "title": "Delete a package version for the authenticated user", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "package_version_id", - "description": "

Unique identifier of the package version.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

\n

The authenticated user must have admin permissions in the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages and delete:packages scopes to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME", - "package_version_id": "PACKAGE_VERSION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", - "title": "Restore a package version for the authenticated user", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "package_version_id", - "description": "

Unique identifier of the package version.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Restores a package version owned by the authenticated user.

\n

You can restore a deleted package version under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
    • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
    • \n
\n

OAuth app tokens and personal access tokens (classic) need the read:packages and write:packages scopes to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME", - "package_version_id": "PACKAGE_VERSION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/docker/conflicts", - "title": "Get list of conflicting packages during Docker migration for user", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 197, - "name": "hello_docker", - "package_type": "container", - "owner": { - "login": "octocat", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.octocatusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "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/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": "User", - "site_admin": false - }, - "version_count": 1, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/hello_docker", - "created_at": "2020-05-19T22:19:11Z", - "updated_at": "2020-05-19T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" - }, - { - "id": 198, - "name": "goodbye_docker", - "package_type": "container", - "owner": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "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/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": "User", - "site_admin": false - }, - "version_count": 2, - "visibility": "private", - "url": "https://api.github.com/user/octocat/packages/container/goodbye_docker", - "created_at": "2020-05-20T22:19:11Z", - "updated_at": "2020-05-20T22:19:11Z", - "html_url": "https://github.com/user/octocat/packages/container/package/goodbye_docker" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Package", - "description": "A software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer" - }, - "name": { - "description": "The name of the package.", - "type": "string" - }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "version_count": { - "description": "The number of versions of the package.", - "type": "integer" - }, - "visibility": { - "type": "string", - "enum": [ - "private", - "public" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "package_type", - "visibility", - "url", - "html_url", - "version_count", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/packages", - "title": "List packages for a user", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "query", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "visibility", - "description": "

The selected visibility of the packages. This parameter is optional and only filters an existing result set.

\n

The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "public", - "private", - "internal" - ] - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all packages in a user's namespace for which the requesting user has access.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 197, - "name": "hello_docker", - "package_type": "container", - "owner": { - "login": "octocat", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.octocatusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "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/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": "User", - "site_admin": false - }, - "version_count": 1, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/hello_docker", - "created_at": "2020-05-19T22:19:11Z", - "updated_at": "2020-05-19T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" - }, - { - "id": 198, - "name": "goodbye_docker", - "package_type": "container", - "owner": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "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/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": "User", - "site_admin": false - }, - "version_count": 2, - "visibility": "private", - "url": "https://api.github.com/user/octocat/packages/container/goodbye_docker", - "created_at": "2020-05-20T22:19:11Z", - "updated_at": "2020-05-20T22:19:11Z", - "html_url": "https://github.com/user/octocat/packages/container/package/goodbye_docker" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Package", - "description": "A software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer" - }, - "name": { - "description": "The name of the package.", - "type": "string" - }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "version_count": { - "description": "The number of versions of the package.", - "type": "integer" - }, - "visibility": { - "type": "string", - "enum": [ - "private", - "public" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "package_type", - "visibility", - "url", - "html_url", - "version_count", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

The value of per_page multiplied by page cannot be greater than 10000.

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/packages/{package_type}/{package_name}", - "title": "Get a package for a user", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific package metadata for a public package owned by a user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 40201, - "name": "octo-name", - "package_type": "rubygems", - "owner": { - "login": "octocat", - "id": 209477, - "node_id": "MDQ6VXNlcjIwOTQ3Nw==", - "avatar_url": "https://avatars.githubusercontent.com/u/209477?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "version_count": 3, - "visibility": "public", - "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name", - "created_at": "2019-10-20T14:17:14Z", - "updated_at": "2019-10-20T14:17:14Z", - "repository": { - "id": 216219492, - "node_id": "MDEwOlJlcG9zaXRvcnkyMTYyMTk0OTI=", - "name": "octo-name-repo", - "full_name": "octocat/octo-name-repo", - "private": false, - "owner": { - "login": "octocat", - "id": 209477, - "node_id": "MDQ6VXNlcjIwOTQ3Nw==", - "avatar_url": "https://avatars.githubusercontent.com/u/209477?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "html_url": "https://github.com/octocat/octo-name-repo", - "description": "Project for octocats", - "fork": false, - "url": "https://api.github.com/repos/octocat/octo-name-repo", - "forks_url": "https://api.github.com/repos/octocat/octo-name-repo/forks", - "keys_url": "https://api.github.com/repos/octocat/octo-name-repo/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octocat/octo-name-repo/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octocat/octo-name-repo/teams", - "hooks_url": "https://api.github.com/repos/octocat/octo-name-repo/hooks", - "issue_events_url": "https://api.github.com/repos/octocat/octo-name-repo/issues/events{/number}", - "events_url": "https://api.github.com/repos/octocat/octo-name-repo/events", - "assignees_url": "https://api.github.com/repos/octocat/octo-name-repo/assignees{/user}", - "branches_url": "https://api.github.com/repos/octocat/octo-name-repo/branches{/branch}", - "tags_url": "https://api.github.com/repos/octocat/octo-name-repo/tags", - "blobs_url": "https://api.github.com/repos/octocat/octo-name-repo/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/octo-name-repo/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/octo-name-repo/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octocat/octo-name-repo/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octocat/octo-name-repo/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octocat/octo-name-repo/languages", - "stargazers_url": "https://api.github.com/repos/octocat/octo-name-repo/stargazers", - "contributors_url": "https://api.github.com/repos/octocat/octo-name-repo/contributors", - "subscribers_url": "https://api.github.com/repos/octocat/octo-name-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/octo-name-repo/subscription", - "commits_url": "https://api.github.com/repos/octocat/octo-name-repo/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octocat/octo-name-repo/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octocat/octo-name-repo/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octocat/octo-name-repo/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octocat/octo-name-repo/contents/{+path}", - "compare_url": "https://api.github.com/repos/octocat/octo-name-repo/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octocat/octo-name-repo/merges", - "archive_url": "https://api.github.com/repos/octocat/octo-name-repo/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octocat/octo-name-repo/downloads", - "issues_url": "https://api.github.com/repos/octocat/octo-name-repo/issues{/number}", - "pulls_url": "https://api.github.com/repos/octocat/octo-name-repo/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octocat/octo-name-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/octo-name-repo/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octocat/octo-name-repo/labels{/name}", - "releases_url": "https://api.github.com/repos/octocat/octo-name-repo/releases{/id}", - "deployments_url": "https://api.github.com/repos/octocat/octo-name-repo/deployments" - }, - "html_url": "https://github.com/octocat/octo-name-repo/packages/40201" - }, - "schema": { - "title": "Package", - "description": "A software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer" - }, - "name": { - "description": "The name of the package.", - "type": "string" - }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "version_count": { - "description": "The number of versions of the package.", - "type": "integer" - }, - "visibility": { - "type": "string", - "enum": [ - "private", - "public" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "package_type", - "visibility", - "url", - "html_url", - "version_count", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/users/{username}/packages/{package_type}/{package_name}", - "title": "Delete a package for a user", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

OAuth app tokens and personal access tokens (classic) need the read:packages and delete:packages scopes to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/users/{username}/packages/{package_type}/{package_name}/restore", - "title": "Restore a package for a user", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "token", - "description": "

package token

", - "schema": { - "type": "string" - }, - "required": false, - "in": "query" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Restores an entire package for a user.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
    • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
    • \n
\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

OAuth app tokens and personal access tokens (classic) need the read:packages and write:packages scopes to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions", - "title": "List package versions for a package owned by a user", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists package versions for a public package owned by a specified user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 3497268, - "name": "0.3.0", - "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/3497268", - "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201", - "license": "MIT", - "created_at": "2020-08-31T15:22:11Z", - "updated_at": "2020-08-31T15:22:12Z", - "description": "Project for octocats", - "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.3.0", - "metadata": { - "package_type": "rubygems" - } - }, - { - "id": 387039, - "name": "0.2.0", - "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039", - "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201", - "license": "MIT", - "created_at": "2019-12-01T20:49:29Z", - "updated_at": "2019-12-01T20:49:30Z", - "description": "Project for octocats", - "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0", - "metadata": { - "package_type": "rubygems" - } - }, - { - "id": 169770, - "name": "0.1.0", - "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/169770", - "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201", - "license": "MIT", - "created_at": "2019-10-20T14:17:14Z", - "updated_at": "2019-10-20T14:17:15Z", - "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.1.0", - "metadata": { - "package_type": "rubygems" - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Package Version", - "description": "A version of a software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package version.", - "type": "integer" - }, - "name": { - "description": "The name of the package version.", - "type": "string" - }, - "url": { - "type": "string" - }, - "package_html_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "license": { - "type": "string" - }, - "description": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "deleted_at": { - "type": "string", - "format": "date-time" - }, - "metadata": { - "type": "object", - "title": "Package Version Metadata", - "properties": { - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - }, - "container": { - "type": "object", - "title": "Container Metadata", - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "tags" - ] - }, - "docker": { - "type": "object", - "title": "Docker Metadata", - "properties": { - "tag": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "tags" - ] - } - }, - "required": [ - "package_type" - ] - } - }, - "required": [ - "id", - "name", - "url", - "package_html_url", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", - "title": "Get a package version for a user", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "package_version_id", - "description": "

Unique identifier of the package version.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a specific package version for a public package owned by a specified user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME", - "package_version_id": "PACKAGE_VERSION_ID", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 387039, - "name": "0.2.0", - "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039", - "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201", - "license": "MIT", - "created_at": "2019-12-01T20:49:29Z", - "updated_at": "2019-12-01T20:49:30Z", - "description": "Octo-name client for Ruby", - "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0", - "metadata": { - "package_type": "rubygems" - } - }, - "schema": { - "title": "Package Version", - "description": "A version of a software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package version.", - "type": "integer" - }, - "name": { - "description": "The name of the package version.", - "type": "string" - }, - "url": { - "type": "string" - }, - "package_html_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "license": { - "type": "string" - }, - "description": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "deleted_at": { - "type": "string", - "format": "date-time" - }, - "metadata": { - "type": "object", - "title": "Package Version Metadata", - "properties": { - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - }, - "container": { - "type": "object", - "title": "Container Metadata", - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "tags" - ] - }, - "docker": { - "type": "object", - "title": "Docker Metadata", - "properties": { - "tag": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "tags" - ] - } - }, - "required": [ - "package_type" - ] - } - }, - "required": [ - "id", - "name", - "url", - "package_html_url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", - "title": "Delete package version for a user", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "package_version_id", - "description": "

Unique identifier of the package version.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

OAuth app tokens and personal access tokens (classic) need the read:packages and delete:packages scopes to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME", - "username": "USERNAME", - "package_version_id": "PACKAGE_VERSION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", - "title": "Restore package version for a user", - "category": "packages", - "subcategory": "packages", - "parameters": [ - { - "name": "package_type", - "description": "

The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "

The name of the package.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "package_version_id", - "description": "

Unique identifier of the package version.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Restores a specific package version for a user.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
    • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
    • \n
\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

OAuth app tokens and personal access tokens (classic) need the read:packages and write:packages scopes to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "package_type": "PACKAGE_TYPE", - "package_name": "PACKAGE_NAME", - "username": "USERNAME", - "package_version_id": "PACKAGE_VERSION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": true, - "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true, - "disabledForPatV2": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/pages.json b/src/rest/data/ghes-3.14-2022-11-28/pages.json deleted file mode 100644 index d5665650ce0c..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/pages.json +++ /dev/null @@ -1,1996 +0,0 @@ -{ - "pages": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages", - "title": "Get a GitHub Enterprise Server Pages site", - "category": "pages", - "subcategory": "pages", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets information about a GitHub Enterprise Server Pages site.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/github/developer.github.com/pages", - "status": "built", - "cname": "developer.github.com", - "custom_404": false, - "html_url": "https://developer.github.com", - "source": { - "branch": "master", - "path": "/" - }, - "public": true, - "pending_domain_unverified_at": "2024-04-30T19:33:31Z", - "protected_domain_state": "verified", - "https_certificate": { - "state": "approved", - "description": "Certificate is approved", - "domains": [ - "developer.github.com" - ], - "expires_at": "2021-05-22" - }, - "https_enforced": true - }, - "schema": { - "title": "GitHub Pages", - "description": "The configuration for GitHub Pages for a repository.", - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "The API address for accessing this Page resource.", - "format": "uri" - }, - "status": { - "type": [ - "string", - "null" - ], - "description": "The status of the most recent build of the Page.", - "enum": [ - "built", - "building", - "errored", - null - ] - }, - "cname": { - "description": "The Pages site's custom domain", - "type": [ - "string", - "null" - ] - }, - "protected_domain_state": { - "type": [ - "string", - "null" - ], - "description": "The state if the domain is verified", - "enum": [ - "pending", - "verified", - "unverified", - null - ] - }, - "pending_domain_unverified_at": { - "type": [ - "string", - "null" - ], - "description": "The timestamp when a pending domain becomes unverified.", - "format": "date-time" - }, - "custom_404": { - "type": "boolean", - "description": "Whether the Page has a custom 404 page.", - "default": false - }, - "html_url": { - "type": "string", - "description": "The web address the Page can be accessed from.", - "format": "uri" - }, - "build_type": { - "type": [ - "string", - "null" - ], - "description": "The process in which the Page will be built.", - "enum": [ - "legacy", - "workflow", - null - ] - }, - "source": { - "title": "Pages Source Hash", - "type": "object", - "properties": { - "branch": { - "type": "string" - }, - "path": { - "type": "string" - } - }, - "required": [ - "branch", - "path" - ] - }, - "public": { - "type": "boolean", - "description": "Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site." - }, - "https_certificate": { - "title": "Pages Https Certificate", - "type": "object", - "properties": { - "state": { - "type": "string", - "enum": [ - "new", - "authorization_created", - "authorization_pending", - "authorized", - "authorization_revoked", - "issued", - "uploaded", - "approved", - "errored", - "bad_authz", - "destroy_pending", - "dns_changed" - ] - }, - "description": { - "type": "string" - }, - "domains": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of the domain set and its alternate name (if it is configured)" - }, - "expires_at": { - "type": "string", - "format": "date" - } - }, - "required": [ - "state", - "description", - "domains" - ] - }, - "https_enforced": { - "type": "boolean", - "description": "Whether https is enabled on the domain" - } - }, - "required": [ - "url", - "status", - "cname", - "custom_404", - "public" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pages\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages", - "title": "Create a GitHub Enterprise Server Pages site", - "category": "pages", - "subcategory": "pages", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "build_type", - "description": "

The process in which the Page will be built. Possible values are \"legacy\" and \"workflow\".

", - "enum": [ - "legacy", - "workflow" - ] - }, - { - "type": "object", - "name": "source", - "description": "

The source branch and directory used to publish your Pages site.

", - "childParamsGroups": [ - { - "type": "string", - "name": "branch", - "description": "

The repository branch used to publish your site's source files.

", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "

The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /

", - "enum": [ - "/", - "/docs" - ], - "default": "/" - } - ] - } - ], - "descriptionHTML": "

Configures a GitHub Enterprise Server Pages site. For more information, see \"About GitHub Pages.\"

\n

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "source": { - "branch": "main", - "path": "/docs" - } - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/github/developer.github.com/pages", - "status": "built", - "cname": "developer.github.com", - "custom_404": false, - "html_url": "https://developer.github.com", - "source": { - "branch": "master", - "path": "/" - }, - "public": true, - "pending_domain_unverified_at": "2024-04-30T19:33:31Z", - "protected_domain_state": "verified", - "https_certificate": { - "state": "approved", - "description": "Certificate is approved", - "domains": [ - "developer.github.com" - ], - "expires_at": "2021-05-22" - }, - "https_enforced": true - }, - "schema": { - "title": "GitHub Pages", - "description": "The configuration for GitHub Pages for a repository.", - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "The API address for accessing this Page resource.", - "format": "uri" - }, - "status": { - "type": [ - "string", - "null" - ], - "description": "The status of the most recent build of the Page.", - "enum": [ - "built", - "building", - "errored", - null - ] - }, - "cname": { - "description": "The Pages site's custom domain", - "type": [ - "string", - "null" - ] - }, - "protected_domain_state": { - "type": [ - "string", - "null" - ], - "description": "The state if the domain is verified", - "enum": [ - "pending", - "verified", - "unverified", - null - ] - }, - "pending_domain_unverified_at": { - "type": [ - "string", - "null" - ], - "description": "The timestamp when a pending domain becomes unverified.", - "format": "date-time" - }, - "custom_404": { - "type": "boolean", - "description": "Whether the Page has a custom 404 page.", - "default": false - }, - "html_url": { - "type": "string", - "description": "The web address the Page can be accessed from.", - "format": "uri" - }, - "build_type": { - "type": [ - "string", - "null" - ], - "description": "The process in which the Page will be built.", - "enum": [ - "legacy", - "workflow", - null - ] - }, - "source": { - "title": "Pages Source Hash", - "type": "object", - "properties": { - "branch": { - "type": "string" - }, - "path": { - "type": "string" - } - }, - "required": [ - "branch", - "path" - ] - }, - "public": { - "type": "boolean", - "description": "Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site." - }, - "https_certificate": { - "title": "Pages Https Certificate", - "type": "object", - "properties": { - "state": { - "type": "string", - "enum": [ - "new", - "authorization_created", - "authorization_pending", - "authorized", - "authorization_revoked", - "issued", - "uploaded", - "approved", - "errored", - "bad_authz", - "destroy_pending", - "dns_changed" - ] - }, - "description": { - "type": "string" - }, - "domains": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of the domain set and its alternate name (if it is configured)" - }, - "expires_at": { - "type": "string", - "format": "date" - } - }, - "required": [ - "state", - "description", - "domains" - ] - }, - "https_enforced": { - "type": "boolean", - "description": "Whether https is enabled on the domain" - } - }, - "required": [ - "url", - "status", - "cname", - "custom_404", - "public" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pages\" repository permissions": "write", - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pages", - "title": "Update information about a GitHub Enterprise Server Pages site", - "category": "pages", - "subcategory": "pages", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string or null", - "name": "cname", - "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

" - }, - { - "type": "boolean", - "name": "https_enforced", - "description": "

Specify whether HTTPS should be enforced for the repository.

" - }, - { - "type": "string", - "name": "build_type", - "description": "

The process by which the GitHub Pages site will be built. workflow means that the site is built by a custom GitHub Actions workflow. legacy means that the site is built by GitHub when changes are pushed to a specific branch.

", - "enum": [ - "legacy", - "workflow" - ] - }, - { - "type": "object", - "name": "source", - "description": "

Update the source for the repository. Must include the branch name and path.

", - "childParamsGroups": [ - { - "type": "string", - "name": "branch", - "description": "

The repository branch used to publish your site's source files.

", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "

The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs.

", - "isRequired": true, - "enum": [ - "/", - "/docs" - ] - } - ] - } - ], - "descriptionHTML": "

Updates information for a GitHub Enterprise Server Pages site. For more information, see \"About GitHub Pages.

\n

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "cname": "octocatblog.com", - "source": { - "branch": "main", - "path": "/" - } - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pages\" repository permissions": "write", - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pages", - "title": "Delete a GitHub Enterprise Server Pages site", - "category": "pages", - "subcategory": "pages", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a GitHub Enterprise Server Pages site. For more information, see \"About GitHub Pages.

\n

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pages\" repository permissions": "write", - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/builds", - "title": "List GitHub Enterprise Server Pages builds", - "category": "pages", - "subcategory": "pages", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists builts of a GitHub Enterprise Server Pages site.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", - "status": "built", - "error": { - "message": null - }, - "pusher": { - "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 - }, - "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b", - "duration": 2104, - "created_at": "2014-02-10T19:00:49Z", - "updated_at": "2014-02-10T19:00:51Z" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Page Build", - "description": "Page Build", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "status": { - "type": "string" - }, - "error": { - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "message" - ] - }, - "pusher": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "commit": { - "type": "string" - }, - "duration": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "url", - "status", - "error", - "pusher", - "commit", - "duration", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pages\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/builds", - "title": "Request a GitHub Enterprise Server Pages build", - "category": "pages", - "subcategory": "pages", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

\n

Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/latest", - "status": "queued" - }, - "schema": { - "title": "Page Build Status", - "description": "Page Build Status", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "status": { - "type": "string" - } - }, - "required": [ - "url", - "status" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pages\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/builds/latest", - "title": "Get latest Pages build", - "category": "pages", - "subcategory": "pages", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets information about the single most recent build of a GitHub Enterprise Server Pages site.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", - "status": "built", - "error": { - "message": null - }, - "pusher": { - "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 - }, - "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b", - "duration": 2104, - "created_at": "2014-02-10T19:00:49Z", - "updated_at": "2014-02-10T19:00:51Z" - }, - "schema": { - "title": "Page Build", - "description": "Page Build", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "status": { - "type": "string" - }, - "error": { - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "message" - ] - }, - "pusher": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "commit": { - "type": "string" - }, - "duration": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "url", - "status", - "error", - "pusher", - "commit", - "duration", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pages\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/builds/{build_id}", - "title": "Get GitHub Enterprise Server Pages build", - "category": "pages", - "subcategory": "pages", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "build_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets information about a GitHub Enterprise Server Pages build.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "build_id": "BUILD_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", - "status": "built", - "error": { - "message": null - }, - "pusher": { - "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 - }, - "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b", - "duration": 2104, - "created_at": "2014-02-10T19:00:49Z", - "updated_at": "2014-02-10T19:00:51Z" - }, - "schema": { - "title": "Page Build", - "description": "Page Build", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "status": { - "type": "string" - }, - "error": { - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "message" - ] - }, - "pusher": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "commit": { - "type": "string" - }, - "duration": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "url", - "status", - "error", - "pusher", - "commit", - "duration", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pages\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployments", - "title": "Create a GitHub Pages deployment", - "category": "pages", - "subcategory": "pages", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "artifact_url", - "description": "

The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "environment", - "description": "

The target environment for this GitHub Pages deployment.

", - "default": "github-pages" - }, - { - "type": "string", - "name": "pages_build_version", - "description": "

A unique string that represents the version of the build for this deployment.

", - "isRequired": true, - "default": "GITHUB_SHA" - }, - { - "type": "string", - "name": "oidc_token", - "description": "

The OIDC token issued by GitHub Actions certifying the origin of the deployment.

", - "isRequired": true - } - ], - "descriptionHTML": "

Create a GitHub Pages deployment for a repository.

\n

The authenticated user must have write permission to the repository.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "artifact_url": "https://downloadcontent/", - "environment": "github-pages", - "pages_build_version": "4fd754f7e594640989b406850d0bc8f06a121251", - "oidc_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IlV2R1h4SUhlY0JFc1JCdEttemUxUEhfUERiVSIsImtpZCI6IjUyRjE5N0M0ODFERTcwMTEyQzQ0MUI0QTlCMzdCNTNDN0ZDRjBEQjUifQ.eyJqdGkiOiJhMWIwNGNjNy0zNzZiLTQ1N2QtOTMzNS05NTY5YmVjZDExYTIiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjYiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM5MDAwODU2LCJleHAiOjE2MzkwMDE3NTYsImlhdCI6MTYzOTAwMTQ1Nn0.VP8WictbQECKozE2SgvKb2FqJ9hisWsoMkYRTqfBrQfZTCXi5IcFEdgDMB2X7a99C2DeUuTvHh9RMKXLL2a0zg3-Sd7YrO7a2ll2kNlnvyIypcN6AeIc7BxHsTTnZN9Ud_xmEsTrSRGOEKmzCFkULQ6N4zlVD0sidypmXlMemmWEcv_ZHqhioEI_VMp5vwXQurketWH7qX4oDgG4okyYtPrv5RQHbfQcVo9izaPJ_jnsDd0CBA0QOx9InjPidtIkMYQLyUgJy33HLJy86EFNUnAf8UhBQuQi5mAsEpEzBBuKpG3PDiPtYCHOk64JZkZGd5mR888a5sbHRiaF8hm8YA" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": "4fd754f7e594640989b406850d0bc8f06a121251", - "status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status", - "page_url": "developer.github.com" - }, - "schema": { - "title": "GitHub Pages", - "description": "The GitHub Pages deployment status.", - "type": "object", - "properties": { - "id": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string" - } - ], - "description": "The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit." - }, - "status_url": { - "type": "string", - "description": "The URI to monitor GitHub Pages deployment status.", - "format": "uri" - }, - "page_url": { - "type": "string", - "description": "The URI to the deployed GitHub Pages.", - "format": "uri" - }, - "preview_url": { - "type": "string", - "description": "The URI to the deployed GitHub Pages preview.", - "format": "uri" - } - }, - "required": [ - "id", - "status_url", - "page_url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pages\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}", - "title": "Get the status of a GitHub Pages deployment", - "category": "pages", - "subcategory": "pages", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pages_deployment_id", - "description": "

The ID of the Pages deployment. You can also give the commit SHA of the deployment.

", - "in": "path", - "required": true, - "schema": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string" - } - ] - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the current status of a GitHub Pages deployment.

\n

The authenticated user must have read permission for the GitHub Pages site.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pages_deployment_id": "PAGES_DEPLOYMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "status": "succeed" - }, - "schema": { - "title": "GitHub Pages deployment status", - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "The current status of the deployment.", - "enum": [ - "deployment_in_progress", - "syncing_files", - "finished_file_sync", - "updating_pages", - "purging_cdn", - "deployment_cancelled", - "deployment_failed", - "deployment_content_failed", - "deployment_attempt_error", - "deployment_lost", - "succeed" - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pages\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel", - "title": "Cancel a GitHub Pages deployment", - "category": "pages", - "subcategory": "pages", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pages_deployment_id", - "description": "

The ID of the Pages deployment. You can also give the commit SHA of the deployment.

", - "in": "path", - "required": true, - "schema": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string" - } - ] - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Cancels a GitHub Pages deployment.

\n

The authenticated user must have write permissions for the GitHub Pages site.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pages_deployment_id": "PAGES_DEPLOYMENT_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

A header with no content is returned.

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

A header with no content is returned.

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pages\" repository permissions": "write" - } - ] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/projects-classic.json b/src/rest/data/ghes-3.14-2022-11-28/projects-classic.json deleted file mode 100644 index 3447a18d0ad7..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/projects-classic.json +++ /dev/null @@ -1,5240 +0,0 @@ -{ - "cards": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Get a project card", - "category": "projects-classic", - "subcategory": "cards", - "parameters": [ - { - "name": "card_id", - "description": "

The unique identifier of the card.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "card_id": "CARD_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - }, - "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "The project card's ID", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri" - }, - "content_url": { - "type": "string", - "format": "uri" - }, - "project_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Update an existing project card", - "category": "projects-classic", - "subcategory": "cards", - "parameters": [ - { - "name": "card_id", - "description": "

The unique identifier of the card.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string or null", - "name": "note", - "description": "

The project card's note

" - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether or not the card is archived

" - } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Change the note on the card", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "note": "Add payload for delete Project column" - }, - "parameters": { - "card_id": "CARD_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - }, - "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "The project card's ID", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri" - }, - "content_url": { - "type": "string", - "format": "uri" - }, - "project_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Delete a project card", - "category": "projects-classic", - "subcategory": "cards", - "parameters": [ - { - "name": "card_id", - "description": "

The unique identifier of the card.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "card_id": "CARD_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/columns/cards/{card_id}/moves", - "title": "Move a project card", - "category": "projects-classic", - "subcategory": "cards", - "parameters": [ - { - "name": "card_id", - "description": "

The unique identifier of the card.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "position", - "description": "

The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.

", - "isRequired": true - }, - { - "type": "integer", - "name": "column_id", - "description": "

The unique identifier of the column the card should be moved to

" - } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Move the card to the bottom of the column", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "column_id": 42, - "position": "bottom" - }, - "parameters": { - "card_id": "CARD_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": null, - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - }, - { - "httpStatusCode": "503", - "description": "

Service Unavailable

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/columns/{column_id}/cards", - "title": "List project cards", - "category": "projects-classic", - "subcategory": "cards", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "archived_state", - "description": "

Filters the project cards that are returned by the card's state.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "archived", - "not_archived" - ], - "default": "not_archived" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "column_id": "COLUMN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "The project card's ID", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri" - }, - "content_url": { - "type": "string", - "format": "uri" - }, - "project_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/columns/{column_id}/cards", - "title": "Create a project card", - "category": "projects-classic", - "subcategory": "cards", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string or null", - "name": "note", - "description": "

The project card's note

", - "isRequired": true - }, - { - "type": "integer", - "name": "content_id", - "description": "

The unique identifier of the content associated with the card

", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "description": "

The piece of content associated with the card

", - "isRequired": true - } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Create a new card", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "note": "Add payload for delete Project column" - }, - "parameters": { - "column_id": "COLUMN_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - }, - "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "The project card's ID", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri" - }, - "content_url": { - "type": "string", - "format": "uri" - }, - "project_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" - }, - { - "httpStatusCode": "503", - "description": "

Service Unavailable

" - } - ], - "previews": [] - } - ], - "collaborators": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators", - "title": "List project collaborators", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "affiliation", - "description": "

Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Add project collaborator", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "description": "

The permission to grant the collaborator.

", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write" - } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Applying write permissions for the new collaborator", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "permission": "write" - }, - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Remove user as a collaborator", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "title": "Get project permission for a user", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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 - } - }, - "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "permission", - "user" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [] - } - ], - "columns": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/columns/{column_id}", - "title": "Get a project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "column_id": "COLUMN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "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" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "cards_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "Name of the project column", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/projects/columns/{column_id}", - "title": "Update an existing project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

Name of the project column

", - "isRequired": true - } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Rename the project column", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "To Do" - }, - "parameters": { - "column_id": "COLUMN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "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" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "cards_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "Name of the project column", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/columns/{column_id}", - "title": "Delete a project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "column_id": "COLUMN_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/columns/{column_id}/moves", - "title": "Move a project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "position", - "description": "

The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

", - "isRequired": true - } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Move the column to the end of the board", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "position": "last" - }, - "parameters": { - "column_id": "COLUMN_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": null, - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}/columns", - "title": "List project columns", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "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" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "cards_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "Name of the project column", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/{project_id}/columns", - "title": "Create a project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

Name of the project column

", - "isRequired": true - } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Remaining tasks" - }, - "parameters": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "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" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "cards_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "Name of the project column", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [] - } - ], - "projects": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/projects", - "title": "List organization projects", - "category": "projects-classic", - "subcategory": "projects", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "

Indicates the state of the projects to return.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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": true - } - ], - "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" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "columns_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "Name of the project", - "type": "string" - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string" - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/projects", - "title": "Create an organization project", - "category": "projects-classic", - "subcategory": "projects", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the project.

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

The description of the project.

" - } - ], - "descriptionHTML": "

Creates an organization project board. Returns a 410 Gone status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year." - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - }, - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "columns_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "Name of the project", - "type": "string" - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string" - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}", - "title": "Get a project", - "category": "projects-classic", - "subcategory": "projects", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - }, - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "columns_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "Name of the project", - "type": "string" - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string" - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/projects/{project_id}", - "title": "Update a project", - "category": "projects-classic", - "subcategory": "projects", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

Name of the project

" - }, - { - "type": "string or null", - "name": "body", - "description": "

Body of the project

" - }, - { - "type": "string", - "name": "state", - "description": "

State of the project; either 'open' or 'closed'

" - }, - { - "type": "string", - "name": "organization_permission", - "description": "

The baseline permission that all organization members have on this project

", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether or not this project can be seen by everyone.

" - } - ], - "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.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Change the name, state, and permissions for a project", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Week One Sprint", - "state": "open", - "organization_permission": "write" - }, - "parameters": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - }, - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "columns_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "Name of the project", - "type": "string" - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string" - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found if the authenticated user does not have access to the project

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/{project_id}", - "title": "Delete a project", - "category": "projects-classic", - "subcategory": "projects", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a project board. Returns a 404 Not Found status if projects are disabled.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Delete Success

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Delete Success

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/projects", - "title": "List repository projects", - "category": "projects-classic", - "subcategory": "projects", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "

Indicates the state of the projects to return.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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" - } - ], - "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" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "columns_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "Name of the project", - "type": "string" - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string" - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/projects", - "title": "Create a repository project", - "category": "projects-classic", - "subcategory": "projects", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the project.

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

The description of the project.

" - } - ], - "descriptionHTML": "

Creates a repository project board. Returns a 410 Gone status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site." - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - }, - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "columns_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "Name of the project", - "type": "string" - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string" - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/user/projects", - "title": "Create a user project", - "category": "projects-classic", - "subcategory": "projects", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

Name of the project

", - "isRequired": true - }, - { - "type": "string or null", - "name": "body", - "description": "

Body of the project

" - } - ], - "descriptionHTML": "

Creates a user project board. Returns a 410 Gone status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Create a new project", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "My Projects", - "body": "A board to manage my personal projects." - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "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" - }, - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "columns_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "Name of the project", - "type": "string" - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string" - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/projects", - "title": "List user projects", - "category": "projects-classic", - "subcategory": "projects", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "

Indicates the state of the projects to return.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "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" - } - ], - "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" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "columns_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "Name of the project", - "type": "string" - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string" - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [] - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/pulls.json b/src/rest/data/ghes-3.14-2022-11-28/pulls.json deleted file mode 100644 index 97ce2fc6d9c2..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/pulls.json +++ /dev/null @@ -1,30115 +0,0 @@ -{ - "pulls": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls", - "title": "List pull requests", - "category": "pulls", - "subcategory": "pulls", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "

Either open, closed, or all to filter by state.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "name": "head", - "description": "

Filter pulls by head user or head organization and branch name in the format of user:ref-name or organization:ref-name. For example: github:new-script-format or octocat:test-branch.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "base", - "description": "

Filter pulls by base branch name. Example: gh-pages.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "

What to sort results by. popularity will sort by the number of comments. long-running will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "popularity", - "long-running" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "

The direction of the sort. Default: desc when sort is created or sort is not specified, otherwise asc.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ] - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists pull requests in a specified repository.

\n

Draft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see GitHub's products\nin the GitHub Help documentation.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "id": 1, - "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", - "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", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", - "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", - "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "number": 1347, - "state": "open", - "locked": true, - "title": "Amazing new feature", - "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 - }, - "body": "Please pull these awesome changes in!", - "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 - } - ], - "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" - }, - "active_lock_reason": "too heated", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:01:12Z", - "closed_at": "2011-01-26T19:01:12Z", - "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "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 - }, - { - "login": "hubot", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/hubot_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/hubot", - "html_url": "https://github.com/hubot", - "followers_url": "https://api.github.com/users/hubot/followers", - "following_url": "https://api.github.com/users/hubot/following{/other_user}", - "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", - "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", - "organizations_url": "https://api.github.com/users/hubot/orgs", - "repos_url": "https://api.github.com/users/hubot/repos", - "events_url": "https://api.github.com/users/hubot/events{/privacy}", - "received_events_url": "https://api.github.com/users/hubot/received_events", - "type": "User", - "site_admin": true - } - ], - "requested_reviewers": [ - { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false - } - ], - "requested_teams": [ - { - "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", - "notification_setting": "notifications_enabled", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "head": { - "label": "octocat:new-topic", - "ref": "new-topic", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "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 - }, - "repo": { - "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, - "allow_auto_merge": false, - "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 - } - }, - "base": { - "label": "octocat:master", - "ref": "master", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "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 - }, - "repo": { - "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, - "allow_auto_merge": false, - "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 - } - }, - "_links": { - "self": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" - }, - "html": { - "href": "https://github.com/octocat/Hello-World/pull/1347" - }, - "issue": { - "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - }, - "comments": { - "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" - }, - "review_comments": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" - }, - "review_comment": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" - }, - "commits": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" - }, - "statuses": { - "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" - } - }, - "author_association": "OWNER", - "auto_merge": null, - "draft": false - } - ], - "schema": { - "type": "array", - "items": { - "title": "Pull Request Simple", - "description": "Pull Request Simple", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls", - "title": "Create a pull request", - "category": "pulls", - "subcategory": "pulls", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "title", - "description": "

The title of the new pull request. Required unless issue is specified.

" - }, - { - "type": "string", - "name": "head", - "description": "

The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

", - "isRequired": true - }, - { - "type": "string", - "name": "head_repo", - "description": "

The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization.

" - }, - { - "type": "string", - "name": "base", - "description": "

The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

The contents of the pull request.

" - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

" - }, - { - "type": "integer", - "name": "issue", - "description": "

An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.

" - } - ], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "title": "Amazing new feature", - "body": "Please pull these awesome changes in!", - "head": "octocat:new-feature", - "base": "master" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "id": 1, - "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", - "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", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", - "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", - "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "number": 1347, - "state": "open", - "locked": true, - "title": "Amazing new feature", - "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 - }, - "body": "Please pull these awesome changes in!", - "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 - } - ], - "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" - }, - "active_lock_reason": "too heated", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:01:12Z", - "closed_at": "2011-01-26T19:01:12Z", - "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "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 - }, - { - "login": "hubot", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/hubot_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/hubot", - "html_url": "https://github.com/hubot", - "followers_url": "https://api.github.com/users/hubot/followers", - "following_url": "https://api.github.com/users/hubot/following{/other_user}", - "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", - "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", - "organizations_url": "https://api.github.com/users/hubot/orgs", - "repos_url": "https://api.github.com/users/hubot/repos", - "events_url": "https://api.github.com/users/hubot/events{/privacy}", - "received_events_url": "https://api.github.com/users/hubot/received_events", - "type": "User", - "site_admin": true - } - ], - "requested_reviewers": [ - { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false - } - ], - "requested_teams": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos" - } - ], - "head": { - "label": "octocat:new-topic", - "ref": "new-topic", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "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 - }, - "repo": { - "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, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "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, - "allow_merge_commit": true, - "allow_forking": true, - "forks": 123, - "open_issues": 123, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - "watchers": 123 - } - }, - "base": { - "label": "octocat:master", - "ref": "master", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "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 - }, - "repo": { - "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, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "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, - "allow_merge_commit": true, - "forks": 123, - "open_issues": 123, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - "watchers": 123 - } - }, - "_links": { - "self": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" - }, - "html": { - "href": "https://github.com/octocat/Hello-World/pull/1347" - }, - "issue": { - "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - }, - "comments": { - "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" - }, - "review_comments": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" - }, - "review_comment": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" - }, - "commits": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" - }, - "statuses": { - "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" - } - }, - "author_association": "OWNER", - "auto_merge": null, - "draft": false, - "merged": false, - "mergeable": true, - "rebaseable": true, - "mergeable_state": "clean", - "merged_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 - }, - "comments": 10, - "review_comments": 0, - "maintainer_can_modify": true, - "commits": 3, - "additions": 100, - "deletions": 3, - "changed_files": 5 - }, - "schema": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "title": "Get a pull request", - "category": "pulls", - "subcategory": "pulls", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
    • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
    • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
    • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Pass the appropriate media type to fetch diff and patch formats.

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "id": 1, - "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", - "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", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", - "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", - "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "number": 1347, - "state": "open", - "locked": true, - "title": "Amazing new feature", - "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 - }, - "body": "Please pull these awesome changes in!", - "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 - } - ], - "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" - }, - "active_lock_reason": "too heated", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:01:12Z", - "closed_at": "2011-01-26T19:01:12Z", - "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "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 - }, - { - "login": "hubot", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/hubot_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/hubot", - "html_url": "https://github.com/hubot", - "followers_url": "https://api.github.com/users/hubot/followers", - "following_url": "https://api.github.com/users/hubot/following{/other_user}", - "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", - "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", - "organizations_url": "https://api.github.com/users/hubot/orgs", - "repos_url": "https://api.github.com/users/hubot/repos", - "events_url": "https://api.github.com/users/hubot/events{/privacy}", - "received_events_url": "https://api.github.com/users/hubot/received_events", - "type": "User", - "site_admin": true - } - ], - "requested_reviewers": [ - { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false - } - ], - "requested_teams": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos" - } - ], - "head": { - "label": "octocat:new-topic", - "ref": "new-topic", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "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 - }, - "repo": { - "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, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "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, - "allow_merge_commit": true, - "allow_forking": true, - "forks": 123, - "open_issues": 123, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - "watchers": 123 - } - }, - "base": { - "label": "octocat:master", - "ref": "master", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "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 - }, - "repo": { - "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, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "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, - "allow_merge_commit": true, - "forks": 123, - "open_issues": 123, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - "watchers": 123 - } - }, - "_links": { - "self": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" - }, - "html": { - "href": "https://github.com/octocat/Hello-World/pull/1347" - }, - "issue": { - "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - }, - "comments": { - "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" - }, - "review_comments": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" - }, - "review_comment": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" - }, - "commits": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" - }, - "statuses": { - "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" - } - }, - "author_association": "OWNER", - "auto_merge": null, - "draft": false, - "merged": false, - "mergeable": true, - "rebaseable": true, - "mergeable_state": "clean", - "merged_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 - }, - "comments": 10, - "review_comments": 0, - "maintainer_can_modify": true, - "commits": 3, - "additions": 100, - "deletions": 3, - "changed_files": 5 - }, - "schema": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Pass the appropriate media type to fetch diff and patch formats.

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "406", - "description": "

Unacceptable

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "read" - }, - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", - "title": "Update a pull request", - "category": "pulls", - "subcategory": "pulls", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

" - }, - { - "type": "string", - "name": "body", - "description": "

The contents of the pull request.

" - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "base", - "description": "

The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

" - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" - } - ], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "title": "new title", - "body": "updated body", - "state": "open", - "base": "master" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "id": 1, - "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", - "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", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", - "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", - "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "number": 1347, - "state": "open", - "locked": true, - "title": "Amazing new feature", - "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 - }, - "body": "Please pull these awesome changes in!", - "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 - } - ], - "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" - }, - "active_lock_reason": "too heated", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:01:12Z", - "closed_at": "2011-01-26T19:01:12Z", - "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "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 - }, - { - "login": "hubot", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/hubot_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/hubot", - "html_url": "https://github.com/hubot", - "followers_url": "https://api.github.com/users/hubot/followers", - "following_url": "https://api.github.com/users/hubot/following{/other_user}", - "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", - "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", - "organizations_url": "https://api.github.com/users/hubot/orgs", - "repos_url": "https://api.github.com/users/hubot/repos", - "events_url": "https://api.github.com/users/hubot/events{/privacy}", - "received_events_url": "https://api.github.com/users/hubot/received_events", - "type": "User", - "site_admin": true - } - ], - "requested_reviewers": [ - { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false - } - ], - "requested_teams": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos" - } - ], - "head": { - "label": "octocat:new-topic", - "ref": "new-topic", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "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 - }, - "repo": { - "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, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "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, - "allow_merge_commit": true, - "allow_forking": true, - "forks": 123, - "open_issues": 123, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - "watchers": 123 - } - }, - "base": { - "label": "octocat:master", - "ref": "master", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "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 - }, - "repo": { - "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, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "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, - "allow_merge_commit": true, - "forks": 123, - "open_issues": 123, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - "watchers": 123 - } - }, - "_links": { - "self": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" - }, - "html": { - "href": "https://github.com/octocat/Hello-World/pull/1347" - }, - "issue": { - "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - }, - "comments": { - "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" - }, - "review_comments": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" - }, - "review_comment": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" - }, - "commits": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" - }, - "statuses": { - "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" - } - }, - "author_association": "OWNER", - "auto_merge": null, - "draft": false, - "merged": false, - "mergeable": true, - "rebaseable": true, - "mergeable_state": "clean", - "merged_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 - }, - "comments": 10, - "review_comments": 0, - "maintainer_can_modify": true, - "commits": 3, - "additions": 100, - "deletions": 3, - "changed_files": 5 - }, - "schema": { - "type": "object", - "title": "Pull Request", - "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "merged": { - "type": "boolean" - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "review_comments": { - "type": "integer" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "commits": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changed_files": { - "type": "integer" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge", - "additions", - "changed_files", - "comments", - "commits", - "deletions", - "mergeable", - "mergeable_state", - "merged", - "maintainer_can_modify", - "merged_by", - "review_comments" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", - "title": "List commits on a pull request", - "category": "pulls", - "subcategory": "pulls", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", - "commit": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "author": { - "name": "Monalisa Octocat", - "email": "support@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "committer": { - "name": "Monalisa Octocat", - "email": "support@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "message": "Fix all the bugs", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" - }, - "comment_count": 0, - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null - } - }, - "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 - }, - "committer": { - "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 - }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "title": "Commit", - "description": "Commit", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "commit": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "message": { - "type": "string" - }, - "comment_count": { - "type": "integer" - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - }, - "verification": { - "title": "Verification", - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "payload": { - "type": [ - "string", - "null" - ] - }, - "signature": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] - }, - "author": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - ], - "type": [ - "null", - "object" - ] - }, - "committer": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - ], - "type": [ - "null", - "object" - ] - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - } - }, - "stats": { - "type": "object", - "properties": { - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": [ - "string", - "null" - ] - }, - "filename": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ] - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changes": { - "type": "integer" - }, - "blob_url": { - "type": "string", - "format": "uri" - }, - "raw_url": { - "type": "string", - "format": "uri" - }, - "contents_url": { - "type": "string", - "format": "uri" - }, - "patch": { - "type": "string" - }, - "previous_filename": { - "type": "string" - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] - } - } - }, - "required": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/files", - "title": "List pull requests files", - "category": "pulls", - "subcategory": "pulls", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the files in a specified pull request.

\n

Note

\n

\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

\n
\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "sha": "bbcd538c8e72b8c175046e27cc8f907076331401", - "filename": "file1.txt", - "status": "added", - "additions": 103, - "deletions": 21, - "changes": 124, - "blob_url": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", - "raw_url": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "patch": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": [ - "string", - "null" - ] - }, - "filename": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ] - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "changes": { - "type": "integer" - }, - "blob_url": { - "type": "string", - "format": "uri" - }, - "raw_url": { - "type": "string", - "format": "uri" - }, - "contents_url": { - "type": "string", - "format": "uri" - }, - "patch": { - "type": "string" - }, - "previous_filename": { - "type": "string" - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "title": "Check if a pull request has been merged", - "category": "pulls", - "subcategory": "pulls", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER" - } - }, - "response": { - "statusCode": "204", - "description": "

Response if pull request has been merged

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Response if pull request has been merged

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found if pull request has not been merged

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "title": "Merge a pull request", - "category": "pulls", - "subcategory": "pulls", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "commit_title", - "description": "

Title for the automatic commit message.

" - }, - { - "type": "string", - "name": "commit_message", - "description": "

Extra detail to append to automatic commit message.

" - }, - { - "type": "string", - "name": "sha", - "description": "

SHA that pull request head must match to allow merge.

" - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ], - "descriptionHTML": "

Merges a pull request into the base branch.\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "commit_title": "Expand enum", - "commit_message": "Add a new value to the merge_method enum" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

if merge was successful

", - "example": { - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "merged": true, - "message": "Pull Request successfully merged" - }, - "schema": { - "title": "Pull Request Merge Result", - "description": "Pull Request Merge Result", - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "merged": { - "type": "boolean" - }, - "message": { - "type": "string" - } - }, - "required": [ - "merged", - "message", - "sha" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

if merge was successful

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "405", - "description": "

Method Not Allowed if merge cannot be performed

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict if sha was provided and pull request head did not match

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", - "title": "Update a pull request branch", - "category": "pulls", - "subcategory": "pulls", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "expected_head_sha", - "description": "

The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

" - } - ], - "descriptionHTML": "

Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.\nNote: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Response

", - "example": { - "message": "Updating pull request branch.", - "url": "https://github.com/repos/octocat/Hello-World/pulls/53" - }, - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "url": { - "type": "string" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - } - ], - "comments": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/comments", - "title": "List review comments in a repository", - "category": "pulls", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "created_at" - ] - }, - "description": "" - }, - { - "name": "direction", - "description": "

The direction to sort results. Ignored without sort parameter.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ] - } - }, - { - "name": "since", - "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", - "pull_request_review_id": 42, - "id": 10, - "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", - "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", - "path": "file1.txt", - "position": 1, - "original_position": 4, - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", - "in_reply_to_id": 8, - "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 - }, - "body": "Great stuff!", - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", - "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", - "author_association": "NONE", - "_links": { - "self": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" - }, - "html": { - "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" - }, - "pull_request": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" - } - }, - "start_line": 1, - "original_start_line": 1, - "start_side": "RIGHT", - "line": 2, - "original_line": 2, - "side": "RIGHT" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Pull Request Review Comment", - "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.", - "type": "object", - "properties": { - "url": { - "description": "URL for the pull request review comment", - "type": "string" - }, - "pull_request_review_id": { - "description": "The ID of the pull request review to which the comment belongs.", - "type": [ - "integer", - "null" - ], - "format": "int64" - }, - "id": { - "description": "The ID of the pull request review comment.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "description": "The node ID of the pull request review comment.", - "type": "string" - }, - "diff_hunk": { - "description": "The diff of the line that the comment refers to.", - "type": "string" - }, - "path": { - "description": "The relative path of the file to which the comment applies.", - "type": "string" - }, - "position": { - "description": "The line index in the diff to which the comment applies. This field is closing down; use `line` instead.", - "type": "integer" - }, - "original_position": { - "description": "The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.", - "type": "integer" - }, - "commit_id": { - "description": "The SHA of the commit to which the comment applies.", - "type": "string" - }, - "original_commit_id": { - "description": "The SHA of the original commit to which the comment applies.", - "type": "string" - }, - "in_reply_to_id": { - "description": "The comment ID to reply to.", - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "description": "The text of the comment.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "description": "HTML URL for the pull request review comment.", - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "description": "URL for the pull request that the review comment belongs to.", - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - }, - "html": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "start_line": { - "type": [ - "integer", - "null" - ], - "description": "The first line of the range for a multi-line comment." - }, - "original_start_line": { - "type": [ - "integer", - "null" - ], - "description": "The first line of the range for a multi-line comment." - }, - "start_side": { - "type": [ - "string", - "null" - ], - "description": "The side of the first line of the range for a multi-line comment.", - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - "line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "original_line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "side": { - "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", - "enum": [ - "LEFT", - "RIGHT" - ], - "default": "RIGHT", - "type": "string" - }, - "subject_type": { - "description": "The level at which the comment is targeted, can be a diff line or a file.", - "type": "string", - "enum": [ - "line", - "file" - ] - }, - "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" - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - } - }, - "required": [ - "url", - "id", - "node_id", - "pull_request_review_id", - "diff_hunk", - "path", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "author_association", - "_links" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "title": "Get a review comment for a pull request", - "category": "pulls", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Provides details for a specified review comment.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", - "pull_request_review_id": 42, - "id": 10, - "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", - "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", - "path": "file1.txt", - "position": 1, - "original_position": 4, - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", - "in_reply_to_id": 8, - "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 - }, - "body": "Great stuff!", - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", - "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", - "author_association": "NONE", - "_links": { - "self": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" - }, - "html": { - "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" - }, - "pull_request": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" - } - }, - "start_line": 1, - "original_start_line": 1, - "start_side": "RIGHT", - "line": 2, - "original_line": 2, - "side": "RIGHT" - }, - "schema": { - "title": "Pull Request Review Comment", - "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.", - "type": "object", - "properties": { - "url": { - "description": "URL for the pull request review comment", - "type": "string" - }, - "pull_request_review_id": { - "description": "The ID of the pull request review to which the comment belongs.", - "type": [ - "integer", - "null" - ], - "format": "int64" - }, - "id": { - "description": "The ID of the pull request review comment.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "description": "The node ID of the pull request review comment.", - "type": "string" - }, - "diff_hunk": { - "description": "The diff of the line that the comment refers to.", - "type": "string" - }, - "path": { - "description": "The relative path of the file to which the comment applies.", - "type": "string" - }, - "position": { - "description": "The line index in the diff to which the comment applies. This field is closing down; use `line` instead.", - "type": "integer" - }, - "original_position": { - "description": "The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.", - "type": "integer" - }, - "commit_id": { - "description": "The SHA of the commit to which the comment applies.", - "type": "string" - }, - "original_commit_id": { - "description": "The SHA of the original commit to which the comment applies.", - "type": "string" - }, - "in_reply_to_id": { - "description": "The comment ID to reply to.", - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "description": "The text of the comment.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "description": "HTML URL for the pull request review comment.", - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "description": "URL for the pull request that the review comment belongs to.", - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - }, - "html": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "start_line": { - "type": [ - "integer", - "null" - ], - "description": "The first line of the range for a multi-line comment." - }, - "original_start_line": { - "type": [ - "integer", - "null" - ], - "description": "The first line of the range for a multi-line comment." - }, - "start_side": { - "type": [ - "string", - "null" - ], - "description": "The side of the first line of the range for a multi-line comment.", - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - "line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "original_line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "side": { - "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", - "enum": [ - "LEFT", - "RIGHT" - ], - "default": "RIGHT", - "type": "string" - }, - "subject_type": { - "description": "The level at which the comment is targeted, can be a diff line or a file.", - "type": "string", - "enum": [ - "line", - "file" - ] - }, - "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" - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - } - }, - "required": [ - "url", - "id", - "node_id", - "pull_request_review_id", - "diff_hunk", - "path", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "author_association", - "_links" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "title": "Update a review comment for a pull request", - "category": "pulls", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "body", - "description": "

The text of the reply to the review comment.

", - "isRequired": true - } - ], - "descriptionHTML": "

Edits the content of a specified review comment.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "body": "I like this too!" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", - "pull_request_review_id": 42, - "id": 10, - "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", - "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", - "path": "file1.txt", - "position": 1, - "original_position": 4, - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", - "in_reply_to_id": 8, - "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 - }, - "body": "Great stuff!", - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", - "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", - "author_association": "NONE", - "_links": { - "self": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" - }, - "html": { - "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" - }, - "pull_request": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" - } - }, - "start_line": 1, - "original_start_line": 1, - "start_side": "RIGHT", - "line": 2, - "original_line": 2, - "side": "RIGHT" - }, - "schema": { - "title": "Pull Request Review Comment", - "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.", - "type": "object", - "properties": { - "url": { - "description": "URL for the pull request review comment", - "type": "string" - }, - "pull_request_review_id": { - "description": "The ID of the pull request review to which the comment belongs.", - "type": [ - "integer", - "null" - ], - "format": "int64" - }, - "id": { - "description": "The ID of the pull request review comment.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "description": "The node ID of the pull request review comment.", - "type": "string" - }, - "diff_hunk": { - "description": "The diff of the line that the comment refers to.", - "type": "string" - }, - "path": { - "description": "The relative path of the file to which the comment applies.", - "type": "string" - }, - "position": { - "description": "The line index in the diff to which the comment applies. This field is closing down; use `line` instead.", - "type": "integer" - }, - "original_position": { - "description": "The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.", - "type": "integer" - }, - "commit_id": { - "description": "The SHA of the commit to which the comment applies.", - "type": "string" - }, - "original_commit_id": { - "description": "The SHA of the original commit to which the comment applies.", - "type": "string" - }, - "in_reply_to_id": { - "description": "The comment ID to reply to.", - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "description": "The text of the comment.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "description": "HTML URL for the pull request review comment.", - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "description": "URL for the pull request that the review comment belongs to.", - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - }, - "html": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "start_line": { - "type": [ - "integer", - "null" - ], - "description": "The first line of the range for a multi-line comment." - }, - "original_start_line": { - "type": [ - "integer", - "null" - ], - "description": "The first line of the range for a multi-line comment." - }, - "start_side": { - "type": [ - "string", - "null" - ], - "description": "The side of the first line of the range for a multi-line comment.", - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - "line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "original_line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "side": { - "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", - "enum": [ - "LEFT", - "RIGHT" - ], - "default": "RIGHT", - "type": "string" - }, - "subject_type": { - "description": "The level at which the comment is targeted, can be a diff line or a file.", - "type": "string", - "enum": [ - "line", - "file" - ] - }, - "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" - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - } - }, - "required": [ - "url", - "id", - "node_id", - "pull_request_review_id", - "diff_hunk", - "path", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "author_association", - "_links" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "title": "Delete a review comment for a pull request", - "category": "pulls", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a review comment.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "title": "List review comments on a pull request", - "category": "pulls", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "sort", - "description": "

The property to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "

The direction to sort results. Ignored without sort parameter.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ] - } - }, - { - "name": "since", - "description": "

Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", - "pull_request_review_id": 42, - "id": 10, - "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", - "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", - "path": "file1.txt", - "position": 1, - "original_position": 4, - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", - "in_reply_to_id": 8, - "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 - }, - "body": "Great stuff!", - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", - "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", - "author_association": "NONE", - "_links": { - "self": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" - }, - "html": { - "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" - }, - "pull_request": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" - } - }, - "start_line": 1, - "original_start_line": 1, - "start_side": "RIGHT", - "line": 2, - "original_line": 2, - "side": "RIGHT" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Pull Request Review Comment", - "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.", - "type": "object", - "properties": { - "url": { - "description": "URL for the pull request review comment", - "type": "string" - }, - "pull_request_review_id": { - "description": "The ID of the pull request review to which the comment belongs.", - "type": [ - "integer", - "null" - ], - "format": "int64" - }, - "id": { - "description": "The ID of the pull request review comment.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "description": "The node ID of the pull request review comment.", - "type": "string" - }, - "diff_hunk": { - "description": "The diff of the line that the comment refers to.", - "type": "string" - }, - "path": { - "description": "The relative path of the file to which the comment applies.", - "type": "string" - }, - "position": { - "description": "The line index in the diff to which the comment applies. This field is closing down; use `line` instead.", - "type": "integer" - }, - "original_position": { - "description": "The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.", - "type": "integer" - }, - "commit_id": { - "description": "The SHA of the commit to which the comment applies.", - "type": "string" - }, - "original_commit_id": { - "description": "The SHA of the original commit to which the comment applies.", - "type": "string" - }, - "in_reply_to_id": { - "description": "The comment ID to reply to.", - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "description": "The text of the comment.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "description": "HTML URL for the pull request review comment.", - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "description": "URL for the pull request that the review comment belongs to.", - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - }, - "html": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "start_line": { - "type": [ - "integer", - "null" - ], - "description": "The first line of the range for a multi-line comment." - }, - "original_start_line": { - "type": [ - "integer", - "null" - ], - "description": "The first line of the range for a multi-line comment." - }, - "start_side": { - "type": [ - "string", - "null" - ], - "description": "The side of the first line of the range for a multi-line comment.", - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - "line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "original_line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "side": { - "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", - "enum": [ - "LEFT", - "RIGHT" - ], - "default": "RIGHT", - "type": "string" - }, - "subject_type": { - "description": "The level at which the comment is targeted, can be a diff line or a file.", - "type": "string", - "enum": [ - "line", - "file" - ] - }, - "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" - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - } - }, - "required": [ - "url", - "id", - "node_id", - "pull_request_review_id", - "diff_hunk", - "path", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "author_association", - "_links" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "title": "Create a review comment for a pull request", - "category": "pulls", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "body", - "description": "

The text of the review comment.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "

The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "

The relative path to the file that necessitates a comment.

", - "isRequired": true - }, - { - "type": "integer", - "name": "position", - "description": "

This parameter is closing down. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

" - }, - { - "type": "string", - "name": "side", - "description": "

In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

", - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer", - "name": "line", - "description": "

Required unless using subject_type:file. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

" - }, - { - "type": "integer", - "name": "start_line", - "description": "

Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

" - }, - { - "type": "string", - "name": "start_side", - "description": "

Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

", - "enum": [ - "LEFT", - "RIGHT", - "side" - ] - }, - { - "type": "integer", - "name": "in_reply_to", - "description": "

The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

" - }, - { - "type": "string", - "name": "subject_type", - "description": "

The level at which the comment is targeted.

", - "enum": [ - "line", - "file" - ] - } - ], - "descriptionHTML": "

Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"

\n

If your comment applies to more than one line in the pull request diff, you should use the parameters line, side, and optionally start_line and start_side in your request.

\n

The position parameter is closing down. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example for a multi-line comment", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "body": "Great stuff!", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "path": "file1.txt", - "start_line": 1, - "start_side": "RIGHT", - "line": 2, - "side": "RIGHT" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", - "pull_request_review_id": 42, - "id": 10, - "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", - "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", - "path": "file1.txt", - "position": 1, - "original_position": 4, - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", - "in_reply_to_id": 8, - "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 - }, - "body": "Great stuff!", - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", - "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", - "author_association": "NONE", - "_links": { - "self": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" - }, - "html": { - "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" - }, - "pull_request": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" - } - }, - "start_line": 1, - "original_start_line": 1, - "start_side": "RIGHT", - "line": 2, - "original_line": 2, - "side": "RIGHT" - }, - "schema": { - "title": "Pull Request Review Comment", - "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.", - "type": "object", - "properties": { - "url": { - "description": "URL for the pull request review comment", - "type": "string" - }, - "pull_request_review_id": { - "description": "The ID of the pull request review to which the comment belongs.", - "type": [ - "integer", - "null" - ], - "format": "int64" - }, - "id": { - "description": "The ID of the pull request review comment.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "description": "The node ID of the pull request review comment.", - "type": "string" - }, - "diff_hunk": { - "description": "The diff of the line that the comment refers to.", - "type": "string" - }, - "path": { - "description": "The relative path of the file to which the comment applies.", - "type": "string" - }, - "position": { - "description": "The line index in the diff to which the comment applies. This field is closing down; use `line` instead.", - "type": "integer" - }, - "original_position": { - "description": "The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.", - "type": "integer" - }, - "commit_id": { - "description": "The SHA of the commit to which the comment applies.", - "type": "string" - }, - "original_commit_id": { - "description": "The SHA of the original commit to which the comment applies.", - "type": "string" - }, - "in_reply_to_id": { - "description": "The comment ID to reply to.", - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "description": "The text of the comment.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "description": "HTML URL for the pull request review comment.", - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "description": "URL for the pull request that the review comment belongs to.", - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - }, - "html": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "start_line": { - "type": [ - "integer", - "null" - ], - "description": "The first line of the range for a multi-line comment." - }, - "original_start_line": { - "type": [ - "integer", - "null" - ], - "description": "The first line of the range for a multi-line comment." - }, - "start_side": { - "type": [ - "string", - "null" - ], - "description": "The side of the first line of the range for a multi-line comment.", - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - "line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "original_line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "side": { - "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", - "enum": [ - "LEFT", - "RIGHT" - ], - "default": "RIGHT", - "type": "string" - }, - "subject_type": { - "description": "The level at which the comment is targeted, can be a diff line or a file.", - "type": "string", - "enum": [ - "line", - "file" - ] - }, - "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" - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - } - }, - "required": [ - "url", - "id", - "node_id", - "pull_request_review_id", - "diff_hunk", - "path", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "author_association", - "_links" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", - "title": "Create a reply for a review comment", - "category": "pulls", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "body", - "description": "

The text of the review comment.

", - "isRequired": true - } - ], - "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "body": "Great stuff!" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", - "pull_request_review_id": 42, - "id": 10, - "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", - "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", - "path": "file1.txt", - "position": 1, - "original_position": 4, - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", - "in_reply_to_id": 426899381, - "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 - }, - "body": "Great stuff!", - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", - "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", - "author_association": "NONE", - "_links": { - "self": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" - }, - "html": { - "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" - }, - "pull_request": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" - } - }, - "start_line": 1, - "original_start_line": 1, - "start_side": "RIGHT", - "line": 2, - "original_line": 2, - "side": "RIGHT" - }, - "schema": { - "title": "Pull Request Review Comment", - "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.", - "type": "object", - "properties": { - "url": { - "description": "URL for the pull request review comment", - "type": "string" - }, - "pull_request_review_id": { - "description": "The ID of the pull request review to which the comment belongs.", - "type": [ - "integer", - "null" - ], - "format": "int64" - }, - "id": { - "description": "The ID of the pull request review comment.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "description": "The node ID of the pull request review comment.", - "type": "string" - }, - "diff_hunk": { - "description": "The diff of the line that the comment refers to.", - "type": "string" - }, - "path": { - "description": "The relative path of the file to which the comment applies.", - "type": "string" - }, - "position": { - "description": "The line index in the diff to which the comment applies. This field is closing down; use `line` instead.", - "type": "integer" - }, - "original_position": { - "description": "The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.", - "type": "integer" - }, - "commit_id": { - "description": "The SHA of the commit to which the comment applies.", - "type": "string" - }, - "original_commit_id": { - "description": "The SHA of the original commit to which the comment applies.", - "type": "string" - }, - "in_reply_to_id": { - "description": "The comment ID to reply to.", - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "description": "The text of the comment.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "description": "HTML URL for the pull request review comment.", - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "description": "URL for the pull request that the review comment belongs to.", - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - }, - "html": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "start_line": { - "type": [ - "integer", - "null" - ], - "description": "The first line of the range for a multi-line comment." - }, - "original_start_line": { - "type": [ - "integer", - "null" - ], - "description": "The first line of the range for a multi-line comment." - }, - "start_side": { - "type": [ - "string", - "null" - ], - "description": "The side of the first line of the range for a multi-line comment.", - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - "line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "original_line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "side": { - "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", - "enum": [ - "LEFT", - "RIGHT" - ], - "default": "RIGHT", - "type": "string" - }, - "subject_type": { - "description": "The level at which the comment is targeted, can be a diff line or a file.", - "type": "string", - "enum": [ - "line", - "file" - ] - }, - "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" - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - } - }, - "required": [ - "url", - "id", - "node_id", - "pull_request_review_id", - "diff_hunk", - "path", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "author_association", - "_links" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - } - ], - "review-requests": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "title": "Get all requested reviewers for a pull request", - "category": "pulls", - "subcategory": "review-requests", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "users": [ - { - "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 - } - ], - "teams": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ] - }, - "schema": { - "title": "Pull Request Review Request", - "description": "Pull Request Review Request", - "type": "object", - "properties": { - "users": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "teams": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - } - }, - "required": [ - "users", - "teams" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "title": "Request reviewers for a pull request", - "category": "pulls", - "subcategory": "review-requests", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "reviewers", - "description": "

An array of user logins that will be requested.

" - }, - { - "type": "array of strings", - "name": "team_reviewers", - "description": "

An array of team slugs that will be requested.

" - } - ], - "descriptionHTML": "

Requests reviews for a pull request from a given set of users and/or teams.\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "reviewers": [ - "octocat", - "hubot", - "other_user" - ], - "team_reviewers": [ - "justice-league" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "id": 1, - "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", - "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", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", - "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", - "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "number": 1347, - "state": "open", - "locked": true, - "title": "Amazing new feature", - "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 - }, - "body": "Please pull these awesome changes in!", - "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 - } - ], - "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" - }, - "active_lock_reason": "too heated", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:01:12Z", - "closed_at": "2011-01-26T19:01:12Z", - "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "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 - }, - { - "login": "hubot", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/hubot_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/hubot", - "html_url": "https://github.com/hubot", - "followers_url": "https://api.github.com/users/hubot/followers", - "following_url": "https://api.github.com/users/hubot/following{/other_user}", - "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", - "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", - "organizations_url": "https://api.github.com/users/hubot/orgs", - "repos_url": "https://api.github.com/users/hubot/repos", - "events_url": "https://api.github.com/users/hubot/events{/privacy}", - "received_events_url": "https://api.github.com/users/hubot/received_events", - "type": "User", - "site_admin": true - } - ], - "requested_reviewers": [ - { - "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 - }, - { - "login": "hubot", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/hubot_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/hubot", - "html_url": "https://github.com/hubot", - "followers_url": "https://api.github.com/users/hubot/followers", - "following_url": "https://api.github.com/users/hubot/following{/other_user}", - "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", - "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", - "organizations_url": "https://api.github.com/users/hubot/orgs", - "repos_url": "https://api.github.com/users/hubot/repos", - "events_url": "https://api.github.com/users/hubot/events{/privacy}", - "received_events_url": "https://api.github.com/users/hubot/received_events", - "type": "User", - "site_admin": true - }, - { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false - } - ], - "requested_teams": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "head": { - "label": "octocat:new-topic", - "ref": "new-topic", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "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 - }, - "repo": { - "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, - "allow_auto_merge": false, - "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 - } - }, - "base": { - "label": "octocat:master", - "ref": "master", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "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 - }, - "repo": { - "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, - "allow_auto_merge": false, - "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 - } - }, - "_links": { - "self": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" - }, - "html": { - "href": "https://github.com/octocat/Hello-World/pull/1347" - }, - "issue": { - "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - }, - "comments": { - "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" - }, - "review_comments": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" - }, - "review_comment": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" - }, - "commits": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" - }, - "statuses": { - "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" - } - }, - "author_association": "OWNER", - "auto_merge": null, - "draft": false - }, - "schema": { - "title": "Pull Request Simple", - "description": "Pull Request Simple", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Unprocessable Entity if user is not a collaborator

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "title": "Remove requested reviewers from a pull request", - "category": "pulls", - "subcategory": "review-requests", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "reviewers", - "description": "

An array of user logins that will be removed.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "team_reviewers", - "description": "

An array of team slugs that will be removed.

" - } - ], - "descriptionHTML": "

Removes review requests from a pull request for a given set of users and/or teams.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "reviewers": [ - "octocat", - "hubot", - "other_user" - ], - "team_reviewers": [ - "justice-league" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "id": 1, - "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", - "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", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", - "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", - "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "number": 1347, - "state": "open", - "locked": true, - "title": "Amazing new feature", - "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 - }, - "body": "Please pull these awesome changes in!", - "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 - } - ], - "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" - }, - "active_lock_reason": "too heated", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:01:12Z", - "closed_at": "2011-01-26T19:01:12Z", - "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "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 - }, - { - "login": "hubot", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/hubot_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/hubot", - "html_url": "https://github.com/hubot", - "followers_url": "https://api.github.com/users/hubot/followers", - "following_url": "https://api.github.com/users/hubot/following{/other_user}", - "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", - "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", - "organizations_url": "https://api.github.com/users/hubot/orgs", - "repos_url": "https://api.github.com/users/hubot/repos", - "events_url": "https://api.github.com/users/hubot/events{/privacy}", - "received_events_url": "https://api.github.com/users/hubot/received_events", - "type": "User", - "site_admin": true - } - ], - "requested_reviewers": [ - { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false - } - ], - "requested_teams": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "head": { - "label": "octocat:new-topic", - "ref": "new-topic", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "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 - }, - "repo": { - "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, - "allow_auto_merge": false, - "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 - } - }, - "base": { - "label": "octocat:master", - "ref": "master", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "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 - }, - "repo": { - "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, - "allow_auto_merge": false, - "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 - } - }, - "_links": { - "self": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" - }, - "html": { - "href": "https://github.com/octocat/Hello-World/pull/1347" - }, - "issue": { - "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - }, - "comments": { - "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" - }, - "review_comments": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" - }, - "review_comment": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" - }, - "commits": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" - }, - "statuses": { - "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" - } - }, - "author_association": "OWNER", - "auto_merge": null, - "draft": false - }, - "schema": { - "title": "Pull Request Simple", - "description": "Pull Request Simple", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "review_comment_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "title": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_reviewers": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "requested_teams": { - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] - }, - "_links": { - "type": "object", - "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "enabled_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." - } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", - "title", - "updated_at", - "url", - "user", - "author_association", - "auto_merge" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - } - ], - "reviews": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "title": "List reviews for a pull request", - "category": "pulls", - "subcategory": "reviews", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

The list of reviews returns in chronological order.

", - "example": [ - { - "id": 80, - "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", - "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 - }, - "body": "Here is the body for the review.", - "state": "APPROVED", - "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", - "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", - "_links": { - "html": { - "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" - }, - "pull_request": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" - } - }, - "submitted_at": "2019-11-17T17:43:43Z", - "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", - "author_association": "COLLABORATOR" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Pull Request Review", - "description": "Pull Request Reviews are reviews on pull requests.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the review", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "description": "The text of the review.", - "type": "string" - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "submitted_at": { - "type": "string", - "format": "date-time" - }, - "commit_id": { - "description": "A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`.", - "type": [ - "string", - "null" - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - }, - "required": [ - "id", - "node_id", - "user", - "body", - "state", - "commit_id", - "html_url", - "pull_request_url", - "_links", - "author_association" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

The list of reviews returns in chronological order.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "title": "Create a review for a pull request", - "category": "pulls", - "subcategory": "reviews", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "commit_id", - "description": "

The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

" - }, - { - "type": "string", - "name": "body", - "description": "

Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

" - }, - { - "type": "string", - "name": "event", - "description": "

The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

", - "enum": [ - "APPROVE", - "REQUEST_CHANGES", - "COMMENT" - ] - }, - { - "type": "array of objects", - "name": "comments", - "description": "

Use the following table to specify the location, destination, and contents of the draft review comment.

", - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "

The relative path to the file that necessitates a review comment.

", - "isRequired": true - }, - { - "type": "integer", - "name": "position", - "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

" - }, - { - "type": "string", - "name": "body", - "description": "

Text of the review comment.

", - "isRequired": true - }, - { - "type": "integer", - "name": "line", - "description": "" - }, - { - "type": "string", - "name": "side", - "description": "" - }, - { - "type": "integer", - "name": "start_line", - "description": "" - }, - { - "type": "string", - "name": "start_side", - "description": "" - } - ] - } - ], - "descriptionHTML": "

Creates a review on a specified pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note

\n

\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.

\n
\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", - "body": "This is close to perfect! Please address the suggested inline change.", - "event": "REQUEST_CHANGES", - "comments": [ - { - "path": "file.md", - "position": 6, - "body": "Please add more information here, and fix this typo." - } - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 80, - "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", - "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 - }, - "body": "This is close to perfect! Please address the suggested inline change.", - "state": "CHANGES_REQUESTED", - "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", - "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", - "_links": { - "html": { - "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" - }, - "pull_request": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" - } - }, - "submitted_at": "2019-11-17T17:43:43Z", - "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", - "author_association": "COLLABORATOR" - }, - "schema": { - "title": "Pull Request Review", - "description": "Pull Request Reviews are reviews on pull requests.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the review", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "description": "The text of the review.", - "type": "string" - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "submitted_at": { - "type": "string", - "format": "date-time" - }, - "commit_id": { - "description": "A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`.", - "type": [ - "string", - "null" - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - }, - "required": [ - "id", - "node_id", - "user", - "body", - "state", - "commit_id", - "html_url", - "pull_request_url", - "_links", - "author_association" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "title": "Get a review for a pull request", - "category": "pulls", - "subcategory": "reviews", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "review_id", - "description": "

The unique identifier of the review.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Retrieves a pull request review by its ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER", - "review_id": "REVIEW_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 80, - "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", - "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 - }, - "body": "Here is the body for the review.", - "state": "APPROVED", - "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", - "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", - "_links": { - "html": { - "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" - }, - "pull_request": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" - } - }, - "submitted_at": "2019-11-17T17:43:43Z", - "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", - "author_association": "COLLABORATOR" - }, - "schema": { - "title": "Pull Request Review", - "description": "Pull Request Reviews are reviews on pull requests.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the review", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "description": "The text of the review.", - "type": "string" - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "submitted_at": { - "type": "string", - "format": "date-time" - }, - "commit_id": { - "description": "A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`.", - "type": [ - "string", - "null" - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - }, - "required": [ - "id", - "node_id", - "user", - "body", - "state", - "commit_id", - "html_url", - "pull_request_url", - "_links", - "author_association" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "title": "Update a review for a pull request", - "category": "pulls", - "subcategory": "reviews", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "review_id", - "description": "

The unique identifier of the review.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "body", - "description": "

The body text of the pull request review.

", - "isRequired": true - } - ], - "descriptionHTML": "

Updates the contents of a specified review summary comment.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "body": "This is close to perfect! Please address the suggested inline change. And add more about this." - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER", - "review_id": "REVIEW_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 80, - "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", - "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 - }, - "body": "This is close to perfect! Please address the suggested inline change. And add more about this.", - "state": "CHANGES_REQUESTED", - "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", - "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", - "_links": { - "html": { - "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" - }, - "pull_request": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" - } - }, - "submitted_at": "2019-11-17T17:43:43Z", - "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", - "author_association": "COLLABORATOR" - }, - "schema": { - "title": "Pull Request Review", - "description": "Pull Request Reviews are reviews on pull requests.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the review", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "description": "The text of the review.", - "type": "string" - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "submitted_at": { - "type": "string", - "format": "date-time" - }, - "commit_id": { - "description": "A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`.", - "type": [ - "string", - "null" - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - }, - "required": [ - "id", - "node_id", - "user", - "body", - "state", - "commit_id", - "html_url", - "pull_request_url", - "_links", - "author_association" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "title": "Delete a pending review for a pull request", - "category": "pulls", - "subcategory": "reviews", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "review_id", - "description": "

The unique identifier of the review.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER", - "review_id": "REVIEW_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 80, - "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", - "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 - }, - "body": "This is close to perfect! Please address the suggested inline change.", - "state": "CHANGES_REQUESTED", - "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", - "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", - "_links": { - "html": { - "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" - }, - "pull_request": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" - } - }, - "submitted_at": "2019-11-17T17:43:43Z", - "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", - "author_association": "COLLABORATOR" - }, - "schema": { - "title": "Pull Request Review", - "description": "Pull Request Reviews are reviews on pull requests.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the review", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "description": "The text of the review.", - "type": "string" - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "submitted_at": { - "type": "string", - "format": "date-time" - }, - "commit_id": { - "description": "A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`.", - "type": [ - "string", - "null" - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - }, - "required": [ - "id", - "node_id", - "user", - "body", - "state", - "commit_id", - "html_url", - "pull_request_url", - "_links", - "author_association" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", - "title": "List comments for a pull request review", - "category": "pulls", - "subcategory": "reviews", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "review_id", - "description": "

The unique identifier of the review.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists comments for a specific pull request review.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER", - "review_id": "REVIEW_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", - "pull_request_review_id": 42, - "id": 10, - "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", - "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", - "path": "file1.txt", - "position": 1, - "original_position": 4, - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", - "in_reply_to_id": 8, - "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 - }, - "body": "Great stuff!", - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", - "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", - "author_association": "NONE", - "_links": { - "self": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" - }, - "html": { - "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" - }, - "pull_request": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" - } - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Legacy Review Comment", - "description": "Legacy Review Comment", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "pull_request_review_id": { - "type": [ - "integer", - "null" - ], - "format": "int64" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "diff_hunk": { - "type": "string" - }, - "path": { - "type": "string" - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "original_position": { - "type": "integer" - }, - "commit_id": { - "type": "string" - }, - "original_commit_id": { - "type": "string" - }, - "in_reply_to_id": { - "type": "integer" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "_links": { - "type": "object", - "properties": { - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "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" - ] - }, - "side": { - "description": "The side of the first line of the range for a multi-line comment.", - "enum": [ - "LEFT", - "RIGHT" - ], - "default": "RIGHT", - "type": "string" - }, - "start_side": { - "type": [ - "string", - "null" - ], - "description": "The side of the first line of the range for a multi-line comment.", - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - "line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "original_line": { - "description": "The original line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "start_line": { - "description": "The first line of the range for a multi-line comment.", - "type": [ - "integer", - "null" - ] - }, - "original_start_line": { - "description": "The original first line of the range for a multi-line comment.", - "type": [ - "integer", - "null" - ] - }, - "subject_type": { - "description": "The level at which the comment is targeted, can be a diff line or a file.", - "type": "string", - "enum": [ - "line", - "file" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "body", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "pull_request_review_id", - "html_url", - "pull_request_url", - "_links", - "author_association", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", - "title": "Dismiss a review for a pull request", - "category": "pulls", - "subcategory": "reviews", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "review_id", - "description": "

The unique identifier of the review.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "message", - "description": "

The message for the pull request review dismissal

", - "isRequired": true - }, - { - "type": "string", - "name": "event", - "description": "", - "enum": [ - "DISMISS" - ] - } - ], - "descriptionHTML": "

Dismisses a specified review on a pull request.

\n

Note

\n

\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

\n
\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "message": "You are dismissed", - "event": "DISMISS" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER", - "review_id": "REVIEW_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 80, - "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", - "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 - }, - "body": "Here is the body for the review.", - "state": "DISMISSED", - "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", - "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", - "_links": { - "html": { - "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" - }, - "pull_request": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" - } - }, - "submitted_at": "2019-11-17T17:43:43Z", - "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", - "author_association": "COLLABORATOR" - }, - "schema": { - "title": "Pull Request Review", - "description": "Pull Request Reviews are reviews on pull requests.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the review", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "description": "The text of the review.", - "type": "string" - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "submitted_at": { - "type": "string", - "format": "date-time" - }, - "commit_id": { - "description": "A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`.", - "type": [ - "string", - "null" - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - }, - "required": [ - "id", - "node_id", - "user", - "body", - "state", - "commit_id", - "html_url", - "pull_request_url", - "_links", - "author_association" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", - "title": "Submit a review for a pull request", - "category": "pulls", - "subcategory": "reviews", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "

The number that identifies the pull request.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "review_id", - "description": "

The unique identifier of the review.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "body", - "description": "

The body text of the pull request review

" - }, - { - "type": "string", - "name": "event", - "description": "

The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.

", - "isRequired": true, - "enum": [ - "APPROVE", - "REQUEST_CHANGES", - "COMMENT" - ] - } - ], - "descriptionHTML": "

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "body": "Here is the body for the review.", - "event": "REQUEST_CHANGES" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pull_number": "PULL_NUMBER", - "review_id": "REVIEW_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 80, - "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", - "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 - }, - "body": "Here is the body for the review.", - "state": "APPROVED", - "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", - "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", - "_links": { - "html": { - "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" - }, - "pull_request": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" - } - }, - "submitted_at": "2019-11-17T17:43:43Z", - "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", - "author_association": "COLLABORATOR" - }, - "schema": { - "title": "Pull Request Review", - "description": "Pull Request Reviews are reviews on pull requests.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the review", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "body": { - "description": "The text of the review.", - "type": "string" - }, - "state": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "submitted_at": { - "type": "string", - "format": "date-time" - }, - "commit_id": { - "description": "A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`.", - "type": [ - "string", - "null" - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - } - }, - "required": [ - "id", - "node_id", - "user", - "body", - "state", - "commit_id", - "html_url", - "pull_request_url", - "_links", - "author_association" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/rate-limit.json b/src/rest/data/ghes-3.14-2022-11-28/rate-limit.json deleted file mode 100644 index d4c3ee9fd6cd..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/rate-limit.json +++ /dev/null @@ -1,435 +0,0 @@ -{ - "rate-limit": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/rate_limit", - "title": "Get rate limit status for the authenticated user", - "category": "rate-limit", - "subcategory": "rate-limit", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nAccessing this endpoint does not count against your REST API rate limit.

\n
\n

Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:

\n
    \n
  • The core object provides your rate limit status for all non-search-related resources in the REST API.
    • \n
  • The search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"
    • \n
  • The code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"
    • \n
  • The graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"
    • \n
  • The integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"
    • \n
  • The dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"
    • \n
  • The dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"
    • \n
  • The code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"
    • \n
  • The actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"
    • \n
  • The source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"
    • \n
\n

Note

\n

\nThe rate object is closing down. 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.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "resources": { - "core": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691591363 - }, - "search": { - "limit": 30, - "used": 12, - "remaining": 18, - "reset": 1691591091 - }, - "graphql": { - "limit": 5000, - "used": 7, - "remaining": 4993, - "reset": 1691593228 - }, - "integration_manifest": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691594631 - }, - "source_import": { - "limit": 100, - "used": 1, - "remaining": 99, - "reset": 1691591091 - }, - "code_scanning_upload": { - "limit": 500, - "used": 1, - "remaining": 499, - "reset": 1691594631 - }, - "actions_runner_registration": { - "limit": 10000, - "used": 0, - "remaining": 10000, - "reset": 1691594631 - }, - "scim": { - "limit": 15000, - "used": 0, - "remaining": 15000, - "reset": 1691594631 - }, - "dependency_snapshots": { - "limit": 100, - "used": 0, - "remaining": 100, - "reset": 1691591091 - }, - "code_search": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - }, - "code_scanning_autofix": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - } - }, - "rate": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1372700873 - } - }, - "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" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "graphql": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "search": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_search": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "source_import": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "integration_manifest": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_upload": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "actions_runner_registration": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "scim": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_sbom": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_autofix": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - } - }, - "required": [ - "core", - "search" - ] - }, - "rate": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - } - }, - "required": [ - "rate", - "resources" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/reactions.json b/src/rest/data/ghes-3.14-2022-11-28/reactions.json deleted file mode 100644 index 2ad9fc7841b9..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/reactions.json +++ /dev/null @@ -1,4368 +0,0 @@ -{ - "reactions": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "title": "List reactions for a commit comment", - "category": "reactions", - "subcategory": "reactions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "content", - "description": "

Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List the reactions to a commit comment.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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" - } - ], - "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" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "title": "Create reaction for a commit comment", - "category": "reactions", - "subcategory": "reactions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "content", - "description": "

The reaction type to add to the commit comment.

", - "isRequired": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - ], - "descriptionHTML": "

Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "content": "heart" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Reaction exists

", - "example": { - "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" - }, - "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" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "content": "heart" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Reaction created

", - "example": { - "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" - }, - "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" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Reaction exists

" - }, - { - "httpStatusCode": "201", - "description": "

Reaction created

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", - "title": "Delete a commit comment reaction", - "category": "reactions", - "subcategory": "reactions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "reaction_id", - "description": "

The unique identifier of the reaction.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a commit comment.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID", - "reaction_id": "REACTION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "title": "List reactions for an issue comment", - "category": "reactions", - "subcategory": "reactions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "content", - "description": "

Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List the reactions to an issue comment.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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" - } - ], - "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" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "title": "Create reaction for an issue comment", - "category": "reactions", - "subcategory": "reactions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "content", - "description": "

The reaction type to add to the issue comment.

", - "isRequired": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - ], - "descriptionHTML": "

Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "content": "heart" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Reaction exists

", - "example": { - "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" - }, - "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" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "content": "heart" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Reaction created

", - "example": { - "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" - }, - "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" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Reaction exists

" - }, - { - "httpStatusCode": "201", - "description": "

Reaction created

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", - "title": "Delete an issue comment reaction", - "category": "reactions", - "subcategory": "reactions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "reaction_id", - "description": "

The unique identifier of the reaction.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to an issue comment.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID", - "reaction_id": "REACTION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "title": "List reactions for an issue", - "category": "reactions", - "subcategory": "reactions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "content", - "description": "

Returns a single reaction type. Omit this parameter to list all reactions to an issue.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List the reactions to an issue.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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" - } - ], - "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" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "410", - "description": "

Gone

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "title": "Create reaction for an issue", - "category": "reactions", - "subcategory": "reactions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "content", - "description": "

The reaction type to add to the issue.

", - "isRequired": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - ], - "descriptionHTML": "

Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "content": "heart" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - }, - "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" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "content": "heart" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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" - }, - "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" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", - "title": "Delete an issue reaction", - "category": "reactions", - "subcategory": "reactions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "

The number that identifies the issue.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "reaction_id", - "description": "

The unique identifier of the reaction.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.

\n
\n

Delete a reaction to an issue.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER", - "reaction_id": "REACTION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Issues\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "title": "List reactions for a pull request review comment", - "category": "reactions", - "subcategory": "reactions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "content", - "description": "

Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List the reactions to a pull request review comment.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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" - } - ], - "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" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "title": "Create reaction for a pull request review comment", - "category": "reactions", - "subcategory": "reactions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "content", - "description": "

The reaction type to add to the pull request review comment.

", - "isRequired": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - ], - "descriptionHTML": "

Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "content": "heart" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Reaction exists

", - "example": { - "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" - }, - "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" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "content": "heart" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Reaction created

", - "example": { - "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" - }, - "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" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Reaction exists

" - }, - { - "httpStatusCode": "201", - "description": "

Reaction created

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", - "title": "Delete a pull request comment reaction", - "category": "reactions", - "subcategory": "reactions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "

The unique identifier of the comment.

", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "reaction_id", - "description": "

The unique identifier of the reaction.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a pull request review comment.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID", - "reaction_id": "REACTION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Pull requests\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions", - "title": "List reactions for a release", - "category": "reactions", - "subcategory": "reactions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "release_id", - "description": "

The unique identifier of the release.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "content", - "description": "

Returns a single reaction type. Omit this parameter to list all reactions to a release.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "laugh", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List the reactions to a release.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "release_id": "RELEASE_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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" - } - ], - "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" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions", - "title": "Create reaction for a release", - "category": "reactions", - "subcategory": "reactions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "release_id", - "description": "

The unique identifier of the release.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "content", - "description": "

The reaction type to add to the release.

", - "isRequired": true, - "enum": [ - "+1", - "laugh", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - ], - "descriptionHTML": "

Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "content": "heart" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "release_id": "RELEASE_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Reaction exists

", - "example": { - "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" - }, - "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" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "content": "heart" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "release_id": "RELEASE_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Reaction created

", - "example": { - "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" - }, - "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" - }, - "node_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Reaction exists

" - }, - { - "httpStatusCode": "201", - "description": "

Reaction created

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}", - "title": "Delete a release reaction", - "category": "reactions", - "subcategory": "reactions", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "release_id", - "description": "

The unique identifier of the release.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "reaction_id", - "description": "

The unique identifier of the reaction.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a release.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "release_id": "RELEASE_ID", - "reaction_id": "REACTION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/releases.json b/src/rest/data/ghes-3.14-2022-11-28/releases.json deleted file mode 100644 index edd0e53ee918..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/releases.json +++ /dev/null @@ -1,5479 +0,0 @@ -{ - "releases": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases", - "title": "List releases", - "category": "releases", - "subcategory": "releases", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.

\n

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", - "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", - "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", - "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", - "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", - "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", - "id": 1, - "node_id": "MDc6UmVsZWFzZTE=", - "tag_name": "v1.0.0", - "target_commitish": "master", - "name": "v1.0.0", - "body": "Description of the release", - "draft": false, - "prerelease": false, - "immutable": false, - "created_at": "2013-02-27T19:35:32Z", - "published_at": "2013-02-27T19:35:32Z", - "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 - }, - "assets": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", - "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", - "id": 1, - "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", - "name": "example.zip", - "label": "short description", - "state": "uploaded", - "content_type": "application/zip", - "size": 1024, - "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", - "download_count": 42, - "created_at": "2013-02-27T19:35:32Z", - "updated_at": "2013-02-27T19:35:32Z", - "uploader": { - "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 - } - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "title": "Release", - "description": "A release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "assets_url": { - "type": "string", - "format": "uri" - }, - "upload_url": { - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "draft": { - "description": "true to create a draft (unpublished) release, false to create a published one.", - "type": "boolean" - }, - "prerelease": { - "description": "Whether to identify the release as a prerelease or a full release.", - "type": "boolean" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "mentions_count": { - "type": "integer" - }, - "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": [ - "assets_url", - "upload_url", - "tarball_url", - "zipball_url", - "created_at", - "published_at", - "draft", - "id", - "node_id", - "author", - "html_url", - "name", - "prerelease", - "tag_name", - "target_commitish", - "assets", - "url" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases", - "title": "Create a release", - "category": "releases", - "subcategory": "releases", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "tag_name", - "description": "

The name of the tag.

", - "isRequired": true - }, - { - "type": "string", - "name": "target_commitish", - "description": "

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.

" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the release.

" - }, - { - "type": "string", - "name": "body", - "description": "

Text describing the contents of the tag.

" - }, - { - "type": "boolean", - "name": "draft", - "description": "

true to create a draft (unpublished) release, false to create a published one.

", - "default": false - }, - { - "type": "boolean", - "name": "prerelease", - "description": "

true to identify the release as a prerelease. false to identify the release as a full release.

", - "default": false - }, - { - "type": "boolean", - "name": "generate_release_notes", - "description": "

Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes.

", - "default": false - }, - { - "type": "string", - "name": "make_latest", - "description": "

Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to true for newly published releases. legacy specifies that the latest release should be determined based on the release creation date and higher semantic version.

", - "enum": [ - "true", - "false", - "legacy" - ], - "default": "true" - } - ], - "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "tag_name": "v1.0.0", - "target_commitish": "master", - "name": "v1.0.0", - "body": "Description of the release", - "draft": false, - "prerelease": false, - "generate_release_notes": false - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", - "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", - "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", - "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", - "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", - "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", - "discussion_url": "https://github.com/octocat/Hello-World/discussions/90", - "id": 1, - "node_id": "MDc6UmVsZWFzZTE=", - "tag_name": "v1.0.0", - "target_commitish": "master", - "name": "v1.0.0", - "body": "Description of the release", - "draft": false, - "prerelease": false, - "immutable": false, - "created_at": "2013-02-27T19:35:32Z", - "published_at": "2013-02-27T19:35:32Z", - "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 - }, - "assets": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", - "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", - "id": 1, - "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", - "name": "example.zip", - "label": "short description", - "state": "uploaded", - "content_type": "application/zip", - "size": 1024, - "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", - "download_count": 42, - "created_at": "2013-02-27T19:35:32Z", - "updated_at": "2013-02-27T19:35:32Z", - "uploader": { - "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 - } - } - ] - }, - "schema": { - "title": "Release", - "description": "A release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "assets_url": { - "type": "string", - "format": "uri" - }, - "upload_url": { - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "draft": { - "description": "true to create a draft (unpublished) release, false to create a published one.", - "type": "boolean" - }, - "prerelease": { - "description": "Whether to identify the release as a prerelease or a full release.", - "type": "boolean" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "mentions_count": { - "type": "integer" - }, - "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": [ - "assets_url", - "upload_url", - "tarball_url", - "zipball_url", - "created_at", - "published_at", - "draft", - "id", - "node_id", - "author", - "html_url", - "name", - "prerelease", - "tag_name", - "target_commitish", - "assets", - "url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - }, - { - "\"Contents\" repository permissions": "write", - "\"Workflows\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases/generate-notes", - "title": "Generate release notes content for a release", - "category": "releases", - "subcategory": "releases", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "tag_name", - "description": "

The tag name for the release. This can be an existing tag or a new one.

", - "isRequired": true - }, - { - "type": "string", - "name": "target_commitish", - "description": "

Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.

" - }, - { - "type": "string", - "name": "previous_tag_name", - "description": "

The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.

" - }, - { - "type": "string", - "name": "configuration_file_path", - "description": "

Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

" - } - ], - "descriptionHTML": "

Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "tag_name": "v1.0.0", - "target_commitish": "main", - "previous_tag_name": "v0.9.2", - "configuration_file_path": ".github/custom_release_config.yml" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Name and body of generated release notes

", - "example": { - "name": "Release v1.0.0 is now available!", - "body": "##Changes in Release v1.0.0 ... ##Contributors @monalisa" - }, - "schema": { - "title": "Generated Release Notes Content", - "description": "Generated name and body describing a release", - "type": "object", - "properties": { - "name": { - "description": "The generated name of the release", - "type": "string" - }, - "body": { - "description": "The generated body describing the contents of the release supporting markdown formatting", - "type": "string" - } - }, - "required": [ - "name", - "body" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Name and body of generated release notes

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/latest", - "title": "Get the latest release", - "category": "releases", - "subcategory": "releases", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

View the latest published full release for the repository.

\n

The latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", - "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", - "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", - "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", - "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", - "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", - "discussion_url": "https://github.com/octocat/Hello-World/discussions/90", - "id": 1, - "node_id": "MDc6UmVsZWFzZTE=", - "tag_name": "v1.0.0", - "target_commitish": "master", - "name": "v1.0.0", - "body": "Description of the release", - "draft": false, - "prerelease": false, - "immutable": false, - "created_at": "2013-02-27T19:35:32Z", - "published_at": "2013-02-27T19:35:32Z", - "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 - }, - "assets": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", - "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", - "id": 1, - "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", - "name": "example.zip", - "label": "short description", - "state": "uploaded", - "content_type": "application/zip", - "size": 1024, - "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", - "download_count": 42, - "created_at": "2013-02-27T19:35:32Z", - "updated_at": "2013-02-27T19:35:32Z", - "uploader": { - "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 - } - } - ] - }, - "schema": { - "title": "Release", - "description": "A release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "assets_url": { - "type": "string", - "format": "uri" - }, - "upload_url": { - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "draft": { - "description": "true to create a draft (unpublished) release, false to create a published one.", - "type": "boolean" - }, - "prerelease": { - "description": "Whether to identify the release as a prerelease or a full release.", - "type": "boolean" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "mentions_count": { - "type": "integer" - }, - "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": [ - "assets_url", - "upload_url", - "tarball_url", - "zipball_url", - "created_at", - "published_at", - "draft", - "id", - "node_id", - "author", - "html_url", - "name", - "prerelease", - "tag_name", - "target_commitish", - "assets", - "url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", - "title": "Get a release by tag name", - "category": "releases", - "subcategory": "releases", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "tag", - "description": "

tag parameter

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Get a published release with the specified tag.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "tag": "TAG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", - "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", - "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", - "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", - "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", - "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", - "discussion_url": "https://github.com/octocat/Hello-World/discussions/90", - "id": 1, - "node_id": "MDc6UmVsZWFzZTE=", - "tag_name": "v1.0.0", - "target_commitish": "master", - "name": "v1.0.0", - "body": "Description of the release", - "draft": false, - "prerelease": false, - "immutable": false, - "created_at": "2013-02-27T19:35:32Z", - "published_at": "2013-02-27T19:35:32Z", - "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 - }, - "assets": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", - "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", - "id": 1, - "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", - "name": "example.zip", - "label": "short description", - "state": "uploaded", - "content_type": "application/zip", - "size": 1024, - "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", - "download_count": 42, - "created_at": "2013-02-27T19:35:32Z", - "updated_at": "2013-02-27T19:35:32Z", - "uploader": { - "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 - } - } - ] - }, - "schema": { - "title": "Release", - "description": "A release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "assets_url": { - "type": "string", - "format": "uri" - }, - "upload_url": { - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "draft": { - "description": "true to create a draft (unpublished) release, false to create a published one.", - "type": "boolean" - }, - "prerelease": { - "description": "Whether to identify the release as a prerelease or a full release.", - "type": "boolean" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "mentions_count": { - "type": "integer" - }, - "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": [ - "assets_url", - "upload_url", - "tarball_url", - "zipball_url", - "created_at", - "published_at", - "draft", - "id", - "node_id", - "author", - "html_url", - "name", - "prerelease", - "tag_name", - "target_commitish", - "assets", - "url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "title": "Get a release", - "category": "releases", - "subcategory": "releases", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "release_id", - "description": "

The unique identifier of the release.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a public release with the specified release ID.

\n

Note

\n

\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "release_id": "RELEASE_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", - "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", - "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", - "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", - "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", - "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", - "discussion_url": "https://github.com/octocat/Hello-World/discussions/90", - "id": 1, - "node_id": "MDc6UmVsZWFzZTE=", - "tag_name": "v1.0.0", - "target_commitish": "master", - "name": "v1.0.0", - "body": "Description of the release", - "draft": false, - "prerelease": false, - "immutable": false, - "created_at": "2013-02-27T19:35:32Z", - "published_at": "2013-02-27T19:35:32Z", - "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 - }, - "assets": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", - "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", - "id": 1, - "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", - "name": "example.zip", - "label": "short description", - "state": "uploaded", - "content_type": "application/zip", - "size": 1024, - "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", - "download_count": 42, - "created_at": "2013-02-27T19:35:32Z", - "updated_at": "2013-02-27T19:35:32Z", - "uploader": { - "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 - } - } - ] - }, - "schema": { - "title": "Release", - "description": "A release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "assets_url": { - "type": "string", - "format": "uri" - }, - "upload_url": { - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "draft": { - "description": "true to create a draft (unpublished) release, false to create a published one.", - "type": "boolean" - }, - "prerelease": { - "description": "Whether to identify the release as a prerelease or a full release.", - "type": "boolean" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "mentions_count": { - "type": "integer" - }, - "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": [ - "assets_url", - "upload_url", - "tarball_url", - "zipball_url", - "created_at", - "published_at", - "draft", - "id", - "node_id", - "author", - "html_url", - "name", - "prerelease", - "tag_name", - "target_commitish", - "assets", - "url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"

" - }, - { - "httpStatusCode": "401", - "description": "

Unauthorized

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "title": "Update a release", - "category": "releases", - "subcategory": "releases", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "release_id", - "description": "

The unique identifier of the release.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "tag_name", - "description": "

The name of the tag.

" - }, - { - "type": "string", - "name": "target_commitish", - "description": "

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.

" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the release.

" - }, - { - "type": "string", - "name": "body", - "description": "

Text describing the contents of the tag.

" - }, - { - "type": "boolean", - "name": "draft", - "description": "

true makes the release a draft, and false publishes the release.

" - }, - { - "type": "boolean", - "name": "prerelease", - "description": "

true to identify the release as a prerelease, false to identify the release as a full release.

" - }, - { - "type": "string", - "name": "make_latest", - "description": "

Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to true for newly published releases. legacy specifies that the latest release should be determined based on the release creation date and higher semantic version.

", - "enum": [ - "true", - "false", - "legacy" - ], - "default": "true" - } - ], - "descriptionHTML": "

Users with push access to the repository can edit a release.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "tag_name": "v1.0.0", - "target_commitish": "master", - "name": "v1.0.0", - "body": "Description of the release", - "draft": false, - "prerelease": false - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "release_id": "RELEASE_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", - "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", - "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", - "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", - "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", - "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", - "discussion_url": "https://github.com/octocat/Hello-World/discussions/90", - "id": 1, - "node_id": "MDc6UmVsZWFzZTE=", - "tag_name": "v1.0.0", - "target_commitish": "master", - "name": "v1.0.0", - "body": "Description of the release", - "draft": false, - "prerelease": false, - "immutable": false, - "created_at": "2013-02-27T19:35:32Z", - "published_at": "2013-02-27T19:35:32Z", - "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 - }, - "assets": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", - "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", - "id": 1, - "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", - "name": "example.zip", - "label": "short description", - "state": "uploaded", - "content_type": "application/zip", - "size": 1024, - "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", - "download_count": 42, - "created_at": "2013-02-27T19:35:32Z", - "updated_at": "2013-02-27T19:35:32Z", - "uploader": { - "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 - } - } - ] - }, - "schema": { - "title": "Release", - "description": "A release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "assets_url": { - "type": "string", - "format": "uri" - }, - "upload_url": { - "type": "string" - }, - "tarball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "zipball_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "tag_name": { - "description": "The name of the tag.", - "type": "string" - }, - "target_commitish": { - "description": "Specifies the commitish value that determines where the Git tag is created from.", - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "draft": { - "description": "true to create a draft (unpublished) release, false to create a published one.", - "type": "boolean" - }, - "prerelease": { - "description": "Whether to identify the release as a prerelease or a full release.", - "type": "boolean" - }, - "immutable": { - "description": "Whether or not the release is immutable.", - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "assets": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "mentions_count": { - "type": "integer" - }, - "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": [ - "assets_url", - "upload_url", - "tarball_url", - "zipball_url", - "created_at", - "published_at", - "draft", - "id", - "node_id", - "author", - "html_url", - "name", - "prerelease", - "tag_name", - "target_commitish", - "assets", - "url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", - "title": "Delete a release", - "category": "releases", - "subcategory": "releases", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "release_id", - "description": "

The unique identifier of the release.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Users with push access to the repository can delete a release.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "release_id": "RELEASE_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - } - ], - "assets": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "title": "Get a release asset", - "category": "releases", - "subcategory": "assets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "asset_id", - "description": "

The unique identifier of the asset.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

To download the asset's binary content:

\n
    \n
  • If within a browser, fetch the location specified in the browser_download_url key provided in the response.
    • \n
  • Alternatively, set the Accept header of the request to\napplication/octet-stream.\nThe API will either redirect the client to the location, or stream it directly if possible.\nAPI clients should handle both a 200 or 302 response.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "asset_id": "ASSET_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", - "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", - "id": 1, - "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", - "name": "example.zip", - "label": "short description", - "state": "uploaded", - "content_type": "application/zip", - "size": 1024, - "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", - "download_count": 42, - "created_at": "2013-02-27T19:35:32Z", - "updated_at": "2013-02-27T19:35:32Z", - "uploader": { - "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 - } - }, - "schema": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "302", - "description": "

Found

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "title": "Update a release asset", - "category": "releases", - "subcategory": "assets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "asset_id", - "description": "

The unique identifier of the asset.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The file name of the asset.

" - }, - { - "type": "string", - "name": "label", - "description": "

An alternate short description of the asset. Used in place of the filename.

" - }, - { - "type": "string", - "name": "state", - "description": "" - } - ], - "descriptionHTML": "

Users with push access to the repository can edit a release asset.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "foo-1.0.0-osx.zip", - "label": "Mac binary" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "asset_id": "ASSET_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", - "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", - "id": 1, - "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", - "name": "example.zip", - "label": "short description", - "state": "uploaded", - "content_type": "application/zip", - "size": 1024, - "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", - "download_count": 42, - "created_at": "2013-02-27T19:35:32Z", - "updated_at": "2013-02-27T19:35:32Z", - "uploader": { - "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 - } - }, - "schema": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "title": "Delete a release asset", - "category": "releases", - "subcategory": "assets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "asset_id", - "description": "

The unique identifier of the asset.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "asset_id": "ASSET_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "title": "List release assets", - "category": "releases", - "subcategory": "assets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "release_id", - "description": "

The unique identifier of the release.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "release_id": "RELEASE_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", - "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", - "id": 1, - "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", - "name": "example.zip", - "label": "short description", - "state": "uploaded", - "content_type": "application/zip", - "size": 1024, - "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", - "download_count": 42, - "created_at": "2013-02-27T19:35:32Z", - "updated_at": "2013-02-27T19:35:32Z", - "uploader": { - "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 - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "https://HOSTNAME/api/uploads", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "title": "Upload a release asset", - "category": "releases", - "subcategory": "assets", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "release_id", - "description": "

The unique identifier of the release.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "name", - "in": "query", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - }, - { - "name": "label", - "in": "query", - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.

\n

You need to use an HTTP client which supports SNI to make calls to this endpoint.

\n

Most libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:

\n

application/zip

\n

GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.

\n

When an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.

\n

Notes:

\n
    \n
  • GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"List release assets\"\nendpoint lists the renamed filenames. For more information and help, contact GitHub Enterprise Server Support.
    • \n
  • To find the release_id query the GET /repos/{owner}/{repo}/releases/latest endpoint.
    • \n
  • If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.
    • \n
", - "codeExamples": [ - { - "request": { - "contentType": "application/octet-stream", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": "@example.zip", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "release_id": "RELEASE_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response for successful upload

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", - "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", - "id": 1, - "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", - "name": "example.zip", - "label": "short description", - "state": "uploaded", - "content_type": "application/zip", - "size": 1024, - "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", - "download_count": 42, - "created_at": "2013-02-27T19:35:32Z", - "updated_at": "2013-02-27T19:35:32Z", - "uploader": { - "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 - } - }, - "schema": { - "title": "Release Asset", - "description": "Data related to a release.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "browser_download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The file name of the asset.", - "type": "string" - }, - "label": { - "type": [ - "string", - "null" - ] - }, - "state": { - "description": "State of the release asset.", - "type": "string", - "enum": [ - "uploaded", - "open" - ] - }, - "content_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "digest": { - "type": [ - "string", - "null" - ] - }, - "download_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "uploader": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "name", - "content_type", - "size", - "digest", - "state", - "url", - "node_id", - "download_count", - "label", - "uploader", - "browser_download_url", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Response for successful upload

" - }, - { - "httpStatusCode": "422", - "description": "

Response if you upload an asset with the same filename as another uploaded asset

" - } - ], - "previews": [] - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/repos.json b/src/rest/data/ghes-3.14-2022-11-28/repos.json deleted file mode 100644 index 465b43bcf5e5..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/repos.json +++ /dev/null @@ -1,43852 +0,0 @@ -{ - "repos": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/repos", - "title": "List organization repositories", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "type", - "description": "

Specifies the types of repositories you want returned. internal is not yet supported when a GitHub App calls this endpoint with an installation access token.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "public", - "private", - "forks", - "sources", - "member", - "internal" - ] - } - }, - { - "name": "sort", - "description": "

The property to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "pushed", - "full_name" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "

The order to sort by. Default: asc when using full_name, otherwise desc.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ] - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists repositories for the specified organization.

\n

Note

\n

\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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, - "has_discussions": false, - "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 - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/repos", - "title": "Create an organization repository", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

A short description of the repository.

" - }, - { - "type": "string", - "name": "homepage", - "description": "

A URL with more information about the repository.

" - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "

The visibility of the repository. Note: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. 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", - "internal" - ] - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Either true to enable issues for this repository or false to disable them.

", - "default": true - }, - { - "type": "boolean", - "name": "has_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 - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Either true to enable the wiki for this repository or false to disable it.

", - "default": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "default": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Either true to make this repo available as a template repository or false to prevent it.

", - "default": false - }, - { - "type": "integer", - "name": "team_id", - "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.

" - }, - { - "type": "boolean", - "name": "auto_init", - "description": "

Pass true to create an initial commit with empty README.

", - "default": false - }, - { - "type": "string", - "name": "gitignore_template", - "description": "

Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

" - }, - { - "type": "string", - "name": "license_template", - "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\".

" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Either true to allow squash-merging pull requests, or false to prevent squash-merging.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

", - "default": false - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion. The authenticated user must be an organization owner to set this property to true.

", - "default": false - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "object", - "name": "custom_properties", - "description": "

The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values.

" - } - ], - "descriptionHTML": "

Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

\n

OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Hello-World", - "description": "This is your first repository", - "homepage": "https://github.com", - "private": false, - "has_issues": true, - "has_projects": true, - "has_wiki": true - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "allow_forking": true, - "web_commit_signoff_required": false, - "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, - "allow_auto_merge": false, - "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, - "allow_auto_merge": false, - "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 - } - }, - "schema": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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" - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "template_repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - ] - }, - "temp_clone_token": { - "type": [ - "string", - "null" - ] - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean" - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "parent": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "source": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "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" - }, - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "key", - "name", - "html_url" - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "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_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}", - "title": "Get a repository", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

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.

\n

Note

\n

\n
    \n
  • In order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
    • \n
  • To view merge-related settings, you must have the contents:read and contents:write permissions.
    • \n
\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Default response

", - "example": { - "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", - "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, - "has_discussions": false, - "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, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "allow_forking": 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, - "allow_auto_merge": false, - "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", - "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, - "allow_auto_merge": false, - "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, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - } - } - } - }, - "schema": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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" - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "template_repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - ] - }, - "temp_clone_token": { - "type": [ - "string", - "null" - ] - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean" - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "parent": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "source": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "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" - }, - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "key", - "name", - "html_url" - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "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_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}", - "title": "Update a repository", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

" - }, - { - "type": "string", - "name": "description", - "description": "

A short description of the repository.

" - }, - { - "type": "string", - "name": "homepage", - "description": "

A URL with more information about the repository.

" - }, - { - "type": "boolean", - "name": "private", - "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.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "

The visibility of the repository.

", - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "object or null", - "name": "security_and_analysis", - "description": "

Specify which security and analysis features to enable or disable for the repository.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

\n

You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

", - "childParamsGroups": [ - { - "type": "object", - "name": "advanced_security", - "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository.\nFor more information, see \"About GitHub Advanced\nSecurity.\"

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "

Can be enabled or disabled.

" - } - ] - }, - { - "type": "object", - "name": "secret_scanning", - "description": "

Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "

Can be enabled or disabled.

" - } - ] - }, - { - "type": "object", - "name": "secret_scanning_push_protection", - "description": "

Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "

Can be enabled or disabled.

" - } - ] - } - ] - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Either true to enable issues for this repository or false to disable them.

", - "default": true - }, - { - "type": "boolean", - "name": "has_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 - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Either true to enable the wiki for this repository or false to disable it.

", - "default": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Either true to make this repo available as a template repository or false to prevent it.

", - "default": false - }, - { - "type": "string", - "name": "default_branch", - "description": "

Updates the default branch for this repository.

" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Either true to allow squash-merging pull requests, or false to prevent squash-merging.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

", - "default": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Either true to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.

", - "default": false - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether to archive this repository. false will unarchive a previously archived repository.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Either true to allow private forks, or false to prevent private forks.

", - "default": false - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Either true to require contributors to sign off on web-based commits, or false to not require contributors to sign off on web-based commits.

", - "default": false - } - ], - "descriptionHTML": "

Note: To edit a repository's topics, use the Replace all repository topics endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Hello-World", - "description": "This is your first repository", - "homepage": "https://github.com", - "private": true, - "has_issues": true, - "has_projects": true, - "has_wiki": true - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "allow_forking": true, - "web_commit_signoff_required": false, - "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, - "allow_auto_merge": false, - "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, - "allow_auto_merge": false, - "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 - } - }, - "schema": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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" - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "template_repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - ] - }, - "temp_clone_token": { - "type": [ - "string", - "null" - ] - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean" - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "parent": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "source": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "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" - }, - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "key", - "name", - "html_url" - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "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_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "307", - "description": "

Temporary Redirect

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [ - "

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\n
", - "

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\n
" - ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}", - "title": "Delete a repository", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deleting a repository requires admin access.

\n

If an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a 403 Forbidden response.

\n

OAuth app tokens and personal access tokens (classic) need the delete_repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "307", - "description": "

Temporary Redirect

" - }, - { - "httpStatusCode": "403", - "description": "

If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/activity", - "title": "List repository activities", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "description": "

The Git reference for the activities you want to list.

\n

The ref for a branch can be formatted either as refs/heads/BRANCH_NAME or BRANCH_NAME, where BRANCH_NAME is the name of your branch.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "actor", - "description": "

The GitHub username to use to filter by the actor who performed the activity.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "time_period", - "description": "

The time period to filter by.

\n

For example, day will filter for activity that occurred in the past 24 hours, and week will filter for activity that occurred in the past 7 days (168 hours).

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "day", - "week", - "month", - "quarter", - "year" - ] - } - }, - { - "name": "activity_type", - "description": "

The activity type to filter by.

\n

For example, you can choose to filter by \"force_push\", to see all force pushes to the repository.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "push", - "force_push", - "branch_creation", - "branch_deletion", - "pr_merge", - "merge_queue_merge" - ] - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.

\n

For more information about viewing repository activity,\nsee \"Viewing activity and data for your repository.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "before": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "after": "827efc6d56897b048c772eb4087f854f46256132", - "ref": "refs/heads/main", - "pushed_at": "2011-01-26T19:06:43Z", - "push_type": "normal", - "pusher": { - "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 - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Activity", - "description": "Activity", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "before": { - "type": "string", - "description": "The SHA of the commit before the activity." - }, - "after": { - "type": "string", - "description": "The SHA of the commit after the activity." - }, - "ref": { - "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." - }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the activity occurred." - }, - "activity_type": { - "type": "string", - "enum": [ - "push", - "force_push", - "branch_deletion", - "branch_creation", - "pr_merge", - "merge_queue_merge" - ], - "description": "The type of the activity that was performed." - }, - "actor": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "before", - "after", - "ref", - "timestamp", - "activity_type", - "actor" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/automated-security-fixes", - "title": "Check if Dependabot security updates are enabled for a repository", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"Configuring Dependabot security updates\".

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response if Dependabot is enabled

", - "example": { - "enabled": true, - "paused": false - }, - "schema": { - "title": "Check Dependabot security updates", - "description": "Check Dependabot security updates", - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Whether Dependabot security updates are enabled for the repository." - }, - "paused": { - "type": "boolean", - "description": "Whether Dependabot security updates are paused for the repository." - } - }, - "required": [ - "enabled", - "paused" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Response if Dependabot is enabled

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found if Dependabot is not enabled for the repository

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/codeowners/errors", - "title": "List CODEOWNERS errors", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "description": "

A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. main)

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List any syntax errors that are detected in the CODEOWNERS\nfile.

\n

For more information about the correct CODEOWNERS syntax,\nsee \"About code owners.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "errors": [ - { - "line": 3, - "column": 1, - "kind": "Invalid pattern", - "source": "***/*.rb @monalisa", - "suggestion": "Did you mean `**/*.rb`?", - "message": "Invalid pattern on line 3: Did you mean `**/*.rb`?\n\n ***/*.rb @monalisa\n ^", - "path": ".github/CODEOWNERS" - }, - { - "line": 7, - "column": 7, - "kind": "Invalid owner", - "source": "*.txt docs@", - "suggestion": null, - "message": "Invalid owner on line 7:\n\n *.txt docs@\n ^", - "path": ".github/CODEOWNERS" - } - ] - }, - "schema": { - "title": "CODEOWNERS errors", - "description": "A list of errors found in a repo's CODEOWNERS file", - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "line": { - "description": "The line number where this errors occurs.", - "type": "integer" - }, - "column": { - "description": "The column number where this errors occurs.", - "type": "integer" - }, - "source": { - "description": "The contents of the line where the error occurs.", - "type": "string" - }, - "kind": { - "description": "The type of error.", - "type": "string" - }, - "suggestion": { - "description": "Suggested action to fix the error. This will usually be `null`, but is provided for some common errors.", - "type": [ - "string", - "null" - ] - }, - "message": { - "description": "A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting).", - "type": "string" - }, - "path": { - "description": "The path of the file where the error occured.", - "type": "string" - } - }, - "required": [ - "line", - "column", - "kind", - "message", - "path" - ] - } - } - }, - "required": [ - "errors" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/contributors", - "title": "List repository contributors", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "anon", - "description": "

Set to 1 or true to include anonymous contributors in results.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.

\n

GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

If repository contains content

", - "example": [ - { - "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, - "contributions": 32 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Contributor", - "description": "Contributor", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "contributions": { - "type": "integer" - }, - "email": { - "type": "string" - }, - "name": { - "type": "string" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "contributions", - "type" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

If repository contains content

" - }, - { - "httpStatusCode": "204", - "description": "

Response if repository is empty

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/dispatches", - "title": "Create a repository dispatch event", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "event_type", - "description": "

A custom webhook event name. Must be 100 characters or fewer.

", - "isRequired": true - }, - { - "type": "object", - "name": "client_payload", - "description": "

JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB.

" - } - ], - "descriptionHTML": "

You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs. For an example repository_dispatch webhook payload, see \"RepositoryDispatchEvent.\"

\n

The client_payload parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the client_payload can include a message that a user would like to send using a GitHub Actions workflow. Or the client_payload can be used as a test to debug your workflow.

\n

This input example shows how you can use the client_payload as a test to debug your workflow.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "event_type": "on-demand-test", - "client_payload": { - "unit": false, - "integration": true - } - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/languages", - "title": "List repository languages", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "C": 78769, - "Python": 7769 - }, - "schema": { - "title": "Language", - "description": "Language", - "type": "object", - "additionalProperties": { - "type": "integer" - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/replicas/caches", - "title": "List repository cache replication status", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the status of each repository cache replica.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Status information for cache replicas

", - "example": [ - { - "host": "host-1", - "location": "berlin", - "git": [ - { - "sync_status": "in_sync" - }, - { - "last_sync": "2022-01-10T19:33:52Z" - } - ] - }, - { - "host": "host-2", - "location": "chicago", - "git": [ - { - "sync_status": "offline" - }, - { - "last_sync": "2022-01-10T19:34:12Z" - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "description": "Status for a cache replica", - "type": "object", - "properties": { - "host": { - "type": "string" - }, - "location": { - "type": "string" - }, - "git": { - "type": "object", - "properties": { - "sync_status": { - "type": "string", - "enum": [ - "offline", - "inactive", - "in_sync", - "not_in_sync" - ] - }, - "last_sync": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "sync_status", - "last_sync" - ] - } - }, - "required": [ - "host", - "location", - "git" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Status information for cache replicas

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/tags", - "title": "List repository tags", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "name": "v0.1", - "commit": { - "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" - }, - "zipball_url": "https://github.com/octocat/Hello-World/zipball/v0.1", - "tarball_url": "https://github.com/octocat/Hello-World/tarball/v0.1", - "node_id": "MDQ6VXNlcjE=" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Tag", - "description": "Tag", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "commit": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - }, - "zipball_url": { - "type": "string", - "format": "uri" - }, - "tarball_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "name", - "node_id", - "commit", - "zipball_url", - "tarball_url" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/teams", - "title": "List repository teams", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the teams that have access to the specified repository and that are also visible to the authenticated user.

\n

For a public repository, a team is listed only if that team added the public repository explicitly.

\n

OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to use this endpoint with a public repository, and repo scope to use this endpoint with a private repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/topics", - "title": "Get all repository topics", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "names": [ - "octocat", - "atom", - "electron", - "api" - ] - }, - "schema": { - "title": "Topic", - "description": "A topic aggregates entities that are related to a subject.", - "type": "object", - "properties": { - "names": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "names" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/topics", - "title": "Replace all repository topics", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "names", - "description": "

An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names will be saved as lowercase.

", - "isRequired": true - } - ], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "names": [ - "octocat", - "atom", - "electron", - "api" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "names": [ - "octocat", - "atom", - "electron", - "api" - ] - }, - "schema": { - "title": "Topic", - "description": "A topic aggregates entities that are related to a subject.", - "type": "object", - "properties": { - "names": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "names" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/transfer", - "title": "Transfer a repository", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "new_owner", - "description": "

The username or organization name the repository will be transferred to.

", - "isRequired": true - }, - { - "type": "string", - "name": "new_name", - "description": "

The new name to be given to the repository.

" - }, - { - "type": "array of integers", - "name": "team_ids", - "description": "

ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

" - } - ], - "descriptionHTML": "

A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "new_owner": "github", - "team_ids": [ - 12, - 345 - ], - "new_name": "octorepo" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "allow_forking": true, - "subscribers_count": 42, - "network_count": 0 - } - }, - "schema": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ], - "disabledForPatV2": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "title": "Check if vulnerability alerts are enabled for a repository", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response if repository is enabled with vulnerability alerts

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

Response if repository is enabled with vulnerability alerts

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found if repository is not enabled with vulnerability alerts

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "title": "Enable vulnerability alerts", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", - "title": "Disable vulnerability alerts", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Disables dependency alerts for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"About security alerts for vulnerable dependencies\".

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{template_owner}/{template_repo}/generate", - "title": "Create a repository using a template", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "template_owner", - "description": "

The account owner of the template repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "template_repo", - "description": "

The name of the template repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "owner", - "description": "

The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the new repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

A short description of the new repository.

" - }, - { - "type": "boolean", - "name": "include_all_branches", - "description": "

Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.

", - "default": false - }, - { - "type": "boolean", - "name": "private", - "description": "

Either true to create a new private repository or false to create a new public one.

", - "default": false - } - ], - "descriptionHTML": "

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. If the repository is not public, 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 endpoint and check that the is_template key is true.

\n

OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "owner": "octocat", - "name": "Hello-World", - "description": "This is your first repository", - "include_all_branches": false, - "private": false - }, - "parameters": { - "template_owner": "TEMPLATE_OWNER", - "template_repo": "TEMPLATE_REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "allow_forking": true, - "web_commit_signoff_required": false, - "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, - "allow_auto_merge": false, - "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, - "allow_auto_merge": false, - "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 - } - }, - "schema": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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" - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "template_repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - ] - }, - "temp_clone_token": { - "type": [ - "string", - "null" - ] - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean" - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "parent": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "source": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "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" - }, - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "key", - "name", - "html_url" - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "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_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - } - ], - "previews": [ - "

Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json\n
" - ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write", - "\"Contents\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repositories", - "title": "List public repositories", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "since", - "description": "

A repository ID. Only return repositories with an ID greater than this ID.

", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "visibility", - "description": "

Specifies the types of repositories to return. This endpoint will only list repositories available to all users on the enterprise.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "public", - "enum": [ - "all", - "public" - ], - "examples": [ - "all" - ] - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all public repositories in the order that they were created.

\n

Note:

\n
    \n
  • For GitHub Enterprise Server, 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 to get the URL for the next page of repositories.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/repos", - "title": "List repositories for the authenticated user", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "visibility", - "description": "

Limit results to repositories with the specified visibility.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "public", - "private" - ], - "default": "all" - } - }, - { - "name": "affiliation", - "description": "

Comma-separated list of values. Can include:

\n
    \n
  • owner: Repositories that are owned by the authenticated user.
    • \n
  • collaborator: Repositories that the user has been added to as a collaborator.
    • \n
  • organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.
    • \n
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "owner,collaborator,organization_member" - } - }, - { - "name": "type", - "description": "

Limit results to repositories of the specified type. Will cause a 422 error if used in the same request as visibility or affiliation.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "owner", - "public", - "private", - "member" - ], - "default": "all" - } - }, - { - "name": "sort", - "description": "

The property to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "pushed", - "full_name" - ], - "default": "full_name" - } - }, - { - "name": "direction", - "description": "

The order to sort by. Default: asc when using full_name, otherwise desc.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ] - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "since", - "description": "

Only show repositories updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "before", - "description": "

Only show repositories updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Default response

", - "example": [ - { - "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, - "allow_auto_merge": false, - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/user/repos", - "title": "Create a repository for the authenticated user", - "category": "repos", - "subcategory": "repos", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

A short description of the repository.

" - }, - { - "type": "string", - "name": "homepage", - "description": "

A URL with more information about the repository.

" - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private.

", - "default": false - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "default": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "default": false - }, - { - "type": "integer", - "name": "team_id", - "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.

" - }, - { - "type": "boolean", - "name": "auto_init", - "description": "

Whether the repository is initialized with a minimal README.

", - "default": false - }, - { - "type": "string", - "name": "gitignore_template", - "description": "

The desired language or platform to apply to the .gitignore.

" - }, - { - "type": "string", - "name": "license_template", - "description": "

The license keyword of the open source license for this repository.

" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow Auto-merge to be used on pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "default": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", - "default": false - } - ], - "descriptionHTML": "

Creates a new repository for the authenticated user.

\n

OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Hello-World", - "description": "This is your first repo!", - "homepage": "https://github.com", - "private": false, - "is_template": true - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "allow_forking": true, - "web_commit_signoff_required": false, - "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, - "allow_auto_merge": false, - "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, - "allow_auto_merge": false, - "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 - } - }, - "schema": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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" - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "template_repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - ] - }, - "temp_clone_token": { - "type": [ - "string", - "null" - ] - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean" - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "parent": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "source": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "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" - }, - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "key", - "name", - "html_url" - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "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_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/repos", - "title": "List repositories for a user", - "category": "repos", - "subcategory": "repos", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "type", - "description": "

Limit results to repositories of the specified type.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "owner", - "member" - ], - "default": "owner" - } - }, - { - "name": "sort", - "description": "

The property to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "pushed", - "full_name" - ], - "default": "full_name" - } - }, - { - "name": "direction", - "description": "

The order to sort by. Default: asc when using full_name, otherwise desc.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ] - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists public repositories for the specified user.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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, - "has_discussions": false, - "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 - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ], - "autolinks": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/autolinks", - "title": "Get all autolinks of a repository", - "category": "repos", - "subcategory": "autolinks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets all autolinks that are configured for a repository.

\n

Information about autolinks are only available to repository administrators.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 1, - "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=", - "is_alphanumeric": true - } - ], - "schema": { - "type": "array", - "items": { - "title": "Autolink reference", - "description": "An autolink reference.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "key_prefix": { - "description": "The prefix of a key that is linkified.", - "type": "string" - }, - "url_template": { - "description": "A template for the target URL that is generated if a key was found.", - "type": "string" - }, - "is_alphanumeric": { - "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.", - "type": "boolean" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "key_prefix", - "url_template", - "is_alphanumeric" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/autolinks", - "title": "Create an autolink reference for a repository", - "category": "repos", - "subcategory": "autolinks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "key_prefix", - "description": "

This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit.

", - "isRequired": true - }, - { - "type": "string", - "name": "url_template", - "description": "

The URL must contain <num> for the reference number. <num> matches different characters depending on the value of is_alphanumeric.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_alphanumeric", - "description": "

Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters.

", - "default": true - } - ], - "descriptionHTML": "

Users with admin access to the repository can create an autolink.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=", - "is_alphanumeric": true - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

response

", - "example": { - "id": 1, - "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=", - "is_alphanumeric": true - }, - "schema": { - "title": "Autolink reference", - "description": "An autolink reference.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "key_prefix": { - "description": "The prefix of a key that is linkified.", - "type": "string" - }, - "url_template": { - "description": "A template for the target URL that is generated if a key was found.", - "type": "string" - }, - "is_alphanumeric": { - "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.", - "type": "boolean" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "key_prefix", - "url_template", - "is_alphanumeric" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}", - "title": "Get an autolink reference of a repository", - "category": "repos", - "subcategory": "autolinks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "autolink_id", - "description": "

The unique identifier of the autolink.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

This returns a single autolink reference by ID that was configured for the given repository.

\n

Information about autolinks are only available to repository administrators.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "autolink_id": "AUTOLINK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=", - "is_alphanumeric": true - }, - "schema": { - "title": "Autolink reference", - "description": "An autolink reference.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "key_prefix": { - "description": "The prefix of a key that is linkified.", - "type": "string" - }, - "url_template": { - "description": "A template for the target URL that is generated if a key was found.", - "type": "string" - }, - "is_alphanumeric": { - "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.", - "type": "boolean" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "key_prefix", - "url_template", - "is_alphanumeric" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}", - "title": "Delete an autolink reference from a repository", - "category": "repos", - "subcategory": "autolinks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "autolink_id", - "description": "

The unique identifier of the autolink.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

This deletes a single autolink reference by ID that was configured for the given repository.

\n

Information about autolinks are only available to repository administrators.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "autolink_id": "AUTOLINK_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - } - ], - "contents": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "title": "Get repository content", - "category": "repos", - "subcategory": "contents", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "path", - "description": "

path parameter

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "description": "

The name of the commit/branch/tag. Default: the repository’s default branch.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory with the path parameter. If you omit the path parameter, you will receive the contents of the repository's root directory.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents for files and symlinks.
    • \n
  • application/vnd.github.html+json: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
  • application/vnd.github.object+json: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an entries attribute containing the array of objects.
    • \n
\n

If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value should be \"submodule\". This behavior exists for backwards compatibility purposes. In the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.

\n

If the content is a submodule, the submodule_git_url field identifies the location of the submodule repository, and the sha identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the github.com URLs (html_url and _links[\"html\"]) will have null values.

\n

Notes:

\n
    \n
  • To get a repository's contents recursively, you can recursively get the tree.
    • \n
  • This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the Git Trees API.
    • \n
  • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
    • \n
  • If the requested file's size is:\n
      \n
    • 1 MB or smaller: All features of this endpoint are supported.
      • \n
    • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty\nstring and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
      • \n
    • Greater than 100 MB: This endpoint is not supported.
      • \n
    \n
    • \n
", - "codeExamples": [ - { - "response": { - "statusCode": "200", - "contentType": "application/vnd.github.object", - "description": "

Response if content is a file

", - "example": { - "type": "file", - "encoding": "base64", - "size": 5362, - "name": "README.md", - "path": "README.md", - "content": "IyBZb2dhIEJvmsgaW4gcHJvZ3Jlc3MhIEZlZWwgdAoKOndhcm5pbmc6IFdvc\\nZnJlZSBmUgdG8gY0byBjaGVjayBvdXQgdGhlIGFwcCwgYnV0IGJlIHN1c29t\\nZSBiYWNrIG9uY2UgaXQgaXMgY29tcGxldGUuCgpBIHdlYiBhcHAgdGhhdCBs\\nZWFkcyB5b3UgdGhyb3VnaCBhIHlvZ2Egc2Vzc2lvbi4KCltXb3Jrb3V0IG5v\\ndyFdKGh0dHBzOi8vc2tlZHdhcmRzODguZ2l0aHViLmlvL3lvZ2EvKQoKPGlt\\nZyBzcmM9InNyYy9pbWFnZXMvbWFza2FibGVfaWNvbl81MTIucG5nIiBhbHQ9\\nImJvdCBsaWZ0aW5nIHdlaWdodHMiIHdpZHRoPSIxMDAiLz4KCkRvIHlvdSBo\\nYXZlIGZlZWRiYWNrIG9yIGlkZWFzIGZvciBpbXByb3ZlbWVudD8gW09wZW4g\\nYW4gaXNzdWVdKGh0dHBzOi8vZ2l0aHViLmNvbS9za2Vkd2FyZHM4OC95b2dh\\nL2lzc3Vlcy9uZXcpLgoKV2FudCBtb3JlIGdhbWVzPyBWaXNpdCBbQ25TIEdh\\nbWVzXShodHRwczovL3NrZWR3YXJkczg4LmdpdGh1Yi5pby9wb3J0Zm9saW8v\\nKS4KCiMjIERldmVsb3BtZW50CgpUbyBhZGQgYSBuZXcgcG9zZSwgYWRkIGFu\\nIGVudHJ5IHRvIHRoZSByZWxldmFudCBmaWxlIGluIGBzcmMvYXNhbmFzYC4K\\nClRvIGJ1aWxkLCBydW4gYG5wbSBydW4gYnVpbGRgLgoKVG8gcnVuIGxvY2Fs\\nbHkgd2l0aCBsaXZlIHJlbG9hZGluZyBhbmQgbm8gc2VydmljZSB3b3JrZXIs\\nIHJ1biBgbnBtIHJ1biBkZXZgLiAoSWYgYSBzZXJ2aWNlIHdvcmtlciB3YXMg\\ncHJldmlvdXNseSByZWdpc3RlcmVkLCB5b3UgY2FuIHVucmVnaXN0ZXIgaXQg\\naW4gY2hyb21lIGRldmVsb3BlciB0b29sczogYEFwcGxpY2F0aW9uYCA+IGBT\\nZXJ2aWNlIHdvcmtlcnNgID4gYFVucmVnaXN0ZXJgLikKClRvIHJ1biBsb2Nh\\nbGx5IGFuZCByZWdpc3RlciB0aGUgc2VydmljZSB3b3JrZXIsIHJ1biBgbnBt\\nIHN0YXJ0YC4KClRvIGRlcGxveSwgcHVzaCB0byBgbWFpbmAgb3IgbWFudWFs\\nbHkgdHJpZ2dlciB0aGUgYC5naXRodWIvd29ya2Zsb3dzL2RlcGxveS55bWxg\\nIHdvcmtmbG93Lgo=\\n", - "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", - "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", - "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", - "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", - "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", - "_links": { - "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", - "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", - "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" - } - }, - "schema": { - "title": "Content Tree", - "description": "Content Tree", - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "content": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url" - ] - } - }, - "encoding": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url" - ] - } - }, - "request": { - "contentType": "application/json", - "description": "Content is a file using the object media type", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "path": "PATH" - } - } - }, - { - "response": { - "statusCode": "200", - "contentType": "application/vnd.github.object", - "description": "

Response if content is a directory and the application/vnd.github.v3.object media type is requested

", - "example": { - "type": "dir", - "size": 0, - "name": "src", - "path": "src", - "sha": "2962be1c94eaae9794b3080790ec9d74b2fa8358", - "url": "https://api.github.com/repos/octocat/octorepo/contents/src?ref=main", - "git_url": "https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", - "html_url": "https://github.com/octocat/octorepo/blob/main/src", - "download_url": "https://raw.githubusercontent.com/octocat/octorepo/main/src", - "_links": { - "self": "https://api.github.com/repos/octocat/octorepo/contents/src", - "git": "https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", - "html": "https://github.com/octocat/octorepo/blob/main/src" - }, - "entries": [ - { - "type": "file", - "size": 625, - "name": "app.js", - "path": "src/app.js", - "sha": "fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", - "url": "https://api.github.com/repos/octocat/octorepo/contents/src/app.js", - "git_url": "https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", - "html_url": "https://github.com/octocat/octorepo/blob/main/src/app.js", - "download_url": "https://raw.githubusercontent.com/octocat/octorepo/main/src/app.js", - "_links": { - "self": "https://api.github.com/repos/octocat/octorepo/contents/src/app.js", - "git": "https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", - "html": "https://github.com/octocat/octorepo/blob/main/src/app.js" - } - }, - { - "type": "dir", - "size": 0, - "name": "images", - "path": "src/images", - "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", - "url": "https://api.github.com/repos/octocat/octorepo/contents/src/images", - "git_url": "https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", - "html_url": "https://github.com/octocat/octorepo/tree/main/src/images", - "download_url": null, - "_links": { - "self": "https://api.github.com/repos/octocat/octorepo/contents/src/images", - "git": "https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", - "html": "https://github.com/octocat/octorepo/tree/main/src/images" - } - } - ] - }, - "schema": { - "title": "Content Tree", - "description": "Content Tree", - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "content": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url" - ] - } - }, - "encoding": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url" - ] - } - }, - "request": { - "contentType": "application/json", - "description": "Content is a directory using the object media type", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "path": "PATH" - } - } - }, - { - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response if content is a file

", - "example": { - "type": "file", - "encoding": "base64", - "size": 5362, - "name": "README.md", - "path": "README.md", - "content": "IyBZb2dhIEJvmsgaW4gcHJvZ3Jlc3MhIEZlZWwgdAoKOndhcm5pbmc6IFdvc\\nZnJlZSBmUgdG8gY0byBjaGVjayBvdXQgdGhlIGFwcCwgYnV0IGJlIHN1c29t\\nZSBiYWNrIG9uY2UgaXQgaXMgY29tcGxldGUuCgpBIHdlYiBhcHAgdGhhdCBs\\nZWFkcyB5b3UgdGhyb3VnaCBhIHlvZ2Egc2Vzc2lvbi4KCltXb3Jrb3V0IG5v\\ndyFdKGh0dHBzOi8vc2tlZHdhcmRzODguZ2l0aHViLmlvL3lvZ2EvKQoKPGlt\\nZyBzcmM9InNyYy9pbWFnZXMvbWFza2FibGVfaWNvbl81MTIucG5nIiBhbHQ9\\nImJvdCBsaWZ0aW5nIHdlaWdodHMiIHdpZHRoPSIxMDAiLz4KCkRvIHlvdSBo\\nYXZlIGZlZWRiYWNrIG9yIGlkZWFzIGZvciBpbXByb3ZlbWVudD8gW09wZW4g\\nYW4gaXNzdWVdKGh0dHBzOi8vZ2l0aHViLmNvbS9za2Vkd2FyZHM4OC95b2dh\\nL2lzc3Vlcy9uZXcpLgoKV2FudCBtb3JlIGdhbWVzPyBWaXNpdCBbQ25TIEdh\\nbWVzXShodHRwczovL3NrZWR3YXJkczg4LmdpdGh1Yi5pby9wb3J0Zm9saW8v\\nKS4KCiMjIERldmVsb3BtZW50CgpUbyBhZGQgYSBuZXcgcG9zZSwgYWRkIGFu\\nIGVudHJ5IHRvIHRoZSByZWxldmFudCBmaWxlIGluIGBzcmMvYXNhbmFzYC4K\\nClRvIGJ1aWxkLCBydW4gYG5wbSBydW4gYnVpbGRgLgoKVG8gcnVuIGxvY2Fs\\nbHkgd2l0aCBsaXZlIHJlbG9hZGluZyBhbmQgbm8gc2VydmljZSB3b3JrZXIs\\nIHJ1biBgbnBtIHJ1biBkZXZgLiAoSWYgYSBzZXJ2aWNlIHdvcmtlciB3YXMg\\ncHJldmlvdXNseSByZWdpc3RlcmVkLCB5b3UgY2FuIHVucmVnaXN0ZXIgaXQg\\naW4gY2hyb21lIGRldmVsb3BlciB0b29sczogYEFwcGxpY2F0aW9uYCA+IGBT\\nZXJ2aWNlIHdvcmtlcnNgID4gYFVucmVnaXN0ZXJgLikKClRvIHJ1biBsb2Nh\\nbGx5IGFuZCByZWdpc3RlciB0aGUgc2VydmljZSB3b3JrZXIsIHJ1biBgbnBt\\nIHN0YXJ0YC4KClRvIGRlcGxveSwgcHVzaCB0byBgbWFpbmAgb3IgbWFudWFs\\nbHkgdHJpZ2dlciB0aGUgYC5naXRodWIvd29ya2Zsb3dzL2RlcGxveS55bWxg\\nIHdvcmtmbG93Lgo=\\n", - "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", - "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", - "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", - "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", - "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", - "_links": { - "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", - "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", - "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" - } - }, - "schema": { - "oneOf": [ - { - "title": "Content Directory", - "description": "A list of directory items", - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "dir", - "file", - "submodule", - "symlink" - ] - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "content": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url" - ] - } - }, - { - "title": "Content File", - "description": "Content File", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "file" - ] - }, - "encoding": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "content": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - }, - "target": { - "type": "string" - }, - "submodule_git_url": { - "type": "string" - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url", - "content", - "encoding" - ] - }, - { - "title": "Symlink Content", - "description": "An object describing a symlink", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "symlink" - ] - }, - "target": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url", - "target" - ] - }, - { - "title": "Submodule Content", - "description": "An object describing a submodule", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "submodule" - ] - }, - "submodule_git_url": { - "type": "string", - "format": "uri" - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url", - "submodule_git_url" - ] - } - ] - } - }, - "request": { - "contentType": "application/json", - "description": "Content is a file", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "path": "PATH" - } - } - }, - { - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response if content is a directory and the application/json media type is requested

", - "example": [ - { - "type": "file", - "size": 625, - "name": "octokit.rb", - "path": "lib/octokit.rb", - "sha": "fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", - "url": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb", - "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", - "html_url": "https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb", - "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb", - "_links": { - "self": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb", - "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", - "html": "https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb" - } - }, - { - "type": "dir", - "size": 0, - "name": "octokit", - "path": "lib/octokit", - "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", - "url": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit", - "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", - "html_url": "https://github.com/octokit/octokit.rb/tree/master/lib/octokit", - "download_url": null, - "_links": { - "self": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit", - "git": "https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", - "html": "https://github.com/octokit/octokit.rb/tree/master/lib/octokit" - } - } - ], - "schema": { - "oneOf": [ - { - "title": "Content Directory", - "description": "A list of directory items", - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "dir", - "file", - "submodule", - "symlink" - ] - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "content": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url" - ] - } - }, - { - "title": "Content File", - "description": "Content File", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "file" - ] - }, - "encoding": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "content": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - }, - "target": { - "type": "string" - }, - "submodule_git_url": { - "type": "string" - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url", - "content", - "encoding" - ] - }, - { - "title": "Symlink Content", - "description": "An object describing a symlink", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "symlink" - ] - }, - "target": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url", - "target" - ] - }, - { - "title": "Submodule Content", - "description": "An object describing a submodule", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "submodule" - ] - }, - "submodule_git_url": { - "type": "string", - "format": "uri" - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url", - "submodule_git_url" - ] - } - ] - } - }, - "request": { - "contentType": "application/json", - "description": "Content is a directory", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "path": "PATH" - } - } - }, - { - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response if content is a symlink and the application/json media type is requested

", - "example": { - "type": "symlink", - "target": "/path/to/symlink/target", - "size": 23, - "name": "some-symlink", - "path": "bin/some-symlink", - "sha": "452a98979c88e093d682cab404a3ec82babebb48", - "url": "https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink", - "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48", - "html_url": "https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink", - "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/bin/some-symlink", - "_links": { - "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48", - "self": "https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink", - "html": "https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink" - } - }, - "schema": { - "oneOf": [ - { - "title": "Content Directory", - "description": "A list of directory items", - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "dir", - "file", - "submodule", - "symlink" - ] - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "content": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url" - ] - } - }, - { - "title": "Content File", - "description": "Content File", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "file" - ] - }, - "encoding": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "content": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - }, - "target": { - "type": "string" - }, - "submodule_git_url": { - "type": "string" - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url", - "content", - "encoding" - ] - }, - { - "title": "Symlink Content", - "description": "An object describing a symlink", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "symlink" - ] - }, - "target": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url", - "target" - ] - }, - { - "title": "Submodule Content", - "description": "An object describing a submodule", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "submodule" - ] - }, - "submodule_git_url": { - "type": "string", - "format": "uri" - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url", - "submodule_git_url" - ] - } - ] - } - }, - "request": { - "contentType": "application/json", - "description": "Content is a symlink", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "path": "PATH" - } - } - }, - { - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response if content is a submodule and the application/json media type is requested

", - "example": { - "type": "submodule", - "submodule_git_url": "git://github.com/jquery/qunit.git", - "size": 0, - "name": "qunit", - "path": "test/qunit", - "sha": "6ca3721222109997540bd6d9ccd396902e0ad2f9", - "url": "https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master", - "git_url": "https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9", - "html_url": "https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9", - "download_url": null, - "_links": { - "git": "https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9", - "self": "https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master", - "html": "https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9" - } - }, - "schema": { - "oneOf": [ - { - "title": "Content Directory", - "description": "A list of directory items", - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "dir", - "file", - "submodule", - "symlink" - ] - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "content": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url" - ] - } - }, - { - "title": "Content File", - "description": "Content File", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "file" - ] - }, - "encoding": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "content": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - }, - "target": { - "type": "string" - }, - "submodule_git_url": { - "type": "string" - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url", - "content", - "encoding" - ] - }, - { - "title": "Symlink Content", - "description": "An object describing a symlink", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "symlink" - ] - }, - "target": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url", - "target" - ] - }, - { - "title": "Submodule Content", - "description": "An object describing a submodule", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "submodule" - ] - }, - "submodule_git_url": { - "type": "string", - "format": "uri" - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url", - "submodule_git_url" - ] - } - ] - } - }, - "request": { - "contentType": "application/json", - "description": "Content is a submodule", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "path": "PATH" - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "302", - "description": "

Found

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "title": "Create or update file contents", - "category": "repos", - "subcategory": "contents", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "path", - "description": "

path parameter

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "message", - "description": "

The commit message.

", - "isRequired": true - }, - { - "type": "string", - "name": "content", - "description": "

The new file content, using Base64 encoding.

", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "

Required if you are updating a file. The blob SHA of the file being replaced.

" - }, - { - "type": "string", - "name": "branch", - "description": "

The branch name. Default: the repository’s default branch.

" - }, - { - "type": "object", - "name": "committer", - "description": "

The person that committed the file. Default: the authenticated user.

", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

", - "isRequired": true - }, - { - "type": "string", - "name": "email", - "description": "

The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

", - "isRequired": true - }, - { - "type": "string", - "name": "date", - "description": "" - } - ] - }, - { - "type": "object", - "name": "author", - "description": "

The author of the file. Default: The committer or the authenticated user if you omit committer.

", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

", - "isRequired": true - }, - { - "type": "string", - "name": "email", - "description": "

The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

", - "isRequired": true - }, - { - "type": "string", - "name": "date", - "description": "" - } - ] - } - ], - "descriptionHTML": "

Creates a new file or replaces an existing file in a repository.

\n

Note

\n

\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.

\n
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example for creating a file", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "message": "my commit message", - "committer": { - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "content": "bXkgbmV3IGZpbGUgY29udGVudHM=" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "path": "PATH" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "content": { - "name": "hello.txt", - "path": "notes/hello.txt", - "sha": "95b966ae1c166bd92f8ae7d1c313e738c731dfc3", - "size": 9, - "url": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", - "html_url": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt", - "git_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3", - "download_url": "https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt", - "type": "file", - "_links": { - "self": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", - "git": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3", - "html": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt" - } - }, - "commit": { - "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", - "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", - "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd", - "author": { - "date": "2014-11-07T22:01:45Z", - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "committer": { - "date": "2014-11-07T22:01:45Z", - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "message": "my commit message", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", - "sha": "691272480426f78a0138979dd3ce63b77f706feb" - }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", - "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5", - "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5" - } - ], - "verification": { - "verified": false, - "reason": "unsigned" - } - } - }, - "schema": { - "title": "File Commit", - "description": "File Commit", - "type": "object", - "required": [ - "content", - "commit" - ], - "properties": { - "content": { - "type": [ - "object", - "null" - ], - "properties": { - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "string" - }, - "git": { - "type": "string" - }, - "html": { - "type": "string" - } - } - } - } - }, - "commit": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "author": { - "type": "object", - "properties": { - "date": { - "type": "string" - }, - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - } - }, - "committer": { - "type": "object", - "properties": { - "date": { - "type": "string" - }, - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - } - }, - "message": { - "type": "string" - }, - "tree": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "sha": { - "type": "string" - } - } - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "sha": { - "type": "string" - } - } - } - }, - "verification": { - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "signature": { - "type": [ - "string", - "null" - ] - }, - "payload": { - "type": [ - "string", - "null" - ] - } - } - } - } - } - } - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Example for updating a file", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "message": "a new commit message", - "committer": { - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "content": "bXkgdXBkYXRlZCBmaWxlIGNvbnRlbnRz", - "sha": "95b966ae1c166bd92f8ae7d1c313e738c731dfc3" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "path": "PATH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "content": { - "name": "hello.txt", - "path": "notes/hello.txt", - "sha": "a56507ed892d05a37c6d6128c260937ea4d287bd", - "size": 9, - "url": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", - "html_url": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt", - "git_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd", - "download_url": "https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt", - "type": "file", - "_links": { - "self": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", - "git": "https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd", - "html": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt" - } - }, - "commit": { - "sha": "18a43cd8e1e3a79c786e3d808a73d23b6d212b16", - "node_id": "MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16", - "html_url": "https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16", - "author": { - "date": "2014-11-07T22:01:45Z", - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "committer": { - "date": "2014-11-07T22:01:45Z", - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "message": "my commit message", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f", - "sha": "9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f" - }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6", - "html_url": "https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6", - "sha": "da5a433788da5c255edad7979b328b67d79f53f6" - } - ], - "verification": { - "verified": false, - "reason": "unsigned" - } - } - }, - "schema": { - "title": "File Commit", - "description": "File Commit", - "type": "object", - "required": [ - "content", - "commit" - ], - "properties": { - "content": { - "type": [ - "object", - "null" - ], - "properties": { - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "string" - }, - "git": { - "type": "string" - }, - "html": { - "type": "string" - } - } - } - } - }, - "commit": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "author": { - "type": "object", - "properties": { - "date": { - "type": "string" - }, - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - } - }, - "committer": { - "type": "object", - "properties": { - "date": { - "type": "string" - }, - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - } - }, - "message": { - "type": "string" - }, - "tree": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "sha": { - "type": "string" - } - } - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "sha": { - "type": "string" - } - } - } - }, - "verification": { - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "signature": { - "type": [ - "string", - "null" - ] - }, - "payload": { - "type": [ - "string", - "null" - ] - } - } - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - }, - { - "\"Contents\" repository permissions": "write", - "\"Workflows\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/contents/{path}", - "title": "Delete a file", - "category": "repos", - "subcategory": "contents", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "path", - "description": "

path parameter

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "message", - "description": "

The commit message.

", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "

The blob SHA of the file being deleted.

", - "isRequired": true - }, - { - "type": "string", - "name": "branch", - "description": "

The branch name. Default: the repository’s default branch

" - }, - { - "type": "object", - "name": "committer", - "description": "

object containing information about the committer.

", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the author (or committer) of the commit

" - }, - { - "type": "string", - "name": "email", - "description": "

The email of the author (or committer) of the commit

" - } - ] - }, - { - "type": "object", - "name": "author", - "description": "

object containing information about the author.

", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the author (or committer) of the commit

" - }, - { - "type": "string", - "name": "email", - "description": "

The email of the author (or committer) of the commit

" - } - ] - } - ], - "descriptionHTML": "

Deletes a file in a repository.

\n

You can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.

\n

The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.

\n

You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.

\n

Note

\n

\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "message": "my commit message", - "committer": { - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "sha": "329688480d39049927147c162b9d2deaf885005f" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "path": "PATH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "commit": { - "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", - "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", - "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd", - "author": { - "date": "2014-11-07T22:01:45Z", - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "committer": { - "date": "2014-11-07T22:01:45Z", - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "message": "my commit message", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", - "sha": "691272480426f78a0138979dd3ce63b77f706feb" - }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", - "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5", - "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5" - } - ], - "verification": { - "verified": false, - "reason": "unsigned" - } - } - }, - "schema": { - "title": "File Commit", - "description": "File Commit", - "type": "object", - "required": [ - "content", - "commit" - ], - "properties": { - "content": { - "type": [ - "object", - "null" - ], - "properties": { - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "string" - }, - "git": { - "type": "string" - }, - "html": { - "type": "string" - } - } - } - } - }, - "commit": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "author": { - "type": "object", - "properties": { - "date": { - "type": "string" - }, - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - } - }, - "committer": { - "type": "object", - "properties": { - "date": { - "type": "string" - }, - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - } - }, - "message": { - "type": "string" - }, - "tree": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "sha": { - "type": "string" - } - } - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "sha": { - "type": "string" - } - } - } - }, - "verification": { - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "signature": { - "type": [ - "string", - "null" - ] - }, - "payload": { - "type": [ - "string", - "null" - ] - } - } - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "write" - }, - { - "\"Contents\" repository permissions": "write", - "\"Workflows\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/readme", - "title": "Get a repository README", - "category": "repos", - "subcategory": "contents", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "description": "

The name of the commit/branch/tag. Default: the repository’s default branch.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the preferred README for a repository.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
    • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "type": "file", - "encoding": "base64", - "size": 5362, - "name": "README.md", - "path": "README.md", - "content": "encoded content ...", - "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", - "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", - "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", - "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", - "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", - "_links": { - "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", - "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", - "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" - } - }, - "schema": { - "title": "Content File", - "description": "Content File", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "file" - ] - }, - "encoding": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "content": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - }, - "target": { - "type": "string" - }, - "submodule_git_url": { - "type": "string" - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url", - "content", - "encoding" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/readme/{dir}", - "title": "Get a repository README for a directory", - "category": "repos", - "subcategory": "contents", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dir", - "description": "

The alternate path to look for a README file

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "description": "

The name of the commit/branch/tag. Default: the repository’s default branch.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets the README from a repository directory.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
    • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "dir": "DIR" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "type": "file", - "encoding": "base64", - "size": 5362, - "name": "README.md", - "path": "README.md", - "content": "encoded content ...", - "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", - "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", - "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", - "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", - "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", - "_links": { - "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", - "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", - "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" - } - }, - "schema": { - "title": "Content File", - "description": "Content File", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "file" - ] - }, - "encoding": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "content": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - }, - "target": { - "type": "string" - }, - "submodule_git_url": { - "type": "string" - } - }, - "required": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url", - "content", - "encoding" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/tarball/{ref}", - "title": "Download a repository archive (tar)", - "category": "repos", - "subcategory": "contents", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.

\n

Note

\n

\nFor private repositories, these links are temporary and expire after five minutes.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "ref": "REF" - } - }, - "response": { - "statusCode": "302", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "302", - "description": "

Found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/zipball/{ref}", - "title": "Download a repository archive (zip)", - "category": "repos", - "subcategory": "contents", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.

\n

Note

\n

\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "ref": "REF" - } - }, - "response": { - "statusCode": "302", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "302", - "description": "

Found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Contents\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ], - "custom-properties": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/properties/values", - "title": "Get all custom property values for a repository", - "category": "repos", - "subcategory": "custom-properties", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets all custom property values that are set for a repository.\nUsers with read access to the repository can use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Custom Property Value", - "description": "Custom property name and associated value", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The value assigned to the property", - "type": [ - "null", - "string", - "array" - ] - } - }, - "required": [ - "property_name", - "value" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/properties/values", - "title": "Create or update custom property values for a repository", - "category": "repos", - "subcategory": "custom-properties", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "array of objects", - "name": "properties", - "description": "

A list of custom property names and associated values to apply to the repositories.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "property_name", - "description": "

The name of the property

", - "isRequired": true - }, - { - "type": "null or string or array", - "name": "value", - "description": "

The value assigned to the property

", - "isRequired": true - } - ] - } - ], - "descriptionHTML": "

Create new or update existing custom property values for a repository.\nUsing a value of null for a custom property will remove or 'unset' the property value from the repository.

\n

Repository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "properties": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

No Content when custom property values are successfully created or updated

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content when custom property values are successfully created or updated

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" repository permissions": "write" - } - ] - } - } - ], - "forks": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/forks", - "title": "List forks", - "category": "repos", - "subcategory": "forks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "

The sort order. stargazers will sort by star count.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "newest", - "oldest", - "stargazers", - "watchers" - ], - "default": "newest" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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": true, - "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 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "delete_branch_on_merge": 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==" - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/forks", - "title": "Create a fork", - "category": "repos", - "subcategory": "forks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "organization", - "description": "

Optional parameter to specify the organization name if forking into an organization.

" - }, - { - "type": "string", - "name": "name", - "description": "

When forking from an existing repository, a new name for the fork.

" - }, - { - "type": "boolean", - "name": "default_branch_only", - "description": "

When forking from an existing repository, fork with only the default branch.

" - } - ], - "descriptionHTML": "

Create a fork for the authenticated user.

\n

Note

\n

\nForking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Server Support.

\n
\n

Note

\n

\nAlthough this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "organization": "octocat", - "name": "Hello-World", - "default_branch_only": true - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "allow_forking": true, - "web_commit_signoff_required": false, - "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, - "allow_auto_merge": false, - "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, - "allow_auto_merge": false, - "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 - } - }, - "schema": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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" - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "template_repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - } - ] - }, - "temp_clone_token": { - "type": [ - "string", - "null" - ] - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean" - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "parent": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "source": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "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" - }, - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "key", - "name", - "html_url" - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "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_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write", - "\"Contents\" repository permissions": "read" - } - ] - } - } - ], - "lfs": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/lfs", - "title": "Enable Git LFS for a repository", - "category": "repos", - "subcategory": "lfs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Enables Git LFS for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the site_admin scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Accepted

", - "example": null, - "schema": { - "type": "object" - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "403", - "description": "

We will return a 403 with one of the following messages:

\n
    \n
  • Git LFS support not enabled because Git LFS is globally disabled.
    • \n
  • Git LFS support not enabled because Git LFS is disabled for the root repository in the network.
    • \n
  • Git LFS support not enabled because Git LFS is disabled for .
    • \n
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/lfs", - "title": "Disable Git LFS for a repository", - "category": "repos", - "subcategory": "lfs", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Disables Git LFS for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the site_admin scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ], - "rule-suites": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets/rule-suites", - "title": "List repository rule suites", - "category": "repos", - "subcategory": "rule-suites", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "description": "

The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned.

", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "time_period", - "description": "

The time period to filter by.

\n

For example, day will filter for rule suites that occurred in the past 24 hours, and week will filter for rule suites that occurred in the past 7 days (168 hours).

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "hour", - "day", - "week", - "month" - ], - "default": "day" - } - }, - { - "name": "actor_name", - "description": "

The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.

", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "rule_suite_result", - "description": "

The rule suite results to filter on. When specified, only suites with this result will be returned.

", - "in": "query", - "schema": { - "type": "string", - "enum": [ - "pass", - "fail", - "bypass", - "all" - ], - "default": "all" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists suites of rule evaluations at the repository level.\nFor more information, see \"Managing rulesets for a repository.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 21, - "actor_id": 12, - "actor_name": "octocat", - "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", - "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", - "ref": "refs/heads/i-see-everything", - "repository_id": 404, - "repository_name": "octo-repo", - "pushed_at": "2023-07-06T08:43:03Z", - "result": "bypass" - }, - { - "id": 25, - "actor_id": 11, - "actor_name": "not-octocat", - "before_sha": "48994e4e01ccc943624c6231f172702b82b233cc", - "after_sha": "ecfd5a1025fa271a33ca5608d089476a2df3c9a1", - "ref": "refs/heads/i-am-everything", - "repository_id": 404, - "repository_name": "octo-repo", - "pushed_at": "2023-07-07T08:43:03Z", - "result": "pass", - "evaluation_result": "fail" - } - ], - "schema": { - "title": "Rule Suites", - "description": "Response", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the rule insight." - }, - "actor_id": { - "type": "integer", - "description": "The number that identifies the user." - }, - "actor_name": { - "type": "string", - "description": "The handle for the GitHub user account." - }, - "before_sha": { - "type": "string", - "description": "The first commit sha before the push evaluation." - }, - "after_sha": { - "type": "string", - "description": "The last commit sha in the push evaluation." - }, - "ref": { - "type": "string", - "description": "The ref name that the evaluation ran on." - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository associated with the rule evaluation." - }, - "repository_name": { - "type": "string", - "description": "The name of the repository without the `.git` extension." - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "result": { - "type": "string", - "enum": [ - "pass", - "fail", - "bypass" - ], - "description": "The result of the rule evaluations for rules with the `active` enforcement status." - }, - "evaluation_result": { - "type": "string", - "enum": [ - "pass", - "fail" - ], - "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`." - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}", - "title": "Get a repository rule suite", - "category": "repos", - "subcategory": "rule-suites", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "rule_suite_id", - "description": "

The unique identifier of the rule suite result.\nTo get this ID, you can use GET /repos/{owner}/{repo}/rulesets/rule-suites\nfor repositories and GET /orgs/{org}/rulesets/rule-suites\nfor organizations.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"Managing rulesets for a repository.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "rule_suite_id": "RULE_SUITE_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 21, - "actor_id": 12, - "actor_name": "octocat", - "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", - "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", - "ref": "refs/heads/i-see-everything", - "repository_id": 404, - "repository_name": "octo-repo", - "pushed_at": "2023-07-06T08:43:03Z", - "result": "bypass", - "evaluation_result": "fail", - "rule_evaluations": [ - { - "rule_source": { - "type": "ruleset", - "id": 2, - "name": "Author email must be a GitHub email address" - }, - "enforcement": "active", - "result": "pass", - "rule_type": "commit_author_email_pattern" - }, - { - "rule_source": { - "type": "protected_branch" - }, - "enforcement": "active", - "result": "fail", - "rule_type": "pull_request", - "details": "Changes must be made through a pull request." - }, - { - "rule_source": { - "type": "ruleset", - "id": 3, - "name": "Evaluate commit message pattern" - }, - "enforcement": "evaluate", - "result": "fail", - "rule_type": "commit_message_pattern" - } - ] - }, - "schema": { - "title": "Rule Suite", - "description": "Response", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the rule insight." - }, - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The number that identifies the user." - }, - "actor_name": { - "type": [ - "string", - "null" - ], - "description": "The handle for the GitHub user account." - }, - "before_sha": { - "type": "string", - "description": "The previous commit SHA of the ref." - }, - "after_sha": { - "type": "string", - "description": "The new commit SHA of the ref." - }, - "ref": { - "type": "string", - "description": "The ref name that the evaluation ran on." - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository associated with the rule evaluation." - }, - "repository_name": { - "type": "string", - "description": "The name of the repository without the `.git` extension." - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "result": { - "type": "string", - "enum": [ - "pass", - "fail", - "bypass" - ], - "description": "The result of the rule evaluations for rules with the `active` enforcement status." - }, - "evaluation_result": { - "type": [ - "string", - "null" - ], - "enum": [ - "pass", - "fail" - ], - "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run." - }, - "rule_evaluations": { - "type": "array", - "description": "Details on the evaluated rules.", - "items": { - "type": "object", - "properties": { - "rule_source": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of rule source." - }, - "id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the rule source." - }, - "name": { - "type": [ - "string", - "null" - ], - "description": "The name of the rule source." - } - } - }, - "enforcement": { - "type": "string", - "enum": [ - "active", - "evaluate", - "deleted ruleset" - ], - "description": "The enforcement level of this rule source." - }, - "result": { - "type": "string", - "enum": [ - "pass", - "fail" - ], - "description": "The result of the evaluation of the individual rule." - }, - "rule_type": { - "type": "string", - "description": "The type of rule." - }, - "details": { - "type": [ - "string", - "null" - ], - "description": "The detailed failure message for the rule. Null if the rule passed." - } - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "read" - } - ] - } - } - ], - "rules": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rules/branches/{branch}", - "title": "Get rules for a branch", - "category": "repos", - "subcategory": "rules", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply\nto a branch with that name will be returned. All active rules that apply will be returned, regardless of the level\nat which they are configured (e.g. repository or organization). Rules in rulesets with \"evaluate\" or \"disabled\"\nenforcement statuses are not returned.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "type": "commit_message_pattern", - "ruleset_source_type": "Repository", - "ruleset_source": "monalisa/my-repo", - "ruleset_id": 42, - "parameters": { - "operator": "starts_with", - "pattern": "issue" - } - }, - { - "type": "commit_author_email_pattern", - "ruleset_source_type": "Organization", - "ruleset_source": "my-org", - "ruleset_id": 73, - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule with ruleset details.", - "oneOf": [ - { - "allOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "repository ruleset data for rule", - "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "properties": { - "ruleset_source_type": { - "type": "string", - "description": "The type of source for the ruleset that includes this rule.", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that includes this rule." - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that includes this rule." - } - } - } - ] - }, - { - "allOf": [ - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "repository ruleset data for rule", - "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "properties": { - "ruleset_source_type": { - "type": "string", - "description": "The type of source for the ruleset that includes this rule.", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that includes this rule." - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that includes this rule." - } - } - } - ] - }, - { - "allOf": [ - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "repository ruleset data for rule", - "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "properties": { - "ruleset_source_type": { - "type": "string", - "description": "The type of source for the ruleset that includes this rule.", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that includes this rule." - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that includes this rule." - } - } - } - ] - }, - { - "allOf": [ - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "repository ruleset data for rule", - "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "properties": { - "ruleset_source_type": { - "type": "string", - "description": "The type of source for the ruleset that includes this rule.", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that includes this rule." - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that includes this rule." - } - } - } - ] - }, - { - "allOf": [ - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "repository ruleset data for rule", - "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "properties": { - "ruleset_source_type": { - "type": "string", - "description": "The type of source for the ruleset that includes this rule.", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that includes this rule." - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that includes this rule." - } - } - } - ] - }, - { - "allOf": [ - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "title": "repository ruleset data for rule", - "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "properties": { - "ruleset_source_type": { - "type": "string", - "description": "The type of source for the ruleset that includes this rule.", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that includes this rule." - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that includes this rule." - } - } - } - ] - }, - { - "allOf": [ - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." - }, - "type": { - "type": "string", - "description": "The type of the reviewer", - "enum": [ - "Team" - ] - } - }, - "required": [ - "id", - "type" - ] - } - }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "repository ruleset data for rule", - "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "properties": { - "ruleset_source_type": { - "type": "string", - "description": "The type of source for the ruleset that includes this rule.", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that includes this rule." - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that includes this rule." - } - } - } - ] - }, - { - "allOf": [ - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "repository ruleset data for rule", - "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "properties": { - "ruleset_source_type": { - "type": "string", - "description": "The type of source for the ruleset that includes this rule.", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that includes this rule." - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that includes this rule." - } - } - } - ] - }, - { - "allOf": [ - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "repository ruleset data for rule", - "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "properties": { - "ruleset_source_type": { - "type": "string", - "description": "The type of source for the ruleset that includes this rule.", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that includes this rule." - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that includes this rule." - } - } - } - ] - }, - { - "allOf": [ - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "repository ruleset data for rule", - "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "properties": { - "ruleset_source_type": { - "type": "string", - "description": "The type of source for the ruleset that includes this rule.", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that includes this rule." - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that includes this rule." - } - } - } - ] - }, - { - "allOf": [ - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "repository ruleset data for rule", - "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "properties": { - "ruleset_source_type": { - "type": "string", - "description": "The type of source for the ruleset that includes this rule.", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that includes this rule." - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that includes this rule." - } - } - } - ] - }, - { - "allOf": [ - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "repository ruleset data for rule", - "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "properties": { - "ruleset_source_type": { - "type": "string", - "description": "The type of source for the ruleset that includes this rule.", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that includes this rule." - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that includes this rule." - } - } - } - ] - }, - { - "allOf": [ - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "repository ruleset data for rule", - "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "properties": { - "ruleset_source_type": { - "type": "string", - "description": "The type of source for the ruleset that includes this rule.", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that includes this rule." - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that includes this rule." - } - } - } - ] - }, - { - "allOf": [ - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "repository ruleset data for rule", - "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "properties": { - "ruleset_source_type": { - "type": "string", - "description": "The type of source for the ruleset that includes this rule.", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that includes this rule." - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that includes this rule." - } - } - } - ] - }, - { - "allOf": [ - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "repository ruleset data for rule", - "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "properties": { - "ruleset_source_type": { - "type": "string", - "description": "The type of source for the ruleset that includes this rule.", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that includes this rule." - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that includes this rule." - } - } - } - ] - }, - { - "allOf": [ - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "repository ruleset data for rule", - "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "properties": { - "ruleset_source_type": { - "type": "string", - "description": "The type of source for the ruleset that includes this rule.", - "enum": [ - "Repository", - "Organization" - ] - }, - "ruleset_source": { - "type": "string", - "description": "The name of the source of the ruleset that includes this rule." - }, - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset that includes this rule." - } - } - } - ] - } - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets", - "title": "Get all repository rulesets", - "category": "repos", - "subcategory": "rules", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "includes_parents", - "description": "

Include rulesets configured at higher levels that apply to this repository

", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": true - } - }, - { - "name": "targets", - "description": "

A comma-separated list of rule targets to filter by.\nIf provided, only rulesets that apply to the specified targets will be returned.\nFor example, branch,tag,push.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "branch,tag,push" - ] - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Get all the rulesets for a repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 42, - "name": "super cool ruleset", - "source_type": "Repository", - "source": "monalisa/my-repo", - "enforcement": "enabled", - "node_id": "RRS_lACkVXNlcgQB", - "_links": { - "self": { - "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42" - }, - "html": { - "href": "https://github.com/monalisa/my-repo/rules/42" - } - }, - "created_at": "2023-07-15T08:43:03Z", - "updated_at": "2023-08-23T16:29:47Z" - }, - { - "id": 314, - "name": "Another ruleset", - "source_type": "Repository", - "source": "monalisa/my-repo", - "enforcement": "enabled", - "node_id": "RRS_lACkVXNlcgQQ", - "_links": { - "self": { - "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/314" - }, - "html": { - "href": "https://github.com/monalisa/my-repo/rules/314" - } - }, - "created_at": "2023-08-15T08:43:03Z", - "updated_at": "2023-09-23T16:29:47Z" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" - }, - "name": { - "type": "string", - "description": "The name of the ruleset" - }, - "target": { - "type": "string", - "description": "The target of the ruleset.", - "enum": [ - "branch", - "tag", - "push" - ] - }, - "source_type": { - "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization" - ] - }, - "source": { - "type": "string", - "description": "The name of the source" - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset" - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } - }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" - ] - }, - "node_id": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": [ - "object", - "null" - ], - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "anyOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } - ] - } - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "rules": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." - }, - "type": { - "type": "string", - "description": "The type of the reviewer", - "enum": [ - "Team" - ] - } - }, - "required": [ - "id", - "type" - ] - } - }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - } - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/rulesets", - "title": "Create a repository ruleset", - "category": "repos", - "subcategory": "rules", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the ruleset.

", - "isRequired": true - }, - { - "type": "string", - "name": "target", - "description": "

The target of the ruleset

", - "enum": [ - "branch", - "tag", - "push" - ], - "default": "branch" - }, - { - "type": "string", - "name": "enforcement", - "description": "

The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. evaluate is not available for the repository target.

", - "isRequired": true, - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - { - "type": "array of objects", - "name": "bypass_actors", - "description": "

The actors that can bypass the rules in this ruleset

", - "childParamsGroups": [ - { - "type": "integer or null", - "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. OrganizationAdmin is not applicable for personal repositories.

" - }, - { - "type": "string", - "name": "actor_type", - "description": "

The type of actor that can bypass a ruleset

", - "isRequired": true, - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ] - }, - { - "type": "string", - "name": "bypass_mode", - "description": "

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type. Also, pull_request is only applicable to branch rulesets.

", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - ] - }, - { - "type": "object", - "name": "conditions", - "description": "

Parameters for a repository ruleset ref name condition

", - "childParamsGroups": [ - { - "type": "object", - "name": "ref_name", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "include", - "description": "

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

" - }, - { - "type": "array of strings", - "name": "exclude", - "description": "

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

" - } - ] - } - ] - }, - { - "type": "array of objects", - "name": "rules", - "description": "

An array of rules within the ruleset.

", - "childParamsGroups": [ - { - "type": "object", - "name": "creation", - "description": "

Only allow users with bypass permission to create matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "creation" - ] - } - ] - }, - { - "type": "object", - "name": "update", - "description": "

Only allow users with bypass permission to update matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "update" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "update_allows_fetch_and_merge", - "description": "

Branch can pull changes from its upstream repository

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "deletion", - "description": "

Only allow users with bypass permissions to delete matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "deletion" - ] - } - ] - }, - { - "type": "object", - "name": "required_linear_history", - "description": "

Prevent merge commits from being pushed to matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_linear_history" - ] - } - ] - }, - { - "type": "object", - "name": "required_deployments", - "description": "

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_deployments" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "required_deployment_environments", - "description": "

The environments that must be successfully deployed to before branches can be merged.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "required_signatures", - "description": "

Commits pushed to matching refs must have verified signatures.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_signatures" - ] - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "pull_request" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "dismiss_stale_reviews_on_push", - "description": "

New, reviewable commits pushed will dismiss previous pull request review approvals.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_code_owner_review", - "description": "

Require an approving review in pull requests that modify files that have a designated code owner.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_last_push_approval", - "description": "

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

", - "isRequired": true - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

The number of approving reviews that are required before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "required_review_thread_resolution", - "description": "

All conversations on code must be resolved before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "required_reviewers", - "description": "

Note

\n

\nrequired_reviewers is in beta and subject to change.

\n
\n

A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "file_patterns", - "description": "

Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.

", - "isRequired": true - }, - { - "type": "integer", - "name": "minimum_approvals", - "description": "

Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.

", - "isRequired": true - }, - { - "type": "object", - "name": "reviewer", - "description": "

A required reviewing team

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

ID of the reviewer which must review changes to matching files.

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The type of the reviewer

", - "isRequired": true, - "enum": [ - "Team" - ] - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "required_status_checks", - "description": "

Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_status_checks" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "required_status_checks", - "description": "

Status checks that are required.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The status check context name that must be present on the commit.

", - "isRequired": true - }, - { - "type": "integer", - "name": "integration_id", - "description": "

The optional integration ID that this status check must originate from.

" - } - ] - }, - { - "type": "boolean", - "name": "strict_required_status_checks_policy", - "description": "

Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "non_fast_forward", - "description": "

Prevent users with push access from force pushing to refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "non_fast_forward" - ] - } - ] - }, - { - "type": "object", - "name": "commit_message_pattern", - "description": "

Parameters to be used for the commit_message_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_message_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "commit_author_email_pattern", - "description": "

Parameters to be used for the commit_author_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_author_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "committer_email_pattern", - "description": "

Parameters to be used for the committer_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "committer_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "branch_name_pattern", - "description": "

Parameters to be used for the branch_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "branch_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "tag_name_pattern", - "description": "

Parameters to be used for the tag_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "tag_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "workflows", - "description": "

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "workflows" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "workflows", - "description": "

Workflows that must pass for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "

The path to the workflow file

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The ref (branch or tag) of the workflow file to use

" - }, - { - "type": "integer", - "name": "repository_id", - "description": "

The ID of the repository where the workflow is defined

", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "

The commit SHA of the workflow file to use

" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "code_scanning", - "description": "

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "code_scanning" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of objects", - "name": "code_scanning_tools", - "description": "

Tools that must provide code scanning results for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - { - "type": "string", - "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - { - "type": "string", - "name": "tool", - "description": "

The name of a code scanning tool

", - "isRequired": true - } - ] - } - ] - } - ] - } - ], - "oneOfObject": true - } - ], - "descriptionHTML": "

Create a ruleset for a repository.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "super cool ruleset", - "target": "branch", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 42, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Repository", - "source": "monalisa/my-repo", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ], - "node_id": "RRS_lACkVXNlcgQB", - "_links": { - "self": { - "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42" - }, - "html": { - "href": "https://github.com/monalisa/my-repo/rules/42" - } - }, - "created_at": "2023-07-15T08:43:03Z", - "updated_at": "2023-08-23T16:29:47Z" - }, - "schema": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" - }, - "name": { - "type": "string", - "description": "The name of the ruleset" - }, - "target": { - "type": "string", - "description": "The target of the ruleset.", - "enum": [ - "branch", - "tag", - "push" - ] - }, - "source_type": { - "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization" - ] - }, - "source": { - "type": "string", - "description": "The name of the source" - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset" - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } - }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" - ] - }, - "node_id": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": [ - "object", - "null" - ], - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "anyOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } - ] - } - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "rules": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." - }, - "type": { - "type": "string", - "description": "The type of the reviewer", - "enum": [ - "Team" - ] - } - }, - "required": [ - "id", - "type" - ] - } - }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - } - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/rulesets/{ruleset_id}", - "title": "Get a repository ruleset", - "category": "repos", - "subcategory": "rules", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ruleset_id", - "description": "

The ID of the ruleset.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "includes_parents", - "description": "

Include rulesets configured at higher levels that apply to this repository

", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": true - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Get a ruleset for a repository.

\n

Note: To prevent leaking sensitive information, the bypass_actors property is only returned if the user\nmaking the API request has write access to the ruleset.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "ruleset_id": "RULESET_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 42, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Repository", - "source": "monalisa/my-repo", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ], - "node_id": "RRS_lACkVXNlcgQB", - "_links": { - "self": { - "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42" - }, - "html": { - "href": "https://github.com/monalisa/my-repo/rules/42" - } - }, - "created_at": "2023-07-15T08:43:03Z", - "updated_at": "2023-08-23T16:29:47Z" - }, - "schema": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" - }, - "name": { - "type": "string", - "description": "The name of the ruleset" - }, - "target": { - "type": "string", - "description": "The target of the ruleset.", - "enum": [ - "branch", - "tag", - "push" - ] - }, - "source_type": { - "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization" - ] - }, - "source": { - "type": "string", - "description": "The name of the source" - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset" - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } - }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" - ] - }, - "node_id": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": [ - "object", - "null" - ], - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "anyOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } - ] - } - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "rules": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." - }, - "type": { - "type": "string", - "description": "The type of the reviewer", - "enum": [ - "Team" - ] - } - }, - "required": [ - "id", - "type" - ] - } - }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - } - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/rulesets/{ruleset_id}", - "title": "Update a repository ruleset", - "category": "repos", - "subcategory": "rules", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ruleset_id", - "description": "

The ID of the ruleset.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the ruleset.

" - }, - { - "type": "string", - "name": "target", - "description": "

The target of the ruleset

", - "enum": [ - "branch", - "tag", - "push" - ] - }, - { - "type": "string", - "name": "enforcement", - "description": "

The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. evaluate is not available for the repository target.

", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - { - "type": "array of objects", - "name": "bypass_actors", - "description": "

The actors that can bypass the rules in this ruleset

", - "childParamsGroups": [ - { - "type": "integer or null", - "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. OrganizationAdmin is not applicable for personal repositories.

" - }, - { - "type": "string", - "name": "actor_type", - "description": "

The type of actor that can bypass a ruleset

", - "isRequired": true, - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ] - }, - { - "type": "string", - "name": "bypass_mode", - "description": "

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type. Also, pull_request is only applicable to branch rulesets.

", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - ] - }, - { - "type": "object", - "name": "conditions", - "description": "

Parameters for a repository ruleset ref name condition

", - "childParamsGroups": [ - { - "type": "object", - "name": "ref_name", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "include", - "description": "

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

" - }, - { - "type": "array of strings", - "name": "exclude", - "description": "

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

" - } - ] - } - ] - }, - { - "type": "array of objects", - "name": "rules", - "description": "

An array of rules within the ruleset.

", - "childParamsGroups": [ - { - "type": "object", - "name": "creation", - "description": "

Only allow users with bypass permission to create matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "creation" - ] - } - ] - }, - { - "type": "object", - "name": "update", - "description": "

Only allow users with bypass permission to update matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "update" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "update_allows_fetch_and_merge", - "description": "

Branch can pull changes from its upstream repository

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "deletion", - "description": "

Only allow users with bypass permissions to delete matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "deletion" - ] - } - ] - }, - { - "type": "object", - "name": "required_linear_history", - "description": "

Prevent merge commits from being pushed to matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_linear_history" - ] - } - ] - }, - { - "type": "object", - "name": "required_deployments", - "description": "

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_deployments" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "required_deployment_environments", - "description": "

The environments that must be successfully deployed to before branches can be merged.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "required_signatures", - "description": "

Commits pushed to matching refs must have verified signatures.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_signatures" - ] - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "pull_request" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "dismiss_stale_reviews_on_push", - "description": "

New, reviewable commits pushed will dismiss previous pull request review approvals.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_code_owner_review", - "description": "

Require an approving review in pull requests that modify files that have a designated code owner.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_last_push_approval", - "description": "

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

", - "isRequired": true - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

The number of approving reviews that are required before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "required_review_thread_resolution", - "description": "

All conversations on code must be resolved before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "required_reviewers", - "description": "

Note

\n

\nrequired_reviewers is in beta and subject to change.

\n
\n

A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "file_patterns", - "description": "

Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.

", - "isRequired": true - }, - { - "type": "integer", - "name": "minimum_approvals", - "description": "

Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.

", - "isRequired": true - }, - { - "type": "object", - "name": "reviewer", - "description": "

A required reviewing team

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

ID of the reviewer which must review changes to matching files.

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The type of the reviewer

", - "isRequired": true, - "enum": [ - "Team" - ] - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "required_status_checks", - "description": "

Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_status_checks" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "required_status_checks", - "description": "

Status checks that are required.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The status check context name that must be present on the commit.

", - "isRequired": true - }, - { - "type": "integer", - "name": "integration_id", - "description": "

The optional integration ID that this status check must originate from.

" - } - ] - }, - { - "type": "boolean", - "name": "strict_required_status_checks_policy", - "description": "

Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "non_fast_forward", - "description": "

Prevent users with push access from force pushing to refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "non_fast_forward" - ] - } - ] - }, - { - "type": "object", - "name": "commit_message_pattern", - "description": "

Parameters to be used for the commit_message_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_message_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "commit_author_email_pattern", - "description": "

Parameters to be used for the commit_author_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_author_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "committer_email_pattern", - "description": "

Parameters to be used for the committer_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "committer_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "branch_name_pattern", - "description": "

Parameters to be used for the branch_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "branch_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "tag_name_pattern", - "description": "

Parameters to be used for the tag_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "tag_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "workflows", - "description": "

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "workflows" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "workflows", - "description": "

Workflows that must pass for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "

The path to the workflow file

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The ref (branch or tag) of the workflow file to use

" - }, - { - "type": "integer", - "name": "repository_id", - "description": "

The ID of the repository where the workflow is defined

", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "

The commit SHA of the workflow file to use

" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "code_scanning", - "description": "

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "code_scanning" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of objects", - "name": "code_scanning_tools", - "description": "

Tools that must provide code scanning results for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - { - "type": "string", - "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - { - "type": "string", - "name": "tool", - "description": "

The name of a code scanning tool

", - "isRequired": true - } - ] - } - ] - } - ] - } - ], - "oneOfObject": true - } - ], - "descriptionHTML": "

Update a ruleset for a repository.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "super cool ruleset", - "target": "branch", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "ruleset_id": "RULESET_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 42, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Repository", - "source": "monalisa/my-repo", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ], - "node_id": "RRS_lACkVXNlcgQB", - "_links": { - "self": { - "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42" - }, - "html": { - "href": "https://github.com/monalisa/my-repo/rules/42" - } - }, - "created_at": "2023-07-15T08:43:03Z", - "updated_at": "2023-08-23T16:29:47Z" - }, - "schema": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" - }, - "name": { - "type": "string", - "description": "The name of the ruleset" - }, - "target": { - "type": "string", - "description": "The target of the ruleset.", - "enum": [ - "branch", - "tag", - "push" - ] - }, - "source_type": { - "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization" - ] - }, - "source": { - "type": "string", - "description": "The name of the source" - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset" - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } - }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" - ] - }, - "node_id": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": [ - "object", - "null" - ], - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "anyOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } - ] - } - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "rules": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." - }, - "type": { - "type": "string", - "description": "The type of the reviewer", - "enum": [ - "Team" - ] - } - }, - "required": [ - "id", - "type" - ] - } - }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule appears when configuring it." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - } - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/rulesets/{ruleset_id}", - "title": "Delete a repository ruleset", - "category": "repos", - "subcategory": "rules", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ruleset_id", - "description": "

The ID of the ruleset.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Delete a ruleset for a repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "ruleset_id": "RULESET_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write" - } - ] - } - } - ], - "tags": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/tags/protection", - "title": "Closing down - List tag protection states for a repository", - "category": "repos", - "subcategory": "tags", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.

\n
\n

This returns the tag protection states of a repository.

\n

This information is only available to repository administrators.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 2, - "pattern": "v1.*" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Tag protection", - "description": "Tag protection", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "pattern": { - "type": "string" - } - }, - "required": [ - "pattern" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/tags/protection", - "title": "Closing down - Create a tag protection state for a repository", - "category": "repos", - "subcategory": "tags", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "pattern", - "description": "

An optional glob pattern to match against when enforcing tag protection.

", - "isRequired": true - } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.

\n
\n

This creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "pattern": "v1.*" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "enabled": true - }, - "schema": { - "title": "Tag protection", - "description": "Tag protection", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "pattern": { - "type": "string" - } - }, - "required": [ - "pattern" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}", - "title": "Closing down - Delete a tag protection state for a repository", - "category": "repos", - "subcategory": "tags", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "tag_protection_id", - "description": "

The unique identifier of the tag protection.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.

\n
\n

This deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "tag_protection_id": "TAG_PROTECTION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [] - } - ], - "webhooks": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks", - "title": "List repository webhooks", - "category": "repos", - "subcategory": "webhooks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists webhooks for a repository. last response may return null if there have not been any deliveries within 30 days.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "type": "Repository", - "id": 12345678, - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "content_type": "json", - "insecure_ssl": "0", - "url": "https://example.com/webhook" - }, - "updated_at": "2019-06-03T00:57:16Z", - "created_at": "2019-06-03T00:57:16Z", - "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", - "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", - "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", - "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", - "last_response": { - "code": null, - "status": "unused", - "message": null - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Webhook", - "description": "Webhooks for repositories.", - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the webhook.", - "type": "integer" - }, - "name": { - "description": "The name of a valid service, use 'web' for a webhook.", - "type": "string" - }, - "active": { - "description": "Determines whether the hook is actually triggered on pushes.", - "type": "boolean" - }, - "events": { - "description": "Determines what events the hook is triggered for. Default: ['push'].", - "type": "array", - "items": { - "type": "string" - } - }, - "config": { - "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.", - "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`." - }, - "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/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers)." - }, - "insecure_ssl": { - "oneOf": [ - { - "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.**" - }, - { - "type": "number" - } - ] - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "test_url": { - "type": "string", - "format": "uri" - }, - "ping_url": { - "type": "string", - "format": "uri" - }, - "deliveries_url": { - "type": "string", - "format": "uri" - }, - "last_response": { - "title": "Hook Response", - "type": "object", - "properties": { - "code": { - "type": [ - "integer", - "null" - ] - }, - "status": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "code", - "status", - "message" - ] - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at", - "last_response", - "test_url" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks", - "title": "Create a repository webhook", - "category": "repos", - "subcategory": "webhooks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

Use web to create a webhook. Default: web. This parameter only accepts the value web.

" - }, - { - "type": "object", - "name": "config", - "description": "

Key/value pairs to provide settings for this webhook.

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL to which the payloads will be delivered.

" - }, - { - "type": "string", - "name": "content_type", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

" - }, - { - "type": "string", - "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" - }, - { - "type": "string or number", - "name": "insecure_ssl", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "

Determines what events the hook is triggered for.

", - "default": [ - "push" - ] - }, - { - "type": "boolean", - "name": "active", - "description": "

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

", - "default": true - } - ], - "descriptionHTML": "

Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can\nshare the same config as long as those webhooks do not have any events that overlap.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "url": "https://example.com/webhook", - "content_type": "json", - "insecure_ssl": "0" - } - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "type": "Repository", - "id": 12345678, - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "content_type": "json", - "insecure_ssl": "0", - "url": "https://example.com/webhook" - }, - "updated_at": "2019-06-03T00:57:16Z", - "created_at": "2019-06-03T00:57:16Z", - "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", - "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", - "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", - "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", - "last_response": { - "code": null, - "status": "unused", - "message": null - } - }, - "schema": { - "title": "Webhook", - "description": "Webhooks for repositories.", - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the webhook.", - "type": "integer" - }, - "name": { - "description": "The name of a valid service, use 'web' for a webhook.", - "type": "string" - }, - "active": { - "description": "Determines whether the hook is actually triggered on pushes.", - "type": "boolean" - }, - "events": { - "description": "Determines what events the hook is triggered for. Default: ['push'].", - "type": "array", - "items": { - "type": "string" - } - }, - "config": { - "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.", - "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`." - }, - "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/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers)." - }, - "insecure_ssl": { - "oneOf": [ - { - "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.**" - }, - { - "type": "number" - } - ] - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "test_url": { - "type": "string", - "format": "uri" - }, - "ping_url": { - "type": "string", - "format": "uri" - }, - "deliveries_url": { - "type": "string", - "format": "uri" - }, - "last_response": { - "title": "Hook Response", - "type": "object", - "properties": { - "code": { - "type": [ - "integer", - "null" - ] - }, - "status": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "code", - "status", - "message" - ] - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at", - "last_response", - "test_url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "title": "Get a repository webhook", - "category": "repos", - "subcategory": "webhooks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns a webhook configured in a repository. To get only the webhook config properties, see \"Get a webhook configuration for a repository.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "type": "Repository", - "id": 12345678, - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "content_type": "json", - "insecure_ssl": "0", - "url": "https://example.com/webhook" - }, - "updated_at": "2019-06-03T00:57:16Z", - "created_at": "2019-06-03T00:57:16Z", - "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", - "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", - "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", - "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", - "last_response": { - "code": null, - "status": "unused", - "message": null - } - }, - "schema": { - "title": "Webhook", - "description": "Webhooks for repositories.", - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the webhook.", - "type": "integer" - }, - "name": { - "description": "The name of a valid service, use 'web' for a webhook.", - "type": "string" - }, - "active": { - "description": "Determines whether the hook is actually triggered on pushes.", - "type": "boolean" - }, - "events": { - "description": "Determines what events the hook is triggered for. Default: ['push'].", - "type": "array", - "items": { - "type": "string" - } - }, - "config": { - "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.", - "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`." - }, - "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/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers)." - }, - "insecure_ssl": { - "oneOf": [ - { - "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.**" - }, - { - "type": "number" - } - ] - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "test_url": { - "type": "string", - "format": "uri" - }, - "ping_url": { - "type": "string", - "format": "uri" - }, - "deliveries_url": { - "type": "string", - "format": "uri" - }, - "last_response": { - "title": "Hook Response", - "type": "object", - "properties": { - "code": { - "type": [ - "integer", - "null" - ] - }, - "status": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "code", - "status", - "message" - ] - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at", - "last_response", - "test_url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "title": "Update a repository webhook", - "category": "repos", - "subcategory": "webhooks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "object", - "name": "config", - "description": "

Configuration object of the webhook

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL to which the payloads will be delivered.

" - }, - { - "type": "string", - "name": "content_type", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

" - }, - { - "type": "string", - "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" - }, - { - "type": "string or number", - "name": "insecure_ssl", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "

Determines what events the hook is triggered for. This replaces the entire array of events.

", - "default": [ - "push" - ] - }, - { - "type": "array of strings", - "name": "add_events", - "description": "

Determines a list of events to be added to the list of events that the Hook triggers for.

" - }, - { - "type": "array of strings", - "name": "remove_events", - "description": "

Determines a list of events to be removed from the list of events that the Hook triggers for.

" - }, - { - "type": "boolean", - "name": "active", - "description": "

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

", - "default": true - } - ], - "descriptionHTML": "

Updates a webhook configured in a repository. 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 a repository.\"

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "active": true, - "add_events": [ - "pull_request" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "type": "Repository", - "id": 12345678, - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "content_type": "json", - "insecure_ssl": "0", - "url": "https://example.com/webhook" - }, - "updated_at": "2019-06-03T00:57:16Z", - "created_at": "2019-06-03T00:57:16Z", - "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", - "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", - "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", - "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", - "last_response": { - "code": null, - "status": "unused", - "message": null - } - }, - "schema": { - "title": "Webhook", - "description": "Webhooks for repositories.", - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the webhook.", - "type": "integer" - }, - "name": { - "description": "The name of a valid service, use 'web' for a webhook.", - "type": "string" - }, - "active": { - "description": "Determines whether the hook is actually triggered on pushes.", - "type": "boolean" - }, - "events": { - "description": "Determines what events the hook is triggered for. Default: ['push'].", - "type": "array", - "items": { - "type": "string" - } - }, - "config": { - "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.", - "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`." - }, - "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/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers)." - }, - "insecure_ssl": { - "oneOf": [ - { - "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.**" - }, - { - "type": "number" - } - ] - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "test_url": { - "type": "string", - "format": "uri" - }, - "ping_url": { - "type": "string", - "format": "uri" - }, - "deliveries_url": { - "type": "string", - "format": "uri" - }, - "last_response": { - "title": "Hook Response", - "type": "object", - "properties": { - "code": { - "type": [ - "integer", - "null" - ] - }, - "status": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "code", - "status", - "message" - ] - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at", - "last_response", - "test_url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", - "title": "Delete a repository webhook", - "category": "repos", - "subcategory": "webhooks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Delete a webhook for an organization.

\n

The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config", - "title": "Get a webhook configuration for a repository", - "category": "repos", - "subcategory": "webhooks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns the webhook configuration for a repository. To get more information about the webhook, including the active state and events, use \"Get a repository webhook.\"

\n

OAuth app tokens and personal access tokens (classic) need the read:repo_hook or repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" - }, - "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.", - "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`." - }, - "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/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers)." - }, - "insecure_ssl": { - "oneOf": [ - { - "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.**" - }, - { - "type": "number" - } - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config", - "title": "Update a webhook configuration for a repository", - "category": "repos", - "subcategory": "webhooks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "url", - "description": "

The URL to which the payloads will be delivered.

" - }, - { - "type": "string", - "name": "content_type", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

" - }, - { - "type": "string", - "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" - }, - { - "type": "string or number", - "name": "insecure_ssl", - "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.

" - } - ], - "descriptionHTML": "

Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"

\n

OAuth app tokens and personal access tokens (classic) need the write:repo_hook or repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example of updating content type and URL", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "content_type": "json", - "url": "https://example.com/webhook" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" - }, - "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.", - "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`." - }, - "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/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers)." - }, - "insecure_ssl": { - "oneOf": [ - { - "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.**" - }, - { - "type": "number" - } - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries", - "title": "List deliveries for a repository webhook", - "category": "repos", - "subcategory": "webhooks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "cursor", - "description": "

Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the link header for the next and previous page cursors.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "status", - "description": "

Returns webhook deliveries filtered by delivery outcome classification based on status_code range. A status of success returns deliveries with a status_code in the 200-399 range (inclusive). A status of failure returns deliveries with a status_code in the 400-599 range (inclusive).

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "success", - "failure" - ] - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns a list of webhook deliveries for a webhook configured in a repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 12345678, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "delivered_at": "2019-06-03T00:57:16Z", - "redelivery": false, - "duration": 0.27, - "status": "OK", - "status_code": 200, - "event": "issues", - "action": "opened", - "installation_id": 123, - "repository_id": 456, - "throttled_at": "2019-06-03T00:57:16Z" - }, - { - "id": 123456789, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "delivered_at": "2019-06-04T00:57:16Z", - "redelivery": true, - "duration": 0.28, - "status": "OK", - "status_code": 200, - "event": "issues", - "action": "opened", - "installation_id": 123, - "repository_id": 456, - "throttled_at": null - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple webhook delivery", - "description": "Delivery made by a webhook, without request and response information.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the webhook delivery.", - "type": "integer", - "format": "int64" - }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", - "type": "string" - }, - "delivered_at": { - "description": "Time when the webhook delivery occurred.", - "type": "string", - "format": "date-time" - }, - "redelivery": { - "description": "Whether the webhook delivery is a redelivery.", - "type": "boolean" - }, - "duration": { - "description": "Time spent delivering.", - "type": "number" - }, - "status": { - "description": "Describes the response returned after attempting the delivery.", - "type": "string" - }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer" - }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string" - }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", - "type": [ - "string", - "null" - ] - }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": [ - "integer", - "null" - ], - "format": "int64" - }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": [ - "integer", - "null" - ], - "format": "int64" - }, - "throttled_at": { - "description": "Time when the webhook delivery was throttled.", - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "guid", - "delivered_at", - "redelivery", - "duration", - "status", - "status_code", - "event", - "action", - "installation_id", - "repository_id" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}", - "title": "Get a delivery for a repository webhook", - "category": "repos", - "subcategory": "webhooks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "delivery_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Returns a delivery for a webhook configured in a repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "hook_id": "HOOK_ID", - "delivery_id": "DELIVERY_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 12345678, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "delivered_at": "2019-06-03T00:57:16Z", - "redelivery": false, - "duration": 0.27, - "status": "OK", - "status_code": 200, - "event": "issues", - "action": "opened", - "installation_id": 123, - "repository_id": 456, - "url": "https://www.example.com", - "throttled_at": "2019-06-03T00:57:16Z", - "request": { - "headers": { - "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "Accept": "*/*", - "X-GitHub-Hook-ID": "42", - "User-Agent": "GitHub-Hookshot/b8c71d8", - "X-GitHub-Event": "issues", - "X-GitHub-Hook-Installation-Target-ID": "123", - "X-GitHub-Hook-Installation-Target-Type": "repository", - "content-type": "application/json", - "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" - }, - "payload": { - "action": "opened", - "issue": { - "body": "foo" - }, - "repository": { - "id": 123 - } - } - }, - "response": { - "headers": { - "Content-Type": "text/html;charset=utf-8" - }, - "payload": "ok" - } - }, - "schema": { - "title": "Webhook delivery", - "description": "Delivery made by a webhook.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the delivery.", - "type": "integer" - }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", - "type": "string" - }, - "delivered_at": { - "description": "Time when the delivery was delivered.", - "type": "string", - "format": "date-time" - }, - "redelivery": { - "description": "Whether the delivery is a redelivery.", - "type": "boolean" - }, - "duration": { - "description": "Time spent delivering.", - "type": "number" - }, - "status": { - "description": "Description of the status of the attempted delivery", - "type": "string" - }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer" - }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string" - }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", - "type": [ - "string", - "null" - ] - }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": [ - "integer", - "null" - ] - }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": [ - "integer", - "null" - ] - }, - "throttled_at": { - "description": "Time when the webhook delivery was throttled.", - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "url": { - "description": "The URL target of the delivery.", - "type": "string" - }, - "request": { - "type": "object", - "properties": { - "headers": { - "description": "The request headers sent with the webhook delivery.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - }, - "payload": { - "description": "The webhook payload.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - } - }, - "required": [ - "headers", - "payload" - ] - }, - "response": { - "type": "object", - "properties": { - "headers": { - "description": "The response headers received when the delivery was made.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - }, - "payload": { - "description": "The response payload received.", - "type": [ - "string", - "null" - ], - "additionalProperties": true - } - }, - "required": [ - "headers", - "payload" - ] - } - }, - "required": [ - "id", - "guid", - "delivered_at", - "redelivery", - "duration", - "status", - "status_code", - "event", - "action", - "installation_id", - "repository_id", - "request", - "response" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", - "title": "Redeliver a delivery for a repository webhook", - "category": "repos", - "subcategory": "webhooks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "delivery_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Redeliver a webhook delivery for a webhook configured in a repository.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "hook_id": "HOOK_ID", - "delivery_id": "DELIVERY_ID" - } - }, - "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "

Accepted

", - "example": null, - "schema": { - "type": "object" - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "

Accepted

" - }, - { - "httpStatusCode": "400", - "description": "

Bad Request

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", - "title": "Ping a repository webhook", - "category": "repos", - "subcategory": "webhooks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

This will trigger a ping event to be sent to the hook.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", - "title": "Test the push repository webhook", - "category": "repos", - "subcategory": "webhooks", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hook_id", - "description": "

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.

\n

Note

\n

\nPreviously /repos/:owner/:repo/hooks/:hook_id/test

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "hook_id": "HOOK_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Webhooks\" repository permissions": "read" - } - ] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/search.json b/src/rest/data/ghes-3.14-2022-11-28/search.json deleted file mode 100644 index 76de00c37907..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/search.json +++ /dev/null @@ -1,9717 +0,0 @@ -{ - "search": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/search/code", - "title": "Search code", - "category": "search", - "subcategory": "search", - "parameters": [ - { - "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports different qualifiers than the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.

", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "

Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: best match

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "indexed" - ] - } - }, - { - "name": "order", - "description": "

Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "desc", - "asc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search:

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n
    \n
  • Only the default branch is considered. In most cases, this will be the master branch.
    • \n
  • Only files smaller than 384 KB are searchable.
    • \n
  • You must always include at least one search term when searching source code. For example, searching for language:go is not valid, while amazing language:go is.
    • \n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 7, - "incomplete_results": false, - "items": [ - { - "name": "classes.js", - "path": "src/attributes/classes.js", - "sha": "d7212f9dee2dcc18f084d7df8f417b80846ded5a", - "url": "https://api.github.com/repositories/167174/contents/src/attributes/classes.js?ref=825ac3773694e0cd23ee74895fd5aeb535b27da4", - "git_url": "https://api.github.com/repositories/167174/git/blobs/d7212f9dee2dcc18f084d7df8f417b80846ded5a", - "html_url": "https://github.com/jquery/jquery/blob/825ac3773694e0cd23ee74895fd5aeb535b27da4/src/attributes/classes.js", - "repository": { - "id": 167174, - "node_id": "MDEwOlJlcG9zaXRvcnkxNjcxNzQ=", - "name": "jquery", - "full_name": "jquery/jquery", - "owner": { - "login": "jquery", - "id": 70142, - "node_id": "MDQ6VXNlcjcwMTQy", - "avatar_url": "https://0.gravatar.com/avatar/6906f317a4733f4379b06c32229ef02f?d=https%3A%2F%2Fidenticons.github.com%2Ff426f04f2f9813718fb806b30e0093de.png", - "gravatar_id": "", - "url": "https://api.github.com/users/jquery", - "html_url": "https://github.com/jquery", - "followers_url": "https://api.github.com/users/jquery/followers", - "following_url": "https://api.github.com/users/jquery/following{/other_user}", - "gists_url": "https://api.github.com/users/jquery/gists{/gist_id}", - "starred_url": "https://api.github.com/users/jquery/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/jquery/subscriptions", - "organizations_url": "https://api.github.com/users/jquery/orgs", - "repos_url": "https://api.github.com/users/jquery/repos", - "events_url": "https://api.github.com/users/jquery/events{/privacy}", - "received_events_url": "https://api.github.com/users/jquery/received_events", - "type": "Organization", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/jquery/jquery", - "description": "jQuery JavaScript Library", - "fork": false, - "url": "https://api.github.com/repos/jquery/jquery", - "forks_url": "https://api.github.com/repos/jquery/jquery/forks", - "keys_url": "https://api.github.com/repos/jquery/jquery/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/jquery/jquery/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/jquery/jquery/teams", - "hooks_url": "https://api.github.com/repos/jquery/jquery/hooks", - "issue_events_url": "https://api.github.com/repos/jquery/jquery/issues/events{/number}", - "events_url": "https://api.github.com/repos/jquery/jquery/events", - "assignees_url": "https://api.github.com/repos/jquery/jquery/assignees{/user}", - "branches_url": "https://api.github.com/repos/jquery/jquery/branches{/branch}", - "tags_url": "https://api.github.com/repos/jquery/jquery/tags", - "blobs_url": "https://api.github.com/repos/jquery/jquery/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/jquery/jquery/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/jquery/jquery/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/jquery/jquery/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/jquery/jquery/statuses/{sha}", - "languages_url": "https://api.github.com/repos/jquery/jquery/languages", - "stargazers_url": "https://api.github.com/repos/jquery/jquery/stargazers", - "contributors_url": "https://api.github.com/repos/jquery/jquery/contributors", - "subscribers_url": "https://api.github.com/repos/jquery/jquery/subscribers", - "subscription_url": "https://api.github.com/repos/jquery/jquery/subscription", - "commits_url": "https://api.github.com/repos/jquery/jquery/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/jquery/jquery/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/jquery/jquery/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/jquery/jquery/issues/comments/{number}", - "contents_url": "https://api.github.com/repos/jquery/jquery/contents/{+path}", - "compare_url": "https://api.github.com/repos/jquery/jquery/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/jquery/jquery/merges", - "archive_url": "https://api.github.com/repos/jquery/jquery/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/jquery/jquery/downloads", - "issues_url": "https://api.github.com/repos/jquery/jquery/issues{/number}", - "pulls_url": "https://api.github.com/repos/jquery/jquery/pulls{/number}", - "milestones_url": "https://api.github.com/repos/jquery/jquery/milestones{/number}", - "notifications_url": "https://api.github.com/repos/jquery/jquery/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/jquery/jquery/labels{/name}", - "deployments_url": "http://api.github.com/repos/octocat/Hello-World/deployments", - "releases_url": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "score": 1 - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "incomplete_results", - "items" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "Code Search Result Item", - "description": "Code Search Result Item", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - }, - "score": { - "type": "number" - }, - "file_size": { - "type": "integer" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "last_modified_at": { - "type": "string", - "format": "date-time" - }, - "line_numbers": { - "type": "array", - "items": { - "type": "string" - } - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - } - } - } - }, - "required": [ - "score", - "name", - "path", - "sha", - "git_url", - "html_url", - "url", - "repository" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/search/commits", - "title": "Search commits", - "category": "search", - "subcategory": "search", - "parameters": [ - { - "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching commits\" for a detailed list of qualifiers.

", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "

Sorts the results of your query by author-date or committer-date. Default: best match

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "author-date", - "committer-date" - ] - } - }, - { - "name": "order", - "description": "

Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "desc", - "asc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Find commits via various criteria on the default branch (usually main). This method returns up to 100 results per page.

\n

When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.

\n

For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:

\n

q=repo:octocat/Spoon-Knife+css

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 1, - "incomplete_results": false, - "items": [ - { - "url": "https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", - "sha": "bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", - "html_url": "https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", - "comments_url": "https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments", - "commit": { - "url": "https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", - "author": { - "date": "2014-02-04T14:38:36-08:00", - "name": "The Octocat", - "email": "octocat@nowhere.com" - }, - "committer": { - "date": "2014-02-12T15:18:55-08:00", - "name": "The Octocat", - "email": "octocat@nowhere.com" - }, - "message": "Create styles.css and updated README", - "tree": { - "url": "https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68", - "sha": "a639e96f9038797fba6e0469f94a4b0cc459fa68" - }, - "comment_count": 8 - }, - "author": { - "login": "octocat", - "id": 583231, - "node_id": "MDQ6VXNlcjU4MzIzMQ==", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=3", - "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 - }, - "committer": {}, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4", - "html_url": "https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4", - "sha": "a30c19e3f13765a3b48829788bc1cb8b4e95cee4" - } - ], - "repository": { - "id": 1300192, - "node_id": "MDEwOlJlcG9zaXRvcnkxMzAwMTky", - "name": "Spoon-Knife", - "full_name": "octocat/Spoon-Knife", - "owner": { - "login": "octocat", - "id": 583231, - "node_id": "MDQ6VXNlcjU4MzIzMQ==", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=3", - "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/Spoon-Knife", - "description": "This repo is for demonstration purposes only.", - "fork": false, - "url": "https://api.github.com/repos/octocat/Spoon-Knife", - "forks_url": "https://api.github.com/repos/octocat/Spoon-Knife/forks", - "keys_url": "https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octocat/Spoon-Knife/teams", - "hooks_url": "https://api.github.com/repos/octocat/Spoon-Knife/hooks", - "issue_events_url": "https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number}", - "events_url": "https://api.github.com/repos/octocat/Spoon-Knife/events", - "assignees_url": "https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user}", - "branches_url": "https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch}", - "tags_url": "https://api.github.com/repos/octocat/Spoon-Knife/tags", - "blobs_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octocat/Spoon-Knife/languages", - "stargazers_url": "https://api.github.com/repos/octocat/Spoon-Knife/stargazers", - "contributors_url": "https://api.github.com/repos/octocat/Spoon-Knife/contributors", - "subscribers_url": "https://api.github.com/repos/octocat/Spoon-Knife/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Spoon-Knife/subscription", - "commits_url": "https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octocat/Spoon-Knife/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path}", - "compare_url": "https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octocat/Spoon-Knife/merges", - "archive_url": "https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octocat/Spoon-Knife/downloads", - "issues_url": "https://api.github.com/repos/octocat/Spoon-Knife/issues{/number}", - "pulls_url": "https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octocat/Spoon-Knife/labels{/name}", - "releases_url": "https://api.github.com/repos/octocat/Spoon-Knife/releases{/id}", - "deployments_url": "https://api.github.com/repos/octocat/Spoon-Knife/deployments" - }, - "score": 1, - "node_id": "MDQ6VXNlcjU4MzIzMQ==" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "incomplete_results", - "items" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "Commit Search Result Item", - "description": "Commit Search Result Item", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "commit": { - "type": "object", - "properties": { - "author": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "email", - "date" - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "comment_count": { - "type": "integer" - }, - "message": { - "type": "string" - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "verification": { - "title": "Verification", - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "payload": { - "type": [ - "string", - "null" - ] - }, - "signature": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] - }, - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "sha": { - "type": "string" - } - } - } - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - }, - "score": { - "type": "number" - }, - "node_id": { - "type": "string" - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - } - } - } - }, - "required": [ - "sha", - "node_id", - "url", - "html_url", - "author", - "committer", - "parents", - "comments_url", - "commit", - "repository", - "score" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/search/issues", - "title": "Search issues and pull requests", - "category": "search", - "subcategory": "search", - "parameters": [ - { - "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching issues and pull requests\" for a detailed list of qualifiers.

", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "

Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "comments", - "reactions", - "reactions-+1", - "reactions--1", - "reactions-smile", - "reactions-thinking_face", - "reactions-heart", - "reactions-tada", - "interactions", - "created", - "updated" - ] - } - }, - { - "name": "order", - "description": "

Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "desc", - "asc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "advanced_search", - "description": "

Set to true to use advanced search.\nExample: http://api.github.com/search/issues?q={query}&advanced_search=true

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "search_type", - "description": "

The type of search to perform on issues. When not specified, the default is lexical search.

\n
    \n
  • semantic — performs a pure semantic (vector) search using embedding-based understanding.
    • \n
  • hybrid — combines semantic search with lexical search for best results.
    • \n
\n

Semantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (/search/issues).

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "semantic", - "hybrid" - ] - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note

\n

\nFor requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

\n
", - "codeExamples": [ - { - "request": { - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Hybrid search response

", - "example": { - "total_count": 280, - "incomplete_results": false, - "search_type": "hybrid", - "items": [ - { - "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", - "repository_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit", - "labels_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}", - "comments_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments", - "events_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events", - "html_url": "https://github.com/batterseapower/pinyin-toolkit/issues/132", - "id": 35802, - "node_id": "MDU6SXNzdWUzNTgwMg==", - "number": 132, - "title": "Line Number Indexes Beyond 20 Not Displayed", - "user": { - "login": "Nick3C", - "id": 90254, - "node_id": "MDQ6VXNlcjkwMjU0", - "avatar_url": "https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", - "gravatar_id": "", - "url": "https://api.github.com/users/Nick3C", - "html_url": "https://github.com/Nick3C", - "followers_url": "https://api.github.com/users/Nick3C/followers", - "following_url": "https://api.github.com/users/Nick3C/following{/other_user}", - "gists_url": "https://api.github.com/users/Nick3C/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Nick3C/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Nick3C/subscriptions", - "organizations_url": "https://api.github.com/users/Nick3C/orgs", - "repos_url": "https://api.github.com/users/Nick3C/repos", - "events_url": "https://api.github.com/users/Nick3C/events{/privacy}", - "received_events_url": "https://api.github.com/users/Nick3C/received_events", - "type": "User", - "site_admin": true - }, - "labels": [ - { - "id": 4, - "node_id": "MDU6TGFiZWw0", - "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug", - "name": "bug", - "color": "ff0000" - } - ], - "state": "open", - "assignee": null, - "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" - }, - "comments": 15, - "created_at": "2009-07-12T20:10:41Z", - "updated_at": "2009-07-19T09:23:43Z", - "closed_at": null, - "pull_request": { - "url": "https://api/github.com/repos/octocat/Hello-World/pull/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://api.github.com/repos/octocat/Hello-World/pulls/1347" - }, - "body": "...", - "score": 1, - "locked": true, - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "incomplete_results", - "items", - "search_type" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "Issue Search Result Item", - "description": "Issue Search Result Item", - "type": "object", - "properties": { - "url": { - "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": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "title": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "assignees": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - } - } - } - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - }, - "state": { - "type": "string" - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - } - } - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "body": { - "type": "string" - }, - "score": { - "type": "number" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "draft": { - "type": "boolean" - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "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", - "score" - ] - } - }, - "search_type": { - "type": "string", - "description": "The type of search that was performed. Possible values are `lexical`, `semantic`, or `hybrid`.", - "enum": [ - "lexical", - "semantic", - "hybrid" - ] - }, - "lexical_fallback_reason": { - "type": "array", - "description": "When a semantic or hybrid search falls back to lexical search, this field contains the reasons for the fallback. Only present when a fallback occurred.", - "items": { - "type": "string", - "enum": [ - "no_text_terms", - "quoted_text", - "non_issue_target", - "or_boolean_not_supported", - "no_accessible_repos", - "server_error", - "only_non_semantic_fields_requested" - ] - } - } - } - } - } - }, - { - "request": { - "description": "Example 2: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Hybrid search with lexical fallback

", - "example": { - "total_count": 280, - "incomplete_results": false, - "search_type": "lexical", - "lexical_fallback_reason": [ - "quoted_text" - ], - "items": [ - "..." - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "incomplete_results", - "items", - "search_type" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "Issue Search Result Item", - "description": "Issue Search Result Item", - "type": "object", - "properties": { - "url": { - "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": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "title": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "assignees": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - } - } - } - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "integer" - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the option", - "type": "string" - }, - "color": { - "description": "The color of the option", - "type": "string" - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - }, - "state": { - "type": "string" - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - } - } - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "body": { - "type": "string" - }, - "score": { - "type": "number" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "draft": { - "type": "boolean" - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean" - }, - "has_pull_requests": { - "description": "Whether pull requests are enabled.", - "default": true, - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "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" - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "pinned_comment": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "external_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "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" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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" - ] - }, - "pin": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Pinned Issue Comment", - "description": "Context around who pinned an issue comment and when it was pinned.", - "type": "object", - "properties": { - "pinned_at": { - "type": "string", - "format": "date-time" - }, - "pinned_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - } - }, - "required": [ - "pinned_at", - "pinned_by" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "user", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "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", - "score" - ] - } - }, - "search_type": { - "type": "string", - "description": "The type of search that was performed. Possible values are `lexical`, `semantic`, or `hybrid`.", - "enum": [ - "lexical", - "semantic", - "hybrid" - ] - }, - "lexical_fallback_reason": { - "type": "array", - "description": "When a semantic or hybrid search falls back to lexical search, this field contains the reasons for the fallback. Only present when a fallback occurred.", - "items": { - "type": "string", - "enum": [ - "no_text_terms", - "quoted_text", - "non_issue_target", - "or_boolean_not_supported", - "no_accessible_repos", - "server_error", - "only_non_semantic_fields_requested" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/search/labels", - "title": "Search labels", - "category": "search", - "subcategory": "search", - "parameters": [ - { - "name": "repository_id", - "description": "

The id of the repository.

", - "in": "query", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "q", - "description": "

The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see Constructing a search query.

", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "

Sorts the results of your query by when the label was created or updated. Default: best match

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ] - } - }, - { - "name": "order", - "description": "

Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "desc", - "asc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.

\n

When searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:

\n

q=bug+defect+enhancement&repository_id=64778136

\n

The labels that best match the query appear first in the search results.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 2, - "incomplete_results": false, - "items": [ - { - "id": 418327088, - "node_id": "MDU6TGFiZWw0MTgzMjcwODg=", - "url": "https://api.github.com/repos/octocat/linguist/labels/enhancement", - "name": "enhancement", - "color": "84b6eb", - "default": true, - "description": "New feature or request.", - "score": 1 - }, - { - "id": 418327086, - "node_id": "MDU6TGFiZWw0MTgzMjcwODY=", - "url": "https://api.github.com/repos/octocat/linguist/labels/bug", - "name": "bug", - "color": "ee0701", - "default": true, - "description": "Something isn't working.", - "score": 1 - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "incomplete_results", - "items" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "Label Search Result Item", - "description": "Label Search Result Item", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "score": { - "type": "number" - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - } - } - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description", - "score" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Metadata\" repository permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/search/repositories", - "title": "Search repositories", - "category": "search", - "subcategory": "search", - "parameters": [ - { - "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching for repositories\" for a detailed list of qualifiers.

", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "

Sorts the results of your query by number of stars, forks, or help-wanted-issues or how recently the items were updated. Default: best match

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "stars", - "forks", - "help-wanted-issues", - "updated" - ] - } - }, - { - "name": "order", - "description": "

Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "desc", - "asc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Find repositories via various criteria. This method returns up to 100 results per page.

\n

When searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:

\n

q=tetris+language:assembly&sort=stars&order=desc

\n

This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 40, - "incomplete_results": false, - "items": [ - { - "id": 3081286, - "node_id": "MDEwOlJlcG9zaXRvcnkzMDgxMjg2", - "name": "Tetris", - "full_name": "dtrupenn/Tetris", - "owner": { - "login": "dtrupenn", - "id": 872147, - "node_id": "MDQ6VXNlcjg3MjE0Nw==", - "avatar_url": "https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", - "gravatar_id": "", - "url": "https://api.github.com/users/dtrupenn", - "received_events_url": "https://api.github.com/users/dtrupenn/received_events", - "type": "User", - "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}", - "site_admin": true - }, - "private": false, - "html_url": "https://github.com/dtrupenn/Tetris", - "description": "A C implementation of Tetris using Pennsim through LC4", - "fork": false, - "url": "https://api.github.com/repos/dtrupenn/Tetris", - "created_at": "2012-01-01T00:31:50Z", - "updated_at": "2013-01-05T17:58:47Z", - "pushed_at": "2012-01-01T00:37:02Z", - "homepage": "https://github.com", - "size": 524, - "stargazers_count": 1, - "watchers_count": 1, - "language": "Assembly", - "forks_count": 0, - "open_issues_count": 0, - "master_branch": "master", - "default_branch": "master", - "score": 1, - "archive_url": "https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}", - "blobs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/dtrupenn/Tetris/comments{/number}", - "commits_url": "https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}", - "compare_url": "https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}", - "contributors_url": "https://api.github.com/repos/dtrupenn/Tetris/contributors", - "deployments_url": "https://api.github.com/repos/dtrupenn/Tetris/deployments", - "downloads_url": "https://api.github.com/repos/dtrupenn/Tetris/downloads", - "events_url": "https://api.github.com/repos/dtrupenn/Tetris/events", - "forks_url": "https://api.github.com/repos/dtrupenn/Tetris/forks", - "git_commits_url": "https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}", - "git_url": "git:github.com/dtrupenn/Tetris.git", - "issue_comment_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}", - "issues_url": "https://api.github.com/repos/dtrupenn/Tetris/issues{/number}", - "keys_url": "https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}", - "labels_url": "https://api.github.com/repos/dtrupenn/Tetris/labels{/name}", - "languages_url": "https://api.github.com/repos/dtrupenn/Tetris/languages", - "merges_url": "https://api.github.com/repos/dtrupenn/Tetris/merges", - "milestones_url": "https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}", - "notifications_url": "https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}", - "releases_url": "https://api.github.com/repos/dtrupenn/Tetris/releases{/id}", - "ssh_url": "git@github.com:dtrupenn/Tetris.git", - "stargazers_url": "https://api.github.com/repos/dtrupenn/Tetris/stargazers", - "statuses_url": "https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/dtrupenn/Tetris/subscribers", - "subscription_url": "https://api.github.com/repos/dtrupenn/Tetris/subscription", - "tags_url": "https://api.github.com/repos/dtrupenn/Tetris/tags", - "teams_url": "https://api.github.com/repos/dtrupenn/Tetris/teams", - "trees_url": "https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}", - "clone_url": "https://github.com/dtrupenn/Tetris.git", - "mirror_url": "git:git.example.com/dtrupenn/Tetris", - "hooks_url": "https://api.github.com/repos/dtrupenn/Tetris/hooks", - "svn_url": "https://svn.github.com/dtrupenn/Tetris", - "forks": 1, - "open_issues": 1, - "watchers": 1, - "has_issues": true, - "has_projects": true, - "has_pages": true, - "has_wiki": true, - "has_downloads": true, - "archived": true, - "disabled": true, - "visibility": "private", - "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" - } - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "incomplete_results", - "items" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "Repo Search Result Item", - "description": "Repo Search Result Item", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "size": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "score": { - "type": "number" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "keys_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "issue_events_url": { - "type": "string" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "assignees_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "blobs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "archive_url": { - "type": "string" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "issues_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "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" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - } - }, - "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", - "score" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/search/topics", - "title": "Search topics", - "category": "search", - "subcategory": "search", - "parameters": [ - { - "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query.

", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.

\n

When searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:

\n

q=ruby+is:featured

\n

This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 6, - "incomplete_results": false, - "items": [ - { - "name": "ruby", - "display_name": "Ruby", - "short_description": "Ruby is a scripting language designed for simplified object-oriented programming.", - "description": "Ruby was developed by Yukihiro \"Matz\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.", - "created_by": "Yukihiro Matsumoto", - "released": "December 21, 1995", - "created_at": "2016-11-28T22:03:59Z", - "updated_at": "2017-10-30T18:16:32Z", - "featured": true, - "curated": true, - "score": 1 - }, - { - "name": "rails", - "display_name": "Rails", - "short_description": "Ruby on Rails (Rails) is a web application framework written in Ruby.", - "description": "Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.", - "created_by": "David Heinemeier Hansson", - "released": "December 13 2005", - "created_at": "2016-12-09T17:03:50Z", - "updated_at": "2017-10-30T16:20:19Z", - "featured": true, - "curated": true, - "score": 1 - }, - { - "name": "python", - "display_name": "Python", - "short_description": "Python is a dynamically typed programming language.", - "description": "Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.", - "created_by": "Guido van Rossum", - "released": "February 20, 1991", - "created_at": "2016-12-07T00:07:02Z", - "updated_at": "2017-10-27T22:45:43Z", - "featured": true, - "curated": true, - "score": 1 - }, - { - "name": "jekyll", - "display_name": "Jekyll", - "short_description": "Jekyll is a simple, blog-aware static site generator.", - "description": "Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.", - "created_by": "Tom Preston-Werner", - "released": "2008", - "created_at": "2016-12-16T21:53:08Z", - "updated_at": "2017-10-27T19:00:24Z", - "featured": true, - "curated": true, - "score": 1 - }, - { - "name": "sass", - "display_name": "Sass", - "short_description": "Sass is a stable extension to classic CSS.", - "description": "Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.", - "created_by": "Hampton Catlin, Natalie Weizenbaum, Chris Eppstein", - "released": "November 28, 2006", - "created_at": "2016-12-16T21:53:45Z", - "updated_at": "2018-01-16T16:30:40Z", - "featured": true, - "curated": true, - "score": 1 - }, - { - "name": "homebrew", - "display_name": "Homebrew", - "short_description": "Homebrew is a package manager for macOS.", - "description": "Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.", - "created_by": "Max Howell", - "released": "2009", - "created_at": "2016-12-17T20:30:44Z", - "updated_at": "2018-02-06T16:14:56Z", - "featured": true, - "curated": true, - "score": 1 - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "incomplete_results", - "items" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "Topic Search Result Item", - "description": "Topic Search Result Item", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "display_name": { - "type": [ - "string", - "null" - ] - }, - "short_description": { - "type": [ - "string", - "null" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "created_by": { - "type": [ - "string", - "null" - ] - }, - "released": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "featured": { - "type": "boolean" - }, - "curated": { - "type": "boolean" - }, - "score": { - "type": "number" - }, - "repository_count": { - "type": [ - "integer", - "null" - ] - }, - "logo_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - } - } - }, - "related": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "topic_relation": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "topic_id": { - "type": "integer" - }, - "relation_type": { - "type": "string" - } - } - } - } - } - }, - "aliases": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "topic_relation": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "topic_id": { - "type": "integer" - }, - "relation_type": { - "type": "string" - } - } - } - } - } - } - }, - "required": [ - "name", - "display_name", - "short_description", - "description", - "created_by", - "released", - "created_at", - "updated_at", - "featured", - "curated", - "score" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/search/users", - "title": "Search users", - "category": "search", - "subcategory": "search", - "parameters": [ - { - "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching users\" for a detailed list of qualifiers.

", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "

Sorts the results of your query by number of followers or repositories, or when the person joined GitHub Enterprise Server. Default: best match

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "followers", - "repositories", - "joined" - ] - } - }, - { - "name": "order", - "description": "

Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "desc", - "asc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Find users via various criteria. This method returns up to 100 results per page.

\n

When searching for users, you can get text match metadata for the issue login, public email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you're looking for a list of popular users, you might try this query:

\n

q=tom+repos:%3E42+followers:%3E1000

\n

This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.

\n

This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"GraphQL Queries.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "total_count": 12, - "incomplete_results": false, - "items": [ - { - "login": "mojombo", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", - "gravatar_id": "", - "url": "https://api.github.com/users/mojombo", - "html_url": "https://github.com/mojombo", - "followers_url": "https://api.github.com/users/mojombo/followers", - "subscriptions_url": "https://api.github.com/users/mojombo/subscriptions", - "organizations_url": "https://api.github.com/users/mojombo/orgs", - "repos_url": "https://api.github.com/users/mojombo/repos", - "received_events_url": "https://api.github.com/users/mojombo/received_events", - "type": "User", - "score": 1, - "following_url": "https://api.github.com/users/mojombo/following{/other_user}", - "gists_url": "https://api.github.com/users/mojombo/gists{/gist_id}", - "starred_url": "https://api.github.com/users/mojombo/starred{/owner}{/repo}", - "events_url": "https://api.github.com/users/mojombo/events{/privacy}", - "site_admin": true - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "incomplete_results", - "items" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "User Search Result Item", - "description": "User Search Result Item", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "score": { - "type": "number" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "site_admin": { - "type": "boolean" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - } - } - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "user_view_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", - "score" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/secret-scanning.json b/src/rest/data/ghes-3.14-2022-11-28/secret-scanning.json deleted file mode 100644 index 9bc5ce90a18a..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/secret-scanning.json +++ /dev/null @@ -1,4347 +0,0 @@ -{ - "secret-scanning": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/secret-scanning/alerts", - "title": "List secret scanning alerts for an enterprise", - "category": "secret-scanning", - "subcategory": "secret-scanning", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "in": "query", - "description": "

Set to open or resolved to only list secret scanning alerts in a specific state.

", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "resolved" - ] - } - }, - { - "name": "secret_type", - "in": "query", - "description": "

A comma-separated list of secret types to return. By default all secret types are returned. See \"Supported secret scanning patterns\" for a complete list of secret types.

", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "resolution", - "in": "query", - "description": "

A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.

", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "

The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "validity", - "in": "query", - "description": "

A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are active, inactive, and unknown.

", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the repo scope or security_events scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager, or for personal account repositories.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "number": 2, - "created_at": "2020-11-06T18:48:51Z", - "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", - "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", - "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", - "state": "resolved", - "resolution": "false_positive", - "resolved_at": "2020-11-07T02:47:13Z", - "resolved_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "secret_type": "adafruit_io_key", - "secret_type_display_name": "Adafruit IO Key", - "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", - "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}", - "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}", - "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": "https://api.github.com/repos/octocat/Hello-World/hooks" - }, - "push_protection_bypassed_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "push_protection_bypassed": true, - "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "push_protection_bypass_request_reviewer": { - "login": "octocat", - "id": 3, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/3?", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "push_protection_bypass_request_reviewer_comment": "Example response", - "push_protection_bypass_request_comment": "Example comment", - "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", - "resolution_comment": "Example comment", - "validity": "active" - }, - { - "number": 1, - "created_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", - "html_url": "https://github.com/owner/repo/security/secret-scanning/1", - "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret_type_display_name": "Mailchimp API Key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "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}", - "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}", - "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": "https://api.github.com/repos/octocat/Hello-World/hooks" - }, - "push_protection_bypassed_by": null, - "push_protection_bypassed": false, - "push_protection_bypassed_at": null, - "push_protection_bypass_request_reviewer": null, - "push_protection_bypass_request_reviewer_comment": null, - "push_protection_bypass_request_comment": null, - "push_protection_bypass_request_html_url": null, - "resolution_comment": null, - "validity": "unknown" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "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 - }, - "updated_at": { - "anyOf": [ - { - "type": "null" - }, - { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - ] - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "locations_url": { - "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", - "type": "string", - "enum": [ - "open", - "resolved" - ] - }, - "resolution": { - "type": [ - "string", - "null" - ], - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - null - ] - }, - "resolved_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "resolved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "secret_type_display_name": { - "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { - "type": "string", - "description": "The secret that was detected." - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the 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", - "url" - ] - }, - "push_protection_bypassed": { - "type": [ - "boolean", - "null" - ], - "description": "Whether push protection was bypassed for the detected secret." - }, - "push_protection_bypassed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "push_protection_bypassed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "resolution_comment": { - "type": [ - "string", - "null" - ], - "description": "The comment that was optionally added when this alert was closed" - }, - "validity": { - "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/secret-scanning/alerts", - "title": "List secret scanning alerts for an organization", - "category": "secret-scanning", - "subcategory": "secret-scanning", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "in": "query", - "description": "

Set to open or resolved to only list secret scanning alerts in a specific state.

", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "resolved" - ] - } - }, - { - "name": "secret_type", - "in": "query", - "description": "

A comma-separated list of secret types to return. By default all secret types are returned. See \"Supported secret scanning patterns\" for a complete list of secret types.

", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "resolution", - "in": "query", - "description": "

A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.

", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "

The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "validity", - "in": "query", - "description": "

A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are active, inactive, and unknown.

", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.

\n

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "number": 2, - "created_at": "2020-11-06T18:48:51Z", - "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", - "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", - "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", - "state": "resolved", - "resolution": "false_positive", - "resolved_at": "2020-11-07T02:47:13Z", - "resolved_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "secret_type": "adafruit_io_key", - "secret_type_display_name": "Adafruit IO Key", - "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", - "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}", - "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}", - "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": "https://api.github.com/repos/octocat/Hello-World/hooks" - }, - "push_protection_bypassed_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "push_protection_bypassed": true, - "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "push_protection_bypass_request_reviewer": { - "login": "octocat", - "id": 3, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/3?", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "push_protection_bypass_request_reviewer_comment": "Example response", - "push_protection_bypass_request_comment": "Example comment", - "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", - "resolution_comment": "Example comment", - "validity": "active" - }, - { - "number": 1, - "created_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", - "html_url": "https://github.com/owner/repo/security/secret-scanning/1", - "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret_type_display_name": "Mailchimp API Key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "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}", - "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}", - "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": "https://api.github.com/repos/octocat/Hello-World/hooks" - }, - "push_protection_bypassed_by": null, - "push_protection_bypassed": false, - "push_protection_bypassed_at": null, - "push_protection_bypass_request_reviewer": null, - "push_protection_bypass_request_reviewer_comment": null, - "push_protection_bypass_request_comment": null, - "push_protection_bypass_request_html_url": null, - "resolution_comment": null, - "validity": "unknown" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "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 - }, - "updated_at": { - "anyOf": [ - { - "type": "null" - }, - { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - ] - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "locations_url": { - "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", - "type": "string", - "enum": [ - "open", - "resolved" - ] - }, - "resolution": { - "type": [ - "string", - "null" - ], - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - null - ] - }, - "resolved_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "resolved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "secret_type_display_name": { - "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { - "type": "string", - "description": "The secret that was detected." - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the 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", - "url" - ] - }, - "push_protection_bypassed": { - "type": [ - "boolean", - "null" - ], - "description": "Whether push protection was bypassed for the detected secret." - }, - "push_protection_bypassed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "push_protection_bypassed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "resolution_comment": { - "type": [ - "string", - "null" - ], - "description": "The comment that was optionally added when this alert was closed" - }, - "validity": { - "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secret scanning alerts\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts", - "title": "List secret scanning alerts for a repository", - "category": "secret-scanning", - "subcategory": "secret-scanning", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "in": "query", - "description": "

Set to open or resolved to only list secret scanning alerts in a specific state.

", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "resolved" - ] - } - }, - { - "name": "secret_type", - "in": "query", - "description": "

A comma-separated list of secret types to return. By default all secret types are returned. See \"Supported secret scanning patterns\" for a complete list of secret types.

", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "resolution", - "in": "query", - "description": "

A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.

", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "

The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "validity", - "in": "query", - "description": "

A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are active, inactive, and unknown.

", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists secret scanning alerts for an eligible repository, from newest to oldest.

\n

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "number": 2, - "created_at": "2020-11-06T18:48:51Z", - "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", - "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", - "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", - "state": "resolved", - "resolution": "false_positive", - "resolved_at": "2020-11-07T02:47:13Z", - "resolved_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "secret_type": "adafruit_io_key", - "secret_type_display_name": "Adafruit IO Key", - "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", - "push_protection_bypassed_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "push_protection_bypassed": true, - "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "push_protection_bypass_request_reviewer": { - "login": "octocat", - "id": 3, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/3?", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "push_protection_bypass_request_reviewer_comment": "Example response", - "push_protection_bypass_request_comment": "Example comment", - "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", - "resolution_comment": "Example comment", - "validity": "inactive" - }, - { - "number": 1, - "created_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", - "html_url": "https://github.com/owner/repo/security/secret-scanning/1", - "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret_type_display_name": "Mailchimp API Key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "push_protection_bypassed_by": null, - "push_protection_bypassed": false, - "push_protection_bypassed_at": null, - "push_protection_bypass_request_reviewer": null, - "push_protection_bypass_request_reviewer_comment": null, - "push_protection_bypass_request_comment": null, - "push_protection_bypass_request_html_url": null, - "resolution_comment": null, - "validity": "unknown" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "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 - }, - "updated_at": { - "anyOf": [ - { - "type": "null" - }, - { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - ] - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "locations_url": { - "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", - "type": "string", - "enum": [ - "open", - "resolved" - ] - }, - "resolution": { - "type": [ - "string", - "null" - ], - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - null - ] - }, - "resolved_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "resolved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "resolution_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment to resolve an alert." - }, - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "secret_type_display_name": { - "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { - "type": "string", - "description": "The secret that was detected." - }, - "push_protection_bypassed": { - "type": [ - "boolean", - "null" - ], - "description": "Whether push protection was bypassed for the detected secret." - }, - "push_protection_bypassed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "push_protection_bypassed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "validity": { - "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Repository is public or secret scanning is disabled for the repository

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secret scanning alerts\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", - "title": "Get a secret scanning alert", - "category": "secret-scanning", - "subcategory": "secret-scanning", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a single secret scanning alert detected in an eligible repository.

\n

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "alert_number": "ALERT_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "number": 42, - "created_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", - "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", - "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations", - "state": "open", - "secret_type": "mailchimp_api_key", - "secret_type_display_name": "Mailchimp API Key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "push_protection_bypassed": false, - "validity": "unknown" - }, - "schema": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "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 - }, - "updated_at": { - "anyOf": [ - { - "type": "null" - }, - { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - ] - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "locations_url": { - "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", - "type": "string", - "enum": [ - "open", - "resolved" - ] - }, - "resolution": { - "type": [ - "string", - "null" - ], - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - null - ] - }, - "resolved_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "resolved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "resolution_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment to resolve an alert." - }, - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "secret_type_display_name": { - "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { - "type": "string", - "description": "The secret that was detected." - }, - "push_protection_bypassed": { - "type": [ - "boolean", - "null" - ], - "description": "Whether push protection was bypassed for the detected secret." - }, - "push_protection_bypassed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "push_protection_bypassed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "validity": { - "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "404", - "description": "

Repository is public, or secret scanning is disabled for the repository, or the resource is not found

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secret scanning alerts\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", - "title": "Update a secret scanning alert", - "category": "secret-scanning", - "subcategory": "secret-scanning", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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 - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "state", - "description": "

Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.

", - "enum": [ - "open", - "resolved" - ] - }, - { - "type": "string or null", - "name": "resolution", - "description": "

Required when the state is resolved. The reason for resolving the alert.

", - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - null - ] - }, - { - "type": "string or null", - "name": "resolution_comment", - "description": "

An optional comment when closing an alert. Cannot be updated or deleted. Must be null when changing state to open.

" - } - ], - "descriptionHTML": "

Updates the status of a secret scanning alert in an eligible repository.

\n

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "state": "resolved", - "resolution": "false_positive" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "alert_number": "ALERT_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "number": 42, - "created_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", - "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", - "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations", - "state": "resolved", - "resolution": "used_in_tests", - "resolved_at": "2020-11-16T22:42:07Z", - "resolved_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "secret_type": "mailchimp_api_key", - "secret_type_display_name": "Mailchimp API Key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "push_protection_bypassed": false, - "resolution_comment": "Example comment", - "validity": "unknown" - }, - "schema": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "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 - }, - "updated_at": { - "anyOf": [ - { - "type": "null" - }, - { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - ] - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "locations_url": { - "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", - "type": "string", - "enum": [ - "open", - "resolved" - ] - }, - "resolution": { - "type": [ - "string", - "null" - ], - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - null - ] - }, - "resolved_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "resolved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "resolution_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment to resolve an alert." - }, - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "secret_type_display_name": { - "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { - "type": "string", - "description": "The secret that was detected." - }, - "push_protection_bypassed": { - "type": [ - "boolean", - "null" - ], - "description": "Whether push protection was bypassed for the detected secret." - }, - "push_protection_bypassed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "push_protection_bypassed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "validity": { - "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "400", - "description": "

Bad request, resolution comment is invalid or the resolution was not changed.

" - }, - { - "httpStatusCode": "404", - "description": "

Repository is public, or secret scanning is disabled for the repository, or the resource is not found

" - }, - { - "httpStatusCode": "422", - "description": "

State does not match the resolution or resolution comment

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secret scanning alerts\" repository permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations", - "title": "List locations for a secret scanning alert", - "category": "secret-scanning", - "subcategory": "secret-scanning", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "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 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all locations for a given secret scanning alert for an eligible repository.

\n

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "alert_number": "ALERT_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "type": "commit", - "details": { - "path": "/example/secrets.txt", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - } - }, - { - "type": "wiki_commit", - "details": { - "path": "/example/Home.md", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5", - "commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5", - "commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - } - }, - { - "type": "issue_title", - "details": { - "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - { - "type": "issue_body", - "details": { - "issue_body_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - { - "type": "issue_comment", - "details": { - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - { - "type": "discussion_title", - "details": { - "discussion_title_url": "https://github.com/community/community/discussions/39082" - } - }, - { - "type": "discussion_body", - "details": { - "discussion_body_url": "https://github.com/community/community/discussions/39082#discussion-4566270" - } - }, - { - "type": "discussion_comment", - "details": { - "discussion_comment_url": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - } - }, - { - "type": "pull_request_title", - "details": { - "pull_request_title_url": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - { - "type": "pull_request_body", - "details": { - "pull_request_body_url": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - { - "type": "pull_request_comment", - "details": { - "pull_request_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1825855898" - } - }, - { - "type": "pull_request_review", - "details": { - "pull_request_review_url": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - } - }, - { - "type": "pull_request_review_comment", - "details": { - "pull_request_review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - } - } - ], - "schema": { - "type": "array", - "description": "List of locations where the secret was detected", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "commit", - "wiki_commit", - "issue_title", - "issue_body", - "issue_comment", - "discussion_title", - "discussion_body", - "discussion_comment", - "pull_request_title", - "pull_request_body", - "pull_request_comment", - "pull_request_review", - "pull_request_review_comment" - ], - "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found." - }, - "details": { - "oneOf": [ - { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob" - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit" - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected." - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected." - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected." - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected." - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected." - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected." - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected." - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected." - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected." - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected." - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected." - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } - ] - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Repository is public, or secret scanning is disabled for the repository, or the resource is not found

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Secret scanning alerts\" repository permissions": "read" - } - ] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/security-advisories.json b/src/rest/data/ghes-3.14-2022-11-28/security-advisories.json deleted file mode 100644 index 5291574e6bce..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/security-advisories.json +++ /dev/null @@ -1,1603 +0,0 @@ -{ - "global-advisories": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/advisories", - "title": "List global security advisories", - "category": "security-advisories", - "subcategory": "global-advisories", - "parameters": [ - { - "name": "ghsa_id", - "in": "query", - "description": "

If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.

", - "schema": { - "type": "string" - } - }, - { - "name": "type", - "in": "query", - "description": "

If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware.

", - "schema": { - "type": "string", - "enum": [ - "reviewed", - "malware", - "unreviewed" - ], - "default": "reviewed" - } - }, - { - "name": "cve_id", - "description": "

If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.

", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ecosystem", - "in": "query", - "description": "

If specified, only advisories for these ecosystems will be returned.

", - "schema": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "enum": [ - "rubygems", - "npm", - "pip", - "maven", - "nuget", - "composer", - "go", - "rust", - "erlang", - "actions", - "pub", - "other", - "swift" - ] - } - }, - { - "name": "severity", - "in": "query", - "description": "

If specified, only advisories with these severities will be returned.

", - "schema": { - "type": "string", - "enum": [ - "unknown", - "low", - "medium", - "high", - "critical" - ] - } - }, - { - "name": "cwes", - "in": "query", - "description": "

If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.

\n

Example: cwes=79,284,22 or cwes[]=79&cwes[]=284&cwes[]=22

", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - } - }, - { - "name": "is_withdrawn", - "in": "query", - "description": "

Whether to only return advisories that have been withdrawn.

", - "schema": { - "type": "boolean" - } - }, - { - "name": "affects", - "in": "query", - "description": "

If specified, only return advisories that affect any of package or package@version. A maximum of 1000 packages can be specified.\nIf the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.

\n

Example: affects=package1,package2@1.0.0,package3@2.0.0 or affects[]=package1&affects[]=package2@1.0.0

", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "maxItems": 1000, - "items": { - "type": "string" - } - } - ] - } - }, - { - "name": "published", - "in": "query", - "description": "

If specified, only return advisories that were published on a date or date range.

\n

For more information on the syntax of the date range, see \"Understanding the search syntax.\"

", - "schema": { - "type": "string" - } - }, - { - "name": "updated", - "in": "query", - "description": "

If specified, only return advisories that were updated on a date or date range.

\n

For more information on the syntax of the date range, see \"Understanding the search syntax.\"

", - "schema": { - "type": "string" - } - }, - { - "name": "modified", - "description": "

If specified, only show advisories that were updated or published on a date or date range.

\n

For more information on the syntax of the date range, see \"Understanding the search syntax.\"

", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "epss_percentage", - "in": "query", - "description": "

If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being exploited.

", - "schema": { - "type": "string" - } - }, - { - "name": "epss_percentile", - "in": "query", - "description": "

If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.

", - "schema": { - "type": "string" - } - }, - { - "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "direction", - "description": "

The direction to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "sort", - "description": "

The property to sort the results by.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "updated", - "published", - "epss_percentage", - "epss_percentile" - ], - "default": "published" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.

\n

By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the type parameter in your request, with the value malware. For more information about the different types of security advisories, see \"About the GitHub Advisory database.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 1, - "ghsa_id": "GHSA-abcd-1234-efgh", - "cve_id": "CVE-2050-00000", - "url": "https://api.github.com/advisories/GHSA-abcd-1234-efgh", - "html_url": "https://github.com/advisories/GHSA-abcd-1234-efgh", - "repository_advisory_url": "https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh", - "summary": "Heartbleed security advisory", - "description": "This bug allows an attacker to read portions of the affected server’s memory, potentially disclosing sensitive information.", - "type": "reviewed", - "severity": "high", - "source_code_location": "https://github.com/project/a-package", - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-abcd-1234-efgh" - }, - { - "type": "CVE", - "value": "CVE-2050-00000" - } - ], - "references": [ - "https://nvd.nist.gov/vuln/detail/CVE-2050-00000" - ], - "published_at": "2023-03-23T02:30:56Z", - "updated_at": "2023-03-24T02:30:56Z", - "github_reviewed_at": "2023-03-23T02:30:56Z", - "nvd_published_at": "2023-03-25T02:30:56Z", - "withdrawn_at": null, - "vulnerabilities": [ - { - "package": { - "ecosystem": "npm", - "name": "a-package" - }, - "first_patched_version": "1.0.3", - "vulnerable_version_range": "<=1.0.2", - "vulnerable_functions": [ - "a_function" - ] - } - ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", - "score": 7.6 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", - "score": 7.6 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", - "score": 9.3 - } - }, - "cwes": [ - { - "cwe_id": "CWE-400", - "name": "Uncontrolled Resource Consumption" - } - ], - "epss": { - "percentage": 0.00045, - "percentile": "0.16001e0" - }, - "credits": [ - { - "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 - }, - "type": "analyst" - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "description": "A GitHub Security Advisory.", - "type": "object", - "properties": { - "ghsa_id": { - "type": "string", - "description": "The GitHub Security Advisory ID.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The Common Vulnerabilities and Exposures (CVE) ID.", - "readOnly": true - }, - "url": { - "type": "string", - "description": "The API URL for the advisory.", - "readOnly": true - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL for the advisory.", - "readOnly": true - }, - "repository_advisory_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "description": "The API URL for the repository advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short summary of the advisory.", - "maxLength": 1024 - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "A detailed description of what the advisory entails.", - "maxLength": 65535 - }, - "type": { - "type": "string", - "description": "The type of advisory.", - "readOnly": true, - "enum": [ - "reviewed", - "unreviewed", - "malware" - ] - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "enum": [ - "critical", - "high", - "medium", - "low", - "unknown" - ] - }, - "source_code_location": { - "type": [ - "string", - "null" - ], - "format": "uri", - "description": "The URL of the advisory's source code." - }, - "identifiers": { - "type": [ - "array", - "null" - ], - "readOnly": true, - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of identifier.", - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The identifier value." - } - }, - "required": [ - "type", - "value" - ] - } - }, - "references": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "description": "URLs with more information regarding the advisory." - } - }, - "published_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was published, in ISO 8601 format.", - "readOnly": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", - "readOnly": true - }, - "github_reviewed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.", - "readOnly": true - }, - "nvd_published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.\nThis field is only populated when the advisory is imported from the National Vulnerability Database.", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", - "readOnly": true - }, - "vulnerabilities": { - "type": [ - "array", - "null" - ], - "description": "The products and respective version ranges affected by the advisory.", - "items": { - "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.", - "type": "object", - "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": [ - "object", - "null" - ], - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "enum": [ - "rubygems", - "npm", - "pip", - "maven", - "nuget", - "composer", - "go", - "rust", - "erlang", - "actions", - "pub", - "other", - "swift" - ] - }, - "name": { - "type": [ - "string", - "null" - ], - "description": "The unique package name within its ecosystem." - } - }, - "required": [ - "ecosystem", - "name" - ] - }, - "vulnerable_version_range": { - "type": [ - "string", - "null" - ], - "description": "The range of the package versions affected by the vulnerability." - }, - "first_patched_version": { - "type": [ - "string", - "null" - ], - "description": "The package version that resolves the vulnerability." - }, - "vulnerable_functions": { - "type": [ - "array", - "null" - ], - "description": "The functions in the package that are affected by the vulnerability.", - "readOnly": true, - "items": { - "type": "string" - } - } - }, - "required": [ - "package", - "vulnerable_version_range", - "first_patched_version", - "vulnerable_functions" - ] - } - }, - "cvss": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS vector." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_severities": { - "type": [ - "object", - "null" - ], - "properties": { - "cvss_v3": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 3 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 4 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "epss": { - "type": [ - "object", - "null" - ], - "readOnly": true, - "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", - "properties": { - "percentage": { - "type": "number", - "minimum": 0, - "maximum": 100 - }, - "percentile": { - "type": "number", - "minimum": 0, - "maximum": 100 - } - } - }, - "cwes": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "cwe_id": { - "type": "string", - "description": "The Common Weakness Enumeration (CWE) identifier." - }, - "name": { - "type": "string", - "description": "The name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ] - } - }, - "credits": { - "type": [ - "array", - "null" - ], - "description": "In GitHub Enterprise Server, this field will always be empty because the user metadata of credited users will not be available.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - } - }, - "required": [ - "user", - "type" - ] - } - } - }, - "required": [ - "ghsa_id", - "cve_id", - "url", - "html_url", - "repository_advisory_url", - "summary", - "description", - "type", - "severity", - "source_code_location", - "identifiers", - "references", - "published_at", - "updated_at", - "github_reviewed_at", - "nvd_published_at", - "withdrawn_at", - "vulnerabilities", - "cvss", - "cwes", - "credits" - ], - "additionalProperties": false - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - }, - { - "httpStatusCode": "429", - "description": "

Too many requests

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/advisories/{ghsa_id}", - "title": "Get a global security advisory", - "category": "security-advisories", - "subcategory": "global-advisories", - "parameters": [ - { - "name": "ghsa_id", - "description": "

The GHSA (GitHub Security Advisory) identifier of the advisory.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "ghsa_id": "GHSA_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "ghsa_id": "GHSA-abcd-1234-efgh", - "cve_id": "CVE-2050-00000", - "url": "https://api.github.com/advisories/GHSA-abcd-1234-efgh", - "html_url": "https://github.com/advisories/GHSA-abcd-1234-efgh", - "repository_advisory_url": "https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh", - "summary": "A short summary of the advisory.", - "description": "A detailed description of what the advisory entails.", - "type": "reviewed", - "severity": "high", - "source_code_location": "https://github.com/project/a-package", - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-abcd-1234-efgh" - }, - { - "type": "CVE", - "value": "CVE-2050-00000" - } - ], - "references": [ - "https://nvd.nist.gov/vuln/detail/CVE-2050-00000" - ], - "published_at": "2023-03-23T02:30:56Z", - "updated_at": "2023-03-24T02:30:56Z", - "github_reviewed_at": "2023-03-23T02:30:56Z", - "nvd_published_at": "2023-03-25T02:30:56Z", - "withdrawn_at": null, - "vulnerabilities": [ - { - "package": { - "ecosystem": "npm", - "name": "a-package" - }, - "first_patched_version": "1.0.3", - "vulnerable_version_range": "<=1.0.2", - "vulnerable_functions": [ - "a_function" - ] - } - ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", - "score": 7.6 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", - "score": 7.6 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", - "score": 9.3 - } - }, - "cwes": [ - { - "cwe_id": "CWE-400", - "name": "Uncontrolled Resource Consumption" - } - ], - "credits": [ - { - "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 - }, - "type": "analyst" - } - ] - }, - "schema": { - "description": "A GitHub Security Advisory.", - "type": "object", - "properties": { - "ghsa_id": { - "type": "string", - "description": "The GitHub Security Advisory ID.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The Common Vulnerabilities and Exposures (CVE) ID.", - "readOnly": true - }, - "url": { - "type": "string", - "description": "The API URL for the advisory.", - "readOnly": true - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL for the advisory.", - "readOnly": true - }, - "repository_advisory_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "description": "The API URL for the repository advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short summary of the advisory.", - "maxLength": 1024 - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "A detailed description of what the advisory entails.", - "maxLength": 65535 - }, - "type": { - "type": "string", - "description": "The type of advisory.", - "readOnly": true, - "enum": [ - "reviewed", - "unreviewed", - "malware" - ] - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "enum": [ - "critical", - "high", - "medium", - "low", - "unknown" - ] - }, - "source_code_location": { - "type": [ - "string", - "null" - ], - "format": "uri", - "description": "The URL of the advisory's source code." - }, - "identifiers": { - "type": [ - "array", - "null" - ], - "readOnly": true, - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of identifier.", - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The identifier value." - } - }, - "required": [ - "type", - "value" - ] - } - }, - "references": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "description": "URLs with more information regarding the advisory." - } - }, - "published_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was published, in ISO 8601 format.", - "readOnly": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", - "readOnly": true - }, - "github_reviewed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.", - "readOnly": true - }, - "nvd_published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.\nThis field is only populated when the advisory is imported from the National Vulnerability Database.", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", - "readOnly": true - }, - "vulnerabilities": { - "type": [ - "array", - "null" - ], - "description": "The products and respective version ranges affected by the advisory.", - "items": { - "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.", - "type": "object", - "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": [ - "object", - "null" - ], - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "enum": [ - "rubygems", - "npm", - "pip", - "maven", - "nuget", - "composer", - "go", - "rust", - "erlang", - "actions", - "pub", - "other", - "swift" - ] - }, - "name": { - "type": [ - "string", - "null" - ], - "description": "The unique package name within its ecosystem." - } - }, - "required": [ - "ecosystem", - "name" - ] - }, - "vulnerable_version_range": { - "type": [ - "string", - "null" - ], - "description": "The range of the package versions affected by the vulnerability." - }, - "first_patched_version": { - "type": [ - "string", - "null" - ], - "description": "The package version that resolves the vulnerability." - }, - "vulnerable_functions": { - "type": [ - "array", - "null" - ], - "description": "The functions in the package that are affected by the vulnerability.", - "readOnly": true, - "items": { - "type": "string" - } - } - }, - "required": [ - "package", - "vulnerable_version_range", - "first_patched_version", - "vulnerable_functions" - ] - } - }, - "cvss": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS vector." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_severities": { - "type": [ - "object", - "null" - ], - "properties": { - "cvss_v3": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 3 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 4 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "epss": { - "type": [ - "object", - "null" - ], - "readOnly": true, - "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", - "properties": { - "percentage": { - "type": "number", - "minimum": 0, - "maximum": 100 - }, - "percentile": { - "type": "number", - "minimum": 0, - "maximum": 100 - } - } - }, - "cwes": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "cwe_id": { - "type": "string", - "description": "The Common Weakness Enumeration (CWE) identifier." - }, - "name": { - "type": "string", - "description": "The name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ] - } - }, - "credits": { - "type": [ - "array", - "null" - ], - "description": "In GitHub Enterprise Server, this field will always be empty because the user metadata of credited users will not be available.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "type": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ] - } - }, - "required": [ - "user", - "type" - ] - } - } - }, - "required": [ - "ghsa_id", - "cve_id", - "url", - "html_url", - "repository_advisory_url", - "summary", - "description", - "type", - "severity", - "source_code_location", - "identifiers", - "references", - "published_at", - "updated_at", - "github_reviewed_at", - "nvd_published_at", - "withdrawn_at", - "vulnerabilities", - "cvss", - "cwes", - "credits" - ], - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/teams.json b/src/rest/data/ghes-3.14-2022-11-28/teams.json deleted file mode 100644 index 38abc0d740c0..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/teams.json +++ /dev/null @@ -1,12820 +0,0 @@ -{ - "teams": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/teams", - "title": "List teams", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all teams in an organization that are visible to the authenticated user.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/teams", - "title": "Create a team", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the team.

", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

The description of the team.

" - }, - { - "type": "array of strings", - "name": "maintainers", - "description": "

List GitHub usernames for organization members who will become team maintainers.

" - }, - { - "type": "array of strings", - "name": "repo_names", - "description": "

The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

" - }, - { - "type": "string", - "name": "privacy", - "description": "

The level of privacy this team should have. The options are:
\nFor a non-nested team:

\n
    \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
    • \n
", - "enum": [ - "secret", - "closed" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "

The notification setting the team has chosen. The options are:

\n
    \n
  • notifications_enabled - team members receive notifications when the team is @mentioned.
    • \n
  • notifications_disabled - no one receives notifications.
    \nDefault: notifications_enabled
    • \n
", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Closing down notice. The permission that new repositories will be added to the team with when none is specified.

", - "enum": [ - "pull", - "push" - ], - "default": "pull" - }, - { - "type": "integer", - "name": "parent_team_id", - "description": "

The ID of a team to set as the parent team.

" - }, - { - "type": "string", - "name": "ldap_dn", - "description": "

The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"

" - } - ], - "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\".

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Justice League", - "description": "A great team", - "permission": "push", - "notification_setting": "notifications_enabled", - "privacy": "closed" - }, - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "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", - "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" - }, - "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" - }, - "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", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer" - }, - "repos_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "company": { - "type": "string" - }, - "blog": { - "type": "string", - "format": "uri" - }, - "location": { - "type": "string" - }, - "email": { - "type": "string", - "format": "email" - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "is_verified": { - "type": "boolean" - }, - "has_organization_projects": { - "type": "boolean" - }, - "has_repository_projects": { - "type": "boolean" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "type": { - "type": "string" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "private_gists": { - "type": [ - "integer", - "null" - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "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", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ] - }, - "members_allowed_repository_creation_type": { - "type": "string" - }, - "members_can_create_public_repositories": { - "type": "boolean" - }, - "members_can_create_private_repositories": { - "type": "boolean" - }, - "members_can_create_internal_repositories": { - "type": "boolean" - }, - "members_can_create_pages": { - "type": "boolean" - }, - "members_can_create_public_pages": { - "type": "boolean" - }, - "members_can_create_private_pages": { - "type": "boolean" - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "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", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team." - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}", - "title": "Get a team by name", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets a team using the team's slug. To create the slug, GitHub Enterprise Server replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, \"My TEam Näme\" would become my-team-name.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "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", - "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" - }, - "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" - }, - "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", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer" - }, - "repos_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "company": { - "type": "string" - }, - "blog": { - "type": "string", - "format": "uri" - }, - "location": { - "type": "string" - }, - "email": { - "type": "string", - "format": "email" - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "is_verified": { - "type": "boolean" - }, - "has_organization_projects": { - "type": "boolean" - }, - "has_repository_projects": { - "type": "boolean" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "type": { - "type": "string" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "private_gists": { - "type": [ - "integer", - "null" - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "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", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ] - }, - "members_allowed_repository_creation_type": { - "type": "string" - }, - "members_can_create_public_repositories": { - "type": "boolean" - }, - "members_can_create_private_repositories": { - "type": "boolean" - }, - "members_can_create_internal_repositories": { - "type": "boolean" - }, - "members_can_create_pages": { - "type": "boolean" - }, - "members_can_create_public_pages": { - "type": "boolean" - }, - "members_can_create_private_pages": { - "type": "boolean" - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "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", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team." - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/orgs/{org}/teams/{team_slug}", - "title": "Update a team", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the team.

" - }, - { - "type": "string", - "name": "description", - "description": "

The description of the team.

" - }, - { - "type": "string", - "name": "privacy", - "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
    \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.
    • \n
", - "enum": [ - "secret", - "closed" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "

The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:

\n
    \n
  • notifications_enabled - team members receive notifications when the team is @mentioned.
    • \n
  • notifications_disabled - no one receives notifications.
    • \n
", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Closing down notice. The permission that new repositories will be added to the team with when none is specified.

", - "enum": [ - "pull", - "push", - "admin" - ], - "default": "pull" - }, - { - "type": "integer or null", - "name": "parent_team_id", - "description": "

The ID of a team to set as the parent team.

" - } - ], - "descriptionHTML": "

To edit a team, the authenticated user must either be an organization owner or a team maintainer.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "new team name", - "description": "new team description", - "privacy": "closed", - "notification_setting": "notifications_enabled" - }, - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response when the updated information already exists

", - "example": { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "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", - "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" - }, - "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" - }, - "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", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer" - }, - "repos_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "company": { - "type": "string" - }, - "blog": { - "type": "string", - "format": "uri" - }, - "location": { - "type": "string" - }, - "email": { - "type": "string", - "format": "email" - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "is_verified": { - "type": "boolean" - }, - "has_organization_projects": { - "type": "boolean" - }, - "has_repository_projects": { - "type": "boolean" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "type": { - "type": "string" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "private_gists": { - "type": [ - "integer", - "null" - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "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", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ] - }, - "members_allowed_repository_creation_type": { - "type": "string" - }, - "members_can_create_public_repositories": { - "type": "boolean" - }, - "members_can_create_private_repositories": { - "type": "boolean" - }, - "members_can_create_internal_repositories": { - "type": "boolean" - }, - "members_can_create_pages": { - "type": "boolean" - }, - "members_can_create_public_pages": { - "type": "boolean" - }, - "members_can_create_private_pages": { - "type": "boolean" - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "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", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team." - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "new team name", - "description": "new team description", - "privacy": "closed", - "notification_setting": "notifications_enabled" - }, - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "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", - "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" - }, - "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" - }, - "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", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer" - }, - "repos_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "company": { - "type": "string" - }, - "blog": { - "type": "string", - "format": "uri" - }, - "location": { - "type": "string" - }, - "email": { - "type": "string", - "format": "email" - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "is_verified": { - "type": "boolean" - }, - "has_organization_projects": { - "type": "boolean" - }, - "has_repository_projects": { - "type": "boolean" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "type": { - "type": "string" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "private_gists": { - "type": [ - "integer", - "null" - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "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", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ] - }, - "members_allowed_repository_creation_type": { - "type": "string" - }, - "members_can_create_public_repositories": { - "type": "boolean" - }, - "members_can_create_private_repositories": { - "type": "boolean" - }, - "members_can_create_internal_repositories": { - "type": "boolean" - }, - "members_can_create_pages": { - "type": "boolean" - }, - "members_can_create_public_pages": { - "type": "boolean" - }, - "members_can_create_private_pages": { - "type": "boolean" - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "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", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team." - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Response when the updated information already exists

" - }, - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}", - "title": "Delete a team", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "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

\n

\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects", - "title": "List team projects", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - } - ], - "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", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "title": "Check team permissions for a project", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "

The unique identifier of the project.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG", - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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 - } - }, - "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", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found if project is not managed by this team

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "title": "Add or update team project permissions", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "

The unique identifier of the project.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "description": "

The permission to grant to the team for this project. Default: 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 this endpoint. For more information, see \"HTTP method.\"

", - "enum": [ - "read", - "write", - "admin" - ] - } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Updates the permissions for the team to write for the project", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "permission": "write" - }, - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG", - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden if the project is not owned by the organization

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "title": "Remove a project from a team", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "

The unique identifier of the project.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG", - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos", - "title": "List team repositories", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists a team's repositories visible to the authenticated user.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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, - "has_discussions": false, - "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 - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "title": "Check team permissions for a repository", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "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

If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG", - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Alternative response with repository permissions

", - "example": { - "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, - "maintain": false, - "push": false, - "triage": false, - "pull": true - }, - "role_name": "read", - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "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 - }, - "schema": { - "title": "Team Repository", - "description": "A team's access to a repository.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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" - ] - }, - "role_name": { - "type": "string" - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": 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." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "default": false, - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Alternative response with repository permissions

" - }, - { - "httpStatusCode": "204", - "description": "

Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header.

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found if team does not have permission for the repository

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read", - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "title": "Add or update team repository permissions", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "description": "

The permission to grant the team on this repository. We accept the following permissions to be set: pull, triage, push, maintain, admin and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

" - } - ], - "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 method.\"

\n

Note

\n

\nYou 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
\n

For more information about the permission levels, see \"Repository permission levels for an organization\".

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Adding a team to an organization repository with the write role", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "permission": "push" - }, - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG", - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write", - "\"Members\" organization permissions": "read", - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "title": "Remove a repository from a team", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "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

\n

\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG", - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write", - "\"Members\" organization permissions": "read", - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/teams", - "title": "List child teams", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the child teams of the team specified by {team_slug}.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

if child teams exist

", - "example": [ - { - "id": 2, - "node_id": "MDQ6VGVhbTI=", - "url": "https://api.github.com/teams/2", - "name": "Original Roster", - "slug": "original-roster", - "description": "Started it all.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "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", - "notification_setting": "notifications_enabled", - "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" - } - ], - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

if child teams exist

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/teams/{team_id}", - "title": "Get a team (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "team_id": "TEAM_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "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", - "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" - }, - "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" - }, - "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", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer" - }, - "repos_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "company": { - "type": "string" - }, - "blog": { - "type": "string", - "format": "uri" - }, - "location": { - "type": "string" - }, - "email": { - "type": "string", - "format": "email" - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "is_verified": { - "type": "boolean" - }, - "has_organization_projects": { - "type": "boolean" - }, - "has_repository_projects": { - "type": "boolean" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "type": { - "type": "string" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "private_gists": { - "type": [ - "integer", - "null" - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "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", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ] - }, - "members_allowed_repository_creation_type": { - "type": "string" - }, - "members_can_create_public_repositories": { - "type": "boolean" - }, - "members_can_create_private_repositories": { - "type": "boolean" - }, - "members_can_create_internal_repositories": { - "type": "boolean" - }, - "members_can_create_pages": { - "type": "boolean" - }, - "members_can_create_public_pages": { - "type": "boolean" - }, - "members_can_create_private_pages": { - "type": "boolean" - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "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", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team." - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/teams/{team_id}", - "title": "Update a team (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The name of the team.

", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

The description of the team.

" - }, - { - "type": "string", - "name": "privacy", - "description": "

The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:

\n
    \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.
    • \n
", - "enum": [ - "secret", - "closed" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "

The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:

\n
    \n
  • notifications_enabled - team members receive notifications when the team is @mentioned.
    • \n
  • notifications_disabled - no one receives notifications.
    • \n
", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Closing down notice. The permission that new repositories will be added to the team with when none is specified.

", - "enum": [ - "pull", - "push", - "admin" - ], - "default": "pull" - }, - { - "type": "integer or null", - "name": "parent_team_id", - "description": "

The ID of a team to set as the parent team.

" - } - ], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.

\n
\n

To edit a team, the authenticated user must either be an organization owner or a team maintainer.

\n

Note

\n

\nWith nested teams, the privacy for parent teams cannot be secret.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "new team name", - "description": "new team description", - "privacy": "closed", - "notification_setting": "notifications_enabled" - }, - "parameters": { - "team_id": "TEAM_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response when the updated information already exists

", - "example": { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "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", - "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" - }, - "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" - }, - "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", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer" - }, - "repos_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "company": { - "type": "string" - }, - "blog": { - "type": "string", - "format": "uri" - }, - "location": { - "type": "string" - }, - "email": { - "type": "string", - "format": "email" - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "is_verified": { - "type": "boolean" - }, - "has_organization_projects": { - "type": "boolean" - }, - "has_repository_projects": { - "type": "boolean" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "type": { - "type": "string" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "private_gists": { - "type": [ - "integer", - "null" - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "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", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ] - }, - "members_allowed_repository_creation_type": { - "type": "string" - }, - "members_can_create_public_repositories": { - "type": "boolean" - }, - "members_can_create_private_repositories": { - "type": "boolean" - }, - "members_can_create_internal_repositories": { - "type": "boolean" - }, - "members_can_create_pages": { - "type": "boolean" - }, - "members_can_create_public_pages": { - "type": "boolean" - }, - "members_can_create_private_pages": { - "type": "boolean" - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "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", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team." - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - } - } - }, - { - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "new team name", - "description": "new team description", - "privacy": "closed", - "notification_setting": "notifications_enabled" - }, - "parameters": { - "team_id": "TEAM_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "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", - "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" - }, - "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" - }, - "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", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer" - }, - "repos_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "company": { - "type": "string" - }, - "blog": { - "type": "string", - "format": "uri" - }, - "location": { - "type": "string" - }, - "email": { - "type": "string", - "format": "email" - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "is_verified": { - "type": "boolean" - }, - "has_organization_projects": { - "type": "boolean" - }, - "has_repository_projects": { - "type": "boolean" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "type": { - "type": "string" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "private_gists": { - "type": [ - "integer", - "null" - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "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", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ] - }, - "members_allowed_repository_creation_type": { - "type": "string" - }, - "members_can_create_public_repositories": { - "type": "boolean" - }, - "members_can_create_private_repositories": { - "type": "boolean" - }, - "members_can_create_internal_repositories": { - "type": "boolean" - }, - "members_can_create_pages": { - "type": "boolean" - }, - "members_can_create_public_pages": { - "type": "boolean" - }, - "members_can_create_private_pages": { - "type": "boolean" - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "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", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team." - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Response when the updated information already exists

" - }, - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/teams/{team_id}", - "title": "Delete a team (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.

\n
\n

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.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "team_id": "TEAM_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/teams/{team_id}/projects", - "title": "List team projects (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "team_id": "TEAM_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - } - ], - "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", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/teams/{team_id}/projects/{project_id}", - "title": "Check team permissions for a project (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "

The unique identifier of the project.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "team_id": "TEAM_ID", - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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 - } - }, - "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", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found if project is not managed by this team

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/teams/{team_id}/projects/{project_id}", - "title": "Add or update team project permissions (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "

The unique identifier of the project.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "description": "

The permission to grant to the team for this project. Default: 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 this endpoint. For more information, see \"HTTP method.\"

", - "enum": [ - "read", - "write", - "admin" - ] - } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example of setting permission to read", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "permission": "read" - }, - "parameters": { - "team_id": "TEAM_ID", - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden if the project is not owned by the organization

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/teams/{team_id}/projects/{project_id}", - "title": "Remove a project from a team (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "

The unique identifier of the project.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a project from a team endpoint.

\n
\n

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. Note: This endpoint removes the project from the team, but does not delete it.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "team_id": "TEAM_ID", - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/teams/{team_id}/repos", - "title": "List team repositories (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "team_id": "TEAM_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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, - "has_discussions": false, - "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 - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "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" - }, - "has_discussions": { - "type": "boolean" - }, - "has_pull_requests": { - "type": "boolean" - }, - "pull_request_creation_policy": { - "description": "The policy controlling who can create pull requests: all or collaborators_only.", - "type": "string", - "enum": [ - "all", - "collaborators_only" - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "body": { - "type": "string" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - } - }, - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "title": "Check team permissions for a repository (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.

\n
\n

Note

\n

\nRepositories inherited through a parent team will also be checked.

\n
\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 Accept header:

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "team_id": "TEAM_ID", - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Alternative response with extra repository information

", - "example": { - "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, - "maintain": false, - "push": false, - "triage": false, - "pull": true - }, - "role_name": "read", - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "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 - }, - "schema": { - "title": "Team Repository", - "description": "A team's access to a repository.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "full_name": { - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "spdx_id": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "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" - ] - }, - "role_name": { - "type": "string" - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "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", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean" - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": 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." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean" - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean" - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "default": false, - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "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" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

Alternative response with extra repository information

" - }, - { - "httpStatusCode": "204", - "description": "

Response if repository is managed by this team

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found if repository is not managed by this team

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read", - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "title": "Add or update team repository permissions (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "description": "

The permission to grant the team on this repository. 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" - ] - } - ], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.

\n
\n

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.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example of setting permission to pull", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "permission": "push" - }, - "parameters": { - "team_id": "TEAM_ID", - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write", - "\"Members\" organization permissions": "read", - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "title": "Remove a repository from a team (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.

\n
\n

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. NOTE: This does not delete the repository, it just removes it from the team.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "team_id": "TEAM_ID", - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Administration\" repository permissions": "write", - "\"Members\" organization permissions": "read", - "\"Metadata\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/teams/{team_id}/teams", - "title": "List child teams (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "team_id": "TEAM_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

if child teams exist

", - "example": [ - { - "id": 2, - "node_id": "MDQ6VGVhbTI=", - "url": "https://api.github.com/teams/2", - "name": "Original Roster", - "slug": "original-roster", - "description": "Started it all.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "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", - "notification_setting": "notifications_enabled", - "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" - } - ], - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

if child teams exist

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/teams", - "title": "List teams for the authenticated user", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

List all of the teams across all of the organizations to which the authenticated\nuser belongs.

\n

OAuth app tokens and personal access tokens (classic) need the user, repo, or read:org scope to use this endpoint.

\n

When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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", - "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", - "type": "Organization" - }, - "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - }, - "members_url": { - "type": "string" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer" - }, - "repos_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "company": { - "type": "string" - }, - "blog": { - "type": "string", - "format": "uri" - }, - "location": { - "type": "string" - }, - "email": { - "type": "string", - "format": "email" - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "is_verified": { - "type": "boolean" - }, - "has_organization_projects": { - "type": "boolean" - }, - "has_repository_projects": { - "type": "boolean" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "type": { - "type": "string" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "private_gists": { - "type": [ - "integer", - "null" - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "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", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ] - }, - "members_allowed_repository_creation_type": { - "type": "string" - }, - "members_can_create_public_repositories": { - "type": "boolean" - }, - "members_can_create_private_repositories": { - "type": "boolean" - }, - "members_can_create_internal_repositories": { - "type": "boolean" - }, - "members_can_create_pages": { - "type": "boolean" - }, - "members_can_create_public_pages": { - "type": "boolean" - }, - "members_can_create_private_pages": { - "type": "boolean" - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ] - }, - "web_commit_signoff_required": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "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", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team." - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs" - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - } - ], - "external-groups": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/external-group/{group_id}", - "title": "Get an external group", - "category": "teams", - "subcategory": "external-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "group_id", - "description": "

The unique identifier of the group.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page for the \"members\" array (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the \"members\" array results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "group_id": "GROUP_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "group_id": "123", - "group_name": "Octocat admins", - "updated_at": "2021-01-24T11:31:04-06:00", - "teams": [ - { - "team_id": 1, - "team_name": "team-test" - }, - { - "team_id": 2, - "team_name": "team-test2" - } - ], - "members": [ - { - "member_id": 1, - "member_login": "mona-lisa_eocsaxrs", - "member_name": "Mona Lisa", - "member_email": "mona_lisa@github.com" - }, - { - "member_id": 2, - "member_login": "octo-lisa_eocsaxrs", - "member_name": "Octo Lisa", - "member_email": "octo_lisa@github.com" - } - ] - }, - "schema": { - "title": "ExternalGroup", - "description": "Information about an external group's usage and its members", - "type": "object", - "required": [ - "group_id", - "group_name", - "teams", - "members" - ], - "properties": { - "group_id": { - "description": "The internal ID of the group", - "type": "integer" - }, - "group_name": { - "description": "The display name for the group", - "type": "string" - }, - "updated_at": { - "description": "The date when the group was last updated_at", - "type": "string" - }, - "teams": { - "description": "An array of teams linked to this group", - "type": "array", - "items": { - "type": "object", - "required": [ - "team_id", - "team_name" - ], - "properties": { - "team_id": { - "description": "The id for a team", - "type": "integer" - }, - "team_name": { - "description": "The name of the team", - "type": "string" - } - } - } - }, - "members": { - "description": "An array of external members linked to this group", - "type": "array", - "items": { - "type": "object", - "required": [ - "member_id", - "member_login", - "member_name", - "member_email" - ], - "properties": { - "member_id": { - "description": "The internal user ID of the identity", - "type": "integer" - }, - "member_login": { - "description": "The handle/login for the user", - "type": "string" - }, - "member_name": { - "description": "The user display name/profile name", - "type": "string" - }, - "member_email": { - "description": "An email attached to a user", - "type": "string" - } - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/external-groups", - "title": "List external groups available to an organization", - "category": "teams", - "subcategory": "external-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

Page token

", - "in": "query", - "schema": { - "type": "integer" - } - }, - { - "name": "display_name", - "description": "

Limits the list to groups containing the text in the group name

", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "groups": [ - { - "group_id": "123", - "group_name": "Octocat admins", - "updated_at": "2021-01-24T11:31:04-06:00" - }, - { - "group_id": "456", - "group_name": "Octocat docs members", - "updated_at": "2021-03-24T11:31:04-06:00" - } - ] - }, - "schema": { - "title": "ExternalGroups", - "description": "A list of external groups available to be connected to a team", - "type": "object", - "properties": { - "groups": { - "description": "An array of external groups available to be mapped to a team", - "type": "array", - "items": { - "type": "object", - "required": [ - "group_id", - "group_name", - "updated_at" - ], - "properties": { - "group_id": { - "description": "The internal ID of the group", - "type": "integer" - }, - "group_name": { - "description": "The display name of the group", - "type": "string" - }, - "updated_at": { - "description": "The time of the last update for this group", - "type": "string" - } - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", - "title": "List a connection between an external group and a team", - "category": "teams", - "subcategory": "external-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists a connection between a team and an external group.

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "groups": [ - { - "group_id": "123", - "group_name": "Octocat admins", - "updated_at": "2021-01-24T11:31:04-06:00" - }, - { - "group_id": "456", - "group_name": "Octocat docs members", - "updated_at": "2021-03-24T11:31:04-06:00" - } - ] - }, - "schema": { - "title": "ExternalGroups", - "description": "A list of external groups available to be connected to a team", - "type": "object", - "properties": { - "groups": { - "description": "An array of external groups available to be mapped to a team", - "type": "array", - "items": { - "type": "object", - "required": [ - "group_id", - "group_name", - "updated_at" - ], - "properties": { - "group_id": { - "description": "The internal ID of the group", - "type": "integer" - }, - "group_name": { - "description": "The display name of the group", - "type": "string" - }, - "updated_at": { - "description": "The time of the last update for this group", - "type": "string" - } - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", - "title": "Update the connection between an external group and a team", - "category": "teams", - "subcategory": "external-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "integer", - "name": "group_id", - "description": "

External Group Id

", - "isRequired": true - } - ], - "descriptionHTML": "

Creates a connection between a team and an external group. Only one external group can be linked to a team.

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "group_id": 123 - }, - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "group_id": "123", - "group_name": "Octocat admins", - "updated_at": "2021-01-24T11:31:04-06:00", - "teams": [ - { - "team_id": 1, - "team_name": "team-test" - }, - { - "team_id": 2, - "team_name": "team-test2" - } - ], - "members": [ - { - "member_id": 1, - "member_login": "mona-lisa_eocsaxrs", - "member_name": "Mona Lisa", - "member_email": "mona_lisa@github.com" - }, - { - "member_id": 2, - "member_login": "octo-lisa_eocsaxrs", - "member_name": "Octo Lisa", - "member_email": "octo_lisa@github.com" - } - ] - }, - "schema": { - "title": "ExternalGroup", - "description": "Information about an external group's usage and its members", - "type": "object", - "required": [ - "group_id", - "group_name", - "teams", - "members" - ], - "properties": { - "group_id": { - "description": "The internal ID of the group", - "type": "integer" - }, - "group_name": { - "description": "The display name for the group", - "type": "string" - }, - "updated_at": { - "description": "The date when the group was last updated_at", - "type": "string" - }, - "teams": { - "description": "An array of teams linked to this group", - "type": "array", - "items": { - "type": "object", - "required": [ - "team_id", - "team_name" - ], - "properties": { - "team_id": { - "description": "The id for a team", - "type": "integer" - }, - "team_name": { - "description": "The name of the team", - "type": "string" - } - } - } - }, - "members": { - "description": "An array of external members linked to this group", - "type": "array", - "items": { - "type": "object", - "required": [ - "member_id", - "member_login", - "member_name", - "member_email" - ], - "properties": { - "member_id": { - "description": "The internal user ID of the identity", - "type": "integer" - }, - "member_login": { - "description": "The handle/login for the user", - "type": "string" - }, - "member_name": { - "description": "The user display name/profile name", - "type": "string" - }, - "member_email": { - "description": "An email attached to a user", - "type": "string" - } - } - } - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", - "title": "Remove the connection between an external group and a team", - "category": "teams", - "subcategory": "external-groups", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes a connection between a team and an external group.

\n

You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - } - ], - "members": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/members", - "title": "List team members", - "category": "teams", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role", - "description": "

Filters members returned by their role in the team.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "member", - "maintainer", - "all" - ], - "default": "all" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "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.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "title": "Get team membership for a user", - "category": "teams", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "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

\n

\nYou 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

\n

\nThe response contains the state of the membership and the member's role.

\n
\n

The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response if user is a team maintainer

", - "example": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "maintainer", - "state": "active" - }, - "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", - "type": "string" - }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

if user has no team membership

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "title": "Add or update team membership for a user", - "category": "teams", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "role", - "description": "

The role that this user should have in the team.

", - "enum": [ - "member", - "maintainer" - ], - "default": "member" - } - ], - "descriptionHTML": "

Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.

\n

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Note

\n

\nWhen 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 Enterprise Server 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 Enterprise Server.\"

\n
\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

\n

\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.

\n
", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Add or update team membership for an organization member", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "role": "maintainer" - }, - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response if user's membership with team is now pending

", - "example": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - }, - "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", - "type": "string" - }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden if team synchronization is set up

" - }, - { - "httpStatusCode": "422", - "description": "

Unprocessable Entity if you attempt to add an organization to a team

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "title": "Remove team membership for a user", - "category": "teams", - "subcategory": "members", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

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

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Note

\n

\nWhen 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 Enterprise Server 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 Enterprise Server.\"

\n
\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden if team synchronization is set up

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/teams/{team_id}/members", - "title": "List team members (Legacy)", - "category": "teams", - "subcategory": "members", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "role", - "description": "

Filters members returned by their role in the team.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "member", - "maintainer", - "all" - ], - "default": "all" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.

\n
\n

Team members will include the members of child teams.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "team_id": "TEAM_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/teams/{team_id}/members/{username}", - "title": "Get team member (Legacy)", - "category": "teams", - "subcategory": "members", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

The \"Get team member\" endpoint (described below) is closing down.

\n

We recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.

\n

To list members in a team, the team must be visible to the authenticated user.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "team_id": "TEAM_ID", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

if user is a member

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

if user is a member

" - }, - { - "httpStatusCode": "404", - "description": "

if user is not a member

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/teams/{team_id}/members/{username}", - "title": "Add team member (Legacy)", - "category": "teams", - "subcategory": "members", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

The \"Add team member\" endpoint (described below) is closing down.

\n

We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

\n

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

\n

Note

\n

\nWhen 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 Enterprise Server 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 Enterprise Server.\"

\n
\n

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "team_id": "TEAM_ID", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found if team synchronization is set up

" - }, - { - "httpStatusCode": "422", - "description": "

Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/teams/{team_id}/members/{username}", - "title": "Remove team member (Legacy)", - "category": "teams", - "subcategory": "members", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

The \"Remove team member\" endpoint (described below) is closing down.

\n

We recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.

\n

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 team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.

\n

Note

\n

\nWhen 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 Enterprise Server 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 Enterprise Server.\"

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "team_id": "TEAM_ID", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found if team synchronization is setup

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/teams/{team_id}/memberships/{username}", - "title": "Get team membership for a user (Legacy)", - "category": "teams", - "subcategory": "members", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.

\n
\n

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:\nThe response contains the state of the membership and the member's role.

\n

The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "team_id": "TEAM_ID", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response if user is a team maintainer

", - "example": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "maintainer", - "state": "active" - }, - "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", - "type": "string" - }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/teams/{team_id}/memberships/{username}", - "title": "Add or update team membership for a user (Legacy)", - "category": "teams", - "subcategory": "members", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "role", - "description": "

The role that this user should have in the team.

", - "enum": [ - "member", - "maintainer" - ], - "default": "member" - } - ], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.

\n
\n

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.

\n

Note

\n

\nWhen 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 Enterprise Server 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 Enterprise Server.\"

\n
\n

If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user 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. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.

\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.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Assign the member role for a user in a team", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "role": "member" - }, - "parameters": { - "team_id": "TEAM_ID", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response if user's membership with team is now pending

", - "example": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - }, - "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", - "type": "string" - }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden if team synchronization is set up

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Unprocessable Entity if you attempt to add an organization to a team

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/teams/{team_id}/memberships/{username}", - "title": "Remove team membership for a user (Legacy)", - "category": "teams", - "subcategory": "members", - "parameters": [ - { - "name": "team_id", - "description": "

The unique identifier of the team.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.

\n
\n

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

\n

\nWhen 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 Enterprise Server 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 Enterprise Server.\"

\n
", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "team_id": "TEAM_ID", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "403", - "description": "

if team synchronization is set up

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - } - ] -} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/users.json b/src/rest/data/ghes-3.14-2022-11-28/users.json deleted file mode 100644 index 02cb98a292b4..000000000000 --- a/src/rest/data/ghes-3.14-2022-11-28/users.json +++ /dev/null @@ -1,8114 +0,0 @@ -{ - "users": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user", - "title": "Get the authenticated user", - "category": "users", - "subcategory": "users", - "parameters": [], - "bodyParameters": [], - "descriptionHTML": "

OAuth app tokens and personal access tokens (classic) need the user scope in order for the response to include private profile information.

", - "codeExamples": [ - { - "request": { - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response with public and private profile information

", - "example": { - "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, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z", - "private_gists": 81, - "total_private_repos": 100, - "owned_private_repos": 100, - "disk_usage": 10000, - "collaborators": 8, - "two_factor_authentication": true, - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "collaborators": 0 - } - }, - "schema": { - "oneOf": [ - { - "title": "Private User", - "description": "Private User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "type": "integer" - }, - "two_factor_authentication": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "business_plus": { - "type": "boolean" - }, - "ldap_dn": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at", - "collaborators", - "disk_usage", - "owned_private_repos", - "private_gists", - "total_private_repos", - "two_factor_authentication" - ] - }, - { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false - } - ] - } - } - }, - { - "request": { - "description": "Example 2: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response with public profile information

", - "example": { - "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, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z" - }, - "schema": { - "oneOf": [ - { - "title": "Private User", - "description": "Private User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "type": "integer" - }, - "two_factor_authentication": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "business_plus": { - "type": "boolean" - }, - "ldap_dn": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at", - "collaborators", - "disk_usage", - "owned_private_repos", - "private_gists", - "total_private_repos", - "two_factor_authentication" - ] - }, - { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false - } - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/user", - "title": "Update the authenticated user", - "category": "users", - "subcategory": "users", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

The new name of the user.

" - }, - { - "type": "string", - "name": "email", - "description": "

The publicly visible email address of the user.

" - }, - { - "type": "string", - "name": "blog", - "description": "

The new blog URL of the user.

" - }, - { - "type": "string or null", - "name": "twitter_username", - "description": "

The new Twitter username of the user.

" - }, - { - "type": "string", - "name": "company", - "description": "

The new company of the user.

" - }, - { - "type": "string", - "name": "location", - "description": "

The new location of the user.

" - }, - { - "type": "boolean", - "name": "hireable", - "description": "

The new hiring availability of the user.

" - }, - { - "type": "string", - "name": "bio", - "description": "

The new short biography of the user.

" - } - ], - "descriptionHTML": "

Note: If your email is set to private and you send an email parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example of updating blog and name", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "blog": "https://github.com/blog", - "name": "monalisa octocat" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "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, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z", - "private_gists": 81, - "total_private_repos": 100, - "owned_private_repos": 100, - "disk_usage": 10000, - "collaborators": 8, - "two_factor_authentication": true, - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "collaborators": 0 - } - }, - "schema": { - "title": "Private User", - "description": "Private User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "type": "integer" - }, - "two_factor_authentication": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "business_plus": { - "type": "boolean" - }, - "ldap_dn": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at", - "collaborators", - "disk_usage", - "owned_private_repos", - "private_gists", - "total_private_repos", - "two_factor_authentication" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Profile\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/{account_id}", - "title": "Get a user using their ID", - "category": "users", - "subcategory": "users", - "parameters": [ - { - "name": "account_id", - "description": "

account_id parameter

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", - "codeExamples": [ - { - "request": { - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "account_id": "ACCOUNT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Default response

", - "example": { - "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, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z" - }, - "schema": { - "oneOf": [ - { - "title": "Private User", - "description": "Private User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "type": "integer" - }, - "two_factor_authentication": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "business_plus": { - "type": "boolean" - }, - "ldap_dn": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at", - "collaborators", - "disk_usage", - "owned_private_repos", - "private_gists", - "total_private_repos", - "two_factor_authentication" - ] - }, - { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false - } - ] - } - } - }, - { - "request": { - "description": "Example 2: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "account_id": "ACCOUNT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response with GitHub plan information

", - "example": { - "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, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z", - "plan": { - "name": "pro", - "space": 976562499, - "collaborators": 0, - "private_repos": 9999 - } - }, - "schema": { - "oneOf": [ - { - "title": "Private User", - "description": "Private User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "type": "integer" - }, - "two_factor_authentication": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "business_plus": { - "type": "boolean" - }, - "ldap_dn": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at", - "collaborators", - "disk_usage", - "owned_private_repos", - "private_gists", - "total_private_repos", - "two_factor_authentication" - ] - }, - { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false - } - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users", - "title": "List users", - "category": "users", - "subcategory": "users", - "parameters": [ - { - "name": "since", - "description": "

A user ID. Only return users with an ID greater than this ID.

", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.

\n

Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}", - "title": "Get a user", - "category": "users", - "subcategory": "users", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", - "codeExamples": [ - { - "request": { - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Default response

", - "example": { - "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, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z" - }, - "schema": { - "oneOf": [ - { - "title": "Private User", - "description": "Private User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "type": "integer" - }, - "two_factor_authentication": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "business_plus": { - "type": "boolean" - }, - "ldap_dn": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at", - "collaborators", - "disk_usage", - "owned_private_repos", - "private_gists", - "total_private_repos", - "two_factor_authentication" - ] - }, - { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false - } - ] - } - } - }, - { - "request": { - "description": "Example 2: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response with GitHub plan information

", - "example": { - "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, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z", - "plan": { - "name": "pro", - "space": 976562499, - "collaborators": 0, - "private_repos": 9999 - } - }, - "schema": { - "oneOf": [ - { - "title": "Private User", - "description": "Private User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "type": "integer" - }, - "two_factor_authentication": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "business_plus": { - "type": "boolean" - }, - "ldap_dn": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at", - "collaborators", - "disk_usage", - "owned_private_repos", - "private_gists", - "total_private_repos", - "two_factor_authentication" - ] - }, - { - "title": "Public User", - "description": "Public User", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "user_view_type": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "notification_email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ] - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] - }, - "private_gists": { - "type": "integer" - }, - "total_private_repos": { - "type": "integer" - }, - "owned_private_repos": { - "type": "integer" - }, - "disk_usage": { - "type": "integer" - }, - "collaborators": { - "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", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false - } - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/hovercard", - "title": "Get contextual information for a user", - "category": "users", - "subcategory": "users", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "subject_type", - "description": "

Identifies which additional information you'd like to receive about the person's hovercard. Can be organization, repository, issue, pull_request. Required when using subject_id.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "organization", - "repository", - "issue", - "pull_request" - ] - } - }, - { - "name": "subject_id", - "description": "

Uses the ID for the subject_type you specified. Required when using subject_type.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

\n

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository, you would use a subject_type value of repository and a subject_id value of 1300192 (the ID of the Spoon-Knife repository).

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "contexts": [ - { - "message": "Owns this repository", - "octicon": "repo" - } - ] - }, - "schema": { - "title": "Hovercard", - "description": "Hovercard", - "type": "object", - "properties": { - "contexts": { - "type": "array", - "items": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "octicon": { - "type": "string" - } - }, - "required": [ - "message", - "octicon" - ] - } - } - }, - "required": [ - "contexts" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ], - "emails": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/emails", - "title": "List email addresses for the authenticated user", - "category": "users", - "subcategory": "emails", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all of your email addresses, and specifies which one is visible\nto the public.

\n

OAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "email": "octocat@github.com", - "verified": true, - "primary": true, - "visibility": "public" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Email", - "description": "Email", - "type": "object", - "properties": { - "email": { - "type": "string", - "format": "email" - }, - "primary": { - "type": "boolean" - }, - "verified": { - "type": "boolean" - }, - "visibility": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "email", - "primary", - "verified", - "visibility" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Email addresses\" user permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/user/emails", - "title": "Add an email address for the authenticated user", - "category": "users", - "subcategory": "emails", - "parameters": [], - "bodyParameters": [ - { - "type": "array of strings", - "name": "emails", - "description": "

Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", - "isRequired": true - } - ], - "descriptionHTML": "

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example adding multiple email addresses", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "emails": [ - "octocat@github.com", - "mona@github.com", - "octocat@octocat.org" - ] - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "email": "octocat@octocat.org", - "primary": false, - "verified": false, - "visibility": "public" - }, - { - "email": "octocat@github.com", - "primary": false, - "verified": false, - "visibility": null - }, - { - "email": "mona@github.com", - "primary": false, - "verified": false, - "visibility": null - } - ], - "schema": { - "type": "array", - "items": { - "title": "Email", - "description": "Email", - "type": "object", - "properties": { - "email": { - "type": "string", - "format": "email" - }, - "primary": { - "type": "boolean" - }, - "verified": { - "type": "boolean" - }, - "visibility": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "email", - "primary", - "verified", - "visibility" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Email addresses\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/user/emails", - "title": "Delete an email address for the authenticated user", - "category": "users", - "subcategory": "emails", - "parameters": [], - "bodyParameters": [ - { - "type": "array of strings", - "name": "emails", - "description": "

Email addresses associated with the GitHub user account.

", - "isRequired": true - } - ], - "descriptionHTML": "

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example deleting multiple email accounts", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "emails": [ - "octocat@github.com", - "mona@github.com" - ] - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Email addresses\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/public_emails", - "title": "List public email addresses for the authenticated user", - "category": "users", - "subcategory": "emails", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists your publicly visible email address, which you can set with the\nSet primary email visibility for the authenticated user\nendpoint.

\n

OAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "email": "octocat@github.com", - "verified": true, - "primary": true, - "visibility": "public" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Email", - "description": "Email", - "type": "object", - "properties": { - "email": { - "type": "string", - "format": "email" - }, - "primary": { - "type": "boolean" - }, - "verified": { - "type": "boolean" - }, - "visibility": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "email", - "primary", - "verified", - "visibility" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Email addresses\" user permissions": "read" - } - ], - "allowsPublicRead": true - } - } - ], - "followers": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/followers", - "title": "List followers of the authenticated user", - "category": "users", - "subcategory": "followers", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the people following the authenticated user.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Followers\" user permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/following", - "title": "List the people the authenticated user follows", - "category": "users", - "subcategory": "followers", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the people who the authenticated user follows.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Followers\" user permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/following/{username}", - "title": "Check if a person is followed by the authenticated user", - "category": "users", - "subcategory": "followers", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

if the person is followed by the authenticated user

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

if the person is followed by the authenticated user

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

if the person is not followed by the authenticated user

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Followers\" user permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/user/following/{username}", - "title": "Follow a user", - "category": "users", - "subcategory": "followers", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "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.\"

\n

OAuth app tokens and personal access tokens (classic) need the user:follow scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Followers\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/user/following/{username}", - "title": "Unfollow a user", - "category": "users", - "subcategory": "followers", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

OAuth app tokens and personal access tokens (classic) need the user:follow scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Followers\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/followers", - "title": "List followers of a user", - "category": "users", - "subcategory": "followers", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the people following the specified user.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/following", - "title": "List the people a user follows", - "category": "users", - "subcategory": "followers", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the people who the specified user follows.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string" - }, - "user_view_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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/following/{target_user}", - "title": "Check if a user follows another user", - "category": "users", - "subcategory": "followers", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "target_user", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "descriptionHTML": "", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME", - "target_user": "TARGET_USER" - } - }, - "response": { - "statusCode": "204", - "description": "

if the user follows the target user

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

if the user follows the target user

" - }, - { - "httpStatusCode": "404", - "description": "

if the user does not follow the target user

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - } - ], - "gpg-keys": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/gpg_keys", - "title": "List GPG keys for the authenticated user", - "category": "users", - "subcategory": "gpg-keys", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the current user's GPG keys.

\n

OAuth app tokens and personal access tokens (classic) need the read:gpg_key scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 3, - "name": "Octocat's GPG Key", - "primary_key_id": 2, - "key_id": "3262EFF25BA0D270", - "public_key": "xsBNBFayYZ...", - "emails": [ - { - "email": "octocat@users.noreply.github.com", - "verified": true - } - ], - "subkeys": [ - { - "id": 4, - "primary_key_id": 3, - "key_id": "4A595D4C72EE49C7", - "public_key": "zsBNBFayYZ...", - "emails": [], - "can_sign": false, - "can_encrypt_comms": true, - "can_encrypt_storage": true, - "can_certify": false, - "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": "2016-03-24T11:31:04-07:00", - "revoked": false - } - ], - "can_sign": true, - "can_encrypt_comms": false, - "can_encrypt_storage": false, - "can_certify": true, - "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": "2016-03-24T11:31:04-07:00", - "revoked": false, - "raw_key": "string" - } - ], - "schema": { - "type": "array", - "items": { - "title": "GPG Key", - "description": "A unique encryption key", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "primary_key_id": { - "type": [ - "integer", - "null" - ] - }, - "key_id": { - "type": "string" - }, - "public_key": { - "type": "string" - }, - "emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string" - }, - "verified": { - "type": "boolean" - } - } - } - }, - "subkeys": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "primary_key_id": { - "type": "integer" - }, - "key_id": { - "type": "string" - }, - "public_key": { - "type": "string" - }, - "emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string" - }, - "verified": { - "type": "boolean" - } - } - } - }, - "subkeys": { - "type": "array", - "items": {} - }, - "can_sign": { - "type": "boolean" - }, - "can_encrypt_comms": { - "type": "boolean" - }, - "can_encrypt_storage": { - "type": "boolean" - }, - "can_certify": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "expires_at": { - "type": [ - "string", - "null" - ] - }, - "raw_key": { - "type": [ - "string", - "null" - ] - }, - "revoked": { - "type": "boolean" - } - } - } - }, - "can_sign": { - "type": "boolean" - }, - "can_encrypt_comms": { - "type": "boolean" - }, - "can_encrypt_storage": { - "type": "boolean" - }, - "can_certify": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "revoked": { - "type": "boolean" - }, - "raw_key": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "id", - "primary_key_id", - "key_id", - "raw_key", - "public_key", - "created_at", - "expires_at", - "can_sign", - "can_encrypt_comms", - "can_encrypt_storage", - "can_certify", - "emails", - "subkeys", - "revoked" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"GPG keys\" user permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/user/gpg_keys", - "title": "Create a GPG key for the authenticated user", - "category": "users", - "subcategory": "gpg-keys", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "description": "

A descriptive name for the new key.

" - }, - { - "type": "string", - "name": "armored_public_key", - "description": "

A GPG key in ASCII-armored format.

", - "isRequired": true - } - ], - "descriptionHTML": "

Adds a GPG key to the authenticated user's GitHub account.

\n

OAuth app tokens and personal access tokens (classic) need the write:gpg_key scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Octocat's GPG Key", - "armored_public_key": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v1\n\nmQINBFnZ2ZIBEADQ2Z7Z7\n-----END PGP PUBLIC KEY BLOCK-----" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 3, - "name": "Octocat's GPG Key", - "primary_key_id": 2, - "key_id": "3262EFF25BA0D270", - "public_key": "xsBNBFayYZ...", - "emails": [ - { - "email": "octocat@users.noreply.github.com", - "verified": true - } - ], - "subkeys": [ - { - "id": 4, - "primary_key_id": 3, - "key_id": "4A595D4C72EE49C7", - "public_key": "zsBNBFayYZ...", - "emails": [], - "can_sign": false, - "can_encrypt_comms": true, - "can_encrypt_storage": true, - "can_certify": false, - "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": "2016-03-24T11:31:04-07:00", - "revoked": false - } - ], - "can_sign": true, - "can_encrypt_comms": false, - "can_encrypt_storage": false, - "can_certify": true, - "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": "2016-03-24T11:31:04-07:00", - "revoked": false, - "raw_key": "\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v2\\n\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\nIts/HFYRLiFgDLmTlxo=\\n=+OzK\\n-----END PGP PUBLIC KEY BLOCK-----\"" - }, - "schema": { - "title": "GPG Key", - "description": "A unique encryption key", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "primary_key_id": { - "type": [ - "integer", - "null" - ] - }, - "key_id": { - "type": "string" - }, - "public_key": { - "type": "string" - }, - "emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string" - }, - "verified": { - "type": "boolean" - } - } - } - }, - "subkeys": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "primary_key_id": { - "type": "integer" - }, - "key_id": { - "type": "string" - }, - "public_key": { - "type": "string" - }, - "emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string" - }, - "verified": { - "type": "boolean" - } - } - } - }, - "subkeys": { - "type": "array", - "items": {} - }, - "can_sign": { - "type": "boolean" - }, - "can_encrypt_comms": { - "type": "boolean" - }, - "can_encrypt_storage": { - "type": "boolean" - }, - "can_certify": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "expires_at": { - "type": [ - "string", - "null" - ] - }, - "raw_key": { - "type": [ - "string", - "null" - ] - }, - "revoked": { - "type": "boolean" - } - } - } - }, - "can_sign": { - "type": "boolean" - }, - "can_encrypt_comms": { - "type": "boolean" - }, - "can_encrypt_storage": { - "type": "boolean" - }, - "can_certify": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "revoked": { - "type": "boolean" - }, - "raw_key": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "id", - "primary_key_id", - "key_id", - "raw_key", - "public_key", - "created_at", - "expires_at", - "can_sign", - "can_encrypt_comms", - "can_encrypt_storage", - "can_certify", - "emails", - "subkeys", - "revoked" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"GPG keys\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/gpg_keys/{gpg_key_id}", - "title": "Get a GPG key for the authenticated user", - "category": "users", - "subcategory": "gpg-keys", - "parameters": [ - { - "name": "gpg_key_id", - "description": "

The unique identifier of the GPG key.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

View extended details for a single GPG key.

\n

OAuth app tokens and personal access tokens (classic) need the read:gpg_key scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "gpg_key_id": "GPG_KEY_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 3, - "name": "Octocat's GPG Key", - "primary_key_id": 2, - "key_id": "3262EFF25BA0D270", - "public_key": "xsBNBFayYZ...", - "emails": [ - { - "email": "octocat@users.noreply.github.com", - "verified": true - } - ], - "subkeys": [ - { - "id": 4, - "primary_key_id": 3, - "key_id": "4A595D4C72EE49C7", - "public_key": "zsBNBFayYZ...", - "emails": [], - "can_sign": false, - "can_encrypt_comms": true, - "can_encrypt_storage": true, - "can_certify": false, - "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": "2016-03-24T11:31:04-07:00", - "revoked": false - } - ], - "can_sign": true, - "can_encrypt_comms": false, - "can_encrypt_storage": false, - "can_certify": true, - "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": "2016-03-24T11:31:04-07:00", - "revoked": false, - "raw_key": "\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v2\\n\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\nIts/HFYRLiFgDLmTlxo=\\n=+OzK\\n-----END PGP PUBLIC KEY BLOCK-----\"" - }, - "schema": { - "title": "GPG Key", - "description": "A unique encryption key", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "primary_key_id": { - "type": [ - "integer", - "null" - ] - }, - "key_id": { - "type": "string" - }, - "public_key": { - "type": "string" - }, - "emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string" - }, - "verified": { - "type": "boolean" - } - } - } - }, - "subkeys": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "primary_key_id": { - "type": "integer" - }, - "key_id": { - "type": "string" - }, - "public_key": { - "type": "string" - }, - "emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string" - }, - "verified": { - "type": "boolean" - } - } - } - }, - "subkeys": { - "type": "array", - "items": {} - }, - "can_sign": { - "type": "boolean" - }, - "can_encrypt_comms": { - "type": "boolean" - }, - "can_encrypt_storage": { - "type": "boolean" - }, - "can_certify": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "expires_at": { - "type": [ - "string", - "null" - ] - }, - "raw_key": { - "type": [ - "string", - "null" - ] - }, - "revoked": { - "type": "boolean" - } - } - } - }, - "can_sign": { - "type": "boolean" - }, - "can_encrypt_comms": { - "type": "boolean" - }, - "can_encrypt_storage": { - "type": "boolean" - }, - "can_certify": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "revoked": { - "type": "boolean" - }, - "raw_key": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "id", - "primary_key_id", - "key_id", - "raw_key", - "public_key", - "created_at", - "expires_at", - "can_sign", - "can_encrypt_comms", - "can_encrypt_storage", - "can_certify", - "emails", - "subkeys", - "revoked" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"GPG keys\" user permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/user/gpg_keys/{gpg_key_id}", - "title": "Delete a GPG key for the authenticated user", - "category": "users", - "subcategory": "gpg-keys", - "parameters": [ - { - "name": "gpg_key_id", - "description": "

The unique identifier of the GPG key.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes a GPG key from the authenticated user's GitHub account.

\n

OAuth app tokens and personal access tokens (classic) need the admin:gpg_key scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "gpg_key_id": "GPG_KEY_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"GPG keys\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/gpg_keys", - "title": "List GPG keys for a user", - "category": "users", - "subcategory": "gpg-keys", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the GPG keys for a user. This information is accessible by anyone.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 3, - "name": "Octocat's GPG Key", - "primary_key_id": 2, - "key_id": "3262EFF25BA0D270", - "public_key": "xsBNBFayYZ...", - "emails": [ - { - "email": "octocat@users.noreply.github.com", - "verified": true - } - ], - "subkeys": [ - { - "id": 4, - "primary_key_id": 3, - "key_id": "4A595D4C72EE49C7", - "public_key": "zsBNBFayYZ...", - "emails": [], - "can_sign": false, - "can_encrypt_comms": true, - "can_encrypt_storage": true, - "can_certify": false, - "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": "2016-03-24T11:31:04-07:00", - "revoked": false - } - ], - "can_sign": true, - "can_encrypt_comms": false, - "can_encrypt_storage": false, - "can_certify": true, - "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": "2016-03-24T11:31:04-07:00", - "revoked": false, - "raw_key": "string" - } - ], - "schema": { - "type": "array", - "items": { - "title": "GPG Key", - "description": "A unique encryption key", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "primary_key_id": { - "type": [ - "integer", - "null" - ] - }, - "key_id": { - "type": "string" - }, - "public_key": { - "type": "string" - }, - "emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string" - }, - "verified": { - "type": "boolean" - } - } - } - }, - "subkeys": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "primary_key_id": { - "type": "integer" - }, - "key_id": { - "type": "string" - }, - "public_key": { - "type": "string" - }, - "emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string" - }, - "verified": { - "type": "boolean" - } - } - } - }, - "subkeys": { - "type": "array", - "items": {} - }, - "can_sign": { - "type": "boolean" - }, - "can_encrypt_comms": { - "type": "boolean" - }, - "can_encrypt_storage": { - "type": "boolean" - }, - "can_certify": { - "type": "boolean" - }, - "created_at": { - "type": "string" - }, - "expires_at": { - "type": [ - "string", - "null" - ] - }, - "raw_key": { - "type": [ - "string", - "null" - ] - }, - "revoked": { - "type": "boolean" - } - } - } - }, - "can_sign": { - "type": "boolean" - }, - "can_encrypt_comms": { - "type": "boolean" - }, - "can_encrypt_storage": { - "type": "boolean" - }, - "can_certify": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "revoked": { - "type": "boolean" - }, - "raw_key": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "id", - "primary_key_id", - "key_id", - "raw_key", - "public_key", - "created_at", - "expires_at", - "can_sign", - "can_encrypt_comms", - "can_encrypt_storage", - "can_certify", - "emails", - "subkeys", - "revoked" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - } - ], - "keys": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/keys", - "title": "List public SSH keys for the authenticated user", - "category": "users", - "subcategory": "keys", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the public SSH keys for the authenticated user's GitHub account.

\n

OAuth app tokens and personal access tokens (classic) need the read:public_key scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "id": 2, - "url": "https://api.github.com/user/keys/2", - "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", - "created_at": "2020-06-11T21:31:57Z", - "verified": false, - "read_only": false - }, - { - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", - "id": 3, - "url": "https://api.github.com/user/keys/3", - "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", - "created_at": "2020-07-11T21:31:57Z", - "verified": false, - "read_only": false - } - ], - "schema": { - "type": "array", - "items": { - "title": "Key", - "description": "Key", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "verified": { - "type": "boolean" - }, - "read_only": { - "type": "boolean" - }, - "last_used": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "key", - "id", - "url", - "title", - "created_at", - "verified", - "read_only" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Git SSH keys\" user permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/user/keys", - "title": "Create a public SSH key for the authenticated user", - "category": "users", - "subcategory": "keys", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "title", - "description": "

A descriptive name for the new key.

" - }, - { - "type": "string", - "name": "key", - "description": "

The public SSH key to add to your GitHub account.

", - "isRequired": true - } - ], - "descriptionHTML": "

Adds a public SSH key to the authenticated user's GitHub account.

\n

OAuth app tokens and personal access tokens (classic) need the write:public_key scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "id": 2, - "url": "https://api.github.com/user/keys/2", - "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", - "created_at": "2020-06-11T21:31:57Z", - "verified": false, - "read_only": false - }, - "schema": { - "title": "Key", - "description": "Key", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "verified": { - "type": "boolean" - }, - "read_only": { - "type": "boolean" - }, - "last_used": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "key", - "id", - "url", - "title", - "created_at", - "verified", - "read_only" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Git SSH keys\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/keys/{key_id}", - "title": "Get a public SSH key for the authenticated user", - "category": "users", - "subcategory": "keys", - "parameters": [ - { - "name": "key_id", - "description": "

The unique identifier of the key.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

View extended details for a single public SSH key.

\n

OAuth app tokens and personal access tokens (classic) need the read:public_key scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "key_id": "KEY_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "id": 2, - "url": "https://api.github.com/user/keys/2", - "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", - "created_at": "2020-06-11T21:31:57Z", - "verified": false, - "read_only": false - }, - "schema": { - "title": "Key", - "description": "Key", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "verified": { - "type": "boolean" - }, - "read_only": { - "type": "boolean" - }, - "last_used": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "key", - "id", - "url", - "title", - "created_at", - "verified", - "read_only" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Git SSH keys\" user permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/user/keys/{key_id}", - "title": "Delete a public SSH key for the authenticated user", - "category": "users", - "subcategory": "keys", - "parameters": [ - { - "name": "key_id", - "description": "

The unique identifier of the key.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes a public SSH key from the authenticated user's GitHub account.

\n

OAuth app tokens and personal access tokens (classic) need the admin:public_key scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "key_id": "KEY_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Git SSH keys\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/keys", - "title": "List public keys for a user", - "category": "users", - "subcategory": "keys", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the verified public SSH keys for a user. This is accessible by anyone.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 1, - "key": "ssh-rsa AAA..." - } - ], - "schema": { - "type": "array", - "items": { - "title": "Key Simple", - "description": "Key Simple", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "key": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "last_used": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "key", - "id" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Git SSH keys\" user permissions": "read" - } - ], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - } - ], - "social-accounts": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/social_accounts", - "title": "List social accounts for the authenticated user", - "category": "users", - "subcategory": "social-accounts", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists all of your social accounts.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "provider": "twitter", - "url": "https://twitter.com/github" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Social account", - "description": "Social media account", - "type": "object", - "properties": { - "provider": { - "type": "string" - }, - "url": { - "type": "string" - } - }, - "required": [ - "provider", - "url" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/user/social_accounts", - "title": "Add social accounts for the authenticated user", - "category": "users", - "subcategory": "social-accounts", - "parameters": [], - "bodyParameters": [ - { - "type": "array of strings", - "name": "account_urls", - "description": "

Full URLs for the social media profiles to add.

", - "isRequired": true - } - ], - "descriptionHTML": "

Add one or more social accounts to the authenticated user's profile.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Adding multiple social accounts", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "account_urls": [ - "https://facebook.com/GitHub", - "https://www.youtube.com/@GitHub" - ] - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "provider": "twitter", - "url": "https://twitter.com/github" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Social account", - "description": "Social media account", - "type": "object", - "properties": { - "provider": { - "type": "string" - }, - "url": { - "type": "string" - } - }, - "required": [ - "provider", - "url" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Profile\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/user/social_accounts", - "title": "Delete social accounts for the authenticated user", - "category": "users", - "subcategory": "social-accounts", - "parameters": [], - "bodyParameters": [ - { - "type": "array of strings", - "name": "account_urls", - "description": "

Full URLs for the social media profiles to delete.

", - "isRequired": true - } - ], - "descriptionHTML": "

Deletes one or more social accounts from the authenticated user's profile.

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Deleting multiple social accounts", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "account_urls": [ - "https://facebook.com/GitHub", - "https://www.youtube.com/@GitHub" - ] - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"Profile\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/social_accounts", - "title": "List social accounts for a user", - "category": "users", - "subcategory": "social-accounts", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists social media accounts for a user. This endpoint is accessible by anyone.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "provider": "twitter", - "url": "https://twitter.com/github" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Social account", - "description": "Social media account", - "type": "object", - "properties": { - "provider": { - "type": "string" - }, - "url": { - "type": "string" - } - }, - "required": [ - "provider", - "url" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - } - ], - "ssh-signing-keys": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/ssh_signing_keys", - "title": "List SSH signing keys for the authenticated user", - "category": "users", - "subcategory": "ssh-signing-keys", - "parameters": [ - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the SSH signing keys for the authenticated user's GitHub account.

\n

OAuth app tokens and personal access tokens (classic) need the read:ssh_signing_key scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 2, - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", - "created_at": "2020-06-11T21:31:57Z" - }, - { - "id": 3, - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", - "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", - "created_at": "2020-07-11T21:31:57Z" - } - ], - "schema": { - "type": "array", - "items": { - "title": "SSH Signing Key", - "description": "A public SSH key used to sign Git commits", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "title": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "key", - "id", - "title", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"SSH signing keys\" user permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/user/ssh_signing_keys", - "title": "Create a SSH signing key for the authenticated user", - "category": "users", - "subcategory": "ssh-signing-keys", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "title", - "description": "

A descriptive name for the new key.

" - }, - { - "type": "string", - "name": "key", - "description": "

The public SSH key to add to your GitHub account. For more information, see \"Checking for existing SSH keys.\"

", - "isRequired": true - } - ], - "descriptionHTML": "

Creates an SSH signing key for the authenticated user's GitHub account.

\n

OAuth app tokens and personal access tokens (classic) need the write:ssh_signing_key scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "title": "ssh-rsa AAAAB3NzaC1yc2EAAA" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 2, - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", - "created_at": "2020-06-11T21:31:57Z" - }, - "schema": { - "title": "SSH Signing Key", - "description": "A public SSH key used to sign Git commits", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "title": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "key", - "id", - "title", - "created_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"SSH signing keys\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/ssh_signing_keys/{ssh_signing_key_id}", - "title": "Get an SSH signing key for the authenticated user", - "category": "users", - "subcategory": "ssh-signing-keys", - "parameters": [ - { - "name": "ssh_signing_key_id", - "description": "

The unique identifier of the SSH signing key.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Gets extended details for an SSH signing key.

\n

OAuth app tokens and personal access tokens (classic) need the read:ssh_signing_key scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "ssh_signing_key_id": "SSH_SIGNING_KEY_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 2, - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", - "created_at": "2020-06-11T21:31:57Z" - }, - "schema": { - "title": "SSH Signing Key", - "description": "A public SSH key used to sign Git commits", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "title": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "key", - "id", - "title", - "created_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"SSH signing keys\" user permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/user/ssh_signing_keys/{ssh_signing_key_id}", - "title": "Delete an SSH signing key for the authenticated user", - "category": "users", - "subcategory": "ssh-signing-keys", - "parameters": [ - { - "name": "ssh_signing_key_id", - "description": "

The unique identifier of the SSH signing key.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Deletes an SSH signing key from the authenticated user's GitHub account.

\n

OAuth app tokens and personal access tokens (classic) need the admin:ssh_signing_key scope to use this endpoint.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "ssh_signing_key_id": "SSH_SIGNING_KEY_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": false, - "fineGrainedPat": true, - "permissions": [ - { - "\"SSH signing keys\" user permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/ssh_signing_keys", - "title": "List SSH signing keys for a user", - "category": "users", - "subcategory": "ssh-signing-keys", - "parameters": [ - { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "

Lists the SSH signing keys for a user. This operation is accessible by anyone.

", - "codeExamples": [ - { - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "id": 2, - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", - "created_at": "2020-06-11T21:31:57Z" - }, - { - "id": 3, - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", - "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", - "created_at": "2020-07-11T21:31:57Z" - } - ], - "schema": { - "type": "array", - "items": { - "title": "SSH Signing Key", - "description": "A public SSH key used to sign Git commits", - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "title": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "key", - "id", - "title", - "created_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [], - "allowPermissionlessAccess": true, - "allowsPublicRead": true - } - } - ] -} \ No newline at end of file diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index e42b1b85c502..f38c5a72271d 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -8,9 +8,6 @@ "2022-11-28", "2026-03-10" ], - "ghes-3.14": [ - "2022-11-28" - ], "ghes-3.15": [ "2022-11-28" ], diff --git a/src/versions/lib/enterprise-server-releases.ts b/src/versions/lib/enterprise-server-releases.ts index c1dfd0fdcafe..123b5f19cc0b 100644 --- a/src/versions/lib/enterprise-server-releases.ts +++ b/src/versions/lib/enterprise-server-releases.ts @@ -33,7 +33,7 @@ export const next = '3.21' export const nextNext = '3.22' // Currently supported GHES versions (in descending order, latest first) -export const supported = ['3.20', '3.19', '3.18', '3.17', '3.16', '3.15', '3.14'] +export const supported = ['3.20', '3.19', '3.18', '3.17', '3.16', '3.15'] // Set to version number when in RC phase, null when no RC is active export const releaseCandidate = null @@ -41,6 +41,7 @@ export const releaseCandidate = null // Deprecated versions with functional redirect handling (3.0+) // When archiving a new version, add it here and update the archival process export const deprecatedWithFunctionalRedirects = [ + '3.14', '3.13', '3.12', '3.11', diff --git a/src/webhooks/data/ghes-3.14/branch_protection_configuration.json b/src/webhooks/data/ghes-3.14/branch_protection_configuration.json deleted file mode 100644 index 6f8df3b3ae9b..000000000000 --- a/src/webhooks/data/ghes-3.14/branch_protection_configuration.json +++ /dev/null @@ -1,112 +0,0 @@ -{ - "disabled": { - "descriptionHtml": "

All branch protections were disabled for a repository.

", - "summaryHtml": "

This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"About protected branches.\"\nFor information about using the APIs to manage branch protection rules, see \"Branch protection rule\" in the GraphQL documentation or \"Branch protection\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "disabled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "disabled", - "category": "branch_protection_configuration" - }, - "enabled": { - "descriptionHtml": "

All branch protections were enabled for a repository.

", - "summaryHtml": "

This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"About protected branches.\"\nFor information about using the APIs to manage branch protection rules, see \"Branch protection rule\" in the GraphQL documentation or \"Branch protection\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "enabled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "enabled", - "category": "branch_protection_configuration" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/branch_protection_rule.json b/src/webhooks/data/ghes-3.14/branch_protection_rule.json deleted file mode 100644 index bce448d4494a..000000000000 --- a/src/webhooks/data/ghes-3.14/branch_protection_rule.json +++ /dev/null @@ -1,927 +0,0 @@ -{ - "created": { - "descriptionHtml": "

A branch protection rule was created.

", - "summaryHtml": "

This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "rule", - "description": "

The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin_enforced", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "allow_deletions_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "string", - "name": "allow_force_pushes_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "array of strings", - "name": "authorized_actor_names", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "authorized_actors_only", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "authorized_dismissal_actors_only", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "create_protected", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "dismiss_stale_reviews_on_push", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "ignore_approvals_from_contributors", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "linear_history_requirement_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "string", - "name": "merge_queue_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_reviews_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_code_owner_review", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_last_push_approval", - "description": "

Whether the most recent push must be approved by someone other than the person who pushed it

" - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "required_conversation_resolution_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "string", - "name": "required_deployments_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "array of strings", - "name": "required_status_checks", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "required_status_checks_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "string", - "name": "signature_requirement_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "boolean", - "name": "strict_required_status_checks_policy", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "branch_protection_rule" - }, - "deleted": { - "descriptionHtml": "

A branch protection rule was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "rule", - "description": "

The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin_enforced", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "allow_deletions_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "string", - "name": "allow_force_pushes_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "array of strings", - "name": "authorized_actor_names", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "authorized_actors_only", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "authorized_dismissal_actors_only", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "create_protected", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "dismiss_stale_reviews_on_push", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "ignore_approvals_from_contributors", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "linear_history_requirement_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "string", - "name": "merge_queue_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_reviews_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_code_owner_review", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_last_push_approval", - "description": "

Whether the most recent push must be approved by someone other than the person who pushed it

" - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "required_conversation_resolution_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "string", - "name": "required_deployments_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "array of strings", - "name": "required_status_checks", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "required_status_checks_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "string", - "name": "signature_requirement_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "boolean", - "name": "strict_required_status_checks_policy", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "branch_protection_rule" - }, - "edited": { - "descriptionHtml": "

A branch protection rule was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "

If the action was edited, the changes to the rule.

", - "childParamsGroups": [ - { - "type": "object", - "name": "admin_enforced", - "description": "", - "childParamsGroups": [ - { - "type": "boolean or null", - "name": "from", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "authorized_actor_names", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "from", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "authorized_actors_only", - "description": "", - "childParamsGroups": [ - { - "type": "boolean or null", - "name": "from", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "authorized_dismissal_actors_only", - "description": "", - "childParamsGroups": [ - { - "type": "boolean or null", - "name": "from", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "linear_history_requirement_enforcement_level", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - } - ] - }, - { - "type": "object", - "name": "pull_request_reviews_enforcement_level", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - } - ] - }, - { - "type": "object", - "name": "require_last_push_approval", - "description": "", - "childParamsGroups": [ - { - "type": "boolean or null", - "name": "from", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "required_status_checks", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "from", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "required_status_checks_enforcement_level", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "rule", - "description": "

The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin_enforced", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "allow_deletions_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "string", - "name": "allow_force_pushes_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "array of strings", - "name": "authorized_actor_names", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "authorized_actors_only", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "authorized_dismissal_actors_only", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "create_protected", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "dismiss_stale_reviews_on_push", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "ignore_approvals_from_contributors", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "linear_history_requirement_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "string", - "name": "merge_queue_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_reviews_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_code_owner_review", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_last_push_approval", - "description": "

Whether the most recent push must be approved by someone other than the person who pushed it

" - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "required_conversation_resolution_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "string", - "name": "required_deployments_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "array of strings", - "name": "required_status_checks", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "required_status_checks_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "string", - "name": "signature_requirement_enforcement_level", - "description": "", - "isRequired": true, - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - { - "type": "boolean", - "name": "strict_required_status_checks_policy", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "edited", - "category": "branch_protection_rule" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/bypass_request_secret_scanning.json b/src/webhooks/data/ghes-3.14/bypass_request_secret_scanning.json deleted file mode 100644 index 50955d220459..000000000000 --- a/src/webhooks/data/ghes-3.14/bypass_request_secret_scanning.json +++ /dev/null @@ -1,2118 +0,0 @@ -{ - "cancelled": { - "descriptionHtml": "

A secret scanning push protection bypass request was cancelled.

", - "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in public preview and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "cancelled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "exemption_request", - "description": "

A request from a user to be exempted from a set of rules.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The ID of the exemption request.

" - }, - { - "type": "integer or null", - "name": "number", - "description": "

The number uniquely identifying the exemption request within it's repository.

" - }, - { - "type": "integer", - "name": "repository_id", - "description": "

The ID of the repository the exemption request is for.

" - }, - { - "type": "integer", - "name": "requester_id", - "description": "

The ID of the user who requested the exemption.

" - }, - { - "type": "string", - "name": "requester_login", - "description": "

The login of the user who requested the exemption.

" - }, - { - "type": "string", - "name": "request_type", - "description": "

The type of request.

", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal", - "dependabot_alert_dismissal", - "license_compliance_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "

Push rules that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data pertaining to the push rules that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset for the rules that were violated

" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "

The name of the ruleset for the rules that were violated

" - }, - { - "type": "integer", - "name": "total_violations", - "description": "

The number of violations

" - }, - { - "type": "string", - "name": "rule_type", - "description": "

The type of rule that was violated

" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "

Secret scanning push protections that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data pertaining to the secret scanning push protections that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "

The type of secret that was detected

" - }, - { - "type": "array of objects", - "name": "locations", - "description": "

The location data of the secret that was detected

", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "

The commit SHA where the secret was detected

" - }, - { - "type": "string", - "name": "branch", - "description": "

The branch where the secret was detected

" - }, - { - "type": "string", - "name": "path", - "description": "

The path of the file where the secret was detected

" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "

Secret scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the secret scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "

The reason for the dismissal request

", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "

The type of secret that was detected

" - }, - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert that was detected

" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "

Code scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the code scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert to be dismissed

" - } - ] - } - ] - }, - { - "type": "object", - "name": "Dependabot alert dismissal request data", - "description": "

Dependabot alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "dependabot_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the Dependabot alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert to be dismissed

" - } - ] - } - ] - }, - { - "type": "object", - "name": "License compliance alert closure request data", - "description": "

License compliance alerts that have closure requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "license_compliance_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the License compliance alerts that have closure requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert to be closed

" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "

The unique identifier for the request type of the exemption request. For example, a commit SHA.

" - }, - { - "type": "string", - "name": "status", - "description": "

The status of the exemption request.

", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "

The comment the requester provided when creating the exemption request.

" - }, - { - "type": "object or null", - "name": "metadata", - "description": "

Metadata about the exemption request.

" - }, - { - "type": "string", - "name": "expires_at", - "description": "

The date and time the exemption request will expire.

" - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time the exemption request was created.

" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "

The responses to the exemption request.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The ID of the exemption response.

" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "

The ID of the user who reviewed the exemption request.

" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "

The login of the user who reviewed the exemption request.

" - }, - { - "type": "string", - "name": "status", - "description": "

The status of the exemption response.

", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "

The comment the reviewer provided when responding to the exemption request.

" - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time the exemption request was created.

" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "

The URL to view the exemption request in a browser.

" - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "cancelled", - "category": "bypass_request_secret_scanning" - }, - "completed": { - "descriptionHtml": "

A secret scanning bypass request was completed.

", - "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in public preview and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "completed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "exemption_request", - "description": "

A request from a user to be exempted from a set of rules.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The ID of the exemption request.

" - }, - { - "type": "integer or null", - "name": "number", - "description": "

The number uniquely identifying the exemption request within it's repository.

" - }, - { - "type": "integer", - "name": "repository_id", - "description": "

The ID of the repository the exemption request is for.

" - }, - { - "type": "integer", - "name": "requester_id", - "description": "

The ID of the user who requested the exemption.

" - }, - { - "type": "string", - "name": "requester_login", - "description": "

The login of the user who requested the exemption.

" - }, - { - "type": "string", - "name": "request_type", - "description": "

The type of request.

", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal", - "dependabot_alert_dismissal", - "license_compliance_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "

Push rules that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data pertaining to the push rules that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset for the rules that were violated

" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "

The name of the ruleset for the rules that were violated

" - }, - { - "type": "integer", - "name": "total_violations", - "description": "

The number of violations

" - }, - { - "type": "string", - "name": "rule_type", - "description": "

The type of rule that was violated

" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "

Secret scanning push protections that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data pertaining to the secret scanning push protections that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "

The type of secret that was detected

" - }, - { - "type": "array of objects", - "name": "locations", - "description": "

The location data of the secret that was detected

", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "

The commit SHA where the secret was detected

" - }, - { - "type": "string", - "name": "branch", - "description": "

The branch where the secret was detected

" - }, - { - "type": "string", - "name": "path", - "description": "

The path of the file where the secret was detected

" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "

Secret scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the secret scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "

The reason for the dismissal request

", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "

The type of secret that was detected

" - }, - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert that was detected

" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "

Code scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the code scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert to be dismissed

" - } - ] - } - ] - }, - { - "type": "object", - "name": "Dependabot alert dismissal request data", - "description": "

Dependabot alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "dependabot_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the Dependabot alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert to be dismissed

" - } - ] - } - ] - }, - { - "type": "object", - "name": "License compliance alert closure request data", - "description": "

License compliance alerts that have closure requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "license_compliance_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the License compliance alerts that have closure requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert to be closed

" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "

The unique identifier for the request type of the exemption request. For example, a commit SHA.

" - }, - { - "type": "string", - "name": "status", - "description": "

The status of the exemption request.

", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "

The comment the requester provided when creating the exemption request.

" - }, - { - "type": "object or null", - "name": "metadata", - "description": "

Metadata about the exemption request.

" - }, - { - "type": "string", - "name": "expires_at", - "description": "

The date and time the exemption request will expire.

" - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time the exemption request was created.

" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "

The responses to the exemption request.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The ID of the exemption response.

" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "

The ID of the user who reviewed the exemption request.

" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "

The login of the user who reviewed the exemption request.

" - }, - { - "type": "string", - "name": "status", - "description": "

The status of the exemption response.

", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "

The comment the reviewer provided when responding to the exemption request.

" - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time the exemption request was created.

" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "

The URL to view the exemption request in a browser.

" - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "completed", - "category": "bypass_request_secret_scanning" - }, - "created": { - "descriptionHtml": "

A secret scanning push protection bypass request was created.

", - "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in public preview and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "exemption_request", - "description": "

A request from a user to be exempted from a set of rules.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The ID of the exemption request.

" - }, - { - "type": "integer or null", - "name": "number", - "description": "

The number uniquely identifying the exemption request within it's repository.

" - }, - { - "type": "integer", - "name": "repository_id", - "description": "

The ID of the repository the exemption request is for.

" - }, - { - "type": "integer", - "name": "requester_id", - "description": "

The ID of the user who requested the exemption.

" - }, - { - "type": "string", - "name": "requester_login", - "description": "

The login of the user who requested the exemption.

" - }, - { - "type": "string", - "name": "request_type", - "description": "

The type of request.

", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal", - "dependabot_alert_dismissal", - "license_compliance_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "

Push rules that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data pertaining to the push rules that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset for the rules that were violated

" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "

The name of the ruleset for the rules that were violated

" - }, - { - "type": "integer", - "name": "total_violations", - "description": "

The number of violations

" - }, - { - "type": "string", - "name": "rule_type", - "description": "

The type of rule that was violated

" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "

Secret scanning push protections that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data pertaining to the secret scanning push protections that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "

The type of secret that was detected

" - }, - { - "type": "array of objects", - "name": "locations", - "description": "

The location data of the secret that was detected

", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "

The commit SHA where the secret was detected

" - }, - { - "type": "string", - "name": "branch", - "description": "

The branch where the secret was detected

" - }, - { - "type": "string", - "name": "path", - "description": "

The path of the file where the secret was detected

" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "

Secret scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the secret scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "

The reason for the dismissal request

", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "

The type of secret that was detected

" - }, - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert that was detected

" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "

Code scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the code scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert to be dismissed

" - } - ] - } - ] - }, - { - "type": "object", - "name": "Dependabot alert dismissal request data", - "description": "

Dependabot alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "dependabot_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the Dependabot alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert to be dismissed

" - } - ] - } - ] - }, - { - "type": "object", - "name": "License compliance alert closure request data", - "description": "

License compliance alerts that have closure requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "license_compliance_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the License compliance alerts that have closure requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert to be closed

" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "

The unique identifier for the request type of the exemption request. For example, a commit SHA.

" - }, - { - "type": "string", - "name": "status", - "description": "

The status of the exemption request.

", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "

The comment the requester provided when creating the exemption request.

" - }, - { - "type": "object or null", - "name": "metadata", - "description": "

Metadata about the exemption request.

" - }, - { - "type": "string", - "name": "expires_at", - "description": "

The date and time the exemption request will expire.

" - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time the exemption request was created.

" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "

The responses to the exemption request.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The ID of the exemption response.

" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "

The ID of the user who reviewed the exemption request.

" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "

The login of the user who reviewed the exemption request.

" - }, - { - "type": "string", - "name": "status", - "description": "

The status of the exemption response.

", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "

The comment the reviewer provided when responding to the exemption request.

" - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time the exemption request was created.

" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "

The URL to view the exemption request in a browser.

" - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "bypass_request_secret_scanning" - }, - "response_dismissed": { - "descriptionHtml": "

A secret scanning push protection bypass response was dismissed.

", - "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in public preview and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "response_dismissed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "exemption_request", - "description": "

A request from a user to be exempted from a set of rules.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The ID of the exemption request.

" - }, - { - "type": "integer or null", - "name": "number", - "description": "

The number uniquely identifying the exemption request within it's repository.

" - }, - { - "type": "integer", - "name": "repository_id", - "description": "

The ID of the repository the exemption request is for.

" - }, - { - "type": "integer", - "name": "requester_id", - "description": "

The ID of the user who requested the exemption.

" - }, - { - "type": "string", - "name": "requester_login", - "description": "

The login of the user who requested the exemption.

" - }, - { - "type": "string", - "name": "request_type", - "description": "

The type of request.

", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal", - "dependabot_alert_dismissal", - "license_compliance_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "

Push rules that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data pertaining to the push rules that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset for the rules that were violated

" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "

The name of the ruleset for the rules that were violated

" - }, - { - "type": "integer", - "name": "total_violations", - "description": "

The number of violations

" - }, - { - "type": "string", - "name": "rule_type", - "description": "

The type of rule that was violated

" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "

Secret scanning push protections that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data pertaining to the secret scanning push protections that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "

The type of secret that was detected

" - }, - { - "type": "array of objects", - "name": "locations", - "description": "

The location data of the secret that was detected

", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "

The commit SHA where the secret was detected

" - }, - { - "type": "string", - "name": "branch", - "description": "

The branch where the secret was detected

" - }, - { - "type": "string", - "name": "path", - "description": "

The path of the file where the secret was detected

" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "

Secret scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the secret scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "

The reason for the dismissal request

", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "

The type of secret that was detected

" - }, - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert that was detected

" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "

Code scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the code scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert to be dismissed

" - } - ] - } - ] - }, - { - "type": "object", - "name": "Dependabot alert dismissal request data", - "description": "

Dependabot alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "dependabot_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the Dependabot alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert to be dismissed

" - } - ] - } - ] - }, - { - "type": "object", - "name": "License compliance alert closure request data", - "description": "

License compliance alerts that have closure requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "license_compliance_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the License compliance alerts that have closure requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert to be closed

" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "

The unique identifier for the request type of the exemption request. For example, a commit SHA.

" - }, - { - "type": "string", - "name": "status", - "description": "

The status of the exemption request.

", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "

The comment the requester provided when creating the exemption request.

" - }, - { - "type": "object or null", - "name": "metadata", - "description": "

Metadata about the exemption request.

" - }, - { - "type": "string", - "name": "expires_at", - "description": "

The date and time the exemption request will expire.

" - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time the exemption request was created.

" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "

The responses to the exemption request.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The ID of the exemption response.

" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "

The ID of the user who reviewed the exemption request.

" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "

The login of the user who reviewed the exemption request.

" - }, - { - "type": "string", - "name": "status", - "description": "

The status of the exemption response.

", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "

The comment the reviewer provided when responding to the exemption request.

" - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time the exemption request was created.

" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "

The URL to view the exemption request in a browser.

" - } - ] - }, - { - "type": "object", - "name": "exemption_response", - "description": "

A response to an exemption request by a delegated bypasser.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The ID of the exemption response.

" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "

The ID of the user who reviewed the exemption request.

" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "

The login of the user who reviewed the exemption request.

" - }, - { - "type": "string", - "name": "status", - "description": "

The status of the exemption response.

", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "

The comment the reviewer provided when responding to the exemption request.

" - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time the exemption request was created.

" - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "response_dismissed", - "category": "bypass_request_secret_scanning" - }, - "response_submitted": { - "descriptionHtml": "

A response either approving or rejecting the secret scanning push protection bypass request was submitted.

", - "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in public preview and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "response_submitted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "exemption_request", - "description": "

A request from a user to be exempted from a set of rules.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The ID of the exemption request.

" - }, - { - "type": "integer or null", - "name": "number", - "description": "

The number uniquely identifying the exemption request within it's repository.

" - }, - { - "type": "integer", - "name": "repository_id", - "description": "

The ID of the repository the exemption request is for.

" - }, - { - "type": "integer", - "name": "requester_id", - "description": "

The ID of the user who requested the exemption.

" - }, - { - "type": "string", - "name": "requester_login", - "description": "

The login of the user who requested the exemption.

" - }, - { - "type": "string", - "name": "request_type", - "description": "

The type of request.

", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal", - "dependabot_alert_dismissal", - "license_compliance_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "

Push rules that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data pertaining to the push rules that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "

The ID of the ruleset for the rules that were violated

" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "

The name of the ruleset for the rules that were violated

" - }, - { - "type": "integer", - "name": "total_violations", - "description": "

The number of violations

" - }, - { - "type": "string", - "name": "rule_type", - "description": "

The type of rule that was violated

" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "

Secret scanning push protections that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data pertaining to the secret scanning push protections that are being requested to be bypassed.

", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "

The type of secret that was detected

" - }, - { - "type": "array of objects", - "name": "locations", - "description": "

The location data of the secret that was detected

", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "

The commit SHA where the secret was detected

" - }, - { - "type": "string", - "name": "branch", - "description": "

The branch where the secret was detected

" - }, - { - "type": "string", - "name": "path", - "description": "

The path of the file where the secret was detected

" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "

Secret scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the secret scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "

The reason for the dismissal request

", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "

The type of secret that was detected

" - }, - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert that was detected

" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "

Code scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the code scanning alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert to be dismissed

" - } - ] - } - ] - }, - { - "type": "object", - "name": "Dependabot alert dismissal request data", - "description": "

Dependabot alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "dependabot_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the Dependabot alerts that have dismissal requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert to be dismissed

" - } - ] - } - ] - }, - { - "type": "object", - "name": "License compliance alert closure request data", - "description": "

License compliance alerts that have closure requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of request

", - "enum": [ - "license_compliance_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "

The data related to the License compliance alerts that have closure requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "

The number of the alert to be closed

" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "

The unique identifier for the request type of the exemption request. For example, a commit SHA.

" - }, - { - "type": "string", - "name": "status", - "description": "

The status of the exemption request.

", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "

The comment the requester provided when creating the exemption request.

" - }, - { - "type": "object or null", - "name": "metadata", - "description": "

Metadata about the exemption request.

" - }, - { - "type": "string", - "name": "expires_at", - "description": "

The date and time the exemption request will expire.

" - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time the exemption request was created.

" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "

The responses to the exemption request.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The ID of the exemption response.

" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "

The ID of the user who reviewed the exemption request.

" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "

The login of the user who reviewed the exemption request.

" - }, - { - "type": "string", - "name": "status", - "description": "

The status of the exemption response.

", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "

The comment the reviewer provided when responding to the exemption request.

" - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time the exemption request was created.

" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "

The URL to view the exemption request in a browser.

" - } - ] - }, - { - "type": "object", - "name": "exemption_response", - "description": "

A response to an exemption request by a delegated bypasser.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The ID of the exemption response.

" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "

The ID of the user who reviewed the exemption request.

" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "

The login of the user who reviewed the exemption request.

" - }, - { - "type": "string", - "name": "status", - "description": "

The status of the exemption response.

", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "

The comment the reviewer provided when responding to the exemption request.

" - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time the exemption request was created.

" - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "response_submitted", - "category": "bypass_request_secret_scanning" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/cache_sync.json b/src/webhooks/data/ghes-3.14/cache_sync.json deleted file mode 100644 index 403d21aa0373..000000000000 --- a/src/webhooks/data/ghes-3.14/cache_sync.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"About repository caching.\"

", - "bodyParameters": [ - { - "type": "string", - "name": "after", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "before", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "cache_location", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "cache_sync" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/check_run.json b/src/webhooks/data/ghes-3.14/check_run.json deleted file mode 100644 index 4f21dbe9a234..000000000000 --- a/src/webhooks/data/ghes-3.14/check_run.json +++ /dev/null @@ -1,8039 +0,0 @@ -{ - "completed": { - "descriptionHtml": "

A check run was completed, and a conclusion is available.

", - "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check run was 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
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "enum": [ - "completed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "check_run", - "description": "

A check performed on the code of a given code change

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "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.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "Simple User", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "Enterprise", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

A short description of the enterprise.

" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "website_url", - "description": "

The enterprise's website URL.

" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the enterprise

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the enterprise.

", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "

The slug url identifier for the enterprise.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.

", - "isRequired": true - }, - { - "type": "integer", - "name": "installations_count", - "description": "

The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

" - } - ] - }, - { - "type": "object", - "name": "check_suite", - "description": "

A suite of checks performed on the code of a given code change

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "after", - "description": "" - }, - { - "type": "object or null", - "name": "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.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "Simple User", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "Enterprise", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

A short description of the enterprise.

" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "website_url", - "description": "

The enterprise's website URL.

" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the enterprise

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the enterprise.

", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "

The slug url identifier for the enterprise.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.

", - "isRequired": true - }, - { - "type": "integer", - "name": "installations_count", - "description": "

The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

" - } - ] - }, - { - "type": "string or null", - "name": "before", - "description": "" - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - "stale", - "startup_failure", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "" - }, - { - "type": "string or null", - "name": "head_branch", - "description": "" - }, - { - "type": "string", - "name": "head_sha", - "description": "

The SHA of the head commit that is being checked.

" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

Minimal Repository

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "" - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "" - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "" - }, - { - "type": "string or null", - "name": "homepage", - "description": "" - }, - { - "type": "string or null", - "name": "language", - "description": "" - }, - { - "type": "integer", - "name": "forks_count", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "" - }, - { - "type": "integer", - "name": "watchers_count", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

" - }, - { - "type": "string", - "name": "default_branch", - "description": "" - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "" - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "" - }, - { - "type": "boolean", - "name": "has_projects", - "description": "" - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "" - }, - { - "type": "boolean", - "name": "has_pages", - "description": "" - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "" - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "" - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "" - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "" - }, - { - "type": "boolean", - "name": "disabled", - "description": "" - }, - { - "type": "string", - "name": "visibility", - "description": "" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "" - }, - { - "type": "string or null", - "name": "created_at", - "description": "" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "" - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "" - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "" - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "" - } - ] - }, - { - "type": "string", - "name": "role_name", - "description": "" - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "" - }, - { - "type": "integer", - "name": "subscribers_count", - "description": "" - }, - { - "type": "integer", - "name": "network_count", - "description": "" - }, - { - "type": "object", - "name": "code_of_conduct", - "description": "

Code Of Conduct

", - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "" - }, - { - "type": "string or null", - "name": "html_url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "license", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "spdx_id", - "description": "" - }, - { - "type": "string or null", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "" - }, - { - "type": "integer", - "name": "open_issues", - "description": "" - }, - { - "type": "integer", - "name": "watchers", - "description": "" - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "" - }, - { - "type": "object or null", - "name": "security_and_analysis", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "advanced_security", - "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "enabled", - "disabled" - ] - } - ] - }, - { - "type": "object", - "name": "dependabot_security_updates", - "description": "

Enable or disable Dependabot security updates for the repository.

", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "

The enablement status of Dependabot security updates for the repository.

", - "enum": [ - "enabled", - "disabled" - ] - } - ] - }, - { - "type": "object", - "name": "secret_scanning", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "enabled", - "disabled" - ] - } - ] - }, - { - "type": "object", - "name": "secret_scanning_push_protection", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "enabled", - "disabled" - ] - } - ] - } - ] - } - ] - }, - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "queued", - "in_progress", - "completed", - "pending", - "waiting" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "completed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "waiting", - "pending", - "startup_failure", - "stale", - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null - ] - }, - { - "type": "object", - "name": "deployment", - "description": "

A deployment created as the result of an Actions check run from a workflow that references an environment

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the deployment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "task", - "description": "

Parameter to specify a task to execute

", - "isRequired": true - }, - { - "type": "string", - "name": "original_environment", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "

Name for the target deployment environment.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "transient_environment", - "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" - }, - { - "type": "boolean", - "name": "production_environment", - "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - } - ] - }, - { - "type": "string", - "name": "details_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "head_sha", - "description": "

The SHA of the commit that is being checked.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

The id of the check.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the check.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "output", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "annotations_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "annotations_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "summary", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "text", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "title", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - } - ] - } - ] - }, - { - "type": "string", - "name": "started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "

The phase of the lifecycle that the check is currently in.

", - "isRequired": true, - "enum": [ - "queued", - "in_progress", - "completed", - "pending" - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "completed", - "category": "check_run" - }, - "created": { - "descriptionHtml": "

A new check run was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check run was 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
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "check_run", - "description": "

A check performed on the code of a given code change

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "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.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "Simple User", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "Enterprise", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

A short description of the enterprise.

" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "website_url", - "description": "

The enterprise's website URL.

" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the enterprise

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the enterprise.

", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "

The slug url identifier for the enterprise.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.

", - "isRequired": true - }, - { - "type": "integer", - "name": "installations_count", - "description": "

The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

" - } - ] - }, - { - "type": "object", - "name": "check_suite", - "description": "

A suite of checks performed on the code of a given code change

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "after", - "description": "" - }, - { - "type": "object or null", - "name": "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.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "Simple User", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "Enterprise", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

A short description of the enterprise.

" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "website_url", - "description": "

The enterprise's website URL.

" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the enterprise

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the enterprise.

", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "

The slug url identifier for the enterprise.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.

", - "isRequired": true - }, - { - "type": "integer", - "name": "installations_count", - "description": "

The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

" - } - ] - }, - { - "type": "string or null", - "name": "before", - "description": "" - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - "stale", - "startup_failure", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "" - }, - { - "type": "string or null", - "name": "head_branch", - "description": "" - }, - { - "type": "string", - "name": "head_sha", - "description": "

The SHA of the head commit that is being checked.

" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

Minimal Repository

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "" - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "" - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "" - }, - { - "type": "string or null", - "name": "homepage", - "description": "" - }, - { - "type": "string or null", - "name": "language", - "description": "" - }, - { - "type": "integer", - "name": "forks_count", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "" - }, - { - "type": "integer", - "name": "watchers_count", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

" - }, - { - "type": "string", - "name": "default_branch", - "description": "" - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "" - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "" - }, - { - "type": "boolean", - "name": "has_projects", - "description": "" - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "" - }, - { - "type": "boolean", - "name": "has_pages", - "description": "" - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "" - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "" - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "" - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "" - }, - { - "type": "boolean", - "name": "disabled", - "description": "" - }, - { - "type": "string", - "name": "visibility", - "description": "" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "" - }, - { - "type": "string or null", - "name": "created_at", - "description": "" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "" - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "" - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "" - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "" - } - ] - }, - { - "type": "string", - "name": "role_name", - "description": "" - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "" - }, - { - "type": "integer", - "name": "subscribers_count", - "description": "" - }, - { - "type": "integer", - "name": "network_count", - "description": "" - }, - { - "type": "object", - "name": "code_of_conduct", - "description": "

Code Of Conduct

", - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "" - }, - { - "type": "string or null", - "name": "html_url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "license", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "spdx_id", - "description": "" - }, - { - "type": "string or null", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "" - }, - { - "type": "integer", - "name": "open_issues", - "description": "" - }, - { - "type": "integer", - "name": "watchers", - "description": "" - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "" - }, - { - "type": "object or null", - "name": "security_and_analysis", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "advanced_security", - "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "enabled", - "disabled" - ] - } - ] - }, - { - "type": "object", - "name": "dependabot_security_updates", - "description": "

Enable or disable Dependabot security updates for the repository.

", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "

The enablement status of Dependabot security updates for the repository.

", - "enum": [ - "enabled", - "disabled" - ] - } - ] - }, - { - "type": "object", - "name": "secret_scanning", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "enabled", - "disabled" - ] - } - ] - }, - { - "type": "object", - "name": "secret_scanning_push_protection", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "enabled", - "disabled" - ] - } - ] - } - ] - } - ] - }, - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "queued", - "in_progress", - "completed", - "pending", - "waiting" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "completed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "waiting", - "pending", - "startup_failure", - "stale", - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null - ] - }, - { - "type": "object", - "name": "deployment", - "description": "

A deployment created as the result of an Actions check run from a workflow that references an environment

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the deployment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "task", - "description": "

Parameter to specify a task to execute

", - "isRequired": true - }, - { - "type": "string", - "name": "original_environment", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "

Name for the target deployment environment.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "transient_environment", - "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" - }, - { - "type": "boolean", - "name": "production_environment", - "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - } - ] - }, - { - "type": "string", - "name": "details_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "head_sha", - "description": "

The SHA of the commit that is being checked.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

The id of the check.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the check.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "output", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "annotations_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "annotations_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "summary", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "text", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "title", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - } - ] - } - ] - }, - { - "type": "string", - "name": "started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "

The phase of the lifecycle that the check is currently in.

", - "isRequired": true, - "enum": [ - "queued", - "in_progress", - "completed", - "pending" - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "check_run" - }, - "requested_action": { - "descriptionHtml": "

A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see \"Creating CI tests with the Checks API.\"

", - "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check run was 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
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "requested_action" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "check_run", - "description": "

A check performed on the code of a given code change

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "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.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "Simple User", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "Enterprise", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

A short description of the enterprise.

" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "website_url", - "description": "

The enterprise's website URL.

" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the enterprise

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the enterprise.

", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "

The slug url identifier for the enterprise.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.

", - "isRequired": true - }, - { - "type": "integer", - "name": "installations_count", - "description": "

The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

" - } - ] - }, - { - "type": "object", - "name": "check_suite", - "description": "

A suite of checks performed on the code of a given code change

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "after", - "description": "" - }, - { - "type": "object or null", - "name": "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.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "Simple User", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "Enterprise", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

A short description of the enterprise.

" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "website_url", - "description": "

The enterprise's website URL.

" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the enterprise

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the enterprise.

", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "

The slug url identifier for the enterprise.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.

", - "isRequired": true - }, - { - "type": "integer", - "name": "installations_count", - "description": "

The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

" - } - ] - }, - { - "type": "string or null", - "name": "before", - "description": "" - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - "stale", - "startup_failure", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "" - }, - { - "type": "string or null", - "name": "head_branch", - "description": "" - }, - { - "type": "string", - "name": "head_sha", - "description": "

The SHA of the head commit that is being checked.

" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

Minimal Repository

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "" - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "" - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "" - }, - { - "type": "string or null", - "name": "homepage", - "description": "" - }, - { - "type": "string or null", - "name": "language", - "description": "" - }, - { - "type": "integer", - "name": "forks_count", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "" - }, - { - "type": "integer", - "name": "watchers_count", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

" - }, - { - "type": "string", - "name": "default_branch", - "description": "" - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "" - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "" - }, - { - "type": "boolean", - "name": "has_projects", - "description": "" - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "" - }, - { - "type": "boolean", - "name": "has_pages", - "description": "" - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "" - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "" - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "" - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "" - }, - { - "type": "boolean", - "name": "disabled", - "description": "" - }, - { - "type": "string", - "name": "visibility", - "description": "" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "" - }, - { - "type": "string or null", - "name": "created_at", - "description": "" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "" - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "" - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "" - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "" - } - ] - }, - { - "type": "string", - "name": "role_name", - "description": "" - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "" - }, - { - "type": "integer", - "name": "subscribers_count", - "description": "" - }, - { - "type": "integer", - "name": "network_count", - "description": "" - }, - { - "type": "object", - "name": "code_of_conduct", - "description": "

Code Of Conduct

", - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "" - }, - { - "type": "string or null", - "name": "html_url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "license", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "spdx_id", - "description": "" - }, - { - "type": "string or null", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "" - }, - { - "type": "integer", - "name": "open_issues", - "description": "" - }, - { - "type": "integer", - "name": "watchers", - "description": "" - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "" - }, - { - "type": "object or null", - "name": "security_and_analysis", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "advanced_security", - "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "enabled", - "disabled" - ] - } - ] - }, - { - "type": "object", - "name": "dependabot_security_updates", - "description": "

Enable or disable Dependabot security updates for the repository.

", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "

The enablement status of Dependabot security updates for the repository.

", - "enum": [ - "enabled", - "disabled" - ] - } - ] - }, - { - "type": "object", - "name": "secret_scanning", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "enabled", - "disabled" - ] - } - ] - }, - { - "type": "object", - "name": "secret_scanning_push_protection", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "enabled", - "disabled" - ] - } - ] - } - ] - } - ] - }, - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "queued", - "in_progress", - "completed", - "pending", - "waiting" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "completed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "waiting", - "pending", - "startup_failure", - "stale", - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null - ] - }, - { - "type": "object", - "name": "deployment", - "description": "

A deployment created as the result of an Actions check run from a workflow that references an environment

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the deployment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "task", - "description": "

Parameter to specify a task to execute

", - "isRequired": true - }, - { - "type": "string", - "name": "original_environment", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "

Name for the target deployment environment.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "transient_environment", - "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" - }, - { - "type": "boolean", - "name": "production_environment", - "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - } - ] - }, - { - "type": "string", - "name": "details_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "head_sha", - "description": "

The SHA of the commit that is being checked.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

The id of the check.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the check.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "output", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "annotations_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "annotations_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "summary", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "text", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "title", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - } - ] - } - ] - }, - { - "type": "string", - "name": "started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "

The phase of the lifecycle that the check is currently in.

", - "isRequired": true, - "enum": [ - "queued", - "in_progress", - "completed", - "pending" - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "requested_action", - "description": "

The action requested by the user.

", - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The integrator reference of the action requested by the user.

" - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "requested_action", - "category": "check_run" - }, - "rerequested": { - "descriptionHtml": "

Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the rerequested payload.

", - "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check run was 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
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "enum": [ - "rerequested" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "check_run", - "description": "

A check performed on the code of a given code change

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "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.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "Simple User", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "Enterprise", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

A short description of the enterprise.

" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "website_url", - "description": "

The enterprise's website URL.

" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the enterprise

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the enterprise.

", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "

The slug url identifier for the enterprise.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.

", - "isRequired": true - }, - { - "type": "integer", - "name": "installations_count", - "description": "

The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

" - } - ] - }, - { - "type": "object", - "name": "check_suite", - "description": "

A suite of checks performed on the code of a given code change

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "after", - "description": "" - }, - { - "type": "object or null", - "name": "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.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "Simple User", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "Enterprise", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

A short description of the enterprise.

" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "website_url", - "description": "

The enterprise's website URL.

" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the enterprise

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the enterprise.

", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "

The slug url identifier for the enterprise.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.

", - "isRequired": true - }, - { - "type": "integer", - "name": "installations_count", - "description": "

The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

" - } - ] - }, - { - "type": "string or null", - "name": "before", - "description": "" - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - "stale", - "startup_failure", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "" - }, - { - "type": "string or null", - "name": "head_branch", - "description": "" - }, - { - "type": "string", - "name": "head_sha", - "description": "

The SHA of the head commit that is being checked.

" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

Minimal Repository

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "" - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "" - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "" - }, - { - "type": "string or null", - "name": "homepage", - "description": "" - }, - { - "type": "string or null", - "name": "language", - "description": "" - }, - { - "type": "integer", - "name": "forks_count", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "" - }, - { - "type": "integer", - "name": "watchers_count", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

" - }, - { - "type": "string", - "name": "default_branch", - "description": "" - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "" - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "" - }, - { - "type": "boolean", - "name": "has_projects", - "description": "" - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "" - }, - { - "type": "boolean", - "name": "has_pages", - "description": "" - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "" - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "" - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "" - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "" - }, - { - "type": "boolean", - "name": "disabled", - "description": "" - }, - { - "type": "string", - "name": "visibility", - "description": "" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "" - }, - { - "type": "string or null", - "name": "created_at", - "description": "" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "" - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "" - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "" - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "" - } - ] - }, - { - "type": "string", - "name": "role_name", - "description": "" - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "" - }, - { - "type": "integer", - "name": "subscribers_count", - "description": "" - }, - { - "type": "integer", - "name": "network_count", - "description": "" - }, - { - "type": "object", - "name": "code_of_conduct", - "description": "

Code Of Conduct

", - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "" - }, - { - "type": "string or null", - "name": "html_url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "license", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "spdx_id", - "description": "" - }, - { - "type": "string or null", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "" - }, - { - "type": "integer", - "name": "open_issues", - "description": "" - }, - { - "type": "integer", - "name": "watchers", - "description": "" - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "" - }, - { - "type": "object or null", - "name": "security_and_analysis", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "advanced_security", - "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "enabled", - "disabled" - ] - } - ] - }, - { - "type": "object", - "name": "dependabot_security_updates", - "description": "

Enable or disable Dependabot security updates for the repository.

", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "

The enablement status of Dependabot security updates for the repository.

", - "enum": [ - "enabled", - "disabled" - ] - } - ] - }, - { - "type": "object", - "name": "secret_scanning", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "enabled", - "disabled" - ] - } - ] - }, - { - "type": "object", - "name": "secret_scanning_push_protection", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "enabled", - "disabled" - ] - } - ] - } - ] - } - ] - }, - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "queued", - "in_progress", - "completed", - "pending", - "waiting" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "completed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "waiting", - "pending", - "startup_failure", - "stale", - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null - ] - }, - { - "type": "object", - "name": "deployment", - "description": "

A deployment created as the result of an Actions check run from a workflow that references an environment

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the deployment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "task", - "description": "

Parameter to specify a task to execute

", - "isRequired": true - }, - { - "type": "string", - "name": "original_environment", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "

Name for the target deployment environment.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "transient_environment", - "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" - }, - { - "type": "boolean", - "name": "production_environment", - "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - } - ] - }, - { - "type": "string", - "name": "details_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "head_sha", - "description": "

The SHA of the commit that is being checked.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

The id of the check.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the check.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "output", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "annotations_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "annotations_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "summary", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "text", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "title", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - } - ] - } - ] - }, - { - "type": "string", - "name": "started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "

The phase of the lifecycle that the check is currently in.

", - "isRequired": true, - "enum": [ - "queued", - "in_progress", - "completed", - "pending" - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "rerequested", - "category": "check_run" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/check_suite.json b/src/webhooks/data/ghes-3.14/check_suite.json deleted file mode 100644 index 029290292e92..000000000000 --- a/src/webhooks/data/ghes-3.14/check_suite.json +++ /dev/null @@ -1,2761 +0,0 @@ -{ - "completed": { - "descriptionHtml": "

All check runs in a check suite have completed, and a conclusion is available.

", - "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check suite was 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
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "completed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "check_suite", - "description": "

The check_suite.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "after", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "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.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, merge_group, pull_request_review_thread, workflow_job, merge_queue_entry, security_and_analysis, projects_v2_item, secret_scanning_alert_location

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string or null", - "name": "client_id", - "description": "

The client ID of the GitHub app

" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "before", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_runs_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "

The summary conclusion for all check runs that are part of the check suite. This value will be null until the check run has completed.

", - "isRequired": true, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - null, - "skipped", - "startup_failure" - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "head_branch", - "description": "

The head branch name the changes are on.

", - "isRequired": true - }, - { - "type": "object", - "name": "head_commit", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "author", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "object", - "name": "committer", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "string", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "message", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "timestamp", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tree_id", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "head_sha", - "description": "

The SHA of the head commit that is being checked.

", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "latest_check_runs_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "

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.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "rerequestable", - "description": "" - }, - { - "type": "boolean", - "name": "runs_rerequestable", - "description": "" - }, - { - "type": "string or null", - "name": "status", - "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", - "isRequired": true, - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - null, - "pending" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL that points to the check suite API resource.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "completed", - "category": "check_suite" - }, - "requested": { - "descriptionHtml": "

Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or \"Create a check run\" in the REST API documentation.

", - "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check suite was 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
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "requested" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "check_suite", - "description": "

The check_suite.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "after", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "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.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, pull_request_review_thread, workflow_job, merge_queue_entry, security_and_analysis, secret_scanning_alert_location, projects_v2_item, merge_group, repository_import

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string or null", - "name": "client_id", - "description": "

Client ID of the GitHub app

" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "artifact_metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "attestations", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "copilot_requests", - "description": "", - "enum": [ - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "merge_queues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "models", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "before", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_runs_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "

The summary conclusion for all check runs that are part of the check suite. This value will be null until the check run has completed.

", - "isRequired": true, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - null, - "skipped" - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "head_branch", - "description": "

The head branch name the changes are on.

", - "isRequired": true - }, - { - "type": "object", - "name": "head_commit", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "author", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "object", - "name": "committer", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "string", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "message", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "timestamp", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tree_id", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "head_sha", - "description": "

The SHA of the head commit that is being checked.

", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "latest_check_runs_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "

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.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "rerequestable", - "description": "" - }, - { - "type": "boolean", - "name": "runs_rerequestable", - "description": "" - }, - { - "type": "string or null", - "name": "status", - "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", - "isRequired": true, - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - null - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL that points to the check suite API resource.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "requested", - "category": "check_suite" - }, - "rerequested": { - "descriptionHtml": "

Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or \"Create a check suite\" in the REST API documentation.

", - "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check suite was 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
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "rerequested" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "check_suite", - "description": "

The check_suite.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "after", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "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.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, pull_request_review_thread, merge_queue_entry, workflow_job

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string or null", - "name": "client_id", - "description": "

The Client ID for the GitHub app

" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "artifact_metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "attestations", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "copilot_requests", - "description": "", - "enum": [ - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "merge_queues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "models", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "before", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_runs_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "

The summary conclusion for all check runs that are part of the check suite. This value will be null until the check run has completed.

", - "isRequired": true, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "head_branch", - "description": "

The head branch name the changes are on.

", - "isRequired": true - }, - { - "type": "object", - "name": "head_commit", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "author", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "object", - "name": "committer", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "string", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "message", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "timestamp", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tree_id", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "head_sha", - "description": "

The SHA of the head commit that is being checked.

", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "latest_check_runs_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "

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.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "rerequestable", - "description": "" - }, - { - "type": "boolean", - "name": "runs_rerequestable", - "description": "" - }, - { - "type": "string or null", - "name": "status", - "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", - "isRequired": true, - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - null - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL that points to the check suite API resource.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "rerequested", - "category": "check_suite" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/code_scanning_alert.json b/src/webhooks/data/ghes-3.14/code_scanning_alert.json deleted file mode 100644 index 6ce72f21e233..000000000000 --- a/src/webhooks/data/ghes-3.14/code_scanning_alert.json +++ /dev/null @@ -1,3182 +0,0 @@ -{ - "appeared_in_branch": { - "descriptionHtml": "

A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "appeared_in_branch" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of objects", - "name": "assignees", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

The dismissal comment associated with the dismissal of the alert.

" - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert.

", - "isRequired": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - { - "type": "null", - "name": "fixed_at", - "description": "

The time that the alert was fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", - "isRequired": true - }, - { - "type": "string", - "name": "category", - "description": "

Identifies the configuration under which the analysis was executed.

" - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" - }, - { - "type": "string", - "name": "environment", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "location", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" - }, - { - "type": "string", - "name": "path", - "description": "" - }, - { - "type": "integer", - "name": "start_column", - "description": "" - }, - { - "type": "integer", - "name": "start_line", - "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "text", - "description": "" - } - ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", - "isRequired": true - }, - { - "type": "object", - "name": "rule", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - } - ] - }, - { - "type": "string or null", - "name": "state", - "description": "

State of a code scanning alert. Events for alerts found outside the default branch will return a null value until they are dismissed or fixed.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed", - null - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "commit_oid", - "description": "

The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "description": "

The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "appeared_in_branch", - "category": "code_scanning_alert" - }, - "closed_by_user": { - "descriptionHtml": "

Someone closed a code scanning alert.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "closed_by_user" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of objects", - "name": "assignees", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

The dismissal comment associated with the dismissal of the alert.

" - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert.

", - "isRequired": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - { - "type": "null", - "name": "fixed_at", - "description": "

The time that the alert was fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", - "isRequired": true - }, - { - "type": "string", - "name": "category", - "description": "

Identifies the configuration under which the analysis was executed.

" - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" - }, - { - "type": "string", - "name": "environment", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "location", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" - }, - { - "type": "string", - "name": "path", - "description": "" - }, - { - "type": "integer", - "name": "start_column", - "description": "" - }, - { - "type": "integer", - "name": "start_line", - "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "text", - "description": "" - } - ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", - "isRequired": true - }, - { - "type": "object", - "name": "rule", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" - }, - { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" - }, - { - "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed" - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "guid", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissal_approved_by", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "commit_oid", - "description": "

The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "description": "

The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "closed_by_user", - "category": "code_scanning_alert" - }, - "created": { - "descriptionHtml": "

A code scanning alert was created in a repository.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "null", - "name": "dismissed_by", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

The dismissal comment associated with the dismissal of the alert.

" - }, - { - "type": "null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true - }, - { - "type": "null", - "name": "fixed_at", - "description": "

The time that the alert was fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "instances_url", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", - "isRequired": true - }, - { - "type": "string", - "name": "category", - "description": "

Identifies the configuration under which the analysis was executed.

" - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" - }, - { - "type": "string", - "name": "environment", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "location", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" - }, - { - "type": "string", - "name": "path", - "description": "" - }, - { - "type": "integer", - "name": "start_column", - "description": "" - }, - { - "type": "integer", - "name": "start_line", - "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "text", - "description": "" - } - ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", - "isRequired": true - }, - { - "type": "object", - "name": "rule", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" - }, - { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" - }, - { - "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "state", - "description": "

State of a code scanning alert. Events for alerts found outside the default branch will return a null value until they are dismissed or fixed.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - null - ] - }, - { - "type": "object or null", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "guid", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "updated_at", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "dismissal_approved_by", - "description": "" - }, - { - "type": "array of objects", - "name": "assignees", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "commit_oid", - "description": "

The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "description": "

The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "code_scanning_alert" - }, - "fixed": { - "descriptionHtml": "

A code scanning alert was fixed in a branch by a commit.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "fixed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of objects", - "name": "assignees", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

The dismissal comment associated with the dismissal of the alert.

" - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert.

", - "isRequired": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - { - "type": "null", - "name": "fixed_at", - "description": "

The time that the alert was fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "instances_url", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", - "isRequired": true - }, - { - "type": "string", - "name": "category", - "description": "

Identifies the configuration under which the analysis was executed.

" - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" - }, - { - "type": "string", - "name": "environment", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "location", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" - }, - { - "type": "string", - "name": "path", - "description": "" - }, - { - "type": "integer", - "name": "start_column", - "description": "" - }, - { - "type": "integer", - "name": "start_line", - "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "text", - "description": "" - } - ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", - "isRequired": true - }, - { - "type": "object", - "name": "rule", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" - }, - { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" - }, - { - "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "state", - "description": "

State of a code scanning alert. Events for alerts found outside the default branch will return a null value until they are dismissed or fixed.

", - "isRequired": true, - "enum": [ - "fixed", - null - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "guid", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "commit_oid", - "description": "

The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "description": "

The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "fixed", - "category": "code_scanning_alert" - }, - "reopened": { - "descriptionHtml": "

A previously fixed code scanning alert reappeared in a branch.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "reopened" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of objects", - "name": "assignees", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

The dismissal comment associated with the dismissal of the alert.

" - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true - }, - { - "type": "null", - "name": "fixed_at", - "description": "

The time that the alert was fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "instances_url", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", - "isRequired": true - }, - { - "type": "string", - "name": "category", - "description": "

Identifies the configuration under which the analysis was executed.

" - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" - }, - { - "type": "string", - "name": "environment", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "location", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" - }, - { - "type": "string", - "name": "path", - "description": "" - }, - { - "type": "integer", - "name": "start_column", - "description": "" - }, - { - "type": "integer", - "name": "start_line", - "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "text", - "description": "" - } - ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", - "isRequired": true - }, - { - "type": "object", - "name": "rule", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" - }, - { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" - }, - { - "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "state", - "description": "

State of a code scanning alert. Events for alerts found outside the default branch will return a null value until they are dismissed or fixed.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed", - null - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "guid", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "updated_at", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "dismissal_approved_by", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "commit_oid", - "description": "

The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "string or null", - "name": "ref", - "description": "

The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "reopened", - "category": "code_scanning_alert" - }, - "reopened_by_user": { - "descriptionHtml": "

Someone reopened a code scanning alert.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "reopened_by_user" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of objects", - "name": "assignees", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "null", - "name": "dismissed_by", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

The dismissal comment associated with the dismissal of the alert.

" - }, - { - "type": "null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true - }, - { - "type": "null", - "name": "fixed_at", - "description": "

The time that the alert was fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", - "isRequired": true - }, - { - "type": "string", - "name": "category", - "description": "

Identifies the configuration under which the analysis was executed.

" - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" - }, - { - "type": "string", - "name": "environment", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "location", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" - }, - { - "type": "string", - "name": "path", - "description": "" - }, - { - "type": "integer", - "name": "start_column", - "description": "" - }, - { - "type": "integer", - "name": "start_line", - "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "text", - "description": "" - } - ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", - "isRequired": true - }, - { - "type": "object", - "name": "rule", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - } - ] - }, - { - "type": "string or null", - "name": "state", - "description": "

State of a code scanning alert. Events for alerts found outside the default branch will return a null value until they are dismissed or fixed.

", - "isRequired": true, - "enum": [ - "open", - "fixed", - null - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "commit_oid", - "description": "

The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "description": "

The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "reopened_by_user", - "category": "code_scanning_alert" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/commit_comment.json b/src/webhooks/data/ghes-3.14/commit_comment.json deleted file mode 100644 index 0daa5c4633b6..000000000000 --- a/src/webhooks/data/ghes-3.14/commit_comment.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "created": { - "descriptionHtml": "

Someone commented on a commit.

", - "summaryHtml": "

This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"Commenting on a pull request.\" For information about the APIs to manage commit comments, see the GraphQL API documentation or \"Commit comments\" in the REST API documentation.

\n

For activity relating to comments on pull request reviews, use the pull_request_review_comment event. For activity relating to issue comments, use the issue_comment event. For activity relating to discussion comments, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "

The action performed. Can be created.

", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "comment", - "description": "

The commit comment resource.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "commit_comment" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/create.json b/src/webhooks/data/ghes-3.14/create.json deleted file mode 100644 index 659724c1058f..000000000000 --- a/src/webhooks/data/ghes-3.14/create.json +++ /dev/null @@ -1,81 +0,0 @@ -{ - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when a Git branch or tag is created.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

Notes:

\n
    \n
  • This event will not occur when more than three tags are created at once.
    • \n
  • Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.
    • \n
", - "bodyParameters": [ - { - "type": "string or null", - "name": "description", - "description": "

The repository's current description.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "master_branch", - "description": "

The name of the repository's default branch (usually main).

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "pusher_type", - "description": "

The pusher type for the event. Can be either user or a deploy key.

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The git ref resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "ref_type", - "description": "

The type of Git ref object created in the repository.

", - "isRequired": true, - "enum": [ - "tag", - "branch" - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "create" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/custom_property.json b/src/webhooks/data/ghes-3.14/custom_property.json deleted file mode 100644 index d6387d75bdfc..000000000000 --- a/src/webhooks/data/ghes-3.14/custom_property.json +++ /dev/null @@ -1,297 +0,0 @@ -{ - "created": { - "descriptionHtml": "

A new custom property was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a custom property.

\n

For more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "definition", - "description": "

Custom property defined on an organization

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "property_name", - "description": "

The name of the property

", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

The URL that can be used to fetch, update, or delete info about this property via the API.

" - }, - { - "type": "string", - "name": "source_type", - "description": "

The source type of the property

", - "enum": [ - "organization", - "enterprise" - ] - }, - { - "type": "string", - "name": "value_type", - "description": "

The type of the value for the property

", - "isRequired": true, - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ] - }, - { - "type": "boolean", - "name": "required", - "description": "

Whether the property is required.

" - }, - { - "type": "null or string or array", - "name": "default_value", - "description": "

Default value of the property

" - }, - { - "type": "string or null", - "name": "description", - "description": "

Short description of the property

" - }, - { - "type": "array of strings or null", - "name": "allowed_values", - "description": "

An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.

" - }, - { - "type": "string or null", - "name": "values_editable_by", - "description": "

Who can edit the values of the property

", - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "organization", - "app" - ], - "action": "created", - "category": "custom_property" - }, - "deleted": { - "descriptionHtml": "

A custom property was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a custom property.

\n

For more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "definition", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "property_name", - "description": "

The name of the property that was deleted.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "organization", - "app" - ], - "action": "deleted", - "category": "custom_property" - }, - "updated": { - "descriptionHtml": "

A custom property was updated.

", - "summaryHtml": "

This event occurs when there is activity relating to a custom property.

\n

For more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "updated" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "definition", - "description": "

Custom property defined on an organization

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "property_name", - "description": "

The name of the property

", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

The URL that can be used to fetch, update, or delete info about this property via the API.

" - }, - { - "type": "string", - "name": "source_type", - "description": "

The source type of the property

", - "enum": [ - "organization", - "enterprise" - ] - }, - { - "type": "string", - "name": "value_type", - "description": "

The type of the value for the property

", - "isRequired": true, - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ] - }, - { - "type": "boolean", - "name": "required", - "description": "

Whether the property is required.

" - }, - { - "type": "null or string or array", - "name": "default_value", - "description": "

Default value of the property

" - }, - { - "type": "string or null", - "name": "description", - "description": "

Short description of the property

" - }, - { - "type": "array of strings or null", - "name": "allowed_values", - "description": "

An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.

" - }, - { - "type": "string or null", - "name": "values_editable_by", - "description": "

Who can edit the values of the property

", - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "organization", - "app" - ], - "action": "updated", - "category": "custom_property" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/custom_property_values.json b/src/webhooks/data/ghes-3.14/custom_property_values.json deleted file mode 100644 index 49b828fb7d80..000000000000 --- a/src/webhooks/data/ghes-3.14/custom_property_values.json +++ /dev/null @@ -1,97 +0,0 @@ -{ - "updated": { - "descriptionHtml": "

The custom property values of a repository were updated.

", - "summaryHtml": "

This event occurs when there is activity relating to custom property values for a repository.

\n

For more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties for a repository, see \"Custom properties\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "updated" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "new_property_values", - "description": "

The new custom property values for the repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "property_name", - "description": "

The name of the property

", - "isRequired": true - }, - { - "type": "null or string or array", - "name": "value", - "description": "

The value assigned to the property

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "old_property_values", - "description": "

The old custom property values for the repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "property_name", - "description": "

The name of the property

", - "isRequired": true - }, - { - "type": "null or string or array", - "name": "value", - "description": "

The value assigned to the property

", - "isRequired": true - } - ] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "updated", - "category": "custom_property_values" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/delete.json b/src/webhooks/data/ghes-3.14/delete.json deleted file mode 100644 index ed154a8a8a29..000000000000 --- a/src/webhooks/data/ghes-3.14/delete.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the push webhook event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

\n

\nThis event will not occur when more than three tags are deleted at once.

\n
", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "pusher_type", - "description": "

The pusher type for the event. Can be either user or a deploy key.

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The git ref resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "ref_type", - "description": "

The type of Git ref object deleted in the repository.

", - "isRequired": true, - "enum": [ - "tag", - "branch" - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "delete" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/dependabot_alert.json b/src/webhooks/data/ghes-3.14/dependabot_alert.json deleted file mode 100644 index 929175ad5e24..000000000000 --- a/src/webhooks/data/ghes-3.14/dependabot_alert.json +++ /dev/null @@ -1,4727 +0,0 @@ -{ - "auto_dismissed": { - "descriptionHtml": "

A Dependabot alert was automatically closed by a Dependabot auto-triage rule.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "auto_dismissed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "

A Dependabot alert.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" - ] - }, - { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" - }, - { - "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", - "enum": [ - "development", - "runtime", - null - ] - } - ] - }, - { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_severities", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "cvss_v3", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 3 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 3 score.

", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_v4", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 4 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 4 score.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", - "isRequired": true, - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "auto_dismissed_at", - "description": "

The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "object or null", - "name": "dismissal_request", - "description": "

Information about an active dismissal request for this Dependabot alert.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the dismissal request.

" - }, - { - "type": "string", - "name": "status", - "description": "

The current status of the dismissal request.

", - "enum": [ - "pending", - "approved", - "rejected", - "cancelled" - ] - }, - { - "type": "object", - "name": "requester", - "description": "

The user who requested the dismissal.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the user.

" - }, - { - "type": "string", - "name": "login", - "description": "

The login name of the user.

" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time when the dismissal request was created.

" - }, - { - "type": "string", - "name": "url", - "description": "

The API URL to get more information about this dismissal request.

" - } - ] - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "auto_dismissed", - "category": "dependabot_alert" - }, - "auto_reopened": { - "descriptionHtml": "

A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "auto_reopened" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "

A Dependabot alert.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" - ] - }, - { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" - }, - { - "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", - "enum": [ - "development", - "runtime", - null - ] - } - ] - }, - { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_severities", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "cvss_v3", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 3 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 3 score.

", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_v4", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 4 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 4 score.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", - "isRequired": true, - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "auto_dismissed_at", - "description": "

The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "object or null", - "name": "dismissal_request", - "description": "

Information about an active dismissal request for this Dependabot alert.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the dismissal request.

" - }, - { - "type": "string", - "name": "status", - "description": "

The current status of the dismissal request.

", - "enum": [ - "pending", - "approved", - "rejected", - "cancelled" - ] - }, - { - "type": "object", - "name": "requester", - "description": "

The user who requested the dismissal.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the user.

" - }, - { - "type": "string", - "name": "login", - "description": "

The login name of the user.

" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time when the dismissal request was created.

" - }, - { - "type": "string", - "name": "url", - "description": "

The API URL to get more information about this dismissal request.

" - } - ] - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "auto_reopened", - "category": "dependabot_alert" - }, - "created": { - "descriptionHtml": "

A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "

A Dependabot alert.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" - ] - }, - { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" - }, - { - "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", - "enum": [ - "development", - "runtime", - null - ] - } - ] - }, - { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_severities", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "cvss_v3", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 3 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 3 score.

", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_v4", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 4 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 4 score.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", - "isRequired": true, - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "auto_dismissed_at", - "description": "

The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "object or null", - "name": "dismissal_request", - "description": "

Information about an active dismissal request for this Dependabot alert.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the dismissal request.

" - }, - { - "type": "string", - "name": "status", - "description": "

The current status of the dismissal request.

", - "enum": [ - "pending", - "approved", - "rejected", - "cancelled" - ] - }, - { - "type": "object", - "name": "requester", - "description": "

The user who requested the dismissal.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the user.

" - }, - { - "type": "string", - "name": "login", - "description": "

The login name of the user.

" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time when the dismissal request was created.

" - }, - { - "type": "string", - "name": "url", - "description": "

The API URL to get more information about this dismissal request.

" - } - ] - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "dependabot_alert" - }, - "dismissed": { - "descriptionHtml": "

A Dependabot alert was manually closed.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "dismissed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "

A Dependabot alert.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" - ] - }, - { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" - }, - { - "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", - "enum": [ - "development", - "runtime", - null - ] - } - ] - }, - { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_severities", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "cvss_v3", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 3 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 3 score.

", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_v4", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 4 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 4 score.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", - "isRequired": true, - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "auto_dismissed_at", - "description": "

The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "object or null", - "name": "dismissal_request", - "description": "

Information about an active dismissal request for this Dependabot alert.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the dismissal request.

" - }, - { - "type": "string", - "name": "status", - "description": "

The current status of the dismissal request.

", - "enum": [ - "pending", - "approved", - "rejected", - "cancelled" - ] - }, - { - "type": "object", - "name": "requester", - "description": "

The user who requested the dismissal.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the user.

" - }, - { - "type": "string", - "name": "login", - "description": "

The login name of the user.

" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time when the dismissal request was created.

" - }, - { - "type": "string", - "name": "url", - "description": "

The API URL to get more information about this dismissal request.

" - } - ] - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "dismissed", - "category": "dependabot_alert" - }, - "fixed": { - "descriptionHtml": "

A manifest file change removed a vulnerability.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "fixed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "

A Dependabot alert.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" - ] - }, - { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" - }, - { - "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", - "enum": [ - "development", - "runtime", - null - ] - } - ] - }, - { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_severities", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "cvss_v3", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 3 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 3 score.

", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_v4", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 4 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 4 score.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", - "isRequired": true, - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "auto_dismissed_at", - "description": "

The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "object or null", - "name": "dismissal_request", - "description": "

Information about an active dismissal request for this Dependabot alert.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the dismissal request.

" - }, - { - "type": "string", - "name": "status", - "description": "

The current status of the dismissal request.

", - "enum": [ - "pending", - "approved", - "rejected", - "cancelled" - ] - }, - { - "type": "object", - "name": "requester", - "description": "

The user who requested the dismissal.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the user.

" - }, - { - "type": "string", - "name": "login", - "description": "

The login name of the user.

" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time when the dismissal request was created.

" - }, - { - "type": "string", - "name": "url", - "description": "

The API URL to get more information about this dismissal request.

" - } - ] - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "fixed", - "category": "dependabot_alert" - }, - "reintroduced": { - "descriptionHtml": "

A manifest file change introduced a vulnerable dependency that had previously been fixed.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "reintroduced" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "

A Dependabot alert.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" - ] - }, - { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" - }, - { - "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", - "enum": [ - "development", - "runtime", - null - ] - } - ] - }, - { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_severities", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "cvss_v3", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 3 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 3 score.

", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_v4", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 4 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 4 score.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", - "isRequired": true, - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "auto_dismissed_at", - "description": "

The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "object or null", - "name": "dismissal_request", - "description": "

Information about an active dismissal request for this Dependabot alert.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the dismissal request.

" - }, - { - "type": "string", - "name": "status", - "description": "

The current status of the dismissal request.

", - "enum": [ - "pending", - "approved", - "rejected", - "cancelled" - ] - }, - { - "type": "object", - "name": "requester", - "description": "

The user who requested the dismissal.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the user.

" - }, - { - "type": "string", - "name": "login", - "description": "

The login name of the user.

" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time when the dismissal request was created.

" - }, - { - "type": "string", - "name": "url", - "description": "

The API URL to get more information about this dismissal request.

" - } - ] - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "reintroduced", - "category": "dependabot_alert" - }, - "reopened": { - "descriptionHtml": "

A Dependabot alert was manually reopened.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "reopened" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "

A Dependabot alert.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" - ] - }, - { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" - }, - { - "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", - "enum": [ - "development", - "runtime", - null - ] - } - ] - }, - { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_severities", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "cvss_v3", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 3 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 3 score.

", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_v4", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 4 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 4 score.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", - "isRequired": true, - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "auto_dismissed_at", - "description": "

The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "object or null", - "name": "dismissal_request", - "description": "

Information about an active dismissal request for this Dependabot alert.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the dismissal request.

" - }, - { - "type": "string", - "name": "status", - "description": "

The current status of the dismissal request.

", - "enum": [ - "pending", - "approved", - "rejected", - "cancelled" - ] - }, - { - "type": "object", - "name": "requester", - "description": "

The user who requested the dismissal.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the user.

" - }, - { - "type": "string", - "name": "login", - "description": "

The login name of the user.

" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The date and time when the dismissal request was created.

" - }, - { - "type": "string", - "name": "url", - "description": "

The API URL to get more information about this dismissal request.

" - } - ] - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "reopened", - "category": "dependabot_alert" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/deploy_key.json b/src/webhooks/data/ghes-3.14/deploy_key.json deleted file mode 100644 index 0c0604acd5e4..000000000000 --- a/src/webhooks/data/ghes-3.14/deploy_key.json +++ /dev/null @@ -1,232 +0,0 @@ -{ - "created": { - "descriptionHtml": "

A deploy key was created.

", - "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "key", - "description": "

The deploy key resource.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "added_by", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "last_used", - "description": "" - }, - { - "type": "boolean", - "name": "read_only", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "verified", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "deploy_key" - }, - "deleted": { - "descriptionHtml": "

A deploy key was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "key", - "description": "

The deploy key resource.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "added_by", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "last_used", - "description": "" - }, - { - "type": "boolean", - "name": "read_only", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "verified", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "deploy_key" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/deployment.json b/src/webhooks/data/ghes-3.14/deployment.json deleted file mode 100644 index a6215a8109c7..000000000000 --- a/src/webhooks/data/ghes-3.14/deployment.json +++ /dev/null @@ -1,2095 +0,0 @@ -{ - "created": { - "descriptionHtml": "

A deployment was created.

", - "summaryHtml": "

This event occurs when there is activity relating to deployments. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment status, use the deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "deployment", - "description": "

The deployment.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "environment", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "original_environment", - "description": "", - "isRequired": true - }, - { - "type": "object or string", - "name": "payload", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, workflow_job, pull_request_review_thread, merge_queue_entry, secret_scanning_alert_location, merge_group

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "production_environment", - "description": "" - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "task", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "transient_environment", - "description": "" - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "workflow", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "badge_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "workflow_run", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "actor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "artifacts_url", - "description": "" - }, - { - "type": "string", - "name": "cancel_url", - "description": "" - }, - { - "type": "integer", - "name": "check_suite_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_suite_node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_suite_url", - "description": "" - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "display_title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "event", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "head_branch", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "head_commit", - "description": "" - }, - { - "type": "object", - "name": "head_repository", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "" - }, - { - "type": "string", - "name": "assignees_url", - "description": "" - }, - { - "type": "string", - "name": "blobs_url", - "description": "" - }, - { - "type": "string", - "name": "branches_url", - "description": "" - }, - { - "type": "string", - "name": "collaborators_url", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "" - }, - { - "type": "string", - "name": "compare_url", - "description": "" - }, - { - "type": "string", - "name": "contents_url", - "description": "" - }, - { - "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" - }, - { - "type": "string", - "name": "forks_url", - "description": "" - }, - { - "type": "string", - "name": "full_name", - "description": "" - }, - { - "type": "string", - "name": "git_commits_url", - "description": "" - }, - { - "type": "string", - "name": "git_refs_url", - "description": "" - }, - { - "type": "string", - "name": "git_tags_url", - "description": "" - }, - { - "type": "string", - "name": "hooks_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "" - }, - { - "type": "string", - "name": "issue_events_url", - "description": "" - }, - { - "type": "string", - "name": "issues_url", - "description": "" - }, - { - "type": "string", - "name": "keys_url", - "description": "" - }, - { - "type": "string", - "name": "labels_url", - "description": "" - }, - { - "type": "string", - "name": "languages_url", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "" - }, - { - "type": "string", - "name": "milestones_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "notifications_url", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" - }, - { - "type": "string", - "name": "statuses_url", - "description": "" - }, - { - "type": "string", - "name": "subscribers_url", - "description": "" - }, - { - "type": "string", - "name": "subscription_url", - "description": "" - }, - { - "type": "string", - "name": "tags_url", - "description": "" - }, - { - "type": "string", - "name": "teams_url", - "description": "" - }, - { - "type": "string", - "name": "trees_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "head_sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "jobs_url", - "description": "" - }, - { - "type": "string", - "name": "logs_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "previous_attempt_url", - "description": "" - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects or null", - "name": "referenced_workflows", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "" - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "" - }, - { - "type": "string", - "name": "assignees_url", - "description": "" - }, - { - "type": "string", - "name": "blobs_url", - "description": "" - }, - { - "type": "string", - "name": "branches_url", - "description": "" - }, - { - "type": "string", - "name": "collaborators_url", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "" - }, - { - "type": "string", - "name": "compare_url", - "description": "" - }, - { - "type": "string", - "name": "contents_url", - "description": "" - }, - { - "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" - }, - { - "type": "string", - "name": "forks_url", - "description": "" - }, - { - "type": "string", - "name": "full_name", - "description": "" - }, - { - "type": "string", - "name": "git_commits_url", - "description": "" - }, - { - "type": "string", - "name": "git_refs_url", - "description": "" - }, - { - "type": "string", - "name": "git_tags_url", - "description": "" - }, - { - "type": "string", - "name": "hooks_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "" - }, - { - "type": "string", - "name": "issue_events_url", - "description": "" - }, - { - "type": "string", - "name": "issues_url", - "description": "" - }, - { - "type": "string", - "name": "keys_url", - "description": "" - }, - { - "type": "string", - "name": "labels_url", - "description": "" - }, - { - "type": "string", - "name": "languages_url", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "" - }, - { - "type": "string", - "name": "milestones_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "notifications_url", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" - }, - { - "type": "string", - "name": "statuses_url", - "description": "" - }, - { - "type": "string", - "name": "subscribers_url", - "description": "" - }, - { - "type": "string", - "name": "subscription_url", - "description": "" - }, - { - "type": "string", - "name": "tags_url", - "description": "" - }, - { - "type": "string", - "name": "teams_url", - "description": "" - }, - { - "type": "string", - "name": "trees_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "rerun_url", - "description": "" - }, - { - "type": "integer", - "name": "run_attempt", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "run_number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "run_started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - "waiting", - "pending" - ] - }, - { - "type": "object or null", - "name": "triggering_actor", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "workflow_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "workflow_url", - "description": "" - } - ] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "deployment" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/deployment_protection_rule.json b/src/webhooks/data/ghes-3.14/deployment_protection_rule.json deleted file mode 100644 index 718380747b81..000000000000 --- a/src/webhooks/data/ghes-3.14/deployment_protection_rule.json +++ /dev/null @@ -1,3866 +0,0 @@ -{ - "requested": { - "descriptionHtml": "

A deployment protection rule was requested for an environment.

", - "summaryHtml": "

This event occurs when there is activity relating to deployment protection rules. For more information, see \"Using environments for deployment.\" For information about the API to manage deployment protection rules, see the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "enum": [ - "requested" - ], - "childParamsGroups": [] - }, - { - "type": "string", - "name": "environment", - "description": "

The name of the environment that has the deployment protection rule.

" - }, - { - "type": "string", - "name": "event", - "description": "

The event that triggered the deployment protection rule.

" - }, - { - "type": "string", - "name": "sha", - "description": "

The commit SHA that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created.

" - }, - { - "type": "string", - "name": "ref", - "description": "

The ref (branch or tag) that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created.

" - }, - { - "type": "string", - "name": "deployment_callback_url", - "description": "

The URL to review the deployment protection rule.

" - }, - { - "type": "object or null", - "name": "deployment", - "description": "

A request for a specific ref(branch,sha,tag) to be deployed

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the deployment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The ref to deploy. This can be a branch, tag, or sha.

", - "isRequired": true - }, - { - "type": "string", - "name": "task", - "description": "

Parameter to specify a task to execute

", - "isRequired": true - }, - { - "type": "object or string", - "name": "payload", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "original_environment", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "

Name for the target deployment environment.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "transient_environment", - "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" - }, - { - "type": "boolean", - "name": "production_environment", - "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "assignee", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "assignees", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "requested_reviewers", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "

The level of privacy this team should have

" - }, - { - "type": "string", - "name": "notification_setting", - "description": "

The notification setting the team has set

" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ldap_dn", - "description": "

Distinguished Name (DN) that team maps to within LDAP environment

" - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "isRequired": true, - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "

License Simple

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - } - ] - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", - "default": false - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository disabled.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

The repository visibility: public, private, or internal.

", - "default": "public" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow Auto-merge to be used on pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

", - "default": false - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow forking this repo

" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

", - "default": false - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "boolean", - "name": "anonymous_access_enabled", - "description": "

Whether anonymous git access is enabled for this repository

" - }, - { - "type": "object", - "name": "code_search_index_status", - "description": "

The status of the code search index for this repository

", - "childParamsGroups": [ - { - "type": "boolean", - "name": "lexical_search_ok", - "description": "" - }, - { - "type": "string", - "name": "lexical_commit_sha", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "

License Simple

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - } - ] - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", - "default": false - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository disabled.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

The repository visibility: public, private, or internal.

", - "default": "public" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow Auto-merge to be used on pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

", - "default": false - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow forking this repo

" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

", - "default": false - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "boolean", - "name": "anonymous_access_enabled", - "description": "

Whether anonymous git access is enabled for this repository

" - }, - { - "type": "object", - "name": "code_search_index_status", - "description": "

The status of the code search index for this repository

", - "childParamsGroups": [ - { - "type": "boolean", - "name": "lexical_search_ok", - "description": "" - }, - { - "type": "string", - "name": "lexical_commit_sha", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "enabled_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - { - "type": "string", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

" - }, - { - "type": "boolean", - "name": "merged", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "additions", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "requested", - "category": "deployment_protection_rule" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/deployment_review.json b/src/webhooks/data/ghes-3.14/deployment_review.json deleted file mode 100644 index e56033fcd13d..000000000000 --- a/src/webhooks/data/ghes-3.14/deployment_review.json +++ /dev/null @@ -1,4949 +0,0 @@ -{ - "approved": { - "descriptionHtml": "

A deployment review was approved.

", - "summaryHtml": "

This event occurs when there is activity relating to deployment reviews. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation or deployment status, use the deployment or deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "approved" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "approver", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "comment", - "description": "", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "reviewers", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "reviewer", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "User" - ] - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "string", - "name": "since", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "workflow_job_run", - "description": "", - "childParamsGroups": [ - { - "type": "null", - "name": "conclusion", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "environment", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "workflow_job_runs", - "description": "", - "childParamsGroups": [ - { - "type": "null", - "name": "conclusion", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "status", - "description": "" - }, - { - "type": "string", - "name": "updated_at", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "workflow_run", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "actor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "artifacts_url", - "description": "" - }, - { - "type": "string", - "name": "cancel_url", - "description": "" - }, - { - "type": "integer", - "name": "check_suite_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_suite_node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_suite_url", - "description": "" - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "display_title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "event", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "head_branch", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "head_commit", - "description": "" - }, - { - "type": "object", - "name": "head_repository", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "" - }, - { - "type": "string", - "name": "assignees_url", - "description": "" - }, - { - "type": "string", - "name": "blobs_url", - "description": "" - }, - { - "type": "string", - "name": "branches_url", - "description": "" - }, - { - "type": "string", - "name": "collaborators_url", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "" - }, - { - "type": "string", - "name": "compare_url", - "description": "" - }, - { - "type": "string", - "name": "contents_url", - "description": "" - }, - { - "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" - }, - { - "type": "string", - "name": "forks_url", - "description": "" - }, - { - "type": "string", - "name": "full_name", - "description": "" - }, - { - "type": "string", - "name": "git_commits_url", - "description": "" - }, - { - "type": "string", - "name": "git_refs_url", - "description": "" - }, - { - "type": "string", - "name": "git_tags_url", - "description": "" - }, - { - "type": "string", - "name": "hooks_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "" - }, - { - "type": "string", - "name": "issue_events_url", - "description": "" - }, - { - "type": "string", - "name": "issues_url", - "description": "" - }, - { - "type": "string", - "name": "keys_url", - "description": "" - }, - { - "type": "string", - "name": "labels_url", - "description": "" - }, - { - "type": "string", - "name": "languages_url", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "" - }, - { - "type": "string", - "name": "milestones_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "notifications_url", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" - }, - { - "type": "string", - "name": "statuses_url", - "description": "" - }, - { - "type": "string", - "name": "subscribers_url", - "description": "" - }, - { - "type": "string", - "name": "subscription_url", - "description": "" - }, - { - "type": "string", - "name": "tags_url", - "description": "" - }, - { - "type": "string", - "name": "teams_url", - "description": "" - }, - { - "type": "string", - "name": "trees_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "head_sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "jobs_url", - "description": "" - }, - { - "type": "string", - "name": "logs_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "previous_attempt_url", - "description": "" - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects or null", - "name": "referenced_workflows", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "" - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "" - }, - { - "type": "string", - "name": "assignees_url", - "description": "" - }, - { - "type": "string", - "name": "blobs_url", - "description": "" - }, - { - "type": "string", - "name": "branches_url", - "description": "" - }, - { - "type": "string", - "name": "collaborators_url", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "" - }, - { - "type": "string", - "name": "compare_url", - "description": "" - }, - { - "type": "string", - "name": "contents_url", - "description": "" - }, - { - "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" - }, - { - "type": "string", - "name": "forks_url", - "description": "" - }, - { - "type": "string", - "name": "full_name", - "description": "" - }, - { - "type": "string", - "name": "git_commits_url", - "description": "" - }, - { - "type": "string", - "name": "git_refs_url", - "description": "" - }, - { - "type": "string", - "name": "git_tags_url", - "description": "" - }, - { - "type": "string", - "name": "hooks_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "" - }, - { - "type": "string", - "name": "issue_events_url", - "description": "" - }, - { - "type": "string", - "name": "issues_url", - "description": "" - }, - { - "type": "string", - "name": "keys_url", - "description": "" - }, - { - "type": "string", - "name": "labels_url", - "description": "" - }, - { - "type": "string", - "name": "languages_url", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "" - }, - { - "type": "string", - "name": "milestones_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "notifications_url", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" - }, - { - "type": "string", - "name": "statuses_url", - "description": "" - }, - { - "type": "string", - "name": "subscribers_url", - "description": "" - }, - { - "type": "string", - "name": "subscription_url", - "description": "" - }, - { - "type": "string", - "name": "tags_url", - "description": "" - }, - { - "type": "string", - "name": "teams_url", - "description": "" - }, - { - "type": "string", - "name": "trees_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "rerun_url", - "description": "" - }, - { - "type": "integer", - "name": "run_attempt", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "run_number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "run_started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - "waiting", - "pending" - ] - }, - { - "type": "object or null", - "name": "triggering_actor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "workflow_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "workflow_url", - "description": "" - } - ] - } - ], - "availability": [ - "app" - ], - "action": "approved", - "category": "deployment_review" - }, - "rejected": { - "descriptionHtml": "

A deployment review was rejected.

", - "summaryHtml": "

This event occurs when there is activity relating to deployment reviews. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation or deployment status, use the deployment or deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "rejected" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "approver", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "comment", - "description": "", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "reviewers", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "reviewer", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "User" - ] - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "string", - "name": "since", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "workflow_job_run", - "description": "", - "childParamsGroups": [ - { - "type": "null", - "name": "conclusion", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "environment", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "workflow_job_runs", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "conclusion", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "status", - "description": "" - }, - { - "type": "string", - "name": "updated_at", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "workflow_run", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "actor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "artifacts_url", - "description": "" - }, - { - "type": "string", - "name": "cancel_url", - "description": "" - }, - { - "type": "integer", - "name": "check_suite_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_suite_node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_suite_url", - "description": "" - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "event", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "head_branch", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "head_commit", - "description": "" - }, - { - "type": "object", - "name": "head_repository", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "" - }, - { - "type": "string", - "name": "assignees_url", - "description": "" - }, - { - "type": "string", - "name": "blobs_url", - "description": "" - }, - { - "type": "string", - "name": "branches_url", - "description": "" - }, - { - "type": "string", - "name": "collaborators_url", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "" - }, - { - "type": "string", - "name": "compare_url", - "description": "" - }, - { - "type": "string", - "name": "contents_url", - "description": "" - }, - { - "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" - }, - { - "type": "string", - "name": "forks_url", - "description": "" - }, - { - "type": "string", - "name": "full_name", - "description": "" - }, - { - "type": "string", - "name": "git_commits_url", - "description": "" - }, - { - "type": "string", - "name": "git_refs_url", - "description": "" - }, - { - "type": "string", - "name": "git_tags_url", - "description": "" - }, - { - "type": "string", - "name": "hooks_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "" - }, - { - "type": "string", - "name": "issue_events_url", - "description": "" - }, - { - "type": "string", - "name": "issues_url", - "description": "" - }, - { - "type": "string", - "name": "keys_url", - "description": "" - }, - { - "type": "string", - "name": "labels_url", - "description": "" - }, - { - "type": "string", - "name": "languages_url", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "" - }, - { - "type": "string", - "name": "milestones_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "notifications_url", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" - }, - { - "type": "string", - "name": "statuses_url", - "description": "" - }, - { - "type": "string", - "name": "subscribers_url", - "description": "" - }, - { - "type": "string", - "name": "subscription_url", - "description": "" - }, - { - "type": "string", - "name": "tags_url", - "description": "" - }, - { - "type": "string", - "name": "teams_url", - "description": "" - }, - { - "type": "string", - "name": "trees_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "head_sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "jobs_url", - "description": "" - }, - { - "type": "string", - "name": "logs_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "previous_attempt_url", - "description": "" - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects or null", - "name": "referenced_workflows", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "" - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "" - }, - { - "type": "string", - "name": "assignees_url", - "description": "" - }, - { - "type": "string", - "name": "blobs_url", - "description": "" - }, - { - "type": "string", - "name": "branches_url", - "description": "" - }, - { - "type": "string", - "name": "collaborators_url", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "" - }, - { - "type": "string", - "name": "compare_url", - "description": "" - }, - { - "type": "string", - "name": "contents_url", - "description": "" - }, - { - "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" - }, - { - "type": "string", - "name": "forks_url", - "description": "" - }, - { - "type": "string", - "name": "full_name", - "description": "" - }, - { - "type": "string", - "name": "git_commits_url", - "description": "" - }, - { - "type": "string", - "name": "git_refs_url", - "description": "" - }, - { - "type": "string", - "name": "git_tags_url", - "description": "" - }, - { - "type": "string", - "name": "hooks_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "" - }, - { - "type": "string", - "name": "issue_events_url", - "description": "" - }, - { - "type": "string", - "name": "issues_url", - "description": "" - }, - { - "type": "string", - "name": "keys_url", - "description": "" - }, - { - "type": "string", - "name": "labels_url", - "description": "" - }, - { - "type": "string", - "name": "languages_url", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "" - }, - { - "type": "string", - "name": "milestones_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "notifications_url", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" - }, - { - "type": "string", - "name": "statuses_url", - "description": "" - }, - { - "type": "string", - "name": "subscribers_url", - "description": "" - }, - { - "type": "string", - "name": "subscription_url", - "description": "" - }, - { - "type": "string", - "name": "tags_url", - "description": "" - }, - { - "type": "string", - "name": "teams_url", - "description": "" - }, - { - "type": "string", - "name": "trees_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "rerun_url", - "description": "" - }, - { - "type": "integer", - "name": "run_attempt", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "run_number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "run_started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - "waiting" - ] - }, - { - "type": "object or null", - "name": "triggering_actor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "workflow_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "workflow_url", - "description": "" - }, - { - "type": "string", - "name": "display_title", - "description": "", - "isRequired": true - } - ] - } - ], - "availability": [ - "app" - ], - "action": "rejected", - "category": "deployment_review" - }, - "requested": { - "descriptionHtml": "

A deployment review was requested.

", - "summaryHtml": "

This event occurs when there is activity relating to deployment reviews. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation or deployment status, use the deployment or deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "requested" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "environment", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "requestor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "reviewers", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "reviewer", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "User", - "Team" - ] - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "string", - "name": "since", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "workflow_job_run", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "null", - "name": "conclusion", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "environment", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "workflow_run", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "actor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "artifacts_url", - "description": "" - }, - { - "type": "string", - "name": "cancel_url", - "description": "" - }, - { - "type": "integer", - "name": "check_suite_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_suite_node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_suite_url", - "description": "" - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "event", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "head_branch", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "head_commit", - "description": "" - }, - { - "type": "object", - "name": "head_repository", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "" - }, - { - "type": "string", - "name": "assignees_url", - "description": "" - }, - { - "type": "string", - "name": "blobs_url", - "description": "" - }, - { - "type": "string", - "name": "branches_url", - "description": "" - }, - { - "type": "string", - "name": "collaborators_url", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "" - }, - { - "type": "string", - "name": "compare_url", - "description": "" - }, - { - "type": "string", - "name": "contents_url", - "description": "" - }, - { - "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" - }, - { - "type": "string", - "name": "forks_url", - "description": "" - }, - { - "type": "string", - "name": "full_name", - "description": "" - }, - { - "type": "string", - "name": "git_commits_url", - "description": "" - }, - { - "type": "string", - "name": "git_refs_url", - "description": "" - }, - { - "type": "string", - "name": "git_tags_url", - "description": "" - }, - { - "type": "string", - "name": "hooks_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "" - }, - { - "type": "string", - "name": "issue_events_url", - "description": "" - }, - { - "type": "string", - "name": "issues_url", - "description": "" - }, - { - "type": "string", - "name": "keys_url", - "description": "" - }, - { - "type": "string", - "name": "labels_url", - "description": "" - }, - { - "type": "string", - "name": "languages_url", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "" - }, - { - "type": "string", - "name": "milestones_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "notifications_url", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" - }, - { - "type": "string", - "name": "statuses_url", - "description": "" - }, - { - "type": "string", - "name": "subscribers_url", - "description": "" - }, - { - "type": "string", - "name": "subscription_url", - "description": "" - }, - { - "type": "string", - "name": "tags_url", - "description": "" - }, - { - "type": "string", - "name": "teams_url", - "description": "" - }, - { - "type": "string", - "name": "trees_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "head_sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "jobs_url", - "description": "" - }, - { - "type": "string", - "name": "logs_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "previous_attempt_url", - "description": "" - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects or null", - "name": "referenced_workflows", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "" - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "" - }, - { - "type": "string", - "name": "assignees_url", - "description": "" - }, - { - "type": "string", - "name": "blobs_url", - "description": "" - }, - { - "type": "string", - "name": "branches_url", - "description": "" - }, - { - "type": "string", - "name": "collaborators_url", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "" - }, - { - "type": "string", - "name": "compare_url", - "description": "" - }, - { - "type": "string", - "name": "contents_url", - "description": "" - }, - { - "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" - }, - { - "type": "string", - "name": "forks_url", - "description": "" - }, - { - "type": "string", - "name": "full_name", - "description": "" - }, - { - "type": "string", - "name": "git_commits_url", - "description": "" - }, - { - "type": "string", - "name": "git_refs_url", - "description": "" - }, - { - "type": "string", - "name": "git_tags_url", - "description": "" - }, - { - "type": "string", - "name": "hooks_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "" - }, - { - "type": "string", - "name": "issue_events_url", - "description": "" - }, - { - "type": "string", - "name": "issues_url", - "description": "" - }, - { - "type": "string", - "name": "keys_url", - "description": "" - }, - { - "type": "string", - "name": "labels_url", - "description": "" - }, - { - "type": "string", - "name": "languages_url", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "" - }, - { - "type": "string", - "name": "milestones_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "notifications_url", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" - }, - { - "type": "string", - "name": "statuses_url", - "description": "" - }, - { - "type": "string", - "name": "subscribers_url", - "description": "" - }, - { - "type": "string", - "name": "subscription_url", - "description": "" - }, - { - "type": "string", - "name": "tags_url", - "description": "" - }, - { - "type": "string", - "name": "teams_url", - "description": "" - }, - { - "type": "string", - "name": "trees_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "rerun_url", - "description": "" - }, - { - "type": "integer", - "name": "run_attempt", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "run_number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "run_started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - "waiting", - "pending" - ] - }, - { - "type": "object or null", - "name": "triggering_actor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "workflow_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "workflow_url", - "description": "" - }, - { - "type": "string", - "name": "display_title", - "description": "", - "isRequired": true - } - ] - } - ], - "availability": [ - "app" - ], - "action": "requested", - "category": "deployment_review" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/deployment_status.json b/src/webhooks/data/ghes-3.14/deployment_status.json deleted file mode 100644 index 1993620623bf..000000000000 --- a/src/webhooks/data/ghes-3.14/deployment_status.json +++ /dev/null @@ -1,2904 +0,0 @@ -{ - "created": { - "descriptionHtml": "

A new deployment status was created.

", - "summaryHtml": "

This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation, use the deployment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

\n

\n

\nA webhook event is not fired for deployment statuses with an inactive state.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "check_run", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "completed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "

The result of the completed check run. This value will be null until the check run has completed.

", - "isRequired": true, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - "skipped", - null - ] - }, - { - "type": "string", - "name": "details_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "head_sha", - "description": "

The SHA of the commit that is being checked.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

The id of the check.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the check run.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "

The current status of the check run. Can be queued, in_progress, or completed.

", - "isRequired": true, - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "pending" - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "deployment", - "description": "

The deployment.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "environment", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "original_environment", - "description": "", - "isRequired": true - }, - { - "type": "null or string or object", - "name": "payload", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, merge_queue_entry, workflow_job, pull_request_review_thread, secret_scanning_alert_location, merge_group

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "production_environment", - "description": "" - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "task", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "transient_environment", - "description": "" - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "deployment_status", - "description": "

The deployment status.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "deployment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

The optional human-readable description added to the status.

", - "isRequired": true - }, - { - "type": "string", - "name": "environment", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "environment_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "log_url", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, pull_request_review_thread, merge_queue_entry, workflow_job, merge_group, secret_scanning_alert_location

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The new state. Can be pending, success, failure, or error.

", - "isRequired": true - }, - { - "type": "string", - "name": "target_url", - "description": "

The optional link added to the status.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "workflow", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "badge_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "workflow_run", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "actor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "artifacts_url", - "description": "" - }, - { - "type": "string", - "name": "cancel_url", - "description": "" - }, - { - "type": "integer", - "name": "check_suite_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_suite_node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_suite_url", - "description": "" - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - null, - "startup_failure" - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "display_title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "event", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "head_branch", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "head_commit", - "description": "" - }, - { - "type": "object", - "name": "head_repository", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "" - }, - { - "type": "string", - "name": "assignees_url", - "description": "" - }, - { - "type": "string", - "name": "blobs_url", - "description": "" - }, - { - "type": "string", - "name": "branches_url", - "description": "" - }, - { - "type": "string", - "name": "collaborators_url", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "" - }, - { - "type": "string", - "name": "compare_url", - "description": "" - }, - { - "type": "string", - "name": "contents_url", - "description": "" - }, - { - "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" - }, - { - "type": "string", - "name": "forks_url", - "description": "" - }, - { - "type": "string", - "name": "full_name", - "description": "" - }, - { - "type": "string", - "name": "git_commits_url", - "description": "" - }, - { - "type": "string", - "name": "git_refs_url", - "description": "" - }, - { - "type": "string", - "name": "git_tags_url", - "description": "" - }, - { - "type": "string", - "name": "hooks_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "" - }, - { - "type": "string", - "name": "issue_events_url", - "description": "" - }, - { - "type": "string", - "name": "issues_url", - "description": "" - }, - { - "type": "string", - "name": "keys_url", - "description": "" - }, - { - "type": "string", - "name": "labels_url", - "description": "" - }, - { - "type": "string", - "name": "languages_url", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "" - }, - { - "type": "string", - "name": "milestones_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "notifications_url", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" - }, - { - "type": "string", - "name": "statuses_url", - "description": "" - }, - { - "type": "string", - "name": "subscribers_url", - "description": "" - }, - { - "type": "string", - "name": "subscription_url", - "description": "" - }, - { - "type": "string", - "name": "tags_url", - "description": "" - }, - { - "type": "string", - "name": "teams_url", - "description": "" - }, - { - "type": "string", - "name": "trees_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "head_sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "jobs_url", - "description": "" - }, - { - "type": "string", - "name": "logs_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "previous_attempt_url", - "description": "" - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects or null", - "name": "referenced_workflows", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "" - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "" - }, - { - "type": "string", - "name": "assignees_url", - "description": "" - }, - { - "type": "string", - "name": "blobs_url", - "description": "" - }, - { - "type": "string", - "name": "branches_url", - "description": "" - }, - { - "type": "string", - "name": "collaborators_url", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "" - }, - { - "type": "string", - "name": "compare_url", - "description": "" - }, - { - "type": "string", - "name": "contents_url", - "description": "" - }, - { - "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" - }, - { - "type": "string", - "name": "forks_url", - "description": "" - }, - { - "type": "string", - "name": "full_name", - "description": "" - }, - { - "type": "string", - "name": "git_commits_url", - "description": "" - }, - { - "type": "string", - "name": "git_refs_url", - "description": "" - }, - { - "type": "string", - "name": "git_tags_url", - "description": "" - }, - { - "type": "string", - "name": "hooks_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "" - }, - { - "type": "string", - "name": "issue_events_url", - "description": "" - }, - { - "type": "string", - "name": "issues_url", - "description": "" - }, - { - "type": "string", - "name": "keys_url", - "description": "" - }, - { - "type": "string", - "name": "labels_url", - "description": "" - }, - { - "type": "string", - "name": "languages_url", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "" - }, - { - "type": "string", - "name": "milestones_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "notifications_url", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" - }, - { - "type": "string", - "name": "statuses_url", - "description": "" - }, - { - "type": "string", - "name": "subscribers_url", - "description": "" - }, - { - "type": "string", - "name": "subscription_url", - "description": "" - }, - { - "type": "string", - "name": "tags_url", - "description": "" - }, - { - "type": "string", - "name": "teams_url", - "description": "" - }, - { - "type": "string", - "name": "trees_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "rerun_url", - "description": "" - }, - { - "type": "integer", - "name": "run_attempt", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "run_number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "run_started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - "waiting", - "pending" - ] - }, - { - "type": "object or null", - "name": "triggering_actor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "workflow_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "workflow_url", - "description": "" - } - ] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "deployment_status" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/discussion.json b/src/webhooks/data/ghes-3.14/discussion.json deleted file mode 100644 index 3fa78280dcdb..000000000000 --- a/src/webhooks/data/ghes-3.14/discussion.json +++ /dev/null @@ -1,12258 +0,0 @@ -{ - "answered": { - "descriptionHtml": "

A comment on the discussion was marked as the answer.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "answered" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "answer", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "answered", - "category": "discussion" - }, - "category_changed": { - "descriptionHtml": "

The category of a discussion was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "category_changed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "from", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "category_changed", - "category": "discussion" - }, - "closed": { - "descriptionHtml": "

A discussion was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "closed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "closed", - "category": "discussion" - }, - "created": { - "descriptionHtml": "

A discussion was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "discussion" - }, - "deleted": { - "descriptionHtml": "

A discussion was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "discussion" - }, - "edited": { - "descriptionHtml": "

The title or body on a discussion was edited, or the category of the discussion was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "body", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "title", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "edited", - "category": "discussion" - }, - "labeled": { - "descriptionHtml": "

A label was added to a discussion.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "labeled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "label", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "labeled", - "category": "discussion" - }, - "locked": { - "descriptionHtml": "

A discussion was locked.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "locked" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "locked", - "category": "discussion" - }, - "pinned": { - "descriptionHtml": "

A discussion was pinned.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "pinned" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "pinned", - "category": "discussion" - }, - "reopened": { - "descriptionHtml": "

A discussion was reopened.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "reopened" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "reopened", - "category": "discussion" - }, - "transferred": { - "descriptionHtml": "

A discussion was transferred to another repository.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "transferred" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "new_discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "new_repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "

License Simple

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "organization", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - } - ] - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", - "default": false - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "object", - "name": "custom_properties", - "description": "

The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.

" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository disabled.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

The repository visibility: public, private, or internal.

", - "default": "public" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "object or null", - "name": "template_repository", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "full_name", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string", - "name": "description", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "" - }, - { - "type": "string", - "name": "assignees_url", - "description": "" - }, - { - "type": "string", - "name": "blobs_url", - "description": "" - }, - { - "type": "string", - "name": "branches_url", - "description": "" - }, - { - "type": "string", - "name": "collaborators_url", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "" - }, - { - "type": "string", - "name": "compare_url", - "description": "" - }, - { - "type": "string", - "name": "contents_url", - "description": "" - }, - { - "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "forks_url", - "description": "" - }, - { - "type": "string", - "name": "git_commits_url", - "description": "" - }, - { - "type": "string", - "name": "git_refs_url", - "description": "" - }, - { - "type": "string", - "name": "git_tags_url", - "description": "" - }, - { - "type": "string", - "name": "git_url", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "" - }, - { - "type": "string", - "name": "issue_events_url", - "description": "" - }, - { - "type": "string", - "name": "issues_url", - "description": "" - }, - { - "type": "string", - "name": "keys_url", - "description": "" - }, - { - "type": "string", - "name": "labels_url", - "description": "" - }, - { - "type": "string", - "name": "languages_url", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "" - }, - { - "type": "string", - "name": "milestones_url", - "description": "" - }, - { - "type": "string", - "name": "notifications_url", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "ssh_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" - }, - { - "type": "string", - "name": "statuses_url", - "description": "" - }, - { - "type": "string", - "name": "subscribers_url", - "description": "" - }, - { - "type": "string", - "name": "subscription_url", - "description": "" - }, - { - "type": "string", - "name": "tags_url", - "description": "" - }, - { - "type": "string", - "name": "teams_url", - "description": "" - }, - { - "type": "string", - "name": "trees_url", - "description": "" - }, - { - "type": "string", - "name": "clone_url", - "description": "" - }, - { - "type": "string", - "name": "mirror_url", - "description": "" - }, - { - "type": "string", - "name": "hooks_url", - "description": "" - }, - { - "type": "string", - "name": "svn_url", - "description": "" - }, - { - "type": "string", - "name": "homepage", - "description": "" - }, - { - "type": "string", - "name": "language", - "description": "" - }, - { - "type": "integer", - "name": "forks_count", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "" - }, - { - "type": "integer", - "name": "watchers_count", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "" - }, - { - "type": "string", - "name": "default_branch", - "description": "" - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "" - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "" - }, - { - "type": "boolean", - "name": "has_projects", - "description": "" - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "" - }, - { - "type": "boolean", - "name": "has_pages", - "description": "" - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "" - }, - { - "type": "boolean", - "name": "archived", - "description": "" - }, - { - "type": "boolean", - "name": "disabled", - "description": "" - }, - { - "type": "string", - "name": "visibility", - "description": "" - }, - { - "type": "string", - "name": "pushed_at", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "" - }, - { - "type": "string", - "name": "updated_at", - "description": "" - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "" - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "" - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "" - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "" - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "" - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "" - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "" - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "" - }, - { - "type": "integer", - "name": "subscribers_count", - "description": "" - }, - { - "type": "integer", - "name": "network_count", - "description": "" - } - ] - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow Auto-merge to be used on pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

", - "default": false - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow forking this repo

" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

", - "default": false - }, - { - "type": "integer", - "name": "subscribers_count", - "description": "" - }, - { - "type": "integer", - "name": "network_count", - "description": "" - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "boolean", - "name": "anonymous_access_enabled", - "description": "

Whether anonymous git access is enabled for this repository

" - } - ] - } - ] - }, - { - "type": "object", - "name": "discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "transferred", - "category": "discussion" - }, - "unanswered": { - "descriptionHtml": "

A comment on the discussion was unmarked as the answer.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "unanswered" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "old_answer", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unanswered", - "category": "discussion" - }, - "unlabeled": { - "descriptionHtml": "

A label was removed from a discussion.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "unlabeled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "label", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unlabeled", - "category": "discussion" - }, - "unlocked": { - "descriptionHtml": "

A discussion was unlocked.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "unlocked" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unlocked", - "category": "discussion" - }, - "unpinned": { - "descriptionHtml": "

A discussion was unpinned.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "unpinned" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unpinned", - "category": "discussion" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/discussion_comment.json b/src/webhooks/data/ghes-3.14/discussion_comment.json deleted file mode 100644 index 77299108313e..000000000000 --- a/src/webhooks/data/ghes-3.14/discussion_comment.json +++ /dev/null @@ -1,1923 +0,0 @@ -{ - "created": { - "descriptionHtml": "

A comment on a discussion was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "comment", - "description": "", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "discussion_comment" - }, - "deleted": { - "descriptionHtml": "

A comment on a discussion was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "comment", - "description": "", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "discussion_comment" - }, - "edited": { - "descriptionHtml": "

A comment on a discussion was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "comment", - "description": "", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "discussion", - "description": "

A Discussion in a repository.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.

", - "isRequired": true, - "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "

The reason for the current state

", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Optional description of the label, such as its purpose.

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "

Whether this label comes by default in a new repository.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "edited", - "category": "discussion_comment" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/enterprise.json b/src/webhooks/data/ghes-3.14/enterprise.json deleted file mode 100644 index cb4a44a22920..000000000000 --- a/src/webhooks/data/ghes-3.14/enterprise.json +++ /dev/null @@ -1,56 +0,0 @@ -{ - "anonymous_access_disabled": { - "descriptionHtml": "

Anonymous Git read access was disabled.

", - "summaryHtml": "

This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "anonymous_access_disabled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "business" - ], - "action": "anonymous_access_disabled", - "category": "enterprise" - }, - "anonymous_access_enabled": { - "descriptionHtml": "

Anonymous Git read access was enabled.

", - "summaryHtml": "

This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "anonymous_access_enabled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "business" - ], - "action": "anonymous_access_enabled", - "category": "enterprise" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/fork.json b/src/webhooks/data/ghes-3.14/fork.json deleted file mode 100644 index 89b9684f5358..000000000000 --- a/src/webhooks/data/ghes-3.14/fork.json +++ /dev/null @@ -1,776 +0,0 @@ -{ - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when someone forks a repository. For more information, see \"Fork a repo.\" For information about the API to manage forks, see \"Forks\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "forkee", - "description": "

The created repository resource.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "default", - "category": "fork" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/github_app_authorization.json b/src/webhooks/data/ghes-3.14/github_app_authorization.json deleted file mode 100644 index 3a344c2297d3..000000000000 --- a/src/webhooks/data/ghes-3.14/github_app_authorization.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "revoked": { - "descriptionHtml": "

Someone revoked their authorization of a GitHub App.

", - "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about requests with a user access token, which require GitHub App authorization, see \"Authenticating with a GitHub App on behalf of a user.\"

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "revoked" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "revoked", - "category": "github_app_authorization" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/gollum.json b/src/webhooks/data/ghes-3.14/gollum.json deleted file mode 100644 index 746b2a0228a3..000000000000 --- a/src/webhooks/data/ghes-3.14/gollum.json +++ /dev/null @@ -1,95 +0,0 @@ -{ - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when someone creates or updates a wiki page. For more information, see \"About wikis.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "pages", - "description": "

The pages that were updated.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "action", - "description": "

The action that was performed on the page. Can be created or edited.

", - "isRequired": true, - "enum": [ - "created", - "edited" - ] - }, - { - "type": "string", - "name": "html_url", - "description": "

Points to the HTML wiki page.

", - "isRequired": true - }, - { - "type": "string", - "name": "page_name", - "description": "

The name of the page.

", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "

The latest commit SHA of the page.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "summary", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The current page title.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "gollum" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/installation.json b/src/webhooks/data/ghes-3.14/installation.json deleted file mode 100644 index 2842bf59cfb9..000000000000 --- a/src/webhooks/data/ghes-3.14/installation.json +++ /dev/null @@ -1,596 +0,0 @@ -{ - "created": { - "descriptionHtml": "

Someone installed a GitHub App on a user or organization account.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "requester", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "created", - "category": "installation" - }, - "deleted": { - "descriptionHtml": "

Someone uninstalled a GitHub App from their user or organization account.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "null", - "name": "requester", - "description": "" - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "deleted", - "category": "installation" - }, - "new_permissions_accepted": { - "descriptionHtml": "

Someone granted new permissions to a GitHub App.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "new_permissions_accepted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "null", - "name": "requester", - "description": "" - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "new_permissions_accepted", - "category": "installation" - }, - "suspend": { - "descriptionHtml": "

Someone blocked access by a GitHub App to their user or organization account.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "suspend" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "null", - "name": "requester", - "description": "" - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "suspend", - "category": "installation" - }, - "unsuspend": { - "descriptionHtml": "

A GitHub App that was blocked from accessing a user or organization account was given access the account again.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "unsuspend" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "null", - "name": "requester", - "description": "" - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "unsuspend", - "category": "installation" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/installation_repositories.json b/src/webhooks/data/ghes-3.14/installation_repositories.json deleted file mode 100644 index feef08c96a60..000000000000 --- a/src/webhooks/data/ghes-3.14/installation_repositories.json +++ /dev/null @@ -1,525 +0,0 @@ -{ - "added": { - "descriptionHtml": "

A GitHub App installation was granted access to one or more repositories.

", - "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "added" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories_added", - "description": "

An array of repository objects, which were added to the installation.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "repositories_removed", - "description": "

An array of repository objects, which were removed from the installation.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

" - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "repository_selection", - "description": "

Describe whether all repositories have been selected or there's a selection involved

", - "isRequired": true, - "enum": [ - "all", - "selected" - ] - }, - { - "type": "object or null", - "name": "requester", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "added", - "category": "installation_repositories" - }, - "removed": { - "descriptionHtml": "

Access to one or more repositories was revoked for a GitHub App installation.

", - "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "removed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories_added", - "description": "

An array of repository objects, which were added to the installation.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "repositories_removed", - "description": "

An array of repository objects, which were removed from the installation.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "repository_selection", - "description": "

Describe whether all repositories have been selected or there's a selection involved

", - "isRequired": true, - "enum": [ - "all", - "selected" - ] - }, - { - "type": "object or null", - "name": "requester", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "removed", - "category": "installation_repositories" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/installation_target.json b/src/webhooks/data/ghes-3.14/installation_target.json deleted file mode 100644 index 00f92bddeccd..000000000000 --- a/src/webhooks/data/ghes-3.14/installation_target.json +++ /dev/null @@ -1,291 +0,0 @@ -{ - "renamed": { - "descriptionHtml": "

Somebody renamed the user or organization account that a GitHub App is installed on.

", - "summaryHtml": "

This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "object", - "name": "account", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "archived_at", - "description": "" - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "" - }, - { - "type": "null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "integer", - "name": "followers", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "integer", - "name": "following", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "boolean", - "name": "has_organization_projects", - "description": "" - }, - { - "type": "boolean", - "name": "has_repository_projects", - "description": "" - }, - { - "type": "string", - "name": "hooks_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_verified", - "description": "" - }, - { - "type": "string", - "name": "issues_url", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "integer", - "name": "public_gists", - "description": "" - }, - { - "type": "string", - "name": "public_members_url", - "description": "" - }, - { - "type": "integer", - "name": "public_repos", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "updated_at", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "null", - "name": "website_url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "renamed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "login", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "slug", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "target_type", - "description": "", - "isRequired": true - } - ], - "availability": [ - "app" - ], - "action": "renamed", - "category": "installation_target" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/issue_comment.json b/src/webhooks/data/ghes-3.14/issue_comment.json deleted file mode 100644 index 2b8dd32c2bcf..000000000000 --- a/src/webhooks/data/ghes-3.14/issue_comment.json +++ /dev/null @@ -1,2960 +0,0 @@ -{ - "created": { - "descriptionHtml": "

A comment on an issue or pull request was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.

\n

For activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "comment", - "description": "

The comment itself.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue the comment belongs to.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "issue_comment" - }, - "deleted": { - "descriptionHtml": "

A comment on an issue or pull request was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.

\n

For activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "comment", - "description": "

The comment itself.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue the comment belongs to.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "issue_comment" - }, - "edited": { - "descriptionHtml": "

A comment on an issue or pull request was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.

\n

For activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "

The changes to the comment.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "body", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the body.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "comment", - "description": "

The comment itself.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue the comment belongs to.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "edited", - "category": "issue_comment" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/issues.json b/src/webhooks/data/ghes-3.14/issues.json deleted file mode 100644 index e576b64f8f76..000000000000 --- a/src/webhooks/data/ghes-3.14/issues.json +++ /dev/null @@ -1,36727 +0,0 @@ -{ - "assigned": { - "descriptionHtml": "

An issue was assigned to a user.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "

The action that was performed.

", - "isRequired": true, - "enum": [ - "assigned" - ], - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "" - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_comment", - "description": "

Comments provide a way for people to collaborate on an issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

Contents of the issue comment

" - }, - { - "type": "string", - "name": "body_text", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pin", - "description": "

Context around who pinned an issue comment and when it was pinned.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pinned_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "issue_field_id", - "description": "

Unique identifier for the issue field.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "data_type", - "description": "

The data type of the issue field

", - "isRequired": true, - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - { - "type": "null or string or number or integer", - "name": "value", - "description": "

The value of the issue field

", - "isRequired": true - }, - { - "type": "object or null", - "name": "single_select_option", - "description": "

Details about the selected option (only present for single_select fields)

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the option.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the option

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The color of the option

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "assigned", - "category": "issues" - }, - "closed": { - "descriptionHtml": "

An issue was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "

The action that was performed.

", - "isRequired": true, - "enum": [ - "closed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "" - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of object,nulls", - "name": "labels", - "description": "" - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "" - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_comment", - "description": "

Comments provide a way for people to collaborate on an issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

Contents of the issue comment

" - }, - { - "type": "string", - "name": "body_text", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pin", - "description": "

Context around who pinned an issue comment and when it was pinned.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pinned_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "issue_field_id", - "description": "

Unique identifier for the issue field.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "data_type", - "description": "

The data type of the issue field

", - "isRequired": true, - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - { - "type": "null or string or number or integer", - "name": "value", - "description": "

The value of the issue field

", - "isRequired": true - }, - { - "type": "object or null", - "name": "single_select_option", - "description": "

Details about the selected option (only present for single_select fields)

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the option.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the option

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The color of the option

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "closed", - "open" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "closed", - "category": "issues" - }, - "deleted": { - "descriptionHtml": "

An issue was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "" - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_comment", - "description": "

Comments provide a way for people to collaborate on an issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

Contents of the issue comment

" - }, - { - "type": "string", - "name": "body_text", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pin", - "description": "

Context around who pinned an issue comment and when it was pinned.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pinned_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "issue_field_id", - "description": "

Unique identifier for the issue field.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "data_type", - "description": "

The data type of the issue field

", - "isRequired": true, - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - { - "type": "null or string or number or integer", - "name": "value", - "description": "

The value of the issue field

", - "isRequired": true - }, - { - "type": "object or null", - "name": "single_select_option", - "description": "

Details about the selected option (only present for single_select fields)

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the option.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the option

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The color of the option

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "issues" - }, - "demilestoned": { - "descriptionHtml": "

An issue was removed from a milestone.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "demilestoned" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of object,nulls", - "name": "labels", - "description": "" - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "" - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_comment", - "description": "

Comments provide a way for people to collaborate on an issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

Contents of the issue comment

" - }, - { - "type": "string", - "name": "body_text", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pin", - "description": "

Context around who pinned an issue comment and when it was pinned.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pinned_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "issue_field_id", - "description": "

Unique identifier for the issue field.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "data_type", - "description": "

The data type of the issue field

", - "isRequired": true, - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - { - "type": "null or string or number or integer", - "name": "value", - "description": "

The value of the issue field

", - "isRequired": true - }, - { - "type": "object or null", - "name": "single_select_option", - "description": "

Details about the selected option (only present for single_select fields)

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the option.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the option

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The color of the option

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "demilestoned", - "category": "issues" - }, - "edited": { - "descriptionHtml": "

The title or body on an issue was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "

The changes to the issue.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "body", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the body.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "title", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the title.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "" - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, security_and_analysis, pull_request_review_thread, reminder

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_comment", - "description": "

Comments provide a way for people to collaborate on an issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

Contents of the issue comment

" - }, - { - "type": "string", - "name": "body_text", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pin", - "description": "

Context around who pinned an issue comment and when it was pinned.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pinned_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "issue_field_id", - "description": "

Unique identifier for the issue field.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "data_type", - "description": "

The data type of the issue field

", - "isRequired": true, - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - { - "type": "null or string or number or integer", - "name": "value", - "description": "

The value of the issue field

", - "isRequired": true - }, - { - "type": "object or null", - "name": "single_select_option", - "description": "

Details about the selected option (only present for single_select fields)

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the option.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the option

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The color of the option

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "label", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "edited", - "category": "issues" - }, - "labeled": { - "descriptionHtml": "

A label was added to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "labeled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "" - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, pull_request_review_thread, reminder

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_comment", - "description": "

Comments provide a way for people to collaborate on an issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

Contents of the issue comment

" - }, - { - "type": "string", - "name": "body_text", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pin", - "description": "

Context around who pinned an issue comment and when it was pinned.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pinned_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "issue_field_id", - "description": "

Unique identifier for the issue field.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "data_type", - "description": "

The data type of the issue field

", - "isRequired": true, - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - { - "type": "null or string or number or integer", - "name": "value", - "description": "

The value of the issue field

", - "isRequired": true - }, - { - "type": "object or null", - "name": "single_select_option", - "description": "

Details about the selected option (only present for single_select fields)

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the option.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the option

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The color of the option

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "label", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "labeled", - "category": "issues" - }, - "locked": { - "descriptionHtml": "

Conversation on an issue was locked. For more information, see \"Locking conversations.\"

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "locked" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of object,nulls", - "name": "labels", - "description": "" - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true, - "enum": [ - true - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, security_and_analysis

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_comment", - "description": "

Comments provide a way for people to collaborate on an issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

Contents of the issue comment

" - }, - { - "type": "string", - "name": "body_text", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pin", - "description": "

Context around who pinned an issue comment and when it was pinned.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pinned_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "issue_field_id", - "description": "

Unique identifier for the issue field.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "data_type", - "description": "

The data type of the issue field

", - "isRequired": true, - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - { - "type": "null or string or number or integer", - "name": "value", - "description": "

The value of the issue field

", - "isRequired": true - }, - { - "type": "object or null", - "name": "single_select_option", - "description": "

Details about the selected option (only present for single_select fields)

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the option.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the option

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The color of the option

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "locked", - "category": "issues" - }, - "milestoned": { - "descriptionHtml": "

An issue was added to a milestone.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "milestoned" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of object,nulls", - "name": "labels", - "description": "" - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "" - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_comment", - "description": "

Comments provide a way for people to collaborate on an issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

Contents of the issue comment

" - }, - { - "type": "string", - "name": "body_text", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pin", - "description": "

Context around who pinned an issue comment and when it was pinned.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pinned_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "issue_field_id", - "description": "

Unique identifier for the issue field.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "data_type", - "description": "

The data type of the issue field

", - "isRequired": true, - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - { - "type": "null or string or number or integer", - "name": "value", - "description": "

The value of the issue field

", - "isRequired": true - }, - { - "type": "object or null", - "name": "single_select_option", - "description": "

Details about the selected option (only present for single_select fields)

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the option.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the option

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The color of the option

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "milestoned", - "category": "issues" - }, - "opened": { - "descriptionHtml": "

An issue was created. When a closed issue is reopened, the action will be reopened instead.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "opened" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "old_issue", - "description": "

The issue itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "" - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

" - }, - { - "type": "string or null", - "name": "closed_at", - "description": "" - }, - { - "type": "integer", - "name": "comments", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "" - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "labels_url", - "description": "" - }, - { - "type": "boolean", - "name": "locked", - "description": "" - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "" - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "issue_field_id", - "description": "

Unique identifier for the issue field.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "data_type", - "description": "

The data type of the issue field

", - "isRequired": true, - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - { - "type": "null or string or number or integer", - "name": "value", - "description": "

The value of the issue field

", - "isRequired": true - }, - { - "type": "object or null", - "name": "single_select_option", - "description": "

Details about the selected option (only present for single_select fields)

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the option.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the option

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The color of the option

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

" - }, - { - "type": "string", - "name": "updated_at", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

" - }, - { - "type": "object or null", - "name": "pinned_comment", - "description": "

Comments provide a way for people to collaborate on an issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

Contents of the issue comment

" - }, - { - "type": "string", - "name": "body_text", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pin", - "description": "

Context around who pinned an issue comment and when it was pinned.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pinned_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - }, - { - "type": "object or null", - "name": "user", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - } - ] - }, - { - "type": "object", - "name": "old_repository", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "custom_properties", - "description": "

The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.

" - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether the repository has discussions enabled.

" - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require commit signoff.

" - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "" - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, security_and_analysis, pull_request_review_thread, reminder

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "issue_field_id", - "description": "

Unique identifier for the issue field.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "data_type", - "description": "

The data type of the issue field

", - "isRequired": true, - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - { - "type": "null or string or number or integer", - "name": "value", - "description": "

The value of the issue field

", - "isRequired": true - }, - { - "type": "object or null", - "name": "single_select_option", - "description": "

Details about the selected option (only present for single_select fields)

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the option.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the option

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The color of the option

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_comment", - "description": "

Comments provide a way for people to collaborate on an issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

Contents of the issue comment

" - }, - { - "type": "string", - "name": "body_text", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pin", - "description": "

Context around who pinned an issue comment and when it was pinned.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pinned_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "opened", - "category": "issues" - }, - "pinned": { - "descriptionHtml": "

An issue was pinned to a repository. For more information, see \"Pinning an issue to your repository.\"

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "pinned" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "" - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_comment", - "description": "

Comments provide a way for people to collaborate on an issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

Contents of the issue comment

" - }, - { - "type": "string", - "name": "body_text", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pin", - "description": "

Context around who pinned an issue comment and when it was pinned.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pinned_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "issue_field_id", - "description": "

Unique identifier for the issue field.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "data_type", - "description": "

The data type of the issue field

", - "isRequired": true, - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - { - "type": "null or string or number or integer", - "name": "value", - "description": "

The value of the issue field

", - "isRequired": true - }, - { - "type": "object or null", - "name": "single_select_option", - "description": "

Details about the selected option (only present for single_select fields)

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the option.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the option

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The color of the option

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "pinned", - "category": "issues" - }, - "reopened": { - "descriptionHtml": "

A closed issue was reopened.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "reopened" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of object,nulls", - "name": "labels", - "description": "" - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "" - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, pull_request_review_thread, reminder

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_comment", - "description": "

Comments provide a way for people to collaborate on an issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

Contents of the issue comment

" - }, - { - "type": "string", - "name": "body_text", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pin", - "description": "

Context around who pinned an issue comment and when it was pinned.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pinned_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "issue_field_id", - "description": "

Unique identifier for the issue field.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "data_type", - "description": "

The data type of the issue field

", - "isRequired": true, - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - { - "type": "null or string or number or integer", - "name": "value", - "description": "

The value of the issue field

", - "isRequired": true - }, - { - "type": "object or null", - "name": "single_select_option", - "description": "

Details about the selected option (only present for single_select fields)

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the option.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the option

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The color of the option

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "reopened", - "category": "issues" - }, - "transferred": { - "descriptionHtml": "

An issue was transferred to another repository. For more information, see \"Transferring an issue to another repository.\"

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "transferred" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "new_issue", - "description": "

The issue itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "" - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_comment", - "description": "

Comments provide a way for people to collaborate on an issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

Contents of the issue comment

" - }, - { - "type": "string", - "name": "body_text", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pin", - "description": "

Context around who pinned an issue comment and when it was pinned.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pinned_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "issue_field_id", - "description": "

Unique identifier for the issue field.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "data_type", - "description": "

The data type of the issue field

", - "isRequired": true, - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - { - "type": "null or string or number or integer", - "name": "value", - "description": "

The value of the issue field

", - "isRequired": true - }, - { - "type": "object or null", - "name": "single_select_option", - "description": "

Details about the selected option (only present for single_select fields)

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the option.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the option

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The color of the option

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "new_repository", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "custom_properties", - "description": "

The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.

" - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "" - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_comment", - "description": "

Comments provide a way for people to collaborate on an issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

Contents of the issue comment

" - }, - { - "type": "string", - "name": "body_text", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pin", - "description": "

Context around who pinned an issue comment and when it was pinned.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pinned_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "issue_field_id", - "description": "

Unique identifier for the issue field.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "data_type", - "description": "

The data type of the issue field

", - "isRequired": true, - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - { - "type": "null or string or number or integer", - "name": "value", - "description": "

The value of the issue field

", - "isRequired": true - }, - { - "type": "object or null", - "name": "single_select_option", - "description": "

Details about the selected option (only present for single_select fields)

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the option.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the option

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The color of the option

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "transferred", - "category": "issues" - }, - "unassigned": { - "descriptionHtml": "

A user was unassigned from an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "

The action that was performed.

", - "isRequired": true, - "enum": [ - "unassigned" - ], - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "" - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_comment", - "description": "

Comments provide a way for people to collaborate on an issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

Contents of the issue comment

" - }, - { - "type": "string", - "name": "body_text", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pin", - "description": "

Context around who pinned an issue comment and when it was pinned.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pinned_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "issue_field_id", - "description": "

Unique identifier for the issue field.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "data_type", - "description": "

The data type of the issue field

", - "isRequired": true, - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - { - "type": "null or string or number or integer", - "name": "value", - "description": "

The value of the issue field

", - "isRequired": true - }, - { - "type": "object or null", - "name": "single_select_option", - "description": "

Details about the selected option (only present for single_select fields)

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the option.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the option

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The color of the option

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unassigned", - "category": "issues" - }, - "unlabeled": { - "descriptionHtml": "

A label was removed from an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "unlabeled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "" - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write", - "admin" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_comment", - "description": "

Comments provide a way for people to collaborate on an issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

Contents of the issue comment

" - }, - { - "type": "string", - "name": "body_text", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pin", - "description": "

Context around who pinned an issue comment and when it was pinned.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pinned_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "issue_field_id", - "description": "

Unique identifier for the issue field.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "data_type", - "description": "

The data type of the issue field

", - "isRequired": true, - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - { - "type": "null or string or number or integer", - "name": "value", - "description": "

The value of the issue field

", - "isRequired": true - }, - { - "type": "object or null", - "name": "single_select_option", - "description": "

Details about the selected option (only present for single_select fields)

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the option.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the option

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The color of the option

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "label", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unlabeled", - "category": "issues" - }, - "unlocked": { - "descriptionHtml": "

Conversation on an issue was locked. For more information, see \"Locking conversations.\"

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "unlocked" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of object,nulls", - "name": "labels", - "description": "" - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true, - "enum": [ - false - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_comment", - "description": "

Comments provide a way for people to collaborate on an issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

Contents of the issue comment

" - }, - { - "type": "string", - "name": "body_text", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pin", - "description": "

Context around who pinned an issue comment and when it was pinned.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pinned_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "issue_field_id", - "description": "

Unique identifier for the issue field.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "data_type", - "description": "

The data type of the issue field

", - "isRequired": true, - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - { - "type": "null or string or number or integer", - "name": "value", - "description": "

The value of the issue field

", - "isRequired": true - }, - { - "type": "object or null", - "name": "single_select_option", - "description": "

Details about the selected option (only present for single_select fields)

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the option.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the option

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The color of the option

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unlocked", - "category": "issues" - }, - "unpinned": { - "descriptionHtml": "

An issue was unpinned from a repository. For more information, see \"Pinning an issue to your repository.\"

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "unpinned" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "issue", - "description": "

The issue itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

Contents of the issue

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "" - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_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.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "diff_url", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "" - }, - { - "type": "string", - "name": "patch_url", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_comment", - "description": "

Comments provide a way for people to collaborate on an issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue comment

", - "isRequired": true - }, - { - "type": "string", - "name": "body", - "description": "

Contents of the issue comment

" - }, - { - "type": "string", - "name": "body_text", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pin", - "description": "

Context around who pinned an issue comment and when it was pinned.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pinned_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "pinned_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "sub_issues_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "total", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "completed", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "percent_completed", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue_dependencies_summary", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "blocking", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocked_by", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_blocking", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "issue_field_values", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "issue_field_id", - "description": "

Unique identifier for the issue field.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "data_type", - "description": "

The data type of the issue field

", - "isRequired": true, - "enum": [ - "text", - "single_select", - "number", - "date" - ] - }, - { - "type": "null or string or number or integer", - "name": "value", - "description": "

The value of the issue field

", - "isRequired": true - }, - { - "type": "object or null", - "name": "single_select_option", - "description": "

Details about the selected option (only present for single_select fields)

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier for the option.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the option

", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "

The color of the option

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of the issue; either 'open' or 'closed'

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string or null", - "name": "state_reason", - "description": "" - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "

Title of the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "type", - "description": "

The type of issue.

", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node identifier of the issue type.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The description of the issue type.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "color", - "description": "

The color of the issue type.

", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time the issue type created.

" - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time the issue type last updated.

" - }, - { - "type": "boolean", - "name": "is_enabled", - "description": "

The enabled state of the issue type.

" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the issue

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unpinned", - "category": "issues" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/label.json b/src/webhooks/data/ghes-3.14/label.json deleted file mode 100644 index 03eb906fa753..000000000000 --- a/src/webhooks/data/ghes-3.14/label.json +++ /dev/null @@ -1,362 +0,0 @@ -{ - "created": { - "descriptionHtml": "

A label was created.

", - "summaryHtml": "

This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.

\n

If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "label", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "label" - }, - "deleted": { - "descriptionHtml": "

A label was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.

\n

If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "label", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "label" - }, - "edited": { - "descriptionHtml": "

A label's name, description, or color was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.

\n

If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "

The changes to the label if the action was edited.

", - "childParamsGroups": [ - { - "type": "object", - "name": "color", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the color if the action was edited.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "description", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the description if the action was edited.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "name", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the name if the action was edited.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "label", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "edited", - "category": "label" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/member.json b/src/webhooks/data/ghes-3.14/member.json deleted file mode 100644 index 1e2728194f9c..000000000000 --- a/src/webhooks/data/ghes-3.14/member.json +++ /dev/null @@ -1,621 +0,0 @@ -{ - "added": { - "descriptionHtml": "

A GitHub user accepted an invitation to a repository.

", - "summaryHtml": "

This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "added" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "permission", - "description": "

This field is included for legacy purposes; use the role_name field instead. The maintain\nrole is mapped to write and the triage role is mapped to read. To determine the role\nassigned to the collaborator, use the role_name field instead, which will provide the full\nrole name, including custom roles.

", - "childParamsGroups": [ - { - "type": "string", - "name": "to", - "description": "", - "isRequired": true, - "enum": [ - "write", - "admin", - "read" - ] - } - ] - }, - { - "type": "object", - "name": "role_name", - "description": "

The role assigned to the collaborator.

", - "childParamsGroups": [ - { - "type": "string", - "name": "to", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "member", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "added", - "category": "member" - }, - "edited": { - "descriptionHtml": "

Permissions were changed for a collaborator on a repository.

", - "summaryHtml": "

This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "

The changes to the collaborator permissions

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "old_permission", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous permissions of the collaborator if the action was edited.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "permission", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "" - }, - { - "type": "string or null", - "name": "to", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "member", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "edited", - "category": "member" - }, - "removed": { - "descriptionHtml": "

A collaborator was removed from a repository.

", - "summaryHtml": "

This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "removed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "member", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "removed", - "category": "member" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/membership.json b/src/webhooks/data/ghes-3.14/membership.json deleted file mode 100644 index b3d5f19c5857..000000000000 --- a/src/webhooks/data/ghes-3.14/membership.json +++ /dev/null @@ -1,803 +0,0 @@ -{ - "added": { - "descriptionHtml": "

An organization member was added to a team.

", - "summaryHtml": "

This event occurs when there is activity relating to team membership. For more information, see \"About teams.\" For more information about the APIs to manage team memberships, see the GraphQL API documentation or \"Team members\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "added" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "member", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "scope", - "description": "

The scope of the membership. Currently, can only be team.

", - "isRequired": true, - "enum": [ - "team" - ] - }, - { - "type": "object or null", - "name": "sender", - "description": "", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "team", - "description": "

Groups of organization members that gives permissions on specified repositories.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "

Whether team members will receive notifications when their team is @mentioned

", - "isRequired": true, - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "isRequired": true, - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - } - ], - "availability": [ - "organization", - "business", - "app" - ], - "action": "added", - "category": "membership" - }, - "removed": { - "descriptionHtml": "

An organization member was removed from a team.

", - "summaryHtml": "

This event occurs when there is activity relating to team membership. For more information, see \"About teams.\" For more information about the APIs to manage team memberships, see the GraphQL API documentation or \"Team members\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "removed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "member", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "scope", - "description": "

The scope of the membership. Currently, can only be team.

", - "isRequired": true, - "enum": [ - "team", - "organization" - ] - }, - { - "type": "object or null", - "name": "sender", - "description": "", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "team", - "description": "

Groups of organization members that gives permissions on specified repositories.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "

Whether team members will receive notifications when their team is @mentioned

", - "isRequired": true, - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "isRequired": true, - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - } - ], - "availability": [ - "organization", - "business", - "app" - ], - "action": "removed", - "category": "membership" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/meta.json b/src/webhooks/data/ghes-3.14/meta.json deleted file mode 100644 index 621006d62504..000000000000 --- a/src/webhooks/data/ghes-3.14/meta.json +++ /dev/null @@ -1,148 +0,0 @@ -{ - "deleted": { - "descriptionHtml": "

The webhook was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a webhook itself.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "hook", - "description": "

The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "active", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "config", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "content_type", - "description": "", - "isRequired": true, - "enum": [ - "json", - "form" - ] - }, - { - "type": "string", - "name": "insecure_ssl", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "secret", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

Supported values are: *, branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, create, delete, deployment, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, meta, milestone, organization, org_block, package, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, pull_request_review_thread, push, registry_package, release, repository, repository_import, repository_vulnerability_alert, secret_scanning_alert, secret_scanning_alert_location, security_and_analysis, star, status, team, team_add, watch, workflow_job, workflow_run, repository_dispatch, projects_v2_item

", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "hook_id", - "description": "

The id of the modified webhook.

", - "isRequired": true - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "marketplace", - "business", - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "meta" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/milestone.json b/src/webhooks/data/ghes-3.14/milestone.json deleted file mode 100644 index 467f9068d2d1..000000000000 --- a/src/webhooks/data/ghes-3.14/milestone.json +++ /dev/null @@ -1,1462 +0,0 @@ -{ - "closed": { - "descriptionHtml": "

A milestone was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.

\n

If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "closed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "closed", - "category": "milestone" - }, - "created": { - "descriptionHtml": "

A milestone was created.

", - "summaryHtml": "

This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.

\n

If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "milestone" - }, - "deleted": { - "descriptionHtml": "

A milestone was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.

\n

If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "milestone" - }, - "edited": { - "descriptionHtml": "

A milestone was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.

\n

If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "

The changes to the milestone if the action was edited.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "description", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the description if the action was edited.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "due_on", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the due date if the action was edited.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "title", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the title if the action was edited.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "edited", - "category": "milestone" - }, - "opened": { - "descriptionHtml": "

A milestone was opened.

", - "summaryHtml": "

This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.

\n

If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "opened" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "opened", - "category": "milestone" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/organization.json b/src/webhooks/data/ghes-3.14/organization.json deleted file mode 100644 index b3df47b5bbd8..000000000000 --- a/src/webhooks/data/ghes-3.14/organization.json +++ /dev/null @@ -1,1284 +0,0 @@ -{ - "deleted": { - "descriptionHtml": "

An organization was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.

\n

If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "membership", - "description": "

The membership between the user and the organization. Not present when the action is member_invited.

", - "childParamsGroups": [ - { - "type": "string", - "name": "organization_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "role", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "direct_membership", - "description": "

Whether the user has direct membership in the organization.

" - }, - { - "type": "array of strings", - "name": "enterprise_teams_providing_indirect_membership", - "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization", - "business", - "app" - ], - "action": "deleted", - "category": "organization" - }, - "member_added": { - "descriptionHtml": "

A member accepted an invitation to join an organization.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.

\n

If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "member_added" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "membership", - "description": "

The membership between the user and the organization. Not present when the action is member_invited.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "organization_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "role", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "direct_membership", - "description": "

Whether the user has direct membership in the organization.

" - }, - { - "type": "array of strings", - "name": "enterprise_teams_providing_indirect_membership", - "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization", - "business", - "app" - ], - "action": "member_added", - "category": "organization" - }, - "member_invited": { - "descriptionHtml": "

A member was invited to join the organization.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.

\n

If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "member_invited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "invitation", - "description": "

The invitation for the user or email if the action is member_invited.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "failed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "failed_reason", - "description": "", - "isRequired": true - }, - { - "type": "number", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "invitation_teams_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "inviter", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "role", - "description": "", - "isRequired": true - }, - { - "type": "number", - "name": "team_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "invitation_source", - "description": "" - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "user", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ], - "availability": [ - "organization", - "business", - "app" - ], - "action": "member_invited", - "category": "organization" - }, - "member_removed": { - "descriptionHtml": "

A member was removed from the organization.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.

\n

If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "member_removed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "membership", - "description": "

The membership between the user and the organization. Not present when the action is member_invited.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "organization_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "role", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "direct_membership", - "description": "

Whether the user has direct membership in the organization.

" - }, - { - "type": "array of strings", - "name": "enterprise_teams_providing_indirect_membership", - "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization", - "business", - "app" - ], - "action": "member_removed", - "category": "organization" - }, - "renamed": { - "descriptionHtml": "

The name of an organization was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.

\n

If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "renamed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "login", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "membership", - "description": "

The membership between the user and the organization. Not present when the action is member_invited.

", - "childParamsGroups": [ - { - "type": "string", - "name": "organization_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "role", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "direct_membership", - "description": "

Whether the user has direct membership in the organization.

" - }, - { - "type": "array of strings", - "name": "enterprise_teams_providing_indirect_membership", - "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization", - "business", - "app" - ], - "action": "renamed", - "category": "organization" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/package.json b/src/webhooks/data/ghes-3.14/package.json deleted file mode 100644 index 07978e7765a2..000000000000 --- a/src/webhooks/data/ghes-3.14/package.json +++ /dev/null @@ -1,1978 +0,0 @@ -{ - "published": { - "descriptionHtml": "

A package was published to a registry.

", - "summaryHtml": "

This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "published" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "package", - "description": "

Information about the package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ecosystem", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "namespace", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "package_type", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "package_version", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "author", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or object", - "name": "body", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "object or null", - "name": "container_metadata", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "labels", - "description": "" - }, - { - "type": "object or null", - "name": "manifest", - "description": "" - }, - { - "type": "object", - "name": "tag", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "digest", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "" - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "docker_metadata", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "tags", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "installation_command", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "manifest", - "description": "" - }, - { - "type": "array of objects", - "name": "metadata", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "npm_metadata", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "version", - "description": "" - }, - { - "type": "string", - "name": "npm_user", - "description": "" - }, - { - "type": "object or null", - "name": "author", - "description": "" - }, - { - "type": "object or null", - "name": "bugs", - "description": "" - }, - { - "type": "object", - "name": "dependencies", - "description": "" - }, - { - "type": "object", - "name": "dev_dependencies", - "description": "" - }, - { - "type": "object", - "name": "peer_dependencies", - "description": "" - }, - { - "type": "object", - "name": "optional_dependencies", - "description": "" - }, - { - "type": "string", - "name": "description", - "description": "" - }, - { - "type": "object or null", - "name": "dist", - "description": "" - }, - { - "type": "string", - "name": "git_head", - "description": "" - }, - { - "type": "string", - "name": "homepage", - "description": "" - }, - { - "type": "string", - "name": "license", - "description": "" - }, - { - "type": "string", - "name": "main", - "description": "" - }, - { - "type": "object or null", - "name": "repository", - "description": "" - }, - { - "type": "object", - "name": "scripts", - "description": "" - }, - { - "type": "string", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "node_version", - "description": "" - }, - { - "type": "string", - "name": "npm_version", - "description": "" - }, - { - "type": "boolean", - "name": "has_shrinkwrap", - "description": "" - }, - { - "type": "array of objects", - "name": "maintainers", - "description": "" - }, - { - "type": "array of objects", - "name": "contributors", - "description": "" - }, - { - "type": "object", - "name": "engines", - "description": "" - }, - { - "type": "array of strings", - "name": "keywords", - "description": "" - }, - { - "type": "array of strings", - "name": "files", - "description": "" - }, - { - "type": "object", - "name": "bin", - "description": "" - }, - { - "type": "object", - "name": "man", - "description": "" - }, - { - "type": "object or null", - "name": "directories", - "description": "" - }, - { - "type": "array of strings", - "name": "os", - "description": "" - }, - { - "type": "array of strings", - "name": "cpu", - "description": "" - }, - { - "type": "string", - "name": "readme", - "description": "" - }, - { - "type": "string", - "name": "installation_command", - "description": "" - }, - { - "type": "integer", - "name": "release_id", - "description": "" - }, - { - "type": "string", - "name": "commit_oid", - "description": "" - }, - { - "type": "boolean", - "name": "published_via_actions", - "description": "" - }, - { - "type": "integer", - "name": "deleted_by_id", - "description": "" - } - ] - }, - { - "type": "array of objects or null", - "name": "nuget_metadata", - "description": "", - "childParamsGroups": [ - { - "type": "integer or string", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "boolean or string or integer or object", - "name": "value", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "package_files", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "content_type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "download_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "md5", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "sha1", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "sha256", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "state", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "package_url", - "description": "" - }, - { - "type": "boolean", - "name": "prerelease", - "description": "" - }, - { - "type": "object", - "name": "release", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "author", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "prerelease", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "published_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tag_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "target_commitish", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "rubygems_metadata", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "readme", - "description": "" - }, - { - "type": "string", - "name": "homepage", - "description": "" - }, - { - "type": "object", - "name": "version_info", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "version", - "description": "" - } - ] - }, - { - "type": "string", - "name": "platform", - "description": "" - }, - { - "type": "object", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "repo", - "description": "" - }, - { - "type": "array of objects", - "name": "dependencies", - "description": "" - }, - { - "type": "string", - "name": "commit_oid", - "description": "" - } - ] - }, - { - "type": "string", - "name": "source_url", - "description": "" - }, - { - "type": "string", - "name": "summary", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tag_name", - "description": "" - }, - { - "type": "string", - "name": "target_commitish", - "description": "" - }, - { - "type": "string", - "name": "target_oid", - "description": "" - }, - { - "type": "string", - "name": "updated_at", - "description": "" - }, - { - "type": "string", - "name": "version", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "registry", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "about_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "vendor", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization" - ], - "action": "published", - "category": "package" - }, - "updated": { - "descriptionHtml": "

A previously published package was updated.

", - "summaryHtml": "

This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "updated" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "package", - "description": "

Information about the package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ecosystem", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "namespace", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "package_type", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "package_version", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "author", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "body_html", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "docker_metadata", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "tags", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "installation_command", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "manifest", - "description": "" - }, - { - "type": "array of objects", - "name": "metadata", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "package_files", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "content_type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "download_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "md5", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "sha1", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha256", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "package_url", - "description": "" - }, - { - "type": "boolean", - "name": "prerelease", - "description": "" - }, - { - "type": "object", - "name": "release", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "author", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "prerelease", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "published_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tag_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "target_commitish", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "rubygems_metadata", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "readme", - "description": "" - }, - { - "type": "string", - "name": "homepage", - "description": "" - }, - { - "type": "object", - "name": "version_info", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "version", - "description": "" - } - ] - }, - { - "type": "string", - "name": "platform", - "description": "" - }, - { - "type": "object", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "repo", - "description": "" - }, - { - "type": "array of objects", - "name": "dependencies", - "description": "" - }, - { - "type": "string", - "name": "commit_oid", - "description": "" - } - ] - }, - { - "type": "string", - "name": "source_url", - "description": "" - }, - { - "type": "string", - "name": "summary", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tag_name", - "description": "" - }, - { - "type": "string", - "name": "target_commitish", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "target_oid", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "version", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "registry", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "about_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "vendor", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization" - ], - "action": "updated", - "category": "package" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/page_build.json b/src/webhooks/data/ghes-3.14/page_build.json deleted file mode 100644 index 1f31adc8c08e..000000000000 --- a/src/webhooks/data/ghes-3.14/page_build.json +++ /dev/null @@ -1,236 +0,0 @@ -{ - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"Configuring a publishing source for your GitHub Pages site.\" For information about the API to manage GitHub Pages, see \"Pages\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "build", - "description": "

The List GitHub Pages builds itself.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "duration", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "error", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "message", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "pusher", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "status", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "page_build" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/personal_access_token_request.json b/src/webhooks/data/ghes-3.14/personal_access_token_request.json deleted file mode 100644 index 9dcc35772c0a..000000000000 --- a/src/webhooks/data/ghes-3.14/personal_access_token_request.json +++ /dev/null @@ -1,1437 +0,0 @@ -{ - "approved": { - "descriptionHtml": "

A fine-grained personal access token request was approved.

", - "summaryHtml": "

This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "approved" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "personal_access_token_request", - "description": "

Details of a Personal Access Token Request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the request for access via fine-grained personal access token. Used as the pat_request_id parameter in the list and review API calls.

", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions_added", - "description": "

New requested permissions, categorized by type of permission.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "organization", - "description": "" - }, - { - "type": "object", - "name": "repository", - "description": "" - }, - { - "type": "object", - "name": "other", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions_upgraded", - "description": "

Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "organization", - "description": "" - }, - { - "type": "object", - "name": "repository", - "description": "" - }, - { - "type": "object", - "name": "other", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions_result", - "description": "

Permissions requested, categorized by type of permission. This field incorporates permissions_added and permissions_upgraded.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "organization", - "description": "" - }, - { - "type": "object", - "name": "repository", - "description": "" - }, - { - "type": "object", - "name": "other", - "description": "" - } - ] - }, - { - "type": "string", - "name": "repository_selection", - "description": "

Type of repository selection requested.

", - "isRequired": true, - "enum": [ - "none", - "all", - "subset" - ] - }, - { - "type": "integer or null", - "name": "repository_count", - "description": "

The number of repositories the token is requesting access to. This field is only populated when repository_selection is subset.

", - "isRequired": true - }, - { - "type": "array of objects or null", - "name": "repositories", - "description": "

An array of repository objects the token is requesting access to. This field is only populated when repository_selection is subset.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

Date and time when the request for access was created.

", - "isRequired": true - }, - { - "type": "integer", - "name": "token_id", - "description": "

Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants.

", - "isRequired": true - }, - { - "type": "string", - "name": "token_name", - "description": "

The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "token_expired", - "description": "

Whether the associated fine-grained personal access token has expired.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "token_expires_at", - "description": "

Date and time when the associated fine-grained personal access token expires.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "token_last_used_at", - "description": "

Date and time when the associated fine-grained personal access token was last used for authentication.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app", - "organization" - ], - "action": "approved", - "category": "personal_access_token_request" - }, - "cancelled": { - "descriptionHtml": "

A fine-grained personal access token request was cancelled by the requester.

", - "summaryHtml": "

This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "cancelled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "personal_access_token_request", - "description": "

Details of a Personal Access Token Request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the request for access via fine-grained personal access token. Used as the pat_request_id parameter in the list and review API calls.

", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions_added", - "description": "

New requested permissions, categorized by type of permission.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "organization", - "description": "" - }, - { - "type": "object", - "name": "repository", - "description": "" - }, - { - "type": "object", - "name": "other", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions_upgraded", - "description": "

Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "organization", - "description": "" - }, - { - "type": "object", - "name": "repository", - "description": "" - }, - { - "type": "object", - "name": "other", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions_result", - "description": "

Permissions requested, categorized by type of permission. This field incorporates permissions_added and permissions_upgraded.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "organization", - "description": "" - }, - { - "type": "object", - "name": "repository", - "description": "" - }, - { - "type": "object", - "name": "other", - "description": "" - } - ] - }, - { - "type": "string", - "name": "repository_selection", - "description": "

Type of repository selection requested.

", - "isRequired": true, - "enum": [ - "none", - "all", - "subset" - ] - }, - { - "type": "integer or null", - "name": "repository_count", - "description": "

The number of repositories the token is requesting access to. This field is only populated when repository_selection is subset.

", - "isRequired": true - }, - { - "type": "array of objects or null", - "name": "repositories", - "description": "

An array of repository objects the token is requesting access to. This field is only populated when repository_selection is subset.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

Date and time when the request for access was created.

", - "isRequired": true - }, - { - "type": "integer", - "name": "token_id", - "description": "

Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants.

", - "isRequired": true - }, - { - "type": "string", - "name": "token_name", - "description": "

The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "token_expired", - "description": "

Whether the associated fine-grained personal access token has expired.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "token_expires_at", - "description": "

Date and time when the associated fine-grained personal access token expires.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "token_last_used_at", - "description": "

Date and time when the associated fine-grained personal access token was last used for authentication.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app", - "organization" - ], - "action": "cancelled", - "category": "personal_access_token_request" - }, - "created": { - "descriptionHtml": "

A fine-grained personal access token request was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "personal_access_token_request", - "description": "

Details of a Personal Access Token Request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the request for access via fine-grained personal access token. Used as the pat_request_id parameter in the list and review API calls.

", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions_added", - "description": "

New requested permissions, categorized by type of permission.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "organization", - "description": "" - }, - { - "type": "object", - "name": "repository", - "description": "" - }, - { - "type": "object", - "name": "other", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions_upgraded", - "description": "

Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "organization", - "description": "" - }, - { - "type": "object", - "name": "repository", - "description": "" - }, - { - "type": "object", - "name": "other", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions_result", - "description": "

Permissions requested, categorized by type of permission. This field incorporates permissions_added and permissions_upgraded.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "organization", - "description": "" - }, - { - "type": "object", - "name": "repository", - "description": "" - }, - { - "type": "object", - "name": "other", - "description": "" - } - ] - }, - { - "type": "string", - "name": "repository_selection", - "description": "

Type of repository selection requested.

", - "isRequired": true, - "enum": [ - "none", - "all", - "subset" - ] - }, - { - "type": "integer or null", - "name": "repository_count", - "description": "

The number of repositories the token is requesting access to. This field is only populated when repository_selection is subset.

", - "isRequired": true - }, - { - "type": "array of objects or null", - "name": "repositories", - "description": "

An array of repository objects the token is requesting access to. This field is only populated when repository_selection is subset.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

Date and time when the request for access was created.

", - "isRequired": true - }, - { - "type": "integer", - "name": "token_id", - "description": "

Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants.

", - "isRequired": true - }, - { - "type": "string", - "name": "token_name", - "description": "

The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "token_expired", - "description": "

Whether the associated fine-grained personal access token has expired.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "token_expires_at", - "description": "

Date and time when the associated fine-grained personal access token expires.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "token_last_used_at", - "description": "

Date and time when the associated fine-grained personal access token was last used for authentication.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - } - ], - "availability": [ - "app", - "organization" - ], - "action": "created", - "category": "personal_access_token_request" - }, - "denied": { - "descriptionHtml": "

A fine-grained personal access token request was denied.

", - "summaryHtml": "

This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "denied" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "personal_access_token_request", - "description": "

Details of a Personal Access Token Request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the request for access via fine-grained personal access token. Used as the pat_request_id parameter in the list and review API calls.

", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions_added", - "description": "

New requested permissions, categorized by type of permission.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "organization", - "description": "" - }, - { - "type": "object", - "name": "repository", - "description": "" - }, - { - "type": "object", - "name": "other", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions_upgraded", - "description": "

Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "organization", - "description": "" - }, - { - "type": "object", - "name": "repository", - "description": "" - }, - { - "type": "object", - "name": "other", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions_result", - "description": "

Permissions requested, categorized by type of permission. This field incorporates permissions_added and permissions_upgraded.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "organization", - "description": "" - }, - { - "type": "object", - "name": "repository", - "description": "" - }, - { - "type": "object", - "name": "other", - "description": "" - } - ] - }, - { - "type": "string", - "name": "repository_selection", - "description": "

Type of repository selection requested.

", - "isRequired": true, - "enum": [ - "none", - "all", - "subset" - ] - }, - { - "type": "integer or null", - "name": "repository_count", - "description": "

The number of repositories the token is requesting access to. This field is only populated when repository_selection is subset.

", - "isRequired": true - }, - { - "type": "array of objects or null", - "name": "repositories", - "description": "

An array of repository objects the token is requesting access to. This field is only populated when repository_selection is subset.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

Date and time when the request for access was created.

", - "isRequired": true - }, - { - "type": "integer", - "name": "token_id", - "description": "

Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants.

", - "isRequired": true - }, - { - "type": "string", - "name": "token_name", - "description": "

The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "token_expired", - "description": "

Whether the associated fine-grained personal access token has expired.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "token_expires_at", - "description": "

Date and time when the associated fine-grained personal access token expires.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "token_last_used_at", - "description": "

Date and time when the associated fine-grained personal access token was last used for authentication.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app", - "organization" - ], - "action": "denied", - "category": "personal_access_token_request" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/ping.json b/src/webhooks/data/ghes-3.14/ping.json deleted file mode 100644 index 12689a9fabb8..000000000000 --- a/src/webhooks/data/ghes-3.14/ping.json +++ /dev/null @@ -1,175 +0,0 @@ -{ - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.

", - "bodyParameters": [ - { - "type": "object", - "name": "hook", - "description": "

The webhook that is being pinged

", - "childParamsGroups": [ - { - "type": "boolean", - "name": "active", - "description": "

Determines whether the hook is actually triggered for the events it subscribes to.

", - "isRequired": true - }, - { - "type": "integer", - "name": "app_id", - "description": "

Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app.

" - }, - { - "type": "object", - "name": "config", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "content_type", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

" - }, - { - "type": "string or number", - "name": "insecure_ssl", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - }, - { - "type": "string", - "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" - }, - { - "type": "string", - "name": "url", - "description": "

The URL to which the payloads will be delivered.

" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deliveries_url", - "description": "" - }, - { - "type": "array of strings", - "name": "events", - "description": "

Determines what events the hook is triggered for. Default: ['push'].

", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the webhook.

", - "isRequired": true - }, - { - "type": "object", - "name": "last_response", - "description": "", - "childParamsGroups": [ - { - "type": "integer or null", - "name": "code", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "status", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "message", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "name", - "description": "

The type of webhook. The only valid value is 'web'.

", - "isRequired": true, - "enum": [ - "web" - ] - }, - { - "type": "string", - "name": "ping_url", - "description": "" - }, - { - "type": "string", - "name": "test_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "hook_id", - "description": "

The ID of the webhook that triggered the ping.

" - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "zen", - "description": "

Random string of GitHub zen.

" - } - ], - "availability": [ - "repository", - "organization", - "app", - "business", - "marketplace" - ], - "action": "default", - "category": "ping" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/project.json b/src/webhooks/data/ghes-3.14/project.json deleted file mode 100644 index 5061a15cbe81..000000000000 --- a/src/webhooks/data/ghes-3.14/project.json +++ /dev/null @@ -1,1348 +0,0 @@ -{ - "closed": { - "descriptionHtml": "

A project (classic) was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "closed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "project", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "body", - "description": "

Body of the project

", - "isRequired": true - }, - { - "type": "string", - "name": "columns_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the project

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "owner_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of the project; either 'open' or 'closed'

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "closed", - "category": "project" - }, - "created": { - "descriptionHtml": "

A project (classic) was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "project", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "body", - "description": "

Body of the project

", - "isRequired": true - }, - { - "type": "string", - "name": "columns_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the project

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "owner_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of the project; either 'open' or 'closed'

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "project" - }, - "deleted": { - "descriptionHtml": "

A project (classic) was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "project", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "body", - "description": "

Body of the project

", - "isRequired": true - }, - { - "type": "string", - "name": "columns_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the project

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "owner_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of the project; either 'open' or 'closed'

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "project" - }, - "edited": { - "descriptionHtml": "

The name or description of a project (classic) was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "

The changes to the project if the action was edited.

", - "childParamsGroups": [ - { - "type": "object", - "name": "body", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the body if the action was edited.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "name", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The changes to the project if the action was edited.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "project", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "body", - "description": "

Body of the project

", - "isRequired": true - }, - { - "type": "string", - "name": "columns_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the project

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "owner_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of the project; either 'open' or 'closed'

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "edited", - "category": "project" - }, - "reopened": { - "descriptionHtml": "

A project (classic) was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "reopened" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "project", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "body", - "description": "

Body of the project

", - "isRequired": true - }, - { - "type": "string", - "name": "columns_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the project

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "owner_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of the project; either 'open' or 'closed'

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "reopened", - "category": "project" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/project_card.json b/src/webhooks/data/ghes-3.14/project_card.json deleted file mode 100644 index 5c906ec8e714..000000000000 --- a/src/webhooks/data/ghes-3.14/project_card.json +++ /dev/null @@ -1,1355 +0,0 @@ -{ - "converted": { - "descriptionHtml": "

A note in a project (classic) was converted to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "converted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "note", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "project_card", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer or null", - "name": "after_id", - "description": "" - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether or not the card is archived

", - "isRequired": true - }, - { - "type": "integer", - "name": "column_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "column_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "content_url", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "id", - "description": "

The project card's ID

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "note", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "project_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "converted", - "category": "project_card" - }, - "created": { - "descriptionHtml": "

A card was added to a project (classic).

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "project_card", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer or null", - "name": "after_id", - "description": "" - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether or not the card is archived

", - "isRequired": true - }, - { - "type": "integer", - "name": "column_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "column_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "content_url", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "id", - "description": "

The project card's ID

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "note", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "project_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "project_card" - }, - "deleted": { - "descriptionHtml": "

A card on a project (classic) was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "project_card", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer or null", - "name": "after_id", - "description": "" - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether or not the card is archived

", - "isRequired": true - }, - { - "type": "integer or null", - "name": "column_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "column_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "content_url", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "id", - "description": "

The project card's ID

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "note", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "project_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "project_card" - }, - "edited": { - "descriptionHtml": "

A note on a project (classic) was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "note", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "project_card", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer or null", - "name": "after_id", - "description": "" - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether or not the card is archived

", - "isRequired": true - }, - { - "type": "integer", - "name": "column_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "column_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "content_url", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "id", - "description": "

The project card's ID

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "note", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "project_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "edited", - "category": "project_card" - }, - "moved": { - "descriptionHtml": "

A card on a project (classic) was moved to another column or to another position in its column.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "moved" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "column_id", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "from", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "project_card", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number or null", - "name": "after_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether or not the card is archived

", - "isRequired": true - }, - { - "type": "integer", - "name": "column_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "column_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "content_url", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "id", - "description": "

The project card's ID

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "note", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "project_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "moved", - "category": "project_card" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/project_column.json b/src/webhooks/data/ghes-3.14/project_column.json deleted file mode 100644 index b4e2880197d3..000000000000 --- a/src/webhooks/data/ghes-3.14/project_column.json +++ /dev/null @@ -1,480 +0,0 @@ -{ - "created": { - "descriptionHtml": "

A column was added to a project (classic).

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "project_column", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer or null", - "name": "after_id", - "description": "" - }, - { - "type": "string", - "name": "cards_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the project column

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the project column

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "project_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "project_column" - }, - "deleted": { - "descriptionHtml": "

A column was deleted from a project (classic).

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "project_column", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer or null", - "name": "after_id", - "description": "" - }, - { - "type": "string", - "name": "cards_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the project column

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the project column

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "project_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "project_column" - }, - "edited": { - "descriptionHtml": "

The name of a column on a project (classic) was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "name", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "project_column", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer or null", - "name": "after_id", - "description": "" - }, - { - "type": "string", - "name": "cards_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the project column

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the project column

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "project_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "edited", - "category": "project_column" - }, - "moved": { - "descriptionHtml": "

A column was moved to a new position on a project (classic).

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "moved" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "project_column", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer or null", - "name": "after_id", - "description": "" - }, - { - "type": "string", - "name": "cards_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the project column

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the project column

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "project_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "moved", - "category": "project_column" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/projects_v2.json b/src/webhooks/data/ghes-3.14/projects_v2.json deleted file mode 100644 index ac7b4b980c9a..000000000000 --- a/src/webhooks/data/ghes-3.14/projects_v2.json +++ /dev/null @@ -1,3758 +0,0 @@ -{ - "closed": { - "descriptionHtml": "

A project in the organization was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "closed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2", - "description": "

A projects v2 project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "

The unique identifier of the project.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the project.

", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "title", - "description": "

The project title.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

A short description of the project.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "

Whether the project is visible to anyone with access to the owner.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "

The time when the project was closed.

", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "

The time when the project was created.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time when the project was last updated.

", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The project number.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "short_description", - "description": "

A concise summary of the project.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "deleted_at", - "description": "

The time when the project was deleted.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "deleted_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the project.

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "object or null", - "name": "latest_status_update", - "description": "

An status update belonging to a project

", - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "

The unique identifier of the status update.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the status update.

", - "isRequired": true - }, - { - "type": "string", - "name": "project_node_id", - "description": "

The node ID of the project that this status update belongs to.

" - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time when the status update was created.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time when the status update was last updated.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "status", - "description": "

The current status.

", - "enum": [ - "INACTIVE", - "ON_TRACK", - "AT_RISK", - "OFF_TRACK", - "COMPLETE", - null - ] - }, - { - "type": "string", - "name": "start_date", - "description": "

The start date of the period covered by the update.

" - }, - { - "type": "string", - "name": "target_date", - "description": "

The target date associated with the update.

" - }, - { - "type": "string or null", - "name": "body", - "description": "

Body of the status update

" - } - ] - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this project is a template

" - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "closed", - "category": "projects_v2" - }, - "created": { - "descriptionHtml": "

A project in the organization was created.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2", - "description": "

A projects v2 project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "

The unique identifier of the project.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the project.

", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "title", - "description": "

The project title.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

A short description of the project.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "

Whether the project is visible to anyone with access to the owner.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "

The time when the project was closed.

", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "

The time when the project was created.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time when the project was last updated.

", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The project number.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "short_description", - "description": "

A concise summary of the project.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "deleted_at", - "description": "

The time when the project was deleted.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "deleted_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the project.

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "object or null", - "name": "latest_status_update", - "description": "

An status update belonging to a project

", - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "

The unique identifier of the status update.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the status update.

", - "isRequired": true - }, - { - "type": "string", - "name": "project_node_id", - "description": "

The node ID of the project that this status update belongs to.

" - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time when the status update was created.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time when the status update was last updated.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "status", - "description": "

The current status.

", - "enum": [ - "INACTIVE", - "ON_TRACK", - "AT_RISK", - "OFF_TRACK", - "COMPLETE", - null - ] - }, - { - "type": "string", - "name": "start_date", - "description": "

The start date of the period covered by the update.

" - }, - { - "type": "string", - "name": "target_date", - "description": "

The target date associated with the update.

" - }, - { - "type": "string or null", - "name": "body", - "description": "

Body of the status update

" - } - ] - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this project is a template

" - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "created", - "category": "projects_v2" - }, - "deleted": { - "descriptionHtml": "

A project in the organization was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2", - "description": "

A projects v2 project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "

The unique identifier of the project.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the project.

", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "title", - "description": "

The project title.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

A short description of the project.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "

Whether the project is visible to anyone with access to the owner.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "

The time when the project was closed.

", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "

The time when the project was created.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time when the project was last updated.

", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The project number.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "short_description", - "description": "

A concise summary of the project.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "deleted_at", - "description": "

The time when the project was deleted.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "deleted_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the project.

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "object or null", - "name": "latest_status_update", - "description": "

An status update belonging to a project

", - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "

The unique identifier of the status update.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the status update.

", - "isRequired": true - }, - { - "type": "string", - "name": "project_node_id", - "description": "

The node ID of the project that this status update belongs to.

" - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time when the status update was created.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time when the status update was last updated.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "status", - "description": "

The current status.

", - "enum": [ - "INACTIVE", - "ON_TRACK", - "AT_RISK", - "OFF_TRACK", - "COMPLETE", - null - ] - }, - { - "type": "string", - "name": "start_date", - "description": "

The start date of the period covered by the update.

" - }, - { - "type": "string", - "name": "target_date", - "description": "

The target date associated with the update.

" - }, - { - "type": "string or null", - "name": "body", - "description": "

Body of the status update

" - } - ] - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this project is a template

" - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "deleted", - "category": "projects_v2" - }, - "edited": { - "descriptionHtml": "

The title, description, or README of a project in the organization was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "description", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "" - }, - { - "type": "string or null", - "name": "to", - "description": "" - } - ] - }, - { - "type": "object", - "name": "public", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "from", - "description": "" - }, - { - "type": "boolean", - "name": "to", - "description": "" - } - ] - }, - { - "type": "object", - "name": "short_description", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "" - }, - { - "type": "string or null", - "name": "to", - "description": "" - } - ] - }, - { - "type": "object", - "name": "title", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "" - }, - { - "type": "string", - "name": "to", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2", - "description": "

A projects v2 project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "

The unique identifier of the project.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the project.

", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "title", - "description": "

The project title.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

A short description of the project.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "

Whether the project is visible to anyone with access to the owner.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "

The time when the project was closed.

", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "

The time when the project was created.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time when the project was last updated.

", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The project number.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "short_description", - "description": "

A concise summary of the project.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "deleted_at", - "description": "

The time when the project was deleted.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "deleted_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the project.

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "object or null", - "name": "latest_status_update", - "description": "

An status update belonging to a project

", - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "

The unique identifier of the status update.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the status update.

", - "isRequired": true - }, - { - "type": "string", - "name": "project_node_id", - "description": "

The node ID of the project that this status update belongs to.

" - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time when the status update was created.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time when the status update was last updated.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "status", - "description": "

The current status.

", - "enum": [ - "INACTIVE", - "ON_TRACK", - "AT_RISK", - "OFF_TRACK", - "COMPLETE", - null - ] - }, - { - "type": "string", - "name": "start_date", - "description": "

The start date of the period covered by the update.

" - }, - { - "type": "string", - "name": "target_date", - "description": "

The target date associated with the update.

" - }, - { - "type": "string or null", - "name": "body", - "description": "

Body of the status update

" - } - ] - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this project is a template

" - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "edited", - "category": "projects_v2" - }, - "reopened": { - "descriptionHtml": "

A project in the organization was reopened.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "reopened" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2", - "description": "

A projects v2 project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "

The unique identifier of the project.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the project.

", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "title", - "description": "

The project title.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

A short description of the project.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "

Whether the project is visible to anyone with access to the owner.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "

The time when the project was closed.

", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "

The time when the project was created.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time when the project was last updated.

", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The project number.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "short_description", - "description": "

A concise summary of the project.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "deleted_at", - "description": "

The time when the project was deleted.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "deleted_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

The current state of the project.

", - "enum": [ - "open", - "closed" - ] - }, - { - "type": "object or null", - "name": "latest_status_update", - "description": "

An status update belonging to a project

", - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "

The unique identifier of the status update.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the status update.

", - "isRequired": true - }, - { - "type": "string", - "name": "project_node_id", - "description": "

The node ID of the project that this status update belongs to.

" - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time when the status update was created.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time when the status update was last updated.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "status", - "description": "

The current status.

", - "enum": [ - "INACTIVE", - "ON_TRACK", - "AT_RISK", - "OFF_TRACK", - "COMPLETE", - null - ] - }, - { - "type": "string", - "name": "start_date", - "description": "

The start date of the period covered by the update.

" - }, - { - "type": "string", - "name": "target_date", - "description": "

The target date associated with the update.

" - }, - { - "type": "string or null", - "name": "body", - "description": "

Body of the status update

" - } - ] - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this project is a template

" - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "reopened", - "category": "projects_v2" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/projects_v2_item.json b/src/webhooks/data/ghes-3.14/projects_v2_item.json deleted file mode 100644 index c37c3ccba803..000000000000 --- a/src/webhooks/data/ghes-3.14/projects_v2_item.json +++ /dev/null @@ -1,1825 +0,0 @@ -{ - "archived": { - "descriptionHtml": "

An item on an organization project was archived. For more information, see \"Archiving items from your project.\"

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "archived" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "archived_at", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "" - }, - { - "type": "string or null", - "name": "to", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "

The unique identifier of the project item.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the project item.

" - }, - { - "type": "string", - "name": "project_node_id", - "description": "

The node ID of the project that contains this item.

" - }, - { - "type": "string", - "name": "content_node_id", - "description": "

The node ID of the content represented by this item.

", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", - "isRequired": true, - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time when the item was created.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time when the item was last updated.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "archived_at", - "description": "

The time when the item was archived.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "archived", - "category": "projects_v2_item" - }, - "converted": { - "descriptionHtml": "

A draft issue in an organization project was converted to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "converted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "content_type", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "" - }, - { - "type": "string", - "name": "to", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "

The unique identifier of the project item.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the project item.

" - }, - { - "type": "string", - "name": "project_node_id", - "description": "

The node ID of the project that contains this item.

" - }, - { - "type": "string", - "name": "content_node_id", - "description": "

The node ID of the content represented by this item.

", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", - "isRequired": true, - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time when the item was created.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time when the item was last updated.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "archived_at", - "description": "

The time when the item was archived.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "converted", - "category": "projects_v2_item" - }, - "created": { - "descriptionHtml": "

An item was added to a project in the organization.

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "

The unique identifier of the project item.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the project item.

" - }, - { - "type": "string", - "name": "project_node_id", - "description": "

The node ID of the project that contains this item.

" - }, - { - "type": "string", - "name": "content_node_id", - "description": "

The node ID of the content represented by this item.

", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", - "isRequired": true, - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time when the item was created.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time when the item was last updated.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "archived_at", - "description": "

The time when the item was archived.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "created", - "category": "projects_v2_item" - }, - "deleted": { - "descriptionHtml": "

An item was deleted from a project in the organization.

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "

The unique identifier of the project item.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the project item.

" - }, - { - "type": "string", - "name": "project_node_id", - "description": "

The node ID of the project that contains this item.

" - }, - { - "type": "string", - "name": "content_node_id", - "description": "

The node ID of the content represented by this item.

", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", - "isRequired": true, - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time when the item was created.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time when the item was last updated.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "archived_at", - "description": "

The time when the item was archived.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "deleted", - "category": "projects_v2_item" - }, - "edited": { - "descriptionHtml": "

The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "

The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.

", - "childParamsGroups": [ - { - "type": "object", - "name": "", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "field_value", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "field_node_id", - "description": "" - }, - { - "type": "string", - "name": "field_type", - "description": "" - }, - { - "type": "string", - "name": "field_name", - "description": "" - }, - { - "type": "integer", - "name": "project_number", - "description": "" - }, - { - "type": "null or string or integer or object", - "name": "from", - "description": "" - }, - { - "type": "null or string or integer or object", - "name": "to", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "" - }, - { - "type": "string or null", - "name": "to", - "description": "" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "

The unique identifier of the project item.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the project item.

" - }, - { - "type": "string", - "name": "project_node_id", - "description": "

The node ID of the project that contains this item.

" - }, - { - "type": "string", - "name": "content_node_id", - "description": "

The node ID of the content represented by this item.

", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", - "isRequired": true, - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time when the item was created.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time when the item was last updated.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "archived_at", - "description": "

The time when the item was archived.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "edited", - "category": "projects_v2_item" - }, - "reordered": { - "descriptionHtml": "

The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "reordered" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "previous_projects_v2_item_node_id", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "" - }, - { - "type": "string or null", - "name": "to", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "

The unique identifier of the project item.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the project item.

" - }, - { - "type": "string", - "name": "project_node_id", - "description": "

The node ID of the project that contains this item.

" - }, - { - "type": "string", - "name": "content_node_id", - "description": "

The node ID of the content represented by this item.

", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", - "isRequired": true, - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time when the item was created.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time when the item was last updated.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "archived_at", - "description": "

The time when the item was archived.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "reordered", - "category": "projects_v2_item" - }, - "restored": { - "descriptionHtml": "

An archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "restored" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "archived_at", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "" - }, - { - "type": "string or null", - "name": "to", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "

The unique identifier of the project item.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the project item.

" - }, - { - "type": "string", - "name": "project_node_id", - "description": "

The node ID of the project that contains this item.

" - }, - { - "type": "string", - "name": "content_node_id", - "description": "

The node ID of the content represented by this item.

", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", - "isRequired": true, - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time when the item was created.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time when the item was last updated.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "archived_at", - "description": "

The time when the item was archived.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "restored", - "category": "projects_v2_item" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/public.json b/src/webhooks/data/ghes-3.14/public.json deleted file mode 100644 index 42e336cf8ad9..000000000000 --- a/src/webhooks/data/ghes-3.14/public.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when repository visibility changes from private to public. For more information, see \"Setting repository visibility.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "public" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/pull_request.json b/src/webhooks/data/ghes-3.14/pull_request.json deleted file mode 100644 index cbae533d9c58..000000000000 --- a/src/webhooks/data/ghes-3.14/pull_request.json +++ /dev/null @@ -1,66173 +0,0 @@ -{ - "assigned": { - "descriptionHtml": "

A pull request was assigned to a user.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "assigned" - ], - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "integer", - "name": "additions", - "description": "" - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "" - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "" - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "" - }, - { - "type": "boolean or null", - "name": "merged", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "" - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "assigned", - "category": "pull_request" - }, - "auto_merge_disabled": { - "descriptionHtml": "

Auto merge was disabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "auto_merge_disabled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "integer", - "name": "additions", - "description": "" - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "" - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "" - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "" - }, - { - "type": "boolean or null", - "name": "merged", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "" - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "reason", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "auto_merge_disabled", - "category": "pull_request" - }, - "auto_merge_enabled": { - "descriptionHtml": "

Auto merge was enabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "auto_merge_enabled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "integer", - "name": "additions", - "description": "" - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "" - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "" - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "" - }, - { - "type": "boolean or null", - "name": "merged", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "" - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "reason", - "description": "" - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "auto_merge_enabled", - "category": "pull_request" - }, - "closed": { - "descriptionHtml": "

A pull request was closed. If merged is false in the webhook payload, the pull request was closed with unmerged commits. If merged is true in the webhook payload, the pull request was merged.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "closed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "assignee", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "assignees", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "requested_reviewers", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "

The level of privacy this team should have

" - }, - { - "type": "string", - "name": "notification_setting", - "description": "

The notification setting the team has set

" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ldap_dn", - "description": "

Distinguished Name (DN) that team maps to within LDAP environment

" - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "isRequired": true, - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "

License Simple

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - } - ] - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", - "default": false - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository disabled.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

The repository visibility: public, private, or internal.

", - "default": "public" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow Auto-merge to be used on pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

", - "default": false - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow forking this repo

" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

", - "default": false - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "boolean", - "name": "anonymous_access_enabled", - "description": "

Whether anonymous git access is enabled for this repository

" - }, - { - "type": "object", - "name": "code_search_index_status", - "description": "

The status of the code search index for this repository

", - "childParamsGroups": [ - { - "type": "boolean", - "name": "lexical_search_ok", - "description": "" - }, - { - "type": "string", - "name": "lexical_commit_sha", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "

License Simple

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - } - ] - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", - "default": false - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository disabled.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

The repository visibility: public, private, or internal.

", - "default": "public" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow Auto-merge to be used on pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

", - "default": false - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow forking this repo

" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

", - "default": false - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "boolean", - "name": "anonymous_access_enabled", - "description": "

Whether anonymous git access is enabled for this repository

" - }, - { - "type": "object", - "name": "code_search_index_status", - "description": "

The status of the code search index for this repository

", - "childParamsGroups": [ - { - "type": "boolean", - "name": "lexical_search_ok", - "description": "" - }, - { - "type": "string", - "name": "lexical_commit_sha", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "enabled_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - { - "type": "string", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

" - }, - { - "type": "boolean", - "name": "merged", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "additions", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether to allow updating the pull request's branch.

" - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged.

", - "default": false - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "closed", - "category": "pull_request" - }, - "converted_to_draft": { - "descriptionHtml": "

A pull request was converted to a draft. For more information, see \"Changing the stage of a pull request.\"

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "converted_to_draft" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "assignee", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "assignees", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "requested_reviewers", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "

The level of privacy this team should have

" - }, - { - "type": "string", - "name": "notification_setting", - "description": "

The notification setting the team has set

" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ldap_dn", - "description": "

Distinguished Name (DN) that team maps to within LDAP environment

" - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "isRequired": true, - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "

License Simple

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - } - ] - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", - "default": false - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository disabled.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

The repository visibility: public, private, or internal.

", - "default": "public" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow Auto-merge to be used on pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

", - "default": false - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow forking this repo

" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

", - "default": false - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "boolean", - "name": "anonymous_access_enabled", - "description": "

Whether anonymous git access is enabled for this repository

" - }, - { - "type": "object", - "name": "code_search_index_status", - "description": "

The status of the code search index for this repository

", - "childParamsGroups": [ - { - "type": "boolean", - "name": "lexical_search_ok", - "description": "" - }, - { - "type": "string", - "name": "lexical_commit_sha", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "

License Simple

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - } - ] - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", - "default": false - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository disabled.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

The repository visibility: public, private, or internal.

", - "default": "public" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow Auto-merge to be used on pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

", - "default": false - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow forking this repo

" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

", - "default": false - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "boolean", - "name": "anonymous_access_enabled", - "description": "

Whether anonymous git access is enabled for this repository

" - }, - { - "type": "object", - "name": "code_search_index_status", - "description": "

The status of the code search index for this repository

", - "childParamsGroups": [ - { - "type": "boolean", - "name": "lexical_search_ok", - "description": "" - }, - { - "type": "string", - "name": "lexical_commit_sha", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "enabled_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - { - "type": "string", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

" - }, - { - "type": "boolean", - "name": "merged", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "additions", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether to allow updating the pull request's branch.

" - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged.

", - "default": false - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "converted_to_draft", - "category": "pull_request" - }, - "demilestoned": { - "descriptionHtml": "

A pull request was removed from a milestone.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "demilestoned" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "integer", - "name": "additions", - "description": "" - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "" - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "" - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "" - }, - { - "type": "boolean or null", - "name": "merged", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "" - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "demilestoned", - "category": "pull_request" - }, - "edited": { - "descriptionHtml": "

The title or body of a pull request was edited, or the base branch of a pull request was changed.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "

The changes to the comment if the action was edited.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "base", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "ref", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sha", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "body", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the body if the action was edited.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "title", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the title if the action was edited.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "assignee", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "assignees", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "requested_reviewers", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "

The level of privacy this team should have

" - }, - { - "type": "string", - "name": "notification_setting", - "description": "

The notification setting the team has set

" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ldap_dn", - "description": "

Distinguished Name (DN) that team maps to within LDAP environment

" - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "isRequired": true, - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "

License Simple

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - } - ] - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", - "default": false - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository disabled.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

The repository visibility: public, private, or internal.

", - "default": "public" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow Auto-merge to be used on pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

", - "default": false - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow forking this repo

" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

", - "default": false - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "boolean", - "name": "anonymous_access_enabled", - "description": "

Whether anonymous git access is enabled for this repository

" - }, - { - "type": "object", - "name": "code_search_index_status", - "description": "

The status of the code search index for this repository

", - "childParamsGroups": [ - { - "type": "boolean", - "name": "lexical_search_ok", - "description": "" - }, - { - "type": "string", - "name": "lexical_commit_sha", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "

License Simple

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - } - ] - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", - "default": false - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository disabled.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

The repository visibility: public, private, or internal.

", - "default": "public" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow Auto-merge to be used on pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

", - "default": false - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow forking this repo

" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

", - "default": false - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "boolean", - "name": "anonymous_access_enabled", - "description": "

Whether anonymous git access is enabled for this repository

" - }, - { - "type": "object", - "name": "code_search_index_status", - "description": "

The status of the code search index for this repository

", - "childParamsGroups": [ - { - "type": "boolean", - "name": "lexical_search_ok", - "description": "" - }, - { - "type": "string", - "name": "lexical_commit_sha", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "enabled_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - { - "type": "string", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

" - }, - { - "type": "boolean", - "name": "merged", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "additions", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether to allow updating the pull request's branch.

" - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged.

", - "default": false - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "edited", - "category": "pull_request" - }, - "labeled": { - "descriptionHtml": "

A label was added to a pull request.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "labeled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "label", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "integer", - "name": "additions", - "description": "" - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "" - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "" - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "" - }, - { - "type": "boolean or null", - "name": "merged", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "" - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "labeled", - "category": "pull_request" - }, - "locked": { - "descriptionHtml": "

Conversation on a pull request was locked. For more information, see \"Locking conversations.\"

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "locked" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "integer", - "name": "additions", - "description": "" - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "" - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "" - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "" - }, - { - "type": "boolean or null", - "name": "merged", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "" - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "locked", - "category": "pull_request" - }, - "milestoned": { - "descriptionHtml": "

A pull request was added to a milestone.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "milestoned" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "integer", - "name": "additions", - "description": "" - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "" - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "" - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "" - }, - { - "type": "boolean or null", - "name": "merged", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "" - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "milestoned", - "category": "pull_request" - }, - "opened": { - "descriptionHtml": "

A pull request was created

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "opened" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "assignee", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "assignees", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "requested_reviewers", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "

The level of privacy this team should have

" - }, - { - "type": "string", - "name": "notification_setting", - "description": "

The notification setting the team has set

" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ldap_dn", - "description": "

Distinguished Name (DN) that team maps to within LDAP environment

" - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "isRequired": true, - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "

License Simple

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - } - ] - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", - "default": false - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository disabled.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

The repository visibility: public, private, or internal.

", - "default": "public" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow Auto-merge to be used on pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

", - "default": false - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow forking this repo

" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

", - "default": false - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "boolean", - "name": "anonymous_access_enabled", - "description": "

Whether anonymous git access is enabled for this repository

" - }, - { - "type": "object", - "name": "code_search_index_status", - "description": "

The status of the code search index for this repository

", - "childParamsGroups": [ - { - "type": "boolean", - "name": "lexical_search_ok", - "description": "" - }, - { - "type": "string", - "name": "lexical_commit_sha", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "

License Simple

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - } - ] - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", - "default": false - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository disabled.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

The repository visibility: public, private, or internal.

", - "default": "public" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow Auto-merge to be used on pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

", - "default": false - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow forking this repo

" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

", - "default": false - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "boolean", - "name": "anonymous_access_enabled", - "description": "

Whether anonymous git access is enabled for this repository

" - }, - { - "type": "object", - "name": "code_search_index_status", - "description": "

The status of the code search index for this repository

", - "childParamsGroups": [ - { - "type": "boolean", - "name": "lexical_search_ok", - "description": "" - }, - { - "type": "string", - "name": "lexical_commit_sha", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "enabled_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - { - "type": "string", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

" - }, - { - "type": "boolean", - "name": "merged", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "additions", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether to allow updating the pull request's branch.

" - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged.

", - "default": false - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "opened", - "category": "pull_request" - }, - "ready_for_review": { - "descriptionHtml": "

A draft pull request was marked as ready for review. For more information, see \"Changing the stage of a pull request.\"

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "ready_for_review" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "assignee", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "assignees", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "requested_reviewers", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "

The level of privacy this team should have

" - }, - { - "type": "string", - "name": "notification_setting", - "description": "

The notification setting the team has set

" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ldap_dn", - "description": "

Distinguished Name (DN) that team maps to within LDAP environment

" - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "isRequired": true, - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "

License Simple

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - } - ] - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", - "default": false - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository disabled.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

The repository visibility: public, private, or internal.

", - "default": "public" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow Auto-merge to be used on pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

", - "default": false - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow forking this repo

" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

", - "default": false - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "boolean", - "name": "anonymous_access_enabled", - "description": "

Whether anonymous git access is enabled for this repository

" - }, - { - "type": "object", - "name": "code_search_index_status", - "description": "

The status of the code search index for this repository

", - "childParamsGroups": [ - { - "type": "boolean", - "name": "lexical_search_ok", - "description": "" - }, - { - "type": "string", - "name": "lexical_commit_sha", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "

License Simple

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - } - ] - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", - "default": false - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository disabled.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

The repository visibility: public, private, or internal.

", - "default": "public" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow Auto-merge to be used on pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

", - "default": false - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow forking this repo

" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

", - "default": false - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "boolean", - "name": "anonymous_access_enabled", - "description": "

Whether anonymous git access is enabled for this repository

" - }, - { - "type": "object", - "name": "code_search_index_status", - "description": "

The status of the code search index for this repository

", - "childParamsGroups": [ - { - "type": "boolean", - "name": "lexical_search_ok", - "description": "" - }, - { - "type": "string", - "name": "lexical_commit_sha", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "enabled_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - { - "type": "string", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

" - }, - { - "type": "boolean", - "name": "merged", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "additions", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether to allow updating the pull request's branch.

" - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged.

", - "default": false - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "ready_for_review", - "category": "pull_request" - }, - "reopened": { - "descriptionHtml": "

A previously closed pull request was reopened.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "reopened" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "assignee", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "assignees", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "requested_reviewers", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "

The level of privacy this team should have

" - }, - { - "type": "string", - "name": "notification_setting", - "description": "

The notification setting the team has set

" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ldap_dn", - "description": "

Distinguished Name (DN) that team maps to within LDAP environment

" - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "isRequired": true, - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "

License Simple

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - } - ] - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", - "default": false - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository disabled.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

The repository visibility: public, private, or internal.

", - "default": "public" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow Auto-merge to be used on pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

", - "default": false - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow forking this repo

" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

", - "default": false - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "boolean", - "name": "anonymous_access_enabled", - "description": "

Whether anonymous git access is enabled for this repository

" - }, - { - "type": "object", - "name": "code_search_index_status", - "description": "

The status of the code search index for this repository

", - "childParamsGroups": [ - { - "type": "boolean", - "name": "lexical_search_ok", - "description": "" - }, - { - "type": "string", - "name": "lexical_commit_sha", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "

License Simple

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - } - ] - }, - { - "type": "object", - "name": "owner", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "

Whether this repository acts as a template that can be used to generate new repositories.

", - "default": false - }, - { - "type": "array of strings", - "name": "topics", - "description": "" - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository disabled.

", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "

The repository visibility: public, private, or internal.

", - "default": "public" - }, - { - "type": "string or null", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "string", - "name": "temp_clone_token", - "description": "" - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow Auto-merge to be used on pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

", - "default": false - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow forking this repo

" - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

", - "default": false - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "boolean", - "name": "anonymous_access_enabled", - "description": "

Whether anonymous git access is enabled for this repository

" - }, - { - "type": "object", - "name": "code_search_index_status", - "description": "

The status of the code search index for this repository

", - "childParamsGroups": [ - { - "type": "boolean", - "name": "lexical_search_ok", - "description": "" - }, - { - "type": "string", - "name": "lexical_commit_sha", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "user", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "

Hypermedia Link

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "enabled_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - { - "type": "string", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

" - }, - { - "type": "boolean", - "name": "merged", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "additions", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "

Whether to allow updating the pull request's branch.

" - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged.

", - "default": false - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "reopened", - "category": "pull_request" - }, - "review_request_removed": { - "descriptionHtml": "

A request for review by a person or team was removed from a pull request.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "review_request_removed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "integer", - "name": "additions", - "description": "" - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "" - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "" - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "" - }, - { - "type": "boolean or null", - "name": "merged", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "" - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "requested_reviewer", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "requested_team", - "description": "

Groups of organization members that gives permissions on specified repositories.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "review_request_removed", - "category": "pull_request" - }, - "review_requested": { - "descriptionHtml": "

Review by a person or team was requested for a pull request. For more information, see \"Requesting a pull request review.\"

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "review_requested" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "integer", - "name": "additions", - "description": "" - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "" - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "" - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "" - }, - { - "type": "boolean or null", - "name": "merged", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "" - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "requested_reviewer", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "requested_team", - "description": "

Groups of organization members that gives permissions on specified repositories.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "review_requested", - "category": "pull_request" - }, - "synchronize": { - "descriptionHtml": "

A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "synchronize" - ], - "childParamsGroups": [] - }, - { - "type": "string", - "name": "after", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "before", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "integer", - "name": "additions", - "description": "" - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "" - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "" - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit message title.

", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "" - }, - { - "type": "boolean or null", - "name": "merged", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "" - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "synchronize", - "category": "pull_request" - }, - "unassigned": { - "descriptionHtml": "

A user was unassigned from a pull request.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "unassigned" - ], - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "integer", - "name": "additions", - "description": "" - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "" - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "" - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "" - }, - { - "type": "boolean or null", - "name": "merged", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "" - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unassigned", - "category": "pull_request" - }, - "unlabeled": { - "descriptionHtml": "

A label was removed from a pull request.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "unlabeled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "label", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "integer", - "name": "additions", - "description": "" - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "" - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "" - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit message title.

", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "" - }, - { - "type": "boolean or null", - "name": "merged", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "" - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unlabeled", - "category": "pull_request" - }, - "unlocked": { - "descriptionHtml": "

Conversation on a pull request was unlocked. For more information, see \"Locking conversations.\"

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "unlocked" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "integer", - "name": "additions", - "description": "" - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "changed_files", - "description": "" - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "comments", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "commits", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "deletions", - "description": "" - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "

Indicates whether or not the pull request is a draft.

", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "mergeable", - "description": "" - }, - { - "type": "string", - "name": "mergeable_state", - "description": "" - }, - { - "type": "boolean or null", - "name": "merged", - "description": "" - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "merged_by", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

Number uniquely identifying the pull request within its repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean or null", - "name": "rebaseable", - "description": "" - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "review_comments", - "description": "" - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of this Pull Request. Either open or closed.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "

The title of the pull request.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unlocked", - "category": "pull_request" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/pull_request_review.json b/src/webhooks/data/ghes-3.14/pull_request_review.json deleted file mode 100644 index d11526b28d28..000000000000 --- a/src/webhooks/data/ghes-3.14/pull_request_review.json +++ /dev/null @@ -1,9885 +0,0 @@ -{ - "dismissed": { - "descriptionHtml": "

A review on a pull request was dismissed.

", - "summaryHtml": "

This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.

\n

For activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "dismissed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "review", - "description": "

The review that was affected.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

The text of the review.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "

A commit SHA for the review.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the review

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "dismissed", - "approved", - "changes_requested" - ] - }, - { - "type": "string", - "name": "submitted_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "" - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "dismissed", - "category": "pull_request_review" - }, - "edited": { - "descriptionHtml": "

The body comment on a pull request review was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.

\n

For activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "body", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the body if the action was edited.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "review", - "description": "

The review that was affected.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

The text of the review.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "

A commit SHA for the review.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the review

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "submitted_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "" - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "edited", - "category": "pull_request_review" - }, - "submitted": { - "descriptionHtml": "

A review on a pull request was submitted.

", - "summaryHtml": "

This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.

\n

For activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "submitted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "review", - "description": "

The review that was affected.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string or null", - "name": "body", - "description": "

The text of the review.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "

A commit SHA for the review.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the review

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "submitted_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "" - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "submitted", - "category": "pull_request_review" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/pull_request_review_comment.json b/src/webhooks/data/ghes-3.14/pull_request_review_comment.json deleted file mode 100644 index 634b1a5d3cd5..000000000000 --- a/src/webhooks/data/ghes-3.14/pull_request_review_comment.json +++ /dev/null @@ -1,9319 +0,0 @@ -{ - "created": { - "descriptionHtml": "

A comment on a pull request diff was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "comment", - "description": "

The comment itself.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "pull_request_review_comment" - }, - "deleted": { - "descriptionHtml": "

A comment on a pull request diff was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "comment", - "description": "

The comment itself.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "pull_request_review_comment" - }, - "edited": { - "descriptionHtml": "

The content of a comment on a pull request diff was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "

The changes to the comment.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "body", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the body.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "comment", - "description": "

The comment itself.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merge_commit_message", - "description": "

The default value for a merge commit message.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • PR_BODY - default to the pull request's body.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - { - "type": "string", - "name": "merge_commit_title", - "description": "

The default value for a merge commit title.

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
    • \n
", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "squash_merge_commit_message", - "description": "

The default value for a squash merge commit message:

\n
    \n
  • PR_BODY - default to the pull request's body.
    • \n
  • COMMIT_MESSAGES - default to the branch's commit messages.
    • \n
  • BLANK - default to a blank commit message.
    • \n
", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - { - "type": "string", - "name": "squash_merge_commit_title", - "description": "

The default value for a squash merge commit title:

\n
    \n
  • PR_TITLE - default to the pull request's title.
    • \n
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
    • \n
", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

", - "default": false - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "edited", - "category": "pull_request_review_comment" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/pull_request_review_thread.json b/src/webhooks/data/ghes-3.14/pull_request_review_thread.json deleted file mode 100644 index 62043102f29f..000000000000 --- a/src/webhooks/data/ghes-3.14/pull_request_review_thread.json +++ /dev/null @@ -1,6882 +0,0 @@ -{ - "resolved": { - "descriptionHtml": "

A comment thread on a pull request was marked as resolved.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.

\n

For activity related to pull request review comments, pull request comments, or pull request reviews, use the pull_request_review_comment, issue_comment, or pull_request_review events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "resolved" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "thread", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of objects", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "

The text of the comment.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "

The SHA of the commit to which the comment applies.

", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "

The diff of the line that the comment refers to.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "

HTML URL for the pull request review comment.

", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

The ID of the pull request review comment.

", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "

The comment ID to reply to.

" - }, - { - "type": "integer or null", - "name": "line", - "description": "

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the pull request review comment.

", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "

The SHA of the original commit to which the comment applies.

", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_line", - "description": "

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "

The index of the original line in the diff to which the comment applies.

", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "

The first line of the range for a multi-line comment.

", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "

The relative path of the file to which the comment applies.

", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "

The line index in the diff to which the comment applies.

", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "

The ID of the pull request review to which the comment belongs.

", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "

URL for the pull request that the review comment belongs to.

", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "

The side of the first line of the range for a multi-line comment.

", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "

The first line of the range for a multi-line comment.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "

The side of the first line of the range for a multi-line comment.

", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "

The level at which the comment is targeted, can be a diff line or a file.

", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the pull request review comment

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "updated_at", - "description": "" - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "resolved", - "category": "pull_request_review_thread" - }, - "unresolved": { - "descriptionHtml": "

A previously resolved comment thread on a pull request was marked as unresolved.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.

\n

For activity related to pull request review comments, pull request comments, or pull request reviews, use the pull_request_review_comment, issue_comment, or pull_request_review events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "unresolved" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "array of object,nulls", - "name": "assignees", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "object or null", - "name": "auto_merge", - "description": "

The status of auto merging a pull request.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "commit_message", - "description": "

Commit message for the merge commit.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_title", - "description": "

Title for the merge commit message.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "enabled_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "merge_method", - "description": "

The merge method to use.

", - "isRequired": true, - "enum": [ - "merge", - "squash", - "rebase" - ] - } - ] - }, - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "clone_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "forks_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, - { - "type": "boolean", - "name": "has_pull_requests", - "description": "

Whether pull requests are enabled.

", - "default": true - }, - { - "type": "string", - "name": "pull_request_creation_policy", - "description": "

The policy controlling who can create pull requests: all or collaborators_only.

", - "enum": [ - "all", - "collaborators_only" - ] - }, - { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "master_branch", - "description": "" - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "labels", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merge_commit_sha", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "merged_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "milestone", - "description": "

A collection of related issues and pull requests.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "patch_url", - "description": "", - "isRequired": true - }, - { - "type": "array", - "name": "requested_reviewers", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "requested_teams", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - } - ] - }, - { - "type": "string", - "name": "review_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "review_comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed" - ] - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "thread", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of objects", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "

The text of the comment.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "

The SHA of the commit to which the comment applies.

", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "

The diff of the line that the comment refers to.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "

HTML URL for the pull request review comment.

", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

The ID of the pull request review comment.

", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "

The comment ID to reply to.

" - }, - { - "type": "integer or null", - "name": "line", - "description": "

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the pull request review comment.

", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "

The SHA of the original commit to which the comment applies.

", - "isRequired": true - }, - { - "type": "integer", - "name": "original_line", - "description": "

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "

The index of the original line in the diff to which the comment applies.

", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "

The first line of the range for a multi-line comment.

", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "

The relative path of the file to which the comment applies.

", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "

The line index in the diff to which the comment applies.

", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "

The ID of the pull request review to which the comment belongs.

", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "

URL for the pull request that the review comment belongs to.

", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "

The side of the first line of the range for a multi-line comment.

", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "

The first line of the range for a multi-line comment.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "

The side of the first line of the range for a multi-line comment.

", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "

The level at which the comment is targeted, can be a diff line or a file.

", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the pull request review comment

", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "updated_at", - "description": "" - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unresolved", - "category": "pull_request_review_thread" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/push.json b/src/webhooks/data/ghes-3.14/push.json deleted file mode 100644 index 0d3389b7872d..000000000000 --- a/src/webhooks/data/ghes-3.14/push.json +++ /dev/null @@ -1,361 +0,0 @@ -{ - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the delete webhook event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

\n

\nEvents will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "after", - "description": "

The SHA of the most recent commit on ref after the push.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "base_ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "before", - "description": "

The SHA of the most recent commit on ref before the push.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "commits", - "description": "

An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 2048 commits. If necessary, you can use the Commits API to fetch additional commits.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of strings", - "name": "added", - "description": "

An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.

" - }, - { - "type": "object", - "name": "author", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "object", - "name": "committer", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "distinct", - "description": "

Whether this commit is distinct from any that have been pushed before.

", - "isRequired": true - }, - { - "type": "string", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "message", - "description": "

The commit message.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "modified", - "description": "

An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.

" - }, - { - "type": "array of strings", - "name": "removed", - "description": "

An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.

" - }, - { - "type": "string", - "name": "timestamp", - "description": "

The ISO 8601 timestamp of the commit.

", - "isRequired": true - }, - { - "type": "string", - "name": "tree_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL that points to the commit API resource.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "compare", - "description": "

URL that shows the changes in this ref update, from the before commit to the after commit. For a newly created ref that is directly based on the default branch, this is the comparison between the head of the default branch and the after commit. Otherwise, this shows all commits until the after commit.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "created", - "description": "

Whether this push created the ref.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "deleted", - "description": "

Whether this push deleted the ref.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "boolean", - "name": "forced", - "description": "

Whether this push was a force push of the ref.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "head_commit", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of strings", - "name": "added", - "description": "

An array of files added in the commit.

" - }, - { - "type": "object", - "name": "author", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "object", - "name": "committer", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "distinct", - "description": "

Whether this commit is distinct from any that have been pushed before.

", - "isRequired": true - }, - { - "type": "string", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "message", - "description": "

The commit message.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "modified", - "description": "

An array of files modified by the commit.

" - }, - { - "type": "array of strings", - "name": "removed", - "description": "

An array of files removed in the commit.

" - }, - { - "type": "string", - "name": "timestamp", - "description": "

The ISO 8601 timestamp of the commit.

", - "isRequired": true - }, - { - "type": "string", - "name": "tree_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL that points to the commit API resource.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pusher", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full git ref that was pushed. Example: refs/heads/main or refs/tags/v3.14.1.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "description": "

A git repository

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "push" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/registry_package.json b/src/webhooks/data/ghes-3.14/registry_package.json deleted file mode 100644 index 2e6af5286149..000000000000 --- a/src/webhooks/data/ghes-3.14/registry_package.json +++ /dev/null @@ -1,1863 +0,0 @@ -{ - "published": { - "descriptionHtml": "

A package was published to a registry.

", - "summaryHtml": "

This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.

\n

To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.

\n

\n

\nGitHub recommends that you use the newer package event instead.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "published" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "registry_package", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ecosystem", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "namespace", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "package_type", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "package_version", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "author", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or object", - "name": "body", - "description": "" - }, - { - "type": "string", - "name": "body_html", - "description": "" - }, - { - "type": "object", - "name": "container_metadata", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "labels", - "description": "" - }, - { - "type": "object or null", - "name": "manifest", - "description": "" - }, - { - "type": "object", - "name": "tag", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "digest", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - } - ] - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "" - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "docker_metadata", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "tags", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "installation_command", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "manifest", - "description": "" - }, - { - "type": "array of objects", - "name": "metadata", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "npm_metadata", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "version", - "description": "" - }, - { - "type": "string", - "name": "npm_user", - "description": "" - }, - { - "type": "null or string or object", - "name": "author", - "description": "" - }, - { - "type": "null or string or object", - "name": "bugs", - "description": "" - }, - { - "type": "object", - "name": "dependencies", - "description": "" - }, - { - "type": "object", - "name": "dev_dependencies", - "description": "" - }, - { - "type": "object", - "name": "peer_dependencies", - "description": "" - }, - { - "type": "object", - "name": "optional_dependencies", - "description": "" - }, - { - "type": "string", - "name": "description", - "description": "" - }, - { - "type": "null or string or object", - "name": "dist", - "description": "" - }, - { - "type": "string", - "name": "git_head", - "description": "" - }, - { - "type": "string", - "name": "homepage", - "description": "" - }, - { - "type": "string", - "name": "license", - "description": "" - }, - { - "type": "string", - "name": "main", - "description": "" - }, - { - "type": "null or string or object", - "name": "repository", - "description": "" - }, - { - "type": "object", - "name": "scripts", - "description": "" - }, - { - "type": "string", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "node_version", - "description": "" - }, - { - "type": "string", - "name": "npm_version", - "description": "" - }, - { - "type": "boolean", - "name": "has_shrinkwrap", - "description": "" - }, - { - "type": "array of strings", - "name": "maintainers", - "description": "" - }, - { - "type": "array of strings", - "name": "contributors", - "description": "" - }, - { - "type": "object", - "name": "engines", - "description": "" - }, - { - "type": "array of strings", - "name": "keywords", - "description": "" - }, - { - "type": "array of strings", - "name": "files", - "description": "" - }, - { - "type": "object", - "name": "bin", - "description": "" - }, - { - "type": "object", - "name": "man", - "description": "" - }, - { - "type": "null or string or object", - "name": "directories", - "description": "" - }, - { - "type": "array of strings", - "name": "os", - "description": "" - }, - { - "type": "array of strings", - "name": "cpu", - "description": "" - }, - { - "type": "string", - "name": "readme", - "description": "" - }, - { - "type": "string", - "name": "installation_command", - "description": "" - }, - { - "type": "integer", - "name": "release_id", - "description": "" - }, - { - "type": "string", - "name": "commit_oid", - "description": "" - }, - { - "type": "boolean", - "name": "published_via_actions", - "description": "" - }, - { - "type": "integer", - "name": "deleted_by_id", - "description": "" - } - ] - }, - { - "type": "array of objects or null", - "name": "nuget_metadata", - "description": "", - "childParamsGroups": [ - { - "type": "null or string or object or integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "boolean or string or integer or object", - "name": "value", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "package_files", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "content_type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "download_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "md5", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "sha1", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "sha256", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "state", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "package_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "prerelease", - "description": "" - }, - { - "type": "object", - "name": "release", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "author", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "" - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "boolean", - "name": "prerelease", - "description": "" - }, - { - "type": "string", - "name": "published_at", - "description": "" - }, - { - "type": "string", - "name": "tag_name", - "description": "" - }, - { - "type": "string", - "name": "target_commitish", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "array of objects", - "name": "rubygems_metadata", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "readme", - "description": "" - }, - { - "type": "string", - "name": "homepage", - "description": "" - }, - { - "type": "object", - "name": "version_info", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "version", - "description": "" - } - ] - }, - { - "type": "string", - "name": "platform", - "description": "" - }, - { - "type": "object", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "repo", - "description": "" - }, - { - "type": "array of objects", - "name": "dependencies", - "description": "" - }, - { - "type": "string", - "name": "commit_oid", - "description": "" - } - ] - }, - { - "type": "string", - "name": "summary", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tag_name", - "description": "" - }, - { - "type": "string", - "name": "target_commitish", - "description": "" - }, - { - "type": "string", - "name": "target_oid", - "description": "" - }, - { - "type": "string", - "name": "updated_at", - "description": "" - }, - { - "type": "string", - "name": "version", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "registry", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "about_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "vendor", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "published", - "category": "registry_package" - }, - "updated": { - "descriptionHtml": "

A package that was previously published to a registry was updated.

", - "summaryHtml": "

This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.

\n

To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.

\n

\n

\nGitHub recommends that you use the newer package event instead.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "updated" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "registry_package", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ecosystem", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "namespace", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "package_type", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "package_version", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "author", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "body_html", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of object,nulls", - "name": "docker_metadata", - "description": "" - }, - { - "type": "boolean", - "name": "draft", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "installation_command", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "manifest", - "description": "" - }, - { - "type": "array of objects", - "name": "metadata", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "package_files", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "content_type", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "" - }, - { - "type": "string", - "name": "download_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string or null", - "name": "md5", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "sha1", - "description": "" - }, - { - "type": "string", - "name": "sha256", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "" - }, - { - "type": "string", - "name": "state", - "description": "" - }, - { - "type": "string", - "name": "updated_at", - "description": "" - } - ] - }, - { - "type": "string", - "name": "package_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "prerelease", - "description": "" - }, - { - "type": "object", - "name": "release", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "author", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "draft", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "prerelease", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "published_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tag_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "target_commitish", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "rubygems_metadata", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "readme", - "description": "" - }, - { - "type": "string", - "name": "homepage", - "description": "" - }, - { - "type": "object", - "name": "version_info", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "version", - "description": "" - } - ] - }, - { - "type": "string", - "name": "platform", - "description": "" - }, - { - "type": "object", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "repo", - "description": "" - }, - { - "type": "array of objects", - "name": "dependencies", - "description": "" - }, - { - "type": "string", - "name": "commit_oid", - "description": "" - } - ] - }, - { - "type": "string", - "name": "summary", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tag_name", - "description": "" - }, - { - "type": "string", - "name": "target_commitish", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "target_oid", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "version", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "registry", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "updated", - "category": "registry_package" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/release.json b/src/webhooks/data/ghes-3.14/release.json deleted file mode 100644 index bc89d9bae2f9..000000000000 --- a/src/webhooks/data/ghes-3.14/release.json +++ /dev/null @@ -1,3486 +0,0 @@ -{ - "created": { - "descriptionHtml": "

A draft was saved, or a release or pre-release was published without previously being saved as a draft.

", - "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "release", - "description": "

The release object.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of objects", - "name": "assets", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "browser_download_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "download_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The file name of the asset.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "digest", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of the release asset.

", - "isRequired": true, - "enum": [ - "uploaded" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "uploader", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "assets_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "author", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "discussion_url", - "description": "" - }, - { - "type": "boolean", - "name": "draft", - "description": "

Whether the release is a draft or published

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "immutable", - "description": "

Whether or not the release is immutable.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "prerelease", - "description": "

Whether the release is identified as a prerelease or a full release.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "published_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "tag_name", - "description": "

The name of the tag.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "tarball_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "target_commitish", - "description": "

Specifies the commitish value that determines where the Git tag is created from.

", - "isRequired": true - }, - { - "type": "string", - "name": "upload_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "zipball_url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "release" - }, - "deleted": { - "descriptionHtml": "

A release, pre-release, or draft release was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "release", - "description": "

The release object.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of objects", - "name": "assets", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "browser_download_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "download_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The file name of the asset.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "digest", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of the release asset.

", - "isRequired": true, - "enum": [ - "uploaded" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "uploader", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "assets_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "author", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "discussion_url", - "description": "" - }, - { - "type": "boolean", - "name": "draft", - "description": "

Whether the release is a draft or published

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "immutable", - "description": "

Whether or not the release is immutable.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "prerelease", - "description": "

Whether the release is identified as a prerelease or a full release.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "published_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "tag_name", - "description": "

The name of the tag.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "tarball_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "target_commitish", - "description": "

Specifies the commitish value that determines where the Git tag is created from.

", - "isRequired": true - }, - { - "type": "string", - "name": "upload_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "zipball_url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "release" - }, - "edited": { - "descriptionHtml": "

The details of a release, pre-release, or draft release were edited. For more information, see \"Managing releases in a repository.\"

", - "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "body", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the body if the action was edited.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "name", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the name if the action was edited.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "tag_name", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the tag_name if the action was edited.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "make_latest", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "to", - "description": "

Whether this release was explicitly edited to be the latest.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "release", - "description": "

The release object.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of objects", - "name": "assets", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "browser_download_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "download_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The file name of the asset.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "digest", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of the release asset.

", - "isRequired": true, - "enum": [ - "uploaded" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "uploader", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "assets_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "author", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "discussion_url", - "description": "" - }, - { - "type": "boolean", - "name": "draft", - "description": "

Whether the release is a draft or published

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "immutable", - "description": "

Whether or not the release is immutable.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "prerelease", - "description": "

Whether the release is identified as a prerelease or a full release.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "published_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "tag_name", - "description": "

The name of the tag.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "tarball_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "target_commitish", - "description": "

Specifies the commitish value that determines where the Git tag is created from.

", - "isRequired": true - }, - { - "type": "string", - "name": "upload_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "zipball_url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "edited", - "category": "release" - }, - "prereleased": { - "descriptionHtml": "

A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.

", - "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "prereleased" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "release", - "description": "

The release object.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of object,nulls", - "name": "assets", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assets_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "author", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "discussion_url", - "description": "" - }, - { - "type": "boolean", - "name": "draft", - "description": "

Whether the release is a draft or published

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "immutable", - "description": "

Whether or not the release is immutable.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "prerelease", - "description": "

Whether the release is identified as a prerelease or a full release.

", - "isRequired": true, - "enum": [ - true - ] - }, - { - "type": "string or null", - "name": "published_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "tag_name", - "description": "

The name of the tag.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "tarball_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "target_commitish", - "description": "

Specifies the commitish value that determines where the Git tag is created from.

", - "isRequired": true - }, - { - "type": "string", - "name": "upload_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "zipball_url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "prereleased", - "category": "release" - }, - "published": { - "descriptionHtml": "

A release, pre-release, or draft of a release was published.

", - "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "published" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "release", - "description": "

The release object.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of object,nulls", - "name": "assets", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assets_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "author", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "discussion_url", - "description": "" - }, - { - "type": "boolean", - "name": "draft", - "description": "

Whether the release is a draft or published

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "immutable", - "description": "

Whether or not the release is immutable.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "prerelease", - "description": "

Whether the release is identified as a prerelease or a full release.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "published_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "tag_name", - "description": "

The name of the tag.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "tarball_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "target_commitish", - "description": "

Specifies the commitish value that determines where the Git tag is created from.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "upload_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "zipball_url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "published", - "category": "release" - }, - "released": { - "descriptionHtml": "

A release was published, or a pre-release was changed to a release.

", - "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "released" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "release", - "description": "

The release object.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of objects", - "name": "assets", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "browser_download_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "download_count", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "label", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The file name of the asset.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "digest", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of the release asset.

", - "isRequired": true, - "enum": [ - "uploaded" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "uploader", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "assets_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "author", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "discussion_url", - "description": "" - }, - { - "type": "boolean", - "name": "draft", - "description": "

Whether the release is a draft or published

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "immutable", - "description": "

Whether or not the release is immutable.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "prerelease", - "description": "

Whether the release is identified as a prerelease or a full release.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "published_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "tag_name", - "description": "

The name of the tag.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "tarball_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "target_commitish", - "description": "

Specifies the commitish value that determines where the Git tag is created from.

", - "isRequired": true - }, - { - "type": "string", - "name": "upload_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "zipball_url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "released", - "category": "release" - }, - "unpublished": { - "descriptionHtml": "

A release or pre-release was unpublished.

", - "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "unpublished" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "release", - "description": "

The release object.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of object,nulls", - "name": "assets", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assets_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "author", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "discussion_url", - "description": "" - }, - { - "type": "boolean", - "name": "draft", - "description": "

Whether the release is a draft or published

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "immutable", - "description": "

Whether or not the release is immutable.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "prerelease", - "description": "

Whether the release is identified as a prerelease or a full release.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "published_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "tag_name", - "description": "

The name of the tag.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "tarball_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "target_commitish", - "description": "

Specifies the commitish value that determines where the Git tag is created from.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "upload_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "zipball_url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unpublished", - "category": "release" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/repository.json b/src/webhooks/data/ghes-3.14/repository.json deleted file mode 100644 index 04a8879b2483..000000000000 --- a/src/webhooks/data/ghes-3.14/repository.json +++ /dev/null @@ -1,935 +0,0 @@ -{ - "anonymous_access_disabled": { - "descriptionHtml": "

Someone disabled anonymous Git read access to the repository. For more information, see \"Enabling anonymous Git read access for a repository.\"

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "anonymous_access_disabled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "app", - "business", - "organization", - "repository" - ], - "action": "anonymous_access_disabled", - "category": "repository" - }, - "anonymous_access_enabled": { - "descriptionHtml": "

Someone enabled anonymous Git read access to the repository. For more information, see \"Enabling anonymous Git read access for a repository.\"

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "anonymous_access_enabled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "app", - "business", - "organization", - "repository" - ], - "action": "anonymous_access_enabled", - "category": "repository" - }, - "archived": { - "descriptionHtml": "

A repository was archived.

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "archived" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "archived", - "category": "repository" - }, - "created": { - "descriptionHtml": "

A repository was created.

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "created", - "category": "repository" - }, - "deleted": { - "descriptionHtml": "

A repository was deleted. GitHub Apps and repository webhooks will not receive this event.

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "repository" - }, - "edited": { - "descriptionHtml": "

The topics, default branch, description, or homepage of a repository was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "default_branch", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "description", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "homepage", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "topics", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings or null", - "name": "from", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "edited", - "category": "repository" - }, - "privatized": { - "descriptionHtml": "

The visibility of a repository was changed to private.

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "privatized" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "privatized", - "category": "repository" - }, - "publicized": { - "descriptionHtml": "

The visibility of a repository was changed to public.

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "publicized" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "publicized", - "category": "repository" - }, - "renamed": { - "descriptionHtml": "

The name of a repository was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "renamed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "repository", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "name", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "renamed", - "category": "repository" - }, - "transferred": { - "descriptionHtml": "

Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the repository.transferred event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "transferred" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "from", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "organization", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "public_members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "user", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "transferred", - "category": "repository" - }, - "unarchived": { - "descriptionHtml": "

A previously archived repository was unarchived.

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "unarchived" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "unarchived", - "category": "repository" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/repository_dispatch.json b/src/webhooks/data/ghes-3.14/repository_dispatch.json deleted file mode 100644 index e66d458b09b7..000000000000 --- a/src/webhooks/data/ghes-3.14/repository_dispatch.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when a GitHub App sends a POST request to /repos/{owner}/{repo}/dispatches. For more information, see the REST API documentation for creating a repository dispatch event. In the payload, the action will be the event_type that was specified in the POST /repos/{owner}/{repo}/dispatches request body.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "

The event_type that was specified in the POST /repos/{owner}/{repo}/dispatches request body.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "string", - "name": "branch", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "client_payload", - "description": "

The client_payload that was specified in the POST /repos/{owner}/{repo}/dispatches request body.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "default", - "category": "repository_dispatch" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/repository_ruleset.json b/src/webhooks/data/ghes-3.14/repository_ruleset.json deleted file mode 100644 index e79fe0680692..000000000000 --- a/src/webhooks/data/ghes-3.14/repository_ruleset.json +++ /dev/null @@ -1,4863 +0,0 @@ -{ - "created": { - "descriptionHtml": "

A repository ruleset was created.

", - "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository_ruleset", - "description": "

A set of rules to apply when specified conditions are met.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The ID of the ruleset

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the ruleset

", - "isRequired": true - }, - { - "type": "string", - "name": "target", - "description": "

The target of the ruleset.

", - "enum": [ - "branch", - "tag", - "push" - ] - }, - { - "type": "string", - "name": "source_type", - "description": "

The type of the source of the ruleset

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "source", - "description": "

The name of the source

", - "isRequired": true - }, - { - "type": "string", - "name": "enforcement", - "description": "

The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. evaluate is not available for the repository target.

", - "isRequired": true, - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - { - "type": "array of objects", - "name": "bypass_actors", - "description": "

The actors that can bypass the rules in this ruleset

", - "childParamsGroups": [ - { - "type": "integer or null", - "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. OrganizationAdmin is not applicable for personal repositories.

" - }, - { - "type": "string", - "name": "actor_type", - "description": "

The type of actor that can bypass a ruleset

", - "isRequired": true, - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ] - }, - { - "type": "string", - "name": "bypass_mode", - "description": "

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type. Also, pull_request is only applicable to branch rulesets.

", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - ] - }, - { - "type": "string", - "name": "current_user_can_bypass", - "description": "

The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.

", - "enum": [ - "always", - "pull_requests_only", - "never" - ] - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object", - "name": "_links", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "self", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "

The URL of the ruleset

" - } - ] - }, - { - "type": "object or null", - "name": "html", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "

The html URL of the ruleset

" - } - ] - } - ] - }, - { - "type": "null or object", - "name": "conditions", - "description": "" - }, - { - "type": "array of objects", - "name": "rules", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "creation", - "description": "

Only allow users with bypass permission to create matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "creation" - ] - } - ] - }, - { - "type": "object", - "name": "update", - "description": "

Only allow users with bypass permission to update matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "update" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "update_allows_fetch_and_merge", - "description": "

Branch can pull changes from its upstream repository

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "deletion", - "description": "

Only allow users with bypass permissions to delete matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "deletion" - ] - } - ] - }, - { - "type": "object", - "name": "required_linear_history", - "description": "

Prevent merge commits from being pushed to matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_linear_history" - ] - } - ] - }, - { - "type": "object", - "name": "required_deployments", - "description": "

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_deployments" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "required_deployment_environments", - "description": "

The environments that must be successfully deployed to before branches can be merged.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "required_signatures", - "description": "

Commits pushed to matching refs must have verified signatures.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_signatures" - ] - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "pull_request" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "dismiss_stale_reviews_on_push", - "description": "

New, reviewable commits pushed will dismiss previous pull request review approvals.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_code_owner_review", - "description": "

Require an approving review in pull requests that modify files that have a designated code owner.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_last_push_approval", - "description": "

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

", - "isRequired": true - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

The number of approving reviews that are required before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "required_review_thread_resolution", - "description": "

All conversations on code must be resolved before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "required_reviewers", - "description": "

Note

\n

\nrequired_reviewers is in beta and subject to change.

\n
\n

A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "file_patterns", - "description": "

Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.

", - "isRequired": true - }, - { - "type": "integer", - "name": "minimum_approvals", - "description": "

Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.

", - "isRequired": true - }, - { - "type": "object", - "name": "reviewer", - "description": "

A required reviewing team

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

ID of the reviewer which must review changes to matching files.

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The type of the reviewer

", - "isRequired": true, - "enum": [ - "Team" - ] - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "required_status_checks", - "description": "

Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_status_checks" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "required_status_checks", - "description": "

Status checks that are required.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The status check context name that must be present on the commit.

", - "isRequired": true - }, - { - "type": "integer", - "name": "integration_id", - "description": "

The optional integration ID that this status check must originate from.

" - } - ] - }, - { - "type": "boolean", - "name": "strict_required_status_checks_policy", - "description": "

Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "non_fast_forward", - "description": "

Prevent users with push access from force pushing to refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "non_fast_forward" - ] - } - ] - }, - { - "type": "object", - "name": "commit_message_pattern", - "description": "

Parameters to be used for the commit_message_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_message_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "commit_author_email_pattern", - "description": "

Parameters to be used for the commit_author_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_author_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "committer_email_pattern", - "description": "

Parameters to be used for the committer_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "committer_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "branch_name_pattern", - "description": "

Parameters to be used for the branch_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "branch_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "tag_name_pattern", - "description": "

Parameters to be used for the tag_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "tag_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "workflows", - "description": "

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "workflows" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "workflows", - "description": "

Workflows that must pass for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "

The path to the workflow file

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The ref (branch or tag) of the workflow file to use

" - }, - { - "type": "integer", - "name": "repository_id", - "description": "

The ID of the repository where the workflow is defined

", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "

The commit SHA of the workflow file to use

" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "code_scanning", - "description": "

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "code_scanning" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of objects", - "name": "code_scanning_tools", - "description": "

Tools that must provide code scanning results for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - { - "type": "string", - "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - { - "type": "string", - "name": "tool", - "description": "

The name of a code scanning tool

", - "isRequired": true - } - ] - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "created_at", - "description": "" - }, - { - "type": "string", - "name": "updated_at", - "description": "" - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "repository_ruleset" - }, - "deleted": { - "descriptionHtml": "

A repository ruleset was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository_ruleset", - "description": "

A set of rules to apply when specified conditions are met.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The ID of the ruleset

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the ruleset

", - "isRequired": true - }, - { - "type": "string", - "name": "target", - "description": "

The target of the ruleset.

", - "enum": [ - "branch", - "tag", - "push" - ] - }, - { - "type": "string", - "name": "source_type", - "description": "

The type of the source of the ruleset

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "source", - "description": "

The name of the source

", - "isRequired": true - }, - { - "type": "string", - "name": "enforcement", - "description": "

The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. evaluate is not available for the repository target.

", - "isRequired": true, - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - { - "type": "array of objects", - "name": "bypass_actors", - "description": "

The actors that can bypass the rules in this ruleset

", - "childParamsGroups": [ - { - "type": "integer or null", - "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. OrganizationAdmin is not applicable for personal repositories.

" - }, - { - "type": "string", - "name": "actor_type", - "description": "

The type of actor that can bypass a ruleset

", - "isRequired": true, - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ] - }, - { - "type": "string", - "name": "bypass_mode", - "description": "

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type. Also, pull_request is only applicable to branch rulesets.

", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - ] - }, - { - "type": "string", - "name": "current_user_can_bypass", - "description": "

The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.

", - "enum": [ - "always", - "pull_requests_only", - "never" - ] - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object", - "name": "_links", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "self", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "

The URL of the ruleset

" - } - ] - }, - { - "type": "object or null", - "name": "html", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "

The html URL of the ruleset

" - } - ] - } - ] - }, - { - "type": "null or object", - "name": "conditions", - "description": "" - }, - { - "type": "array of objects", - "name": "rules", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "creation", - "description": "

Only allow users with bypass permission to create matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "creation" - ] - } - ] - }, - { - "type": "object", - "name": "update", - "description": "

Only allow users with bypass permission to update matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "update" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "update_allows_fetch_and_merge", - "description": "

Branch can pull changes from its upstream repository

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "deletion", - "description": "

Only allow users with bypass permissions to delete matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "deletion" - ] - } - ] - }, - { - "type": "object", - "name": "required_linear_history", - "description": "

Prevent merge commits from being pushed to matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_linear_history" - ] - } - ] - }, - { - "type": "object", - "name": "required_deployments", - "description": "

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_deployments" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "required_deployment_environments", - "description": "

The environments that must be successfully deployed to before branches can be merged.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "required_signatures", - "description": "

Commits pushed to matching refs must have verified signatures.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_signatures" - ] - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "pull_request" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "dismiss_stale_reviews_on_push", - "description": "

New, reviewable commits pushed will dismiss previous pull request review approvals.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_code_owner_review", - "description": "

Require an approving review in pull requests that modify files that have a designated code owner.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_last_push_approval", - "description": "

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

", - "isRequired": true - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

The number of approving reviews that are required before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "required_review_thread_resolution", - "description": "

All conversations on code must be resolved before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "required_reviewers", - "description": "

Note

\n

\nrequired_reviewers is in beta and subject to change.

\n
\n

A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "file_patterns", - "description": "

Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.

", - "isRequired": true - }, - { - "type": "integer", - "name": "minimum_approvals", - "description": "

Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.

", - "isRequired": true - }, - { - "type": "object", - "name": "reviewer", - "description": "

A required reviewing team

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

ID of the reviewer which must review changes to matching files.

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The type of the reviewer

", - "isRequired": true, - "enum": [ - "Team" - ] - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "required_status_checks", - "description": "

Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_status_checks" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "required_status_checks", - "description": "

Status checks that are required.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The status check context name that must be present on the commit.

", - "isRequired": true - }, - { - "type": "integer", - "name": "integration_id", - "description": "

The optional integration ID that this status check must originate from.

" - } - ] - }, - { - "type": "boolean", - "name": "strict_required_status_checks_policy", - "description": "

Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "non_fast_forward", - "description": "

Prevent users with push access from force pushing to refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "non_fast_forward" - ] - } - ] - }, - { - "type": "object", - "name": "commit_message_pattern", - "description": "

Parameters to be used for the commit_message_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_message_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "commit_author_email_pattern", - "description": "

Parameters to be used for the commit_author_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_author_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "committer_email_pattern", - "description": "

Parameters to be used for the committer_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "committer_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "branch_name_pattern", - "description": "

Parameters to be used for the branch_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "branch_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "tag_name_pattern", - "description": "

Parameters to be used for the tag_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "tag_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "workflows", - "description": "

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "workflows" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "workflows", - "description": "

Workflows that must pass for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "

The path to the workflow file

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The ref (branch or tag) of the workflow file to use

" - }, - { - "type": "integer", - "name": "repository_id", - "description": "

The ID of the repository where the workflow is defined

", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "

The commit SHA of the workflow file to use

" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "code_scanning", - "description": "

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "code_scanning" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of objects", - "name": "code_scanning_tools", - "description": "

Tools that must provide code scanning results for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - { - "type": "string", - "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - { - "type": "string", - "name": "tool", - "description": "

The name of a code scanning tool

", - "isRequired": true - } - ] - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "created_at", - "description": "" - }, - { - "type": "string", - "name": "updated_at", - "description": "" - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "repository_ruleset" - }, - "edited": { - "descriptionHtml": "

A repository ruleset was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository_ruleset", - "description": "

A set of rules to apply when specified conditions are met.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

The ID of the ruleset

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the ruleset

", - "isRequired": true - }, - { - "type": "string", - "name": "target", - "description": "

The target of the ruleset.

", - "enum": [ - "branch", - "tag", - "push" - ] - }, - { - "type": "string", - "name": "source_type", - "description": "

The type of the source of the ruleset

", - "enum": [ - "Repository", - "Organization" - ] - }, - { - "type": "string", - "name": "source", - "description": "

The name of the source

", - "isRequired": true - }, - { - "type": "string", - "name": "enforcement", - "description": "

The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. evaluate is not available for the repository target.

", - "isRequired": true, - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - { - "type": "array of objects", - "name": "bypass_actors", - "description": "

The actors that can bypass the rules in this ruleset

", - "childParamsGroups": [ - { - "type": "integer or null", - "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, and Team actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. OrganizationAdmin is not applicable for personal repositories.

" - }, - { - "type": "string", - "name": "actor_type", - "description": "

The type of actor that can bypass a ruleset

", - "isRequired": true, - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ] - }, - { - "type": "string", - "name": "bypass_mode", - "description": "

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type. Also, pull_request is only applicable to branch rulesets.

", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - ] - }, - { - "type": "string", - "name": "current_user_can_bypass", - "description": "

The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.

", - "enum": [ - "always", - "pull_requests_only", - "never" - ] - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object", - "name": "_links", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "self", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "

The URL of the ruleset

" - } - ] - }, - { - "type": "object or null", - "name": "html", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "

The html URL of the ruleset

" - } - ] - } - ] - }, - { - "type": "null or object", - "name": "conditions", - "description": "" - }, - { - "type": "array of objects", - "name": "rules", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "creation", - "description": "

Only allow users with bypass permission to create matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "creation" - ] - } - ] - }, - { - "type": "object", - "name": "update", - "description": "

Only allow users with bypass permission to update matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "update" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "update_allows_fetch_and_merge", - "description": "

Branch can pull changes from its upstream repository

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "deletion", - "description": "

Only allow users with bypass permissions to delete matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "deletion" - ] - } - ] - }, - { - "type": "object", - "name": "required_linear_history", - "description": "

Prevent merge commits from being pushed to matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_linear_history" - ] - } - ] - }, - { - "type": "object", - "name": "required_deployments", - "description": "

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_deployments" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "required_deployment_environments", - "description": "

The environments that must be successfully deployed to before branches can be merged.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "required_signatures", - "description": "

Commits pushed to matching refs must have verified signatures.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_signatures" - ] - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "pull_request" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "dismiss_stale_reviews_on_push", - "description": "

New, reviewable commits pushed will dismiss previous pull request review approvals.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_code_owner_review", - "description": "

Require an approving review in pull requests that modify files that have a designated code owner.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_last_push_approval", - "description": "

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

", - "isRequired": true - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

The number of approving reviews that are required before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "required_review_thread_resolution", - "description": "

All conversations on code must be resolved before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "required_reviewers", - "description": "

Note

\n

\nrequired_reviewers is in beta and subject to change.

\n
\n

A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "file_patterns", - "description": "

Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.

", - "isRequired": true - }, - { - "type": "integer", - "name": "minimum_approvals", - "description": "

Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.

", - "isRequired": true - }, - { - "type": "object", - "name": "reviewer", - "description": "

A required reviewing team

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

ID of the reviewer which must review changes to matching files.

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The type of the reviewer

", - "isRequired": true, - "enum": [ - "Team" - ] - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "required_status_checks", - "description": "

Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_status_checks" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "required_status_checks", - "description": "

Status checks that are required.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The status check context name that must be present on the commit.

", - "isRequired": true - }, - { - "type": "integer", - "name": "integration_id", - "description": "

The optional integration ID that this status check must originate from.

" - } - ] - }, - { - "type": "boolean", - "name": "strict_required_status_checks_policy", - "description": "

Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "non_fast_forward", - "description": "

Prevent users with push access from force pushing to refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "non_fast_forward" - ] - } - ] - }, - { - "type": "object", - "name": "commit_message_pattern", - "description": "

Parameters to be used for the commit_message_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_message_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "commit_author_email_pattern", - "description": "

Parameters to be used for the commit_author_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_author_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "committer_email_pattern", - "description": "

Parameters to be used for the committer_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "committer_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "branch_name_pattern", - "description": "

Parameters to be used for the branch_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "branch_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "tag_name_pattern", - "description": "

Parameters to be used for the tag_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "tag_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "workflows", - "description": "

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "workflows" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "workflows", - "description": "

Workflows that must pass for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "

The path to the workflow file

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The ref (branch or tag) of the workflow file to use

" - }, - { - "type": "integer", - "name": "repository_id", - "description": "

The ID of the repository where the workflow is defined

", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "

The commit SHA of the workflow file to use

" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "code_scanning", - "description": "

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "code_scanning" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of objects", - "name": "code_scanning_tools", - "description": "

Tools that must provide code scanning results for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - { - "type": "string", - "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - { - "type": "string", - "name": "tool", - "description": "

The name of a code scanning tool

", - "isRequired": true - } - ] - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "created_at", - "description": "" - }, - { - "type": "string", - "name": "updated_at", - "description": "" - } - ] - }, - { - "type": "object", - "name": "changes", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "name", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "" - } - ] - }, - { - "type": "object", - "name": "enforcement", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "" - } - ] - }, - { - "type": "object", - "name": "conditions", - "description": "", - "childParamsGroups": [ - { - "type": "array of objects", - "name": "added", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "ref_name", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "include", - "description": "

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

" - }, - { - "type": "array of strings", - "name": "exclude", - "description": "

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

" - } - ] - } - ] - }, - { - "type": "array of objects", - "name": "deleted", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "ref_name", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "include", - "description": "

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

" - }, - { - "type": "array of strings", - "name": "exclude", - "description": "

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

" - } - ] - } - ] - }, - { - "type": "array of objects", - "name": "updated", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "condition", - "description": "

Parameters for a repository ruleset ref name condition

", - "childParamsGroups": [ - { - "type": "object", - "name": "ref_name", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "include", - "description": "

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

" - }, - { - "type": "array of strings", - "name": "exclude", - "description": "

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

" - } - ] - } - ] - }, - { - "type": "object", - "name": "changes", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "condition_type", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "" - } - ] - }, - { - "type": "object", - "name": "target", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "" - } - ] - }, - { - "type": "object", - "name": "include", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "from", - "description": "" - } - ] - }, - { - "type": "object", - "name": "exclude", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "from", - "description": "" - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "rules", - "description": "", - "childParamsGroups": [ - { - "type": "array of objects", - "name": "added", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "creation", - "description": "

Only allow users with bypass permission to create matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "creation" - ] - } - ] - }, - { - "type": "object", - "name": "update", - "description": "

Only allow users with bypass permission to update matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "update" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "update_allows_fetch_and_merge", - "description": "

Branch can pull changes from its upstream repository

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "deletion", - "description": "

Only allow users with bypass permissions to delete matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "deletion" - ] - } - ] - }, - { - "type": "object", - "name": "required_linear_history", - "description": "

Prevent merge commits from being pushed to matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_linear_history" - ] - } - ] - }, - { - "type": "object", - "name": "required_deployments", - "description": "

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_deployments" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "required_deployment_environments", - "description": "

The environments that must be successfully deployed to before branches can be merged.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "required_signatures", - "description": "

Commits pushed to matching refs must have verified signatures.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_signatures" - ] - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "pull_request" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "dismiss_stale_reviews_on_push", - "description": "

New, reviewable commits pushed will dismiss previous pull request review approvals.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_code_owner_review", - "description": "

Require an approving review in pull requests that modify files that have a designated code owner.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_last_push_approval", - "description": "

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

", - "isRequired": true - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

The number of approving reviews that are required before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "required_review_thread_resolution", - "description": "

All conversations on code must be resolved before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "required_reviewers", - "description": "

Note

\n

\nrequired_reviewers is in beta and subject to change.

\n
\n

A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "file_patterns", - "description": "

Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.

", - "isRequired": true - }, - { - "type": "integer", - "name": "minimum_approvals", - "description": "

Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.

", - "isRequired": true - }, - { - "type": "object", - "name": "reviewer", - "description": "

A required reviewing team

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

ID of the reviewer which must review changes to matching files.

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The type of the reviewer

", - "isRequired": true, - "enum": [ - "Team" - ] - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "required_status_checks", - "description": "

Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_status_checks" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "required_status_checks", - "description": "

Status checks that are required.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The status check context name that must be present on the commit.

", - "isRequired": true - }, - { - "type": "integer", - "name": "integration_id", - "description": "

The optional integration ID that this status check must originate from.

" - } - ] - }, - { - "type": "boolean", - "name": "strict_required_status_checks_policy", - "description": "

Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "non_fast_forward", - "description": "

Prevent users with push access from force pushing to refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "non_fast_forward" - ] - } - ] - }, - { - "type": "object", - "name": "commit_message_pattern", - "description": "

Parameters to be used for the commit_message_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_message_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "commit_author_email_pattern", - "description": "

Parameters to be used for the commit_author_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_author_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "committer_email_pattern", - "description": "

Parameters to be used for the committer_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "committer_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "branch_name_pattern", - "description": "

Parameters to be used for the branch_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "branch_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "tag_name_pattern", - "description": "

Parameters to be used for the tag_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "tag_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "workflows", - "description": "

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "workflows" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "workflows", - "description": "

Workflows that must pass for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "

The path to the workflow file

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The ref (branch or tag) of the workflow file to use

" - }, - { - "type": "integer", - "name": "repository_id", - "description": "

The ID of the repository where the workflow is defined

", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "

The commit SHA of the workflow file to use

" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "code_scanning", - "description": "

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "code_scanning" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of objects", - "name": "code_scanning_tools", - "description": "

Tools that must provide code scanning results for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - { - "type": "string", - "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - { - "type": "string", - "name": "tool", - "description": "

The name of a code scanning tool

", - "isRequired": true - } - ] - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "array of objects", - "name": "deleted", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "creation", - "description": "

Only allow users with bypass permission to create matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "creation" - ] - } - ] - }, - { - "type": "object", - "name": "update", - "description": "

Only allow users with bypass permission to update matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "update" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "update_allows_fetch_and_merge", - "description": "

Branch can pull changes from its upstream repository

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "deletion", - "description": "

Only allow users with bypass permissions to delete matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "deletion" - ] - } - ] - }, - { - "type": "object", - "name": "required_linear_history", - "description": "

Prevent merge commits from being pushed to matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_linear_history" - ] - } - ] - }, - { - "type": "object", - "name": "required_deployments", - "description": "

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_deployments" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "required_deployment_environments", - "description": "

The environments that must be successfully deployed to before branches can be merged.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "required_signatures", - "description": "

Commits pushed to matching refs must have verified signatures.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_signatures" - ] - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "pull_request" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "dismiss_stale_reviews_on_push", - "description": "

New, reviewable commits pushed will dismiss previous pull request review approvals.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_code_owner_review", - "description": "

Require an approving review in pull requests that modify files that have a designated code owner.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_last_push_approval", - "description": "

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

", - "isRequired": true - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

The number of approving reviews that are required before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "required_review_thread_resolution", - "description": "

All conversations on code must be resolved before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "required_reviewers", - "description": "

Note

\n

\nrequired_reviewers is in beta and subject to change.

\n
\n

A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "file_patterns", - "description": "

Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.

", - "isRequired": true - }, - { - "type": "integer", - "name": "minimum_approvals", - "description": "

Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.

", - "isRequired": true - }, - { - "type": "object", - "name": "reviewer", - "description": "

A required reviewing team

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

ID of the reviewer which must review changes to matching files.

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The type of the reviewer

", - "isRequired": true, - "enum": [ - "Team" - ] - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "required_status_checks", - "description": "

Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_status_checks" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "required_status_checks", - "description": "

Status checks that are required.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The status check context name that must be present on the commit.

", - "isRequired": true - }, - { - "type": "integer", - "name": "integration_id", - "description": "

The optional integration ID that this status check must originate from.

" - } - ] - }, - { - "type": "boolean", - "name": "strict_required_status_checks_policy", - "description": "

Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "non_fast_forward", - "description": "

Prevent users with push access from force pushing to refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "non_fast_forward" - ] - } - ] - }, - { - "type": "object", - "name": "commit_message_pattern", - "description": "

Parameters to be used for the commit_message_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_message_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "commit_author_email_pattern", - "description": "

Parameters to be used for the commit_author_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_author_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "committer_email_pattern", - "description": "

Parameters to be used for the committer_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "committer_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "branch_name_pattern", - "description": "

Parameters to be used for the branch_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "branch_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "tag_name_pattern", - "description": "

Parameters to be used for the tag_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "tag_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "workflows", - "description": "

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "workflows" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "workflows", - "description": "

Workflows that must pass for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "

The path to the workflow file

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The ref (branch or tag) of the workflow file to use

" - }, - { - "type": "integer", - "name": "repository_id", - "description": "

The ID of the repository where the workflow is defined

", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "

The commit SHA of the workflow file to use

" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "code_scanning", - "description": "

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "code_scanning" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of objects", - "name": "code_scanning_tools", - "description": "

Tools that must provide code scanning results for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - { - "type": "string", - "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - { - "type": "string", - "name": "tool", - "description": "

The name of a code scanning tool

", - "isRequired": true - } - ] - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "array of objects", - "name": "updated", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "rule", - "description": "

A repository rule.

", - "childParamsGroups": [ - { - "type": "object", - "name": "creation", - "description": "

Only allow users with bypass permission to create matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "creation" - ] - } - ] - }, - { - "type": "object", - "name": "update", - "description": "

Only allow users with bypass permission to update matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "update" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "update_allows_fetch_and_merge", - "description": "

Branch can pull changes from its upstream repository

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "deletion", - "description": "

Only allow users with bypass permissions to delete matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "deletion" - ] - } - ] - }, - { - "type": "object", - "name": "required_linear_history", - "description": "

Prevent merge commits from being pushed to matching refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_linear_history" - ] - } - ] - }, - { - "type": "object", - "name": "required_deployments", - "description": "

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_deployments" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "required_deployment_environments", - "description": "

The environments that must be successfully deployed to before branches can be merged.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "required_signatures", - "description": "

Commits pushed to matching refs must have verified signatures.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_signatures" - ] - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "pull_request" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "dismiss_stale_reviews_on_push", - "description": "

New, reviewable commits pushed will dismiss previous pull request review approvals.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_code_owner_review", - "description": "

Require an approving review in pull requests that modify files that have a designated code owner.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "require_last_push_approval", - "description": "

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

", - "isRequired": true - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

The number of approving reviews that are required before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "required_review_thread_resolution", - "description": "

All conversations on code must be resolved before a pull request can be merged.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "required_reviewers", - "description": "

Note

\n

\nrequired_reviewers is in beta and subject to change.

\n
\n

A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "file_patterns", - "description": "

Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.

", - "isRequired": true - }, - { - "type": "integer", - "name": "minimum_approvals", - "description": "

Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.

", - "isRequired": true - }, - { - "type": "object", - "name": "reviewer", - "description": "

A required reviewing team

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "

ID of the reviewer which must review changes to matching files.

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The type of the reviewer

", - "isRequired": true, - "enum": [ - "Team" - ] - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "required_status_checks", - "description": "

Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "required_status_checks" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "required_status_checks", - "description": "

Status checks that are required.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The status check context name that must be present on the commit.

", - "isRequired": true - }, - { - "type": "integer", - "name": "integration_id", - "description": "

The optional integration ID that this status check must originate from.

" - } - ] - }, - { - "type": "boolean", - "name": "strict_required_status_checks_policy", - "description": "

Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "non_fast_forward", - "description": "

Prevent users with push access from force pushing to refs.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "non_fast_forward" - ] - } - ] - }, - { - "type": "object", - "name": "commit_message_pattern", - "description": "

Parameters to be used for the commit_message_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_message_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "commit_author_email_pattern", - "description": "

Parameters to be used for the commit_author_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "commit_author_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "committer_email_pattern", - "description": "

Parameters to be used for the committer_email_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "committer_email_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "branch_name_pattern", - "description": "

Parameters to be used for the branch_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "branch_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "tag_name_pattern", - "description": "

Parameters to be used for the tag_name_pattern rule

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "tag_name_pattern" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

How this rule appears when configuring it.

" - }, - { - "type": "boolean", - "name": "negate", - "description": "

If true, the rule will fail if the pattern matches.

" - }, - { - "type": "string", - "name": "operator", - "description": "

The operator to use for matching.

", - "isRequired": true, - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - { - "type": "string", - "name": "pattern", - "description": "

The pattern to match with.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "workflows", - "description": "

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "workflows" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "do_not_enforce_on_create", - "description": "

Allow repositories and branches to be created if a check would otherwise prohibit it.

" - }, - { - "type": "array of objects", - "name": "workflows", - "description": "

Workflows that must pass for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "

The path to the workflow file

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The ref (branch or tag) of the workflow file to use

" - }, - { - "type": "integer", - "name": "repository_id", - "description": "

The ID of the repository where the workflow is defined

", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "

The commit SHA of the workflow file to use

" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "code_scanning", - "description": "

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true, - "enum": [ - "code_scanning" - ] - }, - { - "type": "object", - "name": "parameters", - "description": "", - "childParamsGroups": [ - { - "type": "array of objects", - "name": "code_scanning_tools", - "description": "

Tools that must provide code scanning results for this rule to pass.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - { - "type": "string", - "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", - "isRequired": true, - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - { - "type": "string", - "name": "tool", - "description": "

The name of a code scanning tool

", - "isRequired": true - } - ] - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "object", - "name": "changes", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "configuration", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "" - } - ] - }, - { - "type": "object", - "name": "rule_type", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "" - } - ] - }, - { - "type": "object", - "name": "pattern", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "" - } - ] - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "edited", - "category": "repository_ruleset" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/repository_vulnerability_alert.json b/src/webhooks/data/ghes-3.14/repository_vulnerability_alert.json deleted file mode 100644 index 06371fb1de66..000000000000 --- a/src/webhooks/data/ghes-3.14/repository_vulnerability_alert.json +++ /dev/null @@ -1,1118 +0,0 @@ -{ - "create": { - "descriptionHtml": "

A repository vulnerability alert was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a security vulnerability alert in a repository.

\n

\n

\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "create" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "

The security alert of the vulnerable dependency.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "affected_package_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "affected_range", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "dismiss_reason", - "description": "" - }, - { - "type": "string", - "name": "dismissed_at", - "description": "" - }, - { - "type": "object or null", - "name": "dismisser", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "external_identifier", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "external_reference", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "fix_reason", - "description": "" - }, - { - "type": "string", - "name": "fixed_at", - "description": "" - }, - { - "type": "string", - "name": "fixed_in", - "description": "" - }, - { - "type": "string", - "name": "ghsa_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "severity", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "auto_dismissed", - "open" - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization" - ], - "action": "create", - "category": "repository_vulnerability_alert" - }, - "dismiss": { - "descriptionHtml": "

A repository vulnerability alert was dismissed.

", - "summaryHtml": "

This event occurs when there is activity relating to a security vulnerability alert in a repository.

\n

\n

\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "dismiss" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "

The security alert of the vulnerable dependency.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "affected_package_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "affected_range", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismiss_comment", - "description": "" - }, - { - "type": "string", - "name": "dismiss_reason", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "dismissed_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismisser", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "external_identifier", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "external_reference", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "fix_reason", - "description": "" - }, - { - "type": "string", - "name": "fixed_at", - "description": "" - }, - { - "type": "string", - "name": "fixed_in", - "description": "" - }, - { - "type": "string", - "name": "ghsa_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "severity", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "dismissed" - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization" - ], - "action": "dismiss", - "category": "repository_vulnerability_alert" - }, - "reopen": { - "descriptionHtml": "

A previously dismissed or resolved repository vulnerability alert was reopened.

", - "summaryHtml": "

This event occurs when there is activity relating to a security vulnerability alert in a repository.

\n

\n

\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "reopen" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "

The security alert of the vulnerable dependency.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "affected_package_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "affected_range", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "dismiss_reason", - "description": "" - }, - { - "type": "string", - "name": "dismissed_at", - "description": "" - }, - { - "type": "object or null", - "name": "dismisser", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "external_identifier", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "external_reference", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "fix_reason", - "description": "" - }, - { - "type": "string", - "name": "fixed_at", - "description": "" - }, - { - "type": "string", - "name": "fixed_in", - "description": "" - }, - { - "type": "string", - "name": "ghsa_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "severity", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "auto_dismissed", - "open" - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization" - ], - "action": "reopen", - "category": "repository_vulnerability_alert" - }, - "resolve": { - "descriptionHtml": "

A repository vulnerability alert was marked as resolved.

", - "summaryHtml": "

This event occurs when there is activity relating to a security vulnerability alert in a repository.

\n

\n

\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.

\n
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "resolve" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "

The security alert of the vulnerable dependency.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "affected_package_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "affected_range", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "dismiss_reason", - "description": "" - }, - { - "type": "string", - "name": "dismissed_at", - "description": "" - }, - { - "type": "object or null", - "name": "dismisser", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "external_identifier", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "external_reference", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "fix_reason", - "description": "" - }, - { - "type": "string", - "name": "fixed_at", - "description": "" - }, - { - "type": "string", - "name": "fixed_in", - "description": "" - }, - { - "type": "string", - "name": "ghsa_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "severity", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "fixed", - "open" - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization" - ], - "action": "resolve", - "category": "repository_vulnerability_alert" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/secret_scanning_alert.json b/src/webhooks/data/ghes-3.14/secret_scanning_alert.json deleted file mode 100644 index 94b30e7681df..000000000000 --- a/src/webhooks/data/ghes-3.14/secret_scanning_alert.json +++ /dev/null @@ -1,1666 +0,0 @@ -{ - "created": { - "descriptionHtml": "

A secret scanning alert was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "number", - "description": "

The security alert number.

" - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "null", - "name": "updated_at", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

" - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

" - }, - { - "type": "string", - "name": "locations_url", - "description": "

The REST API URL of the code locations for this alert.

" - }, - { - "type": "string or null", - "name": "resolution", - "description": "

The reason for resolving the alert.

", - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - "pattern_deleted", - "pattern_edited", - null - ] - }, - { - "type": "string or null", - "name": "resolved_at", - "description": "

The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "object or null", - "name": "resolved_by", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "resolution_comment", - "description": "

An optional comment to resolve an alert.

" - }, - { - "type": "string", - "name": "secret_type", - "description": "

The type of secret that secret scanning detected.

" - }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" - }, - { - "type": "string", - "name": "validity", - "description": "

The token status as of the latest validity check.

", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - { - "type": "boolean or null", - "name": "push_protection_bypassed", - "description": "

Whether push protection was bypassed for the detected secret.

" - }, - { - "type": "object or null", - "name": "push_protection_bypassed_by", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "push_protection_bypassed_at", - "description": "

The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "secret_scanning_alert" - }, - "reopened": { - "descriptionHtml": "

A previously closed secret scanning alert was reopened.

", - "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "reopened" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "number", - "description": "

The security alert number.

" - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "null", - "name": "updated_at", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

" - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

" - }, - { - "type": "string", - "name": "locations_url", - "description": "

The REST API URL of the code locations for this alert.

" - }, - { - "type": "string or null", - "name": "resolution", - "description": "

The reason for resolving the alert.

", - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - "pattern_deleted", - "pattern_edited", - null - ] - }, - { - "type": "string or null", - "name": "resolved_at", - "description": "

The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "object or null", - "name": "resolved_by", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "resolution_comment", - "description": "

An optional comment to resolve an alert.

" - }, - { - "type": "string", - "name": "secret_type", - "description": "

The type of secret that secret scanning detected.

" - }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" - }, - { - "type": "string", - "name": "validity", - "description": "

The token status as of the latest validity check.

", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - { - "type": "boolean or null", - "name": "push_protection_bypassed", - "description": "

Whether push protection was bypassed for the detected secret.

" - }, - { - "type": "object or null", - "name": "push_protection_bypassed_by", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "push_protection_bypassed_at", - "description": "

The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "reopened", - "category": "secret_scanning_alert" - }, - "resolved": { - "descriptionHtml": "

A secret scanning alert was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "resolved" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "number", - "description": "

The security alert number.

" - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "null", - "name": "updated_at", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

" - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

" - }, - { - "type": "string", - "name": "locations_url", - "description": "

The REST API URL of the code locations for this alert.

" - }, - { - "type": "string or null", - "name": "resolution", - "description": "

The reason for resolving the alert.

", - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - "pattern_deleted", - "pattern_edited", - null - ] - }, - { - "type": "string or null", - "name": "resolved_at", - "description": "

The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "object or null", - "name": "resolved_by", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "resolution_comment", - "description": "

An optional comment to resolve an alert.

" - }, - { - "type": "string", - "name": "secret_type", - "description": "

The type of secret that secret scanning detected.

" - }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" - }, - { - "type": "string", - "name": "validity", - "description": "

The token status as of the latest validity check.

", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - { - "type": "boolean or null", - "name": "push_protection_bypassed", - "description": "

Whether push protection was bypassed for the detected secret.

" - }, - { - "type": "object or null", - "name": "push_protection_bypassed_by", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "push_protection_bypassed_at", - "description": "

The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "resolved", - "category": "secret_scanning_alert" - }, - "validated": { - "descriptionHtml": "

A secret scanning alert was validated.

", - "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "validated" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "number", - "description": "

The security alert number.

" - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "null", - "name": "updated_at", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

" - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

" - }, - { - "type": "string", - "name": "locations_url", - "description": "

The REST API URL of the code locations for this alert.

" - }, - { - "type": "string or null", - "name": "resolution", - "description": "

The reason for resolving the alert.

", - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - "pattern_deleted", - "pattern_edited", - null - ] - }, - { - "type": "string or null", - "name": "resolved_at", - "description": "

The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "object or null", - "name": "resolved_by", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "resolution_comment", - "description": "

An optional comment to resolve an alert.

" - }, - { - "type": "string", - "name": "secret_type", - "description": "

The type of secret that secret scanning detected.

" - }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" - }, - { - "type": "string", - "name": "validity", - "description": "

The token status as of the latest validity check.

", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - { - "type": "boolean or null", - "name": "push_protection_bypassed", - "description": "

Whether push protection was bypassed for the detected secret.

" - }, - { - "type": "object or null", - "name": "push_protection_bypassed_by", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "push_protection_bypassed_at", - "description": "

The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "validated", - "category": "secret_scanning_alert" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/secret_scanning_alert_location.json b/src/webhooks/data/ghes-3.14/secret_scanning_alert_location.json deleted file mode 100644 index 138444640135..000000000000 --- a/src/webhooks/data/ghes-3.14/secret_scanning_alert_location.json +++ /dev/null @@ -1,713 +0,0 @@ -{ - "created": { - "descriptionHtml": "

A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.

", - "summaryHtml": "

This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.

\n

For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alerts, use the secret_scanning_alert event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "number", - "description": "

The security alert number.

" - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "null", - "name": "updated_at", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

" - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

" - }, - { - "type": "string", - "name": "locations_url", - "description": "

The REST API URL of the code locations for this alert.

" - }, - { - "type": "string or null", - "name": "resolution", - "description": "

The reason for resolving the alert.

", - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - "pattern_deleted", - "pattern_edited", - null - ] - }, - { - "type": "string or null", - "name": "resolved_at", - "description": "

The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "type": "object or null", - "name": "resolved_by", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "resolution_comment", - "description": "

An optional comment to resolve an alert.

" - }, - { - "type": "string", - "name": "secret_type", - "description": "

The type of secret that secret scanning detected.

" - }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" - }, - { - "type": "string", - "name": "validity", - "description": "

The token status as of the latest validity check.

", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - { - "type": "boolean or null", - "name": "push_protection_bypassed", - "description": "

Whether push protection was bypassed for the detected secret.

" - }, - { - "type": "object or null", - "name": "push_protection_bypassed_by", - "description": "

A GitHub user.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "push_protection_bypassed_at", - "description": "

The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - } - ] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "location", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.

", - "enum": [ - "commit", - "wiki_commit", - "issue_title", - "issue_body", - "issue_comment", - "discussion_title", - "discussion_body", - "discussion_comment", - "pull_request_title", - "pull_request_body", - "pull_request_comment", - "pull_request_review", - "pull_request_review_comment" - ] - }, - { - "type": "object", - "name": "details", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "", - "description": "

Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.

", - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "

The file path in the repository

", - "isRequired": true - }, - { - "type": "number", - "name": "start_line", - "description": "

Line number at which the secret starts in the file

", - "isRequired": true - }, - { - "type": "number", - "name": "end_line", - "description": "

Line number at which the secret ends in the file

", - "isRequired": true - }, - { - "type": "number", - "name": "start_column", - "description": "

The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII

", - "isRequired": true - }, - { - "type": "number", - "name": "end_column", - "description": "

The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII

", - "isRequired": true - }, - { - "type": "string", - "name": "blob_sha", - "description": "

SHA-1 hash ID of the associated blob

", - "isRequired": true - }, - { - "type": "string", - "name": "blob_url", - "description": "

The API URL to get the associated blob resource

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_sha", - "description": "

SHA-1 hash ID of the associated commit

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_url", - "description": "

The API URL to get the associated commit resource

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "", - "description": "

Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.

", - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "

The file path of the wiki page

", - "isRequired": true - }, - { - "type": "number", - "name": "start_line", - "description": "

Line number at which the secret starts in the file

", - "isRequired": true - }, - { - "type": "number", - "name": "end_line", - "description": "

Line number at which the secret ends in the file

", - "isRequired": true - }, - { - "type": "number", - "name": "start_column", - "description": "

The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII.

", - "isRequired": true - }, - { - "type": "number", - "name": "end_column", - "description": "

The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII.

", - "isRequired": true - }, - { - "type": "string", - "name": "blob_sha", - "description": "

SHA-1 hash ID of the associated blob

", - "isRequired": true - }, - { - "type": "string", - "name": "page_url", - "description": "

The GitHub URL to get the associated wiki page

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_sha", - "description": "

SHA-1 hash ID of the associated commit

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_url", - "description": "

The GitHub URL to get the associated wiki commit

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "", - "description": "

Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.

", - "childParamsGroups": [ - { - "type": "string", - "name": "issue_title_url", - "description": "

The API URL to get the issue where the secret was detected.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "", - "description": "

Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.

", - "childParamsGroups": [ - { - "type": "string", - "name": "issue_body_url", - "description": "

The API URL to get the issue where the secret was detected.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "", - "description": "

Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.

", - "childParamsGroups": [ - { - "type": "string", - "name": "issue_comment_url", - "description": "

The API URL to get the issue comment where the secret was detected.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "", - "description": "

Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.

", - "childParamsGroups": [ - { - "type": "string", - "name": "discussion_title_url", - "description": "

The URL to the discussion where the secret was detected.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "", - "description": "

Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.

", - "childParamsGroups": [ - { - "type": "string", - "name": "discussion_body_url", - "description": "

The URL to the discussion where the secret was detected.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "", - "description": "

Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.

", - "childParamsGroups": [ - { - "type": "string", - "name": "discussion_comment_url", - "description": "

The API URL to get the discussion comment where the secret was detected.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "", - "description": "

Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pull_request_title_url", - "description": "

The API URL to get the pull request where the secret was detected.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "", - "description": "

Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pull_request_body_url", - "description": "

The API URL to get the pull request where the secret was detected.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "", - "description": "

Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pull_request_comment_url", - "description": "

The API URL to get the pull request comment where the secret was detected.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "", - "description": "

Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pull_request_review_url", - "description": "

The API URL to get the pull request review where the secret was detected.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "", - "description": "

Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.

", - "childParamsGroups": [ - { - "type": "string", - "name": "pull_request_review_comment_url", - "description": "

The API URL to get the pull request review comment where the secret was detected.

", - "isRequired": true - } - ] - } - ], - "oneOfObject": true - } - ] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "secret_scanning_alert_location" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/security_advisory.json b/src/webhooks/data/ghes-3.14/security_advisory.json deleted file mode 100644 index c8c4dd68ccd2..000000000000 --- a/src/webhooks/data/ghes-3.14/security_advisory.json +++ /dev/null @@ -1,824 +0,0 @@ -{ - "published": { - "descriptionHtml": "

A security advisory was published to the GitHub community.

", - "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "published" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "security_advisory", - "description": "

The details of the security advisory, including summary, description, and severity.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "cvss", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "vector_string", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_severities", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "cvss_v3", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 3 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 3 score.

", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_v4", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 4 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 4 score.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "array of objects", - "name": "cwes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "cwe_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ghsa_id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "identifiers", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "value", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "published_at", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "references", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "summary", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "vulnerabilities", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "first_patched_version", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "package", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "withdrawn_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "published", - "category": "security_advisory" - }, - "updated": { - "descriptionHtml": "

The metadata or description of a security advisory was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "updated" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "security_advisory", - "description": "

The details of the security advisory, including summary, description, and severity.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "cvss", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "vector_string", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_severities", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "cvss_v3", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 3 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 3 score.

", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_v4", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 4 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 4 score.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "array of objects", - "name": "cwes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "cwe_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ghsa_id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "identifiers", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "value", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "published_at", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "references", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "summary", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "vulnerabilities", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "first_patched_version", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "package", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "withdrawn_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "updated", - "category": "security_advisory" - }, - "withdrawn": { - "descriptionHtml": "

A previously published security advisory was withdrawn.

", - "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "withdrawn" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "security_advisory", - "description": "

The details of the security advisory, including summary, description, and severity.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "cvss", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "vector_string", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_severities", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "cvss_v3", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 3 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 3 score.

", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "cvss_v4", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "vector_string", - "description": "

The CVSS 4 vector string.

", - "isRequired": true - }, - { - "type": "number or null", - "name": "score", - "description": "

The CVSS 4 score.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "array of objects", - "name": "cwes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "cwe_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ghsa_id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "identifiers", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "value", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "published_at", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "references", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "summary", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "vulnerabilities", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "first_patched_version", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "package", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "withdrawn_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "withdrawn", - "category": "security_advisory" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/security_and_analysis.json b/src/webhooks/data/ghes-3.14/security_and_analysis.json deleted file mode 100644 index 12fe3ef8810a..000000000000 --- a/src/webhooks/data/ghes-3.14/security_and_analysis.json +++ /dev/null @@ -1,132 +0,0 @@ -{ - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"GitHub security features.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "from", - "description": "", - "childParamsGroups": [ - { - "type": "object or null", - "name": "security_and_analysis", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "advanced_security", - "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "enabled", - "disabled" - ] - } - ] - }, - { - "type": "object", - "name": "dependabot_security_updates", - "description": "

Enable or disable Dependabot security updates for the repository.

", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "

The enablement status of Dependabot security updates for the repository.

", - "enum": [ - "enabled", - "disabled" - ] - } - ] - }, - { - "type": "object", - "name": "secret_scanning", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "enabled", - "disabled" - ] - } - ] - }, - { - "type": "object", - "name": "secret_scanning_push_protection", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "status", - "description": "", - "enum": [ - "enabled", - "disabled" - ] - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

Full Repository

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "security_and_analysis" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/sponsorship.json b/src/webhooks/data/ghes-3.14/sponsorship.json deleted file mode 100644 index fa39c79a6d44..000000000000 --- a/src/webhooks/data/ghes-3.14/sponsorship.json +++ /dev/null @@ -1,3125 +0,0 @@ -{ - "cancelled": { - "descriptionHtml": "

A sponsorship was cancelled and the last billing cycle has ended.

\n

This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.

", - "summaryHtml": "

This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.

\n

You can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "cancelled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sponsorship", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "maintainer", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "privacy_level", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "sponsor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "sponsorable", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "tier", - "description": "

The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_custom_ammount", - "description": "" - }, - { - "type": "boolean", - "name": "is_custom_amount", - "description": "" - }, - { - "type": "boolean", - "name": "is_one_time", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "monthly_price_in_cents", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "monthly_price_in_dollars", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - } - ] - } - ] - } - ], - "availability": [ - "sponsors_listing" - ], - "action": "cancelled", - "category": "sponsorship" - }, - "created": { - "descriptionHtml": "

A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.

", - "summaryHtml": "

This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.

\n

You can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sponsorship", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "maintainer", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "privacy_level", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "sponsor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "sponsorable", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "tier", - "description": "

The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_custom_ammount", - "description": "" - }, - { - "type": "boolean", - "name": "is_custom_amount", - "description": "" - }, - { - "type": "boolean", - "name": "is_one_time", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "monthly_price_in_cents", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "monthly_price_in_dollars", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - } - ] - } - ] - } - ], - "availability": [ - "sponsors_listing" - ], - "action": "created", - "category": "sponsorship" - }, - "edited": { - "descriptionHtml": "

A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.

", - "summaryHtml": "

This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.

\n

You can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "privacy_level", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The edited event types include the details about the change when someone edits a sponsorship to change the privacy.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sponsorship", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "maintainer", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "privacy_level", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "sponsor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "sponsorable", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "tier", - "description": "

The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_custom_ammount", - "description": "" - }, - { - "type": "boolean", - "name": "is_custom_amount", - "description": "" - }, - { - "type": "boolean", - "name": "is_one_time", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "monthly_price_in_cents", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "monthly_price_in_dollars", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - } - ] - } - ] - } - ], - "availability": [ - "sponsors_listing" - ], - "action": "edited", - "category": "sponsorship" - }, - "pending_cancellation": { - "descriptionHtml": "

A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.

\n

This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.

", - "summaryHtml": "

This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.

\n

You can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "pending_cancellation" - ], - "childParamsGroups": [] - }, - { - "type": "string", - "name": "effective_date", - "description": "

The pending_cancellation and pending_tier_change event types will include the date the cancellation or tier change will take effect.

" - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sponsorship", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "maintainer", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "privacy_level", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "sponsor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "sponsorable", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "tier", - "description": "

The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_custom_ammount", - "description": "" - }, - { - "type": "boolean", - "name": "is_custom_amount", - "description": "" - }, - { - "type": "boolean", - "name": "is_one_time", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "monthly_price_in_cents", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "monthly_price_in_dollars", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - } - ] - } - ] - } - ], - "availability": [ - "sponsors_listing" - ], - "action": "pending_cancellation", - "category": "sponsorship" - }, - "pending_tier_change": { - "descriptionHtml": "

A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.

", - "summaryHtml": "

This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.

\n

You can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "pending_tier_change" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "tier", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "from", - "description": "

The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_custom_ammount", - "description": "" - }, - { - "type": "boolean", - "name": "is_custom_amount", - "description": "" - }, - { - "type": "boolean", - "name": "is_one_time", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "monthly_price_in_cents", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "monthly_price_in_dollars", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - } - ] - } - ] - } - ] - }, - { - "type": "string", - "name": "effective_date", - "description": "

The pending_cancellation and pending_tier_change event types will include the date the cancellation or tier change will take effect.

" - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sponsorship", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "maintainer", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "privacy_level", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "sponsor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "sponsorable", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "tier", - "description": "

The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_custom_ammount", - "description": "" - }, - { - "type": "boolean", - "name": "is_custom_amount", - "description": "" - }, - { - "type": "boolean", - "name": "is_one_time", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "monthly_price_in_cents", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "monthly_price_in_dollars", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - } - ] - } - ] - } - ], - "availability": [ - "sponsors_listing" - ], - "action": "pending_tier_change", - "category": "sponsorship" - }, - "tier_changed": { - "descriptionHtml": "

A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.

", - "summaryHtml": "

This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.

\n

You can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "tier_changed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "tier", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "from", - "description": "

The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_custom_ammount", - "description": "" - }, - { - "type": "boolean", - "name": "is_custom_amount", - "description": "" - }, - { - "type": "boolean", - "name": "is_one_time", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "monthly_price_in_cents", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "monthly_price_in_dollars", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sponsorship", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "maintainer", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "privacy_level", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "sponsor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object or null", - "name": "sponsorable", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "tier", - "description": "

The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_custom_ammount", - "description": "" - }, - { - "type": "boolean", - "name": "is_custom_amount", - "description": "" - }, - { - "type": "boolean", - "name": "is_one_time", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "monthly_price_in_cents", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "monthly_price_in_dollars", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - } - ] - } - ] - } - ], - "availability": [ - "sponsors_listing" - ], - "action": "tier_changed", - "category": "sponsorship" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/star.json b/src/webhooks/data/ghes-3.14/star.json deleted file mode 100644 index a585d60575ac..000000000000 --- a/src/webhooks/data/ghes-3.14/star.json +++ /dev/null @@ -1,124 +0,0 @@ -{ - "created": { - "descriptionHtml": "

Someone starred a repository.

", - "summaryHtml": "

This event occurs when there is activity relating to repository stars. For more information about stars, see \"Saving repositories with stars.\" For information about the APIs to manage stars, see the GraphQL documentation or \"Starring\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "string or null", - "name": "starred_at", - "description": "

The time the star was created. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Will be null for the deleted action.

", - "isRequired": true - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "star" - }, - "deleted": { - "descriptionHtml": "

Someone unstarred the repository.

", - "summaryHtml": "

This event occurs when there is activity relating to repository stars. For more information about stars, see \"Saving repositories with stars.\" For information about the APIs to manage stars, see the GraphQL documentation or \"Starring\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "null", - "name": "starred_at", - "description": "

The time the star was created. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Will be null for the deleted action.

", - "isRequired": true - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "star" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/status.json b/src/webhooks/data/ghes-3.14/status.json deleted file mode 100644 index 578ef082b949..000000000000 --- a/src/webhooks/data/ghes-3.14/status.json +++ /dev/null @@ -1,609 +0,0 @@ -{ - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Commit statuses\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.

", - "bodyParameters": [ - { - "type": "string or null", - "name": "avatar_url", - "description": "" - }, - { - "type": "array of objects", - "name": "branches", - "description": "

An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "commit", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "protected", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commit", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "author", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "commit", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "author", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "comment_count", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "committer", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "string", - "name": "message", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "tree", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "verification", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "payload", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "reason", - "description": "", - "isRequired": true, - "enum": [ - "expired_key", - "not_signing_key", - "gpgverify_error", - "gpgverify_unavailable", - "unsigned", - "unknown_signature_type", - "no_user", - "unverified_email", - "bad_email", - "unknown_key", - "malformed_signature", - "invalid", - "valid", - "bad_cert", - "ocsp_pending" - ] - }, - { - "type": "string or null", - "name": "signature", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "verified", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object or null", - "name": "committer", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "parents", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "context", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "

The optional human-readable description added to the status.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "id", - "description": "

The unique identifier of the status.

", - "isRequired": true - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "string", - "name": "sha", - "description": "

The Commit SHA.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The new state. Can be pending, success, failure, or error.

", - "isRequired": true, - "enum": [ - "pending", - "success", - "failure", - "error" - ] - }, - { - "type": "string or null", - "name": "target_url", - "description": "

The optional link added to the status.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "status" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/team.json b/src/webhooks/data/ghes-3.14/team.json deleted file mode 100644 index 7e449e9adfa5..000000000000 --- a/src/webhooks/data/ghes-3.14/team.json +++ /dev/null @@ -1,1428 +0,0 @@ -{ - "added_to_repository": { - "descriptionHtml": "

A team was granted access to a repository.

", - "summaryHtml": "

This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "added_to_repository" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

A git repository

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "team", - "description": "

Groups of organization members that gives permissions on specified repositories.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "

Whether team members will receive notifications when their team is @mentioned

", - "isRequired": true, - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "isRequired": true, - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "

Whether team members will receive notifications when their team is @mentioned

", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - } - ], - "availability": [ - "organization", - "business", - "app" - ], - "action": "added_to_repository", - "category": "team" - }, - "created": { - "descriptionHtml": "

A team was created.

", - "summaryHtml": "

This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

A git repository

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "team", - "description": "

Groups of organization members that gives permissions on specified repositories.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "

Whether team members will receive notifications when their team is @mentioned

", - "isRequired": true, - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "isRequired": true, - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "

Whether team members will receive notifications when their team is @mentioned

", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - } - ], - "availability": [ - "organization", - "business", - "app" - ], - "action": "created", - "category": "team" - }, - "deleted": { - "descriptionHtml": "

A team was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

A git repository

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "team", - "description": "

Groups of organization members that gives permissions on specified repositories.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "

Whether team members will receive notifications when their team is @mentioned

", - "isRequired": true, - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "isRequired": true, - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "

Whether team members will receive notifications when their team is @mentioned

", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - } - ], - "availability": [ - "organization", - "business", - "app" - ], - "action": "deleted", - "category": "team" - }, - "edited": { - "descriptionHtml": "

The name, description, or visibility of a team was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "description": "

The changes to the team if the action was edited.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "description", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the description if the action was edited.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "name", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the name if the action was edited.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "privacy", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the team's privacy if the action was edited.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "notification_setting", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "

The previous version of the team's notification setting if the action was edited.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "permissions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "from", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "

The previous version of the team member's admin permission on a repository, if the action was edited.

" - }, - { - "type": "boolean", - "name": "pull", - "description": "

The previous version of the team member's pull permission on a repository, if the action was edited.

" - }, - { - "type": "boolean", - "name": "push", - "description": "

The previous version of the team member's push permission on a repository, if the action was edited.

" - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

A git repository

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "team", - "description": "

Groups of organization members that gives permissions on specified repositories.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "

Whether team members will receive notifications when their team is @mentioned

", - "isRequired": true, - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "isRequired": true, - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "

Whether team members will receive notifications when their team is @mentioned

", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - } - ], - "availability": [ - "organization", - "business", - "app" - ], - "action": "edited", - "category": "team" - }, - "removed_from_repository": { - "descriptionHtml": "

A team's access to a repository was removed.

", - "summaryHtml": "

This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "removed_from_repository" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

A git repository

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "team", - "description": "

Groups of organization members that gives permissions on specified repositories.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "

Whether team members will receive notifications when their team is @mentioned

", - "isRequired": true, - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "isRequired": true, - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "

Whether team members will receive notifications when their team is @mentioned

", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - } - ], - "availability": [ - "organization", - "business", - "app" - ], - "action": "removed_from_repository", - "category": "team" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/team_add.json b/src/webhooks/data/ghes-3.14/team_add.json deleted file mode 100644 index ee15f59128b7..000000000000 --- a/src/webhooks/data/ghes-3.14/team_add.json +++ /dev/null @@ -1,258 +0,0 @@ -{ - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when a team is added to a repository.\nFor more information, see \"Managing teams and people with access to your repository.\"

\n

For activity relating to teams, see the teams event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "team", - "description": "

Groups of organization members that gives permissions on specified repositories.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "object or null", - "name": "parent", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "

Description of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "members_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

Name of the team

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

", - "isRequired": true - }, - { - "type": "string", - "name": "privacy", - "description": "", - "isRequired": true, - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "

Whether team members will receive notifications when their team is @mentioned

", - "isRequired": true, - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "isRequired": true, - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - }, - { - "type": "string", - "name": "permission", - "description": "

Permission that the team will have for its repositories

" - }, - { - "type": "string", - "name": "privacy", - "description": "", - "enum": [ - "open", - "closed", - "secret" - ] - }, - { - "type": "string", - "name": "notification_setting", - "description": "

Whether team members will receive notifications when their team is @mentioned

", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - { - "type": "string", - "name": "repositories_url", - "description": "" - }, - { - "type": "string", - "name": "slug", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "

URL for the team

" - }, - { - "type": "string", - "name": "type", - "description": "

The ownership type of the team

", - "enum": [ - "enterprise", - "organization" - ] - }, - { - "type": "integer", - "name": "organization_id", - "description": "

Unique identifier of the organization to which this team belongs

" - }, - { - "type": "integer", - "name": "enterprise_id", - "description": "

Unique identifier of the enterprise to which this team belongs

" - } - ] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "team_add" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/user.json b/src/webhooks/data/ghes-3.14/user.json deleted file mode 100644 index 88cbb28d0204..000000000000 --- a/src/webhooks/data/ghes-3.14/user.json +++ /dev/null @@ -1,352 +0,0 @@ -{ - "created": { - "descriptionHtml": "

A user account was added to the enterprise.

", - "summaryHtml": "

This event occurs when there is activity relating to user accounts in an enterprise.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "user", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ], - "availability": [ - "business" - ], - "action": "created", - "category": "user" - }, - "deleted": { - "descriptionHtml": "

A user account was removed from the enterprise.

", - "summaryHtml": "

This event occurs when there is activity relating to user accounts in an enterprise.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "user", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ], - "availability": [ - "business" - ], - "action": "deleted", - "category": "user" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/watch.json b/src/webhooks/data/ghes-3.14/watch.json deleted file mode 100644 index 1166f83778a8..000000000000 --- a/src/webhooks/data/ghes-3.14/watch.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "started": { - "descriptionHtml": "

Someone started watching the repository.

", - "summaryHtml": "

This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"Managing your subscriptions.\" For information about the APIs to manage watching, see \"Watching\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "started" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "started", - "category": "watch" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/workflow_dispatch.json b/src/webhooks/data/ghes-3.14/workflow_dispatch.json deleted file mode 100644 index b138cc3c2956..000000000000 --- a/src/webhooks/data/ghes-3.14/workflow_dispatch.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"Manually running a workflow.\"

\n

For activity relating to workflow runs, use the workflow_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "inputs", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "string", - "name": "workflow", - "description": "", - "isRequired": true - } - ], - "availability": [ - "app" - ], - "action": "default", - "category": "workflow_dispatch" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/workflow_job.json b/src/webhooks/data/ghes-3.14/workflow_job.json deleted file mode 100644 index ed73af4b8a45..000000000000 --- a/src/webhooks/data/ghes-3.14/workflow_job.json +++ /dev/null @@ -1,2018 +0,0 @@ -{ - "completed": { - "descriptionHtml": "

A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.

", - "summaryHtml": "

This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.

\n

For activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "completed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "workflow_job", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "check_run_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "completed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "success", - "failure", - null, - "skipped", - "cancelled", - "action_required", - "neutral", - "timed_out" - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the job created.

", - "isRequired": true - }, - { - "type": "string", - "name": "head_sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "labels", - "description": "

Custom labels for the job. Specified by the \"runs-on\" attribute in the workflow YAML.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "run_attempt", - "description": "", - "isRequired": true - }, - { - "type": "number", - "name": "run_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "run_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "runner_group_id", - "description": "

The ID of the runner group that is running this job. This will be null as long as workflow_job[status] is queued.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "runner_group_name", - "description": "

The name of the runner group that is running this job. This will be null as long as workflow_job[status] is queued.

", - "isRequired": true - }, - { - "type": "integer or null", - "name": "runner_id", - "description": "

The ID of the runner that is running this job. This will be null as long as workflow_job[status] is queued.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "runner_name", - "description": "

The name of the runner that is running this job. This will be null as long as workflow_job[status] is queued.

", - "isRequired": true - }, - { - "type": "string", - "name": "started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "

The current status of the job. Can be queued, in_progress, waiting, or completed.

", - "isRequired": true, - "enum": [ - "queued", - "in_progress", - "completed", - "waiting" - ] - }, - { - "type": "string or null", - "name": "head_branch", - "description": "

The name of the current branch.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "workflow_name", - "description": "

The name of the workflow.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "steps", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "completed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "failure", - "skipped", - "success", - "cancelled", - null - ] - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "in_progress", - "completed", - "queued" - ] - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "deployment", - "description": "

A request for a specific ref(branch,sha,tag) to be deployed

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the deployment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The ref to deploy. This can be a branch, tag, or sha.

", - "isRequired": true - }, - { - "type": "string", - "name": "task", - "description": "

Parameter to specify a task to execute

", - "isRequired": true - }, - { - "type": "object or string", - "name": "payload", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "original_environment", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "

Name for the target deployment environment.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "transient_environment", - "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" - }, - { - "type": "boolean", - "name": "production_environment", - "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - } - ] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "completed", - "category": "workflow_job" - }, - "in_progress": { - "descriptionHtml": "

A job in a workflow run started processing on a runner.

", - "summaryHtml": "

This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.

\n

For activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "in_progress" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "workflow_job", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "check_run_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "completed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "success", - "failure", - null, - "cancelled", - "neutral" - ] - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the job created.

", - "isRequired": true - }, - { - "type": "string", - "name": "head_sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "labels", - "description": "

Custom labels for the job. Specified by the \"runs-on\" attribute in the workflow YAML.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "run_attempt", - "description": "", - "isRequired": true - }, - { - "type": "number", - "name": "run_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "run_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "runner_group_id", - "description": "

The ID of the runner group that is running this job. This will be null as long as workflow_job[status] is queued.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "runner_group_name", - "description": "

The name of the runner group that is running this job. This will be null as long as workflow_job[status] is queued.

", - "isRequired": true - }, - { - "type": "integer or null", - "name": "runner_id", - "description": "

The ID of the runner that is running this job. This will be null as long as workflow_job[status] is queued.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "runner_name", - "description": "

The name of the runner that is running this job. This will be null as long as workflow_job[status] is queued.

", - "isRequired": true - }, - { - "type": "string", - "name": "started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "

The current status of the job. Can be queued, in_progress, or completed.

", - "isRequired": true, - "enum": [ - "queued", - "in_progress", - "completed" - ] - }, - { - "type": "string or null", - "name": "head_branch", - "description": "

The name of the current branch.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "workflow_name", - "description": "

The name of the workflow.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "steps", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "completed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "failure", - "skipped", - "success", - null, - "cancelled" - ] - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "in_progress", - "completed", - "queued", - "pending" - ] - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "deployment", - "description": "

A request for a specific ref(branch,sha,tag) to be deployed

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the deployment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The ref to deploy. This can be a branch, tag, or sha.

", - "isRequired": true - }, - { - "type": "string", - "name": "task", - "description": "

Parameter to specify a task to execute

", - "isRequired": true - }, - { - "type": "object or string", - "name": "payload", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "original_environment", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "

Name for the target deployment environment.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "transient_environment", - "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" - }, - { - "type": "boolean", - "name": "production_environment", - "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - } - ] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "in_progress", - "category": "workflow_job" - }, - "queued": { - "descriptionHtml": "

A job in a workflow run was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.

\n

For activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "queued" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "workflow_job", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "check_run_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "completed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the job created.

", - "isRequired": true - }, - { - "type": "string", - "name": "head_sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "labels", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "run_attempt", - "description": "", - "isRequired": true - }, - { - "type": "number", - "name": "run_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "run_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "runner_group_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "runner_group_name", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "runner_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "runner_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "queued", - "in_progress", - "completed", - "waiting" - ] - }, - { - "type": "string or null", - "name": "head_branch", - "description": "

The name of the current branch.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "workflow_name", - "description": "

The name of the workflow.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "steps", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "completed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "failure", - "skipped", - "success", - "cancelled", - null - ] - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "completed", - "in_progress", - "queued", - "pending" - ] - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "deployment", - "description": "

A request for a specific ref(branch,sha,tag) to be deployed

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the deployment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The ref to deploy. This can be a branch, tag, or sha.

", - "isRequired": true - }, - { - "type": "string", - "name": "task", - "description": "

Parameter to specify a task to execute

", - "isRequired": true - }, - { - "type": "object or string", - "name": "payload", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "original_environment", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "

Name for the target deployment environment.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "transient_environment", - "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" - }, - { - "type": "boolean", - "name": "production_environment", - "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - } - ] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "queued", - "category": "workflow_job" - }, - "waiting": { - "descriptionHtml": "

A job in a workflow run was created and is waiting for approvals.

", - "summaryHtml": "

This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.

\n

For activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "waiting" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "workflow_job", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "check_run_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "completed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "

The time that the job created.

", - "isRequired": true - }, - { - "type": "string", - "name": "head_sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "labels", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "run_attempt", - "description": "", - "isRequired": true - }, - { - "type": "number", - "name": "run_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "run_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "runner_group_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "runner_group_name", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "runner_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "runner_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "started_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "head_branch", - "description": "

The name of the current branch.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "workflow_name", - "description": "

The name of the workflow.

", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "queued", - "in_progress", - "completed", - "waiting" - ] - }, - { - "type": "array of objects", - "name": "steps", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "completed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "failure", - "skipped", - "success", - "cancelled", - null - ] - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "completed", - "in_progress", - "queued", - "pending", - "waiting" - ] - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "deployment", - "description": "

A request for a specific ref(branch,sha,tag) to be deployed

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the deployment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "

The ref to deploy. This can be a branch, tag, or sha.

", - "isRequired": true - }, - { - "type": "string", - "name": "task", - "description": "

Parameter to specify a task to execute

", - "isRequired": true - }, - { - "type": "object or string", - "name": "payload", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "original_environment", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "

Name for the target deployment environment.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "transient_environment", - "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" - }, - { - "type": "boolean", - "name": "production_environment", - "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "" - } - ] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "waiting", - "category": "workflow_job" - } -} \ No newline at end of file diff --git a/src/webhooks/data/ghes-3.14/workflow_run.json b/src/webhooks/data/ghes-3.14/workflow_run.json deleted file mode 100644 index 4cb6d5c03e05..000000000000 --- a/src/webhooks/data/ghes-3.14/workflow_run.json +++ /dev/null @@ -1,4579 +0,0 @@ -{ - "completed": { - "descriptionHtml": "

A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.

", - "summaryHtml": "

This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.

\n

For activity relating to a job in a workflow run, use the workflow_job event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "completed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "workflow", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "badge_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "workflow_run", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "actor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "artifacts_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "cancel_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "check_suite_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_suite_node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_suite_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "action_required", - "cancelled", - "failure", - "neutral", - "skipped", - "stale", - "success", - "timed_out", - "startup_failure", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "event", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "head_branch", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "head_commit", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "author", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "object", - "name": "committer", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "string", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "message", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "timestamp", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tree_id", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "head_repository", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "head_sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "jobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "logs_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "previous_attempt_url", - "description": "", - "isRequired": true - }, - { - "type": "array of object,nulls", - "name": "pull_requests", - "description": "", - "isRequired": true - }, - { - "type": "array of objects or null", - "name": "referenced_workflows", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "" - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "rerun_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "run_attempt", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "run_number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "run_started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - "pending", - "waiting" - ] - }, - { - "type": "object or null", - "name": "triggering_actor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "workflow_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "workflow_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "display_title", - "description": "

The event-specific title associated with the run or the run-name if set, or the value of run-name if it is set in the workflow.

" - } - ] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "completed", - "category": "workflow_run" - }, - "in_progress": { - "descriptionHtml": "

A workflow run started processing on a runner.

", - "summaryHtml": "

This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.

\n

For activity relating to a job in a workflow run, use the workflow_job event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "in_progress" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "workflow", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "badge_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "workflow_run", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "actor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "artifacts_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "cancel_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "check_suite_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_suite_node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_suite_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "action_required", - "cancelled", - "failure", - "neutral", - "skipped", - "stale", - "success", - "timed_out", - null - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "event", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "head_branch", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "head_commit", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "author", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "object", - "name": "committer", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "string", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "message", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "timestamp", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tree_id", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "head_repository", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "head_sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "jobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "logs_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "previous_attempt_url", - "description": "", - "isRequired": true - }, - { - "type": "array of object,nulls", - "name": "pull_requests", - "description": "", - "isRequired": true - }, - { - "type": "array of objects or null", - "name": "referenced_workflows", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "" - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "rerun_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "run_attempt", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "run_number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "run_started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - "pending" - ] - }, - { - "type": "object or null", - "name": "triggering_actor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "workflow_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "workflow_url", - "description": "", - "isRequired": true - } - ] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "in_progress", - "category": "workflow_run" - }, - "requested": { - "descriptionHtml": "

A workflow run was triggered.

", - "summaryHtml": "

This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.

\n

For activity relating to a job in a workflow run, use the workflow_job event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "description": "", - "isRequired": true, - "enum": [ - "requested" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "workflow", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "badge_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "workflow_run", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "actor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "artifacts_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "cancel_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "check_suite_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_suite_node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_suite_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - null, - "skipped", - "startup_failure" - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "event", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "head_branch", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "head_commit", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "author", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "object", - "name": "committer", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "string", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "message", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "timestamp", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tree_id", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "head_repository", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "head_sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "jobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "logs_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "previous_attempt_url", - "description": "", - "isRequired": true - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "number", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "number", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "array of objects or null", - "name": "referenced_workflows", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "description": "" - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "assignees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "blobs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "branches_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "collaborators_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "compare_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contents_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "contributors_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "deployments_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "downloads_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "fork", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "forks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issue_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "milestones_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "rerun_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "run_attempt", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "run_number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "run_started_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - "pending", - "waiting" - ] - }, - { - "type": "object or null", - "name": "triggering_actor", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "workflow_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "workflow_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "display_title", - "description": "", - "isRequired": true - } - ] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "requested", - "category": "workflow_run" - } -} \ No newline at end of file